1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.util;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Paths;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.TreeSet;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
/**
* A helper class to find all classes on the current classpath. This is used to automatically create
* JUnit 3 and 4 test suites.
*/
public final class Classpath {
private static final String CLASS_EXTENSION = ".class";
/**
* Base exception for any classpath related errors.
*/
public static final class ClassPathException extends Exception {
public ClassPathException(String format, Object... args) {
super(String.format(format, args));
}
}
/** Finds all classes that live in or below the given package. */
public static Set<Class<?>> findClasses(String packageName) throws ClassPathException {
Set<Class<?>> result = new LinkedHashSet<>();
String pathPrefix = (packageName + '.').replace('.', '/');
for (String entryName : getClassPath()) {
File classPathEntry = new File(entryName);
if (classPathEntry.exists()) {
try {
Set<String> classNames;
if (classPathEntry.isDirectory()) {
classNames = findClassesInDirectory(classPathEntry, pathPrefix);
} else {
classNames = findClassesInJar(classPathEntry, pathPrefix);
}
for (String className : classNames) {
try {
Class<?> clazz = Class.forName(className);
result.add(clazz);
} catch (UnsatisfiedLinkError | NoClassDefFoundError unused) {
// Ignore: we're most likely running on a different platform.
}
}
} catch (IOException e) {
throw new ClassPathException(
"Can't read classpath entry %s: %s", entryName, e.getMessage());
} catch (ClassNotFoundException e) {
throw new ClassPathException(
"Class not found even though it is on the classpath %s: %s",
entryName, e.getMessage());
}
}
}
return result;
}
private static Set<String> findClassesInDirectory(File classPathEntry, String pathPrefix) {
Set<String> result = new TreeSet<>();
File directory = new File(classPathEntry, pathPrefix);
innerFindClassesInDirectory(result, directory, pathPrefix);
return result;
}
/**
* Finds all classes and sub packages in the given directory that are below the given package and
* add them to the respective sets.
*
* @param directory Directory to inspect
* @param pathPrefix Prefix for the path to the classes that are requested
* (ex: {@code com/google/foo/bar})
*/
private static void innerFindClassesInDirectory(Set<String> classNames, File directory,
String pathPrefix) {
Preconditions.checkArgument(pathPrefix.endsWith("/"));
if (directory.exists()) {
for (File f : directory.listFiles()) {
String name = f.getName();
if (name.endsWith(CLASS_EXTENSION)) {
String clzName = getClassName(pathPrefix + name);
classNames.add(clzName);
} else if (f.isDirectory()) {
findClassesInDirectory(f, pathPrefix + name + "/");
}
}
}
}
/**
* Returns a set of all classes in the jar that start with the given prefix.
*/
private static Set<String> findClassesInJar(File jarFile, String pathPrefix) throws IOException {
Set<String> classNames = new TreeSet<>();
try (ZipFile zipFile = new ZipFile(jarFile)) {
Enumeration<? extends ZipEntry> entries = zipFile.entries();
while (entries.hasMoreElements()) {
String entryName = entries.nextElement().getName();
if (entryName.startsWith(pathPrefix) && entryName.endsWith(CLASS_EXTENSION)) {
classNames.add(getClassName(entryName));
}
}
}
return classNames;
}
/**
* Given the absolute path of a class file, return the class name.
*/
private static String getClassName(String className) {
int classNameEnd = className.length() - CLASS_EXTENSION.length();
return className.substring(0, classNameEnd).replace('/', '.');
}
private static void getClassPathsFromClasspathJar(File classpathJar, Set<String> classPaths)
throws IOException, ClassPathException {
Manifest manifest = new JarFile(classpathJar).getManifest();
Attributes attributes = manifest.getMainAttributes();
for (String classPath : attributes.getValue("Class-Path").split(" ")) {
try {
classPaths.add(Paths.get(new URI(classPath)).toAbsolutePath().toString());
} catch (URISyntaxException e) {
throw new ClassPathException(
"Error parsing classpath uri %s: %s", classPath, e.getMessage());
}
}
}
/** Gets the classpath from current classloader. */
private static Set<String> getClassPath() throws ClassPathException {
ClassLoader classloader = Classpath.class.getClassLoader();
if (!(classloader instanceof URLClassLoader)) {
throw new IllegalStateException("Unable to find classes to test, since Test Suite class is "
+ "loaded by an unsupported Classloader.");
}
Set<String> completeClassPaths = new TreeSet<>();
URL[] urls = ((URLClassLoader) classloader).getURLs();
for (URL url : urls) {
String entryName = url.getPath();
completeClassPaths.add(entryName);
if (entryName.endsWith("-classpath.jar")) {
// Bazel creates a classpath jar when the class path length exceeds command line length
// limit, read the class path value from its manifest file if it's a classpath jar.
File classPathEntry = new File(entryName);
if (classPathEntry.exists() && classPathEntry.isFile()) {
try {
getClassPathsFromClasspathJar(classPathEntry, completeClassPaths);
} catch (IOException e) {
throw new ClassPathException(
"Can't read classpath entry %s: %s", entryName, e.getMessage());
}
}
}
}
return completeClassPaths;
}
}
|
