org.opendaylight.infrautils.testutils.ClasspathHellDuplicatesChecker Maven / Gradle / Ivy
/*
* Copyright (c) 2018 Red Hat, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.infrautils.testutils;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.github.classgraph.ClassGraph;
import io.github.classgraph.ResourceList;
import io.github.classgraph.ScanResult;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.stream.Collectors;
/**
* Check classpath for duplicates.
*
* @author Michael Vorburger.ch
*/
public class ClasspathHellDuplicatesChecker {
public static final ClasspathHellDuplicatesChecker INSTANCE = new ClasspathHellDuplicatesChecker();
private final Map> duplicates;
@SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "Poor original design")
public ClasspathHellDuplicatesChecker() {
duplicates = recheck();
}
public Map> getDuplicates() {
return duplicates;
}
public String toString(Map> map) {
StringBuilder sb = new StringBuilder();
for (Entry> entry : map.entrySet()) {
sb.append(entry.getKey()).append('\n');
for (String location : entry.getValue()) {
sb.append(" ").append(location).append('\n');
}
}
return sb.toString();
}
private Map> recheck() {
Map> dupes = new HashMap<>();
// To debug this scanner, use ClassGraph().verbose()
// We intentionally do not use .classFilesOnly(), or .nonClassFilesOnly(), to check both
try (ScanResult scanResult = new ClassGraph().scan()) {
for (Entry dupe : scanResult.getAllResources().findDuplicatePaths()) {
String path = dupe.getKey();
if (!isHarmlessDuplicate(path)) {
dupes.put(path, dupe.getValue().stream()
.map(resource -> resource.getURL().toExternalForm()).collect(Collectors.toList()));
}
}
return dupes;
}
}
@SuppressFBWarnings("DM_CONVERT_CASE")
protected boolean isHarmlessDuplicate(String resourcePath) {
// list from org.jhades.reports.DuplicatesReport
return resourcePath.equals("META-INF/MANIFEST.MF")
|| resourcePath.equals("META-INF/INDEX.LIST")
|| resourcePath.equals("META-INF/ORACLE_J.SF")
|| resourcePath.toUpperCase().startsWith("META-INF/NOTICE")
|| resourcePath.toUpperCase().startsWith("META-INF/LICENSE")
|| resourcePath.toUpperCase().startsWith("LICENSE")
|| resourcePath.toUpperCase().startsWith("LICENSE/NOTICE")
// list formerly in ClasspathHellDuplicatesCheckRule (moved here in INFRAUTILS-52)
|| resourcePath.endsWith(".txt")
|| resourcePath.endsWith("LICENSE")
|| resourcePath.endsWith("license.html")
|| resourcePath.endsWith("about.html")
|| resourcePath.endsWith("readme.html")
|| resourcePath.endsWith("README.md")
|| resourcePath.startsWith("META-INF/services")
|| resourcePath.equals("META-INF/DEPENDENCIES")
|| resourcePath.equals("META-INF/git.properties")
|| resourcePath.equals("META-INF/io.netty.versions.properties")
|| resourcePath.equals("META-INF/jersey-module-version")
|| resourcePath.startsWith("OSGI-INF/blueprint/")
|| resourcePath.startsWith("org/opendaylight/blueprint/")
|| resourcePath.equals("WEB-INF/web.xml")
|| resourcePath.endsWith("reference.conf") // in Akka's JARs
|| resourcePath.equals("META-INF/eclipse.inf")
|| resourcePath.equals("META-INF/ECLIPSE_.SF")
|| resourcePath.equals("META-INF/ECLIPSE_.RSA")
|| resourcePath.equals("META-INF/BC2048KE.DSA")
|| resourcePath.equals("META-INF/BC2048KE.SF")
|| resourcePath.equals("META-INF/BC1024KE.SF")
|| resourcePath.equals("OSGI-INF/bundle.info")
// Something doesn't to be a perfectly clean in Maven Surefire:
|| resourcePath.startsWith("META-INF/maven/")
|| resourcePath.contains("surefire")
// org.slf4j.impl.StaticLoggerBinder.class in testutils for the LogCaptureRule
|| resourcePath.equals("org/slf4j/impl/StaticLoggerBinder.class")
// INFRAUTILS-35: JavaLaunchHelper is both in java and libinstrument.dylib (?) on Mac OS X
|| resourcePath.contains("JavaLaunchHelper")
// javax.annotation is a big mess... :( E.g. javax.annotation.Resource (and some others)
// are present both in rt.jar AND javax.annotation-api-1.3.2.jar and similar - BUT those
// JARs cannot just be excluded, because they contain some additional annotations, in the
// (reserved!) package javax.annotation, such as javax.annotation.Priority et al. The
// super proper way to address this cleanly would be to make our own JAR for javax.annotation
// and have it contain ONLY what is not already in package javax.annotation in rt.jar.. but for now:
|| resourcePath.equals("javax/annotation/Resource$AuthenticationType.class")
// NEUTRON-205: javax.inject is a mess :( because of javax.inject:javax.inject (which we widely use in ODL)
// VS. org.glassfish.hk2.external:javax.inject (which Glassfish Jersey has dependencies on). Attempts to
// cleanly exclude glassfish.hk2's javax.inject and align everything on only depending on
// javax.inject:javax.inject have failed, because the OSGi bundle
// org.glassfish.jersey.containers.jersey-container-servlet-core (2.25.1) has a non-optional Package-Import
// for javax.inject, but we made javax.inject:javax.inject true in odlparent, and don't bundle it.
|| resourcePath.startsWith("javax/inject/")
// Java 9 modules
|| resourcePath.endsWith("module-info.class")
|| resourcePath.contains("findbugs")
// list newly introduced in INFRAUTILS-52, because classgraph scans more than JHades did
|| resourcePath.equals("plugin.properties")
|| resourcePath.equals(".api_description")
// errorprone with Java 11 integration leaks to classpath, which causes a conflict between
// checkerframework/checker-qual and checkerframework/dataflow
|| resourcePath.startsWith("org/checkerframework/dataflow/qual/")
// bundle.properties are perfectly fine
|| resourcePath.equals("bundle.properties")
;
}
}