Skip to content

Commit c39f06a

Browse files
uschindleruschindler
committed
Add DEBUG level logging and report classpath and JDK type to allow debugging od classpath/JDK related problems. This closes #202 
1 parent 500e8cc commit c39f06a

File tree

10 files changed

+65
-10
lines changed

10 files changed

+65
-10
lines changed

‎src/main/java/de/thetaphi/forbiddenapis/Checker.java

+15-4
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public static enum Option {
6666
final Logger logger;
6767

6868
final ClassLoader loader;
69+
final String humanClasspath;
6970
final java.lang.reflect.Method method_Class_getModule, method_Module_getName;
7071
final EnumSet<Option> options;
7172

@@ -79,13 +80,14 @@ public static enum Option {
7980
/** descriptors (not internal names) of all annotations that suppress */
8081
final Set<String> suppressAnnotations = new LinkedHashSet<>();
8182

82-
public Checker(Logger logger, ClassLoader loader, Option... options) {
83-
this(logger, loader, (options.length == 0) ? EnumSet.noneOf(Option.class) : EnumSet.copyOf(Arrays.asList(options)));
83+
public Checker(Logger logger, ClassLoader loader, String humanClasspath, Option... options) {
84+
this(logger, loader, humanClasspath, (options.length == 0) ? EnumSet.noneOf(Option.class) : EnumSet.copyOf(Arrays.asList(options)));
8485
}
8586

86-
public Checker(Logger logger, ClassLoader loader, EnumSet<Option> options) {
87+
public Checker(Logger logger, ClassLoader loader, String humanClasspath, EnumSet<Option> options) {
8788
this.logger = logger;
8889
this.loader = loader;
90+
this.humanClasspath = (humanClasspath == null || humanClasspath.isEmpty()) ? null : humanClasspath;
8991
this.options = options;
9092
this.start = System.currentTimeMillis();
9193

@@ -101,6 +103,7 @@ public Checker(Logger logger, ClassLoader loader, EnumSet<Option> options) {
101103
method_Module_getName = method_Class_getModule
102104
.getReturnType().getMethod("getName");
103105
isSupportedJDK = true;
106+
logger.debug("Detected Java 9 or later with module system.");
104107
} catch (NoSuchMethodException e) {
105108
method_Class_getModule = method_Module_getName = null;
106109
}
@@ -116,6 +119,7 @@ public Checker(Logger logger, ClassLoader loader, EnumSet<Option> options) {
116119
if (objectClassURL != null && "jrt".equalsIgnoreCase(objectClassURL.getProtocol())) {
117120
// this is Java 9+ allowing direct access to .class file resources - we do not need to deal with modules!
118121
isSupportedJDK = true;
122+
logger.debug("Detected Java 9 or later with JRT file system.");
119123
} else {
120124
String javaHome = System.getProperty("java.home");
121125
if (javaHome != null) {
@@ -146,7 +150,9 @@ public Checker(Logger logger, ClassLoader loader, EnumSet<Option> options) {
146150
}
147151
}
148152
isSupportedJDK = !runtimePaths.isEmpty();
149-
if (!isSupportedJDK) {
153+
if (isSupportedJDK) {
154+
logger.debug("Detected classical classpath-based JDK @ " + runtimePaths);
155+
} else {
150156
logger.warn("Boot classpath appears to be empty or ${java.home} not defined; marking runtime as not suppported.");
151157
}
152158
}
@@ -317,6 +323,11 @@ public ClassMetadata lookupRelatedClass(String internalName, String internalName
317323
}
318324
}
319325

326+
@Override
327+
public String getHumanClasspath() {
328+
return humanClasspath;
329+
}
330+
320331
/** Reads a list of bundled API signatures from classpath. */
321332
public void addBundledSignatures(String name, String jdkTargetVersion) throws IOException,ParseException {
322333
forbiddenSignatures.addBundledSignatures(name, jdkTargetVersion);

‎src/main/java/de/thetaphi/forbiddenapis/Logger.java

+1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ public interface Logger {
2020
void error(String msg);
2121
void warn(String msg);
2222
void info(String msg);
23+
void debug(String msg);
2324
}

‎src/main/java/de/thetaphi/forbiddenapis/RelatedClassLookup.java

+1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@
2121
public interface RelatedClassLookup {
2222
ClassMetadata lookupRelatedClass(String internalName, String internalNameOrig);
2323
ClassMetadata getClassFromClassLoader(String clazz) throws ClassNotFoundException,IOException;
24+
String getHumanClasspath();
2425
}

‎src/main/java/de/thetaphi/forbiddenapis/Signatures.java

+6
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ private void addSignature(final String line, final String defaultMessage, final
190190
return;
191191
}
192192
if (report.reportClassNotFound) {
193+
if (report != UnresolvableReporting.SILENT && lookup.getHumanClasspath() != null) {
194+
logger.debug("Classpath: " + lookup.getHumanClasspath());
195+
}
193196
report.parseFailed(logger, String.format(Locale.ENGLISH, "Class '%s' not found on classpath", cnfe.getMessage()), signature);
194197
} else {
195198
missingClasses.add(clazz);
@@ -231,6 +234,9 @@ private void reportMissingSignatureClasses(Set<String> missingClasses) {
231234
if (missingClasses.isEmpty()) {
232235
return;
233236
}
237+
if (lookup.getHumanClasspath() != null) {
238+
logger.debug("Classpath: " + lookup.getHumanClasspath());
239+
}
234240
logger.warn("Some signatures were ignored because the following classes were not found on classpath:");
235241
final StringBuilder sb = new StringBuilder();
236242
int count = 0;

‎src/main/java/de/thetaphi/forbiddenapis/StdIoLogger.java

+5
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,9 @@ public void info(String msg) {
3838
System.out.println(msg);
3939
}
4040

41+
@Override
42+
public void debug(String msg) {
43+
// no reporting of debug messages
44+
}
45+
4146
}

‎src/main/java/de/thetaphi/forbiddenapis/ant/AntTask.java

+6-1
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ public void warn(String msg) {
9191
public void info(String msg) {
9292
log(msg, Project.MSG_INFO);
9393
}
94+
95+
@Override
96+
public void debug(String msg) {
97+
log(msg, Project.MSG_DEBUG);
98+
}
9499
};
95100

96101
AntClassLoader antLoader = null;
@@ -116,7 +121,7 @@ public void info(String msg) {
116121
}
117122
if (ignoreSignaturesOfMissingClasses) options.add(IGNORE_SIGNATURES_OF_MISSING_CLASSES);
118123
if (disableClassloadingCache) options.add(DISABLE_CLASSLOADING_CACHE);
119-
final Checker checker = new Checker(log, loader, options);
124+
final Checker checker = new Checker(log, loader, (classpath == null) ? null : classpath.toString(), options);
120125

121126
if (!checker.isSupportedJDK) {
122127
final String msg = String.format(Locale.ENGLISH,

‎src/main/java/de/thetaphi/forbiddenapis/cli/CliMain.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -196,16 +196,22 @@ public void run() throws ExitException {
196196
// parse classpath given as argument; add -d to classpath, too
197197
final String[] classpath = cmd.getOptionValues(classpathOpt.getLongOpt());
198198
final URL[] urls;
199+
final CharSequence humanClasspath;
199200
try {
200201
if (classpath == null) {
201202
urls = new URL[] { classesDirectory.toURI().toURL() };
203+
humanClasspath = classesDirectory.toString();
202204
} else {
203205
urls = new URL[classpath.length + 1];
204206
int i = 0;
207+
final StringBuilder sb = new StringBuilder();
205208
for (final String cpElement : classpath) {
206209
urls[i++] = new File(cpElement).toURI().toURL();
210+
sb.append(cpElement).append(File.pathSeparatorChar);
207211
}
208212
urls[i++] = classesDirectory.toURI().toURL();
213+
sb.append(classesDirectory.toString());
214+
humanClasspath = sb;
209215
assert i == urls.length;
210216
}
211217
} catch (MalformedURLException mfue) {
@@ -222,7 +228,7 @@ public void run() throws ExitException {
222228
options.add(FAIL_ON_UNRESOLVABLE_SIGNATURES);
223229
}
224230
if (cmd.hasOption(ignoresignaturesofmissingclassesOpt.getLongOpt())) options.add(IGNORE_SIGNATURES_OF_MISSING_CLASSES);
225-
final Checker checker = new Checker(LOG, loader, options);
231+
final Checker checker = new Checker(LOG, loader, humanClasspath.toString(), options);
226232

227233
if (!checker.isSupportedJDK) {
228234
throw new ExitException(EXIT_UNSUPPORTED_JDK, String.format(Locale.ENGLISH,

‎src/main/java/de/thetaphi/forbiddenapis/gradle/CheckForbiddenApis.java

+11-1
Original file line numberDiff line numberDiff line change
@@ -498,16 +498,26 @@ public void warn(String msg) {
498498
public void info(String msg) {
499499
getLogger().info(msg);
500500
}
501+
502+
@Override
503+
public void debug(String msg) {
504+
getLogger().debug(msg);
505+
}
501506
};
502507

503508
final Set<File> cpElements = new LinkedHashSet<>();
504509
cpElements.addAll(classpath.getFiles());
505510
cpElements.addAll(classesDirs.getFiles());
506511
final URL[] urls = new URL[cpElements.size()];
512+
final StringBuilder humanClasspath = new StringBuilder();
507513
try {
508514
int i = 0;
509515
for (final File cpElement : cpElements) {
510516
urls[i++] = cpElement.toURI().toURL();
517+
if (humanClasspath.length() > 0) {
518+
humanClasspath.append(File.pathSeparatorChar);
519+
}
520+
humanClasspath.append(cpElement);
511521
}
512522
assert i == urls.length;
513523
} catch (MalformedURLException mfue) {
@@ -530,7 +540,7 @@ public void info(String msg) {
530540
}
531541
if (getIgnoreSignaturesOfMissingClasses()) options.add(IGNORE_SIGNATURES_OF_MISSING_CLASSES);
532542
if (getDisableClassloadingCache()) options.add(DISABLE_CLASSLOADING_CACHE);
533-
final Checker checker = new Checker(log, loader, options);
543+
final Checker checker = new Checker(log, loader, humanClasspath.toString(), options);
534544

535545
if (!checker.isSupportedJDK) {
536546
final String msg = String.format(Locale.ENGLISH,

‎src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java

+11-1
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,11 @@ public void warn(String msg) {
304304
public void info(String msg) {
305305
getLog().info(msg);
306306
}
307+
308+
@Override
309+
public void debug(String msg) {
310+
getLog().debug(msg);
311+
}
307312
};
308313

309314
if (skip) {
@@ -323,10 +328,15 @@ public void info(String msg) {
323328

324329
final List<String> cp = getClassPathElements();
325330
final URL[] urls = new URL[cp.size()];
331+
final StringBuilder humanClasspath = new StringBuilder();
326332
try {
327333
int i = 0;
328334
for (final String cpElement : cp) {
329335
urls[i++] = new File(cpElement).toURI().toURL();
336+
if (humanClasspath.length() > 0) {
337+
humanClasspath.append(File.pathSeparatorChar);
338+
}
339+
humanClasspath.append(cpElement);
330340
}
331341
assert i == urls.length;
332342
} catch (MalformedURLException e) {
@@ -349,7 +359,7 @@ public void info(String msg) {
349359
}
350360
if (ignoreSignaturesOfMissingClasses) options.add(IGNORE_SIGNATURES_OF_MISSING_CLASSES);
351361
if (disableClassloadingCache) options.add(DISABLE_CLASSLOADING_CACHE);
352-
final Checker checker = new Checker(log, loader, options);
362+
final Checker checker = new Checker(log, loader, humanClasspath.toString(), options);
353363

354364
if (!checker.isSupportedJDK) {
355365
final String msg = String.format(Locale.ENGLISH,

‎src/test/java/de/thetaphi/forbiddenapis/CheckerSetupTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public final class CheckerSetupTest {
3535

3636
@Before
3737
public void setUp() {
38-
checker = new Checker(StdIoLogger.INSTANCE, ClassLoader.getSystemClassLoader(), FAIL_ON_MISSING_CLASSES, FAIL_ON_VIOLATION, FAIL_ON_UNRESOLVABLE_SIGNATURES);
38+
checker = new Checker(StdIoLogger.INSTANCE, ClassLoader.getSystemClassLoader(), null, FAIL_ON_MISSING_CLASSES, FAIL_ON_VIOLATION, FAIL_ON_UNRESOLVABLE_SIGNATURES);
3939
assumeTrue("This test only works with a supported JDK (see docs)", checker.isSupportedJDK);
4040
assertEquals(EnumSet.of(FAIL_ON_MISSING_CLASSES, FAIL_ON_VIOLATION, FAIL_ON_UNRESOLVABLE_SIGNATURES), checker.options);
4141
forbiddenSignatures = checker.forbiddenSignatures;
@@ -146,7 +146,7 @@ public void testWildcardMethodSignatureNotExist() throws Exception {
146146

147147
@Test
148148
public void testEmptyCtor() throws Exception {
149-
Checker chk = new Checker(StdIoLogger.INSTANCE, ClassLoader.getSystemClassLoader());
149+
Checker chk = new Checker(StdIoLogger.INSTANCE, ClassLoader.getSystemClassLoader(), null);
150150
assertEquals(EnumSet.noneOf(Checker.Option.class), chk.options);
151151
}
152152

0 commit comments

Comments
 (0)