Krishna
2 years ago
committed by
GitHub
20 changed files with 505 additions and 77 deletions
@ -0,0 +1,310 @@
@@ -0,0 +1,310 @@
|
||||
/* |
||||
* Copyright 2012-2022 the original author or authors. |
||||
* |
||||
* 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 |
||||
* |
||||
* https://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 org.springframework.cloud.test; |
||||
|
||||
import java.io.File; |
||||
import java.lang.management.ManagementFactory; |
||||
import java.lang.reflect.AnnotatedElement; |
||||
import java.lang.reflect.Method; |
||||
import java.net.URISyntaxException; |
||||
import java.net.URL; |
||||
import java.net.URLClassLoader; |
||||
import java.util.ArrayList; |
||||
import java.util.Arrays; |
||||
import java.util.Collection; |
||||
import java.util.LinkedHashSet; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
import java.util.Set; |
||||
import java.util.jar.Attributes; |
||||
import java.util.jar.JarFile; |
||||
import java.util.regex.Pattern; |
||||
import java.util.stream.Collectors; |
||||
import java.util.stream.Stream; |
||||
|
||||
import org.apache.maven.repository.internal.MavenRepositorySystemUtils; |
||||
import org.eclipse.aether.DefaultRepositorySystemSession; |
||||
import org.eclipse.aether.RepositorySystem; |
||||
import org.eclipse.aether.artifact.DefaultArtifact; |
||||
import org.eclipse.aether.collection.CollectRequest; |
||||
import org.eclipse.aether.connector.basic.BasicRepositoryConnectorFactory; |
||||
import org.eclipse.aether.graph.Dependency; |
||||
import org.eclipse.aether.impl.DefaultServiceLocator; |
||||
import org.eclipse.aether.repository.LocalRepository; |
||||
import org.eclipse.aether.repository.RemoteRepository; |
||||
import org.eclipse.aether.resolution.ArtifactResult; |
||||
import org.eclipse.aether.resolution.DependencyRequest; |
||||
import org.eclipse.aether.resolution.DependencyResult; |
||||
import org.eclipse.aether.spi.connector.RepositoryConnectorFactory; |
||||
import org.eclipse.aether.spi.connector.transport.TransporterFactory; |
||||
import org.eclipse.aether.transport.http.HttpTransporterFactory; |
||||
|
||||
import org.springframework.core.annotation.MergedAnnotation; |
||||
import org.springframework.core.annotation.MergedAnnotations; |
||||
import org.springframework.util.AntPathMatcher; |
||||
import org.springframework.util.ConcurrentReferenceHashMap; |
||||
import org.springframework.util.ObjectUtils; |
||||
import org.springframework.util.StringUtils; |
||||
|
||||
/** |
||||
* Custom {@link URLClassLoader} that modifies the class path. |
||||
* |
||||
* @author Andy Wilkinson |
||||
* @author Christoph Dreis |
||||
* @author Siva Krishna Battu |
||||
* @see <a href= |
||||
* "https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/classpath/ModifiedClassPathClassLoader.java">ModifiedClassPathClassLoader.java</a> |
||||
*/ |
||||
final class ModifiedClassPathClassLoader extends URLClassLoader { |
||||
|
||||
private static final Map<List<AnnotatedElement>, ModifiedClassPathClassLoader> cache = new ConcurrentReferenceHashMap<>(); |
||||
|
||||
private static final Pattern INTELLIJ_CLASSPATH_JAR_PATTERN = Pattern.compile(".*classpath(\\d+)?\\.jar"); |
||||
|
||||
private static final int MAX_RESOLUTION_ATTEMPTS = 5; |
||||
|
||||
private final ClassLoader junitLoader; |
||||
|
||||
ModifiedClassPathClassLoader(URL[] urls, ClassLoader parent, ClassLoader junitLoader) { |
||||
super(urls, parent); |
||||
this.junitLoader = junitLoader; |
||||
} |
||||
|
||||
@Override |
||||
public Class<?> loadClass(String name) throws ClassNotFoundException { |
||||
if (name.startsWith("org.junit") || name.startsWith("org.hamcrest") |
||||
|| name.startsWith("io.netty.internal.tcnative")) { |
||||
return Class.forName(name, false, this.junitLoader); |
||||
} |
||||
return super.loadClass(name); |
||||
} |
||||
|
||||
static ModifiedClassPathClassLoader get(Class<?> testClass, Method testMethod, List<Object> arguments) { |
||||
Set<AnnotatedElement> candidates = new LinkedHashSet<>(); |
||||
candidates.add(testClass); |
||||
candidates.add(testMethod); |
||||
candidates.addAll(getAnnotatedElements(arguments.toArray())); |
||||
List<AnnotatedElement> annotatedElements = candidates.stream() |
||||
.filter(ModifiedClassPathClassLoader::hasAnnotation).collect(Collectors.toList()); |
||||
if (annotatedElements.isEmpty()) { |
||||
return null; |
||||
} |
||||
return cache.computeIfAbsent(annotatedElements, (key) -> compute(testClass.getClassLoader(), key)); |
||||
} |
||||
|
||||
private static Collection<AnnotatedElement> getAnnotatedElements(Object[] array) { |
||||
Set<AnnotatedElement> result = new LinkedHashSet<>(); |
||||
for (Object item : array) { |
||||
if (item instanceof AnnotatedElement) { |
||||
result.add((AnnotatedElement) item); |
||||
} |
||||
else if (ObjectUtils.isArray(item)) { |
||||
result.addAll(getAnnotatedElements(ObjectUtils.toObjectArray(item))); |
||||
} |
||||
} |
||||
return result; |
||||
} |
||||
|
||||
private static boolean hasAnnotation(AnnotatedElement element) { |
||||
MergedAnnotations annotations = MergedAnnotations.from(element, |
||||
MergedAnnotations.SearchStrategy.TYPE_HIERARCHY); |
||||
return annotations.isPresent(ClassPathOverrides.class) || annotations.isPresent(ClassPathExclusions.class); |
||||
} |
||||
|
||||
private static ModifiedClassPathClassLoader compute(ClassLoader classLoader, |
||||
List<AnnotatedElement> annotatedClasses) { |
||||
List<MergedAnnotations> annotations = annotatedClasses.stream() |
||||
.map((source) -> MergedAnnotations.from(source, MergedAnnotations.SearchStrategy.TYPE_HIERARCHY)) |
||||
.toList(); |
||||
return new ModifiedClassPathClassLoader(processUrls(extractUrls(classLoader), annotations), |
||||
classLoader.getParent(), classLoader); |
||||
} |
||||
|
||||
private static URL[] extractUrls(ClassLoader classLoader) { |
||||
List<URL> extractedUrls = new ArrayList<>(); |
||||
doExtractUrls(classLoader).forEach((URL url) -> { |
||||
if (isManifestOnlyJar(url)) { |
||||
extractedUrls.addAll(extractUrlsFromManifestClassPath(url)); |
||||
} |
||||
else { |
||||
extractedUrls.add(url); |
||||
} |
||||
}); |
||||
return extractedUrls.toArray(new URL[0]); |
||||
} |
||||
|
||||
private static Stream<URL> doExtractUrls(ClassLoader classLoader) { |
||||
if (classLoader instanceof URLClassLoader urlClassLoader) { |
||||
return Stream.of(urlClassLoader.getURLs()); |
||||
} |
||||
return Stream.of(ManagementFactory.getRuntimeMXBean().getClassPath().split(File.pathSeparator)) |
||||
.map(ModifiedClassPathClassLoader::toURL); |
||||
} |
||||
|
||||
private static URL toURL(String entry) { |
||||
try { |
||||
return new File(entry).toURI().toURL(); |
||||
} |
||||
catch (Exception ex) { |
||||
throw new IllegalArgumentException(ex); |
||||
} |
||||
} |
||||
|
||||
private static boolean isManifestOnlyJar(URL url) { |
||||
return isShortenedIntelliJJar(url); |
||||
} |
||||
|
||||
private static boolean isShortenedIntelliJJar(URL url) { |
||||
String urlPath = url.getPath(); |
||||
boolean isCandidate = INTELLIJ_CLASSPATH_JAR_PATTERN.matcher(urlPath).matches(); |
||||
if (isCandidate) { |
||||
try { |
||||
Attributes attributes = getManifestMainAttributesFromUrl(url); |
||||
String createdBy = attributes.getValue("Created-By"); |
||||
return createdBy != null && createdBy.contains("IntelliJ"); |
||||
} |
||||
catch (Exception ex) { |
||||
} |
||||
} |
||||
return false; |
||||
} |
||||
|
||||
private static List<URL> extractUrlsFromManifestClassPath(URL booterJar) { |
||||
List<URL> urls = new ArrayList<>(); |
||||
try { |
||||
for (String entry : getClassPath(booterJar)) { |
||||
urls.add(new URL(entry)); |
||||
} |
||||
} |
||||
catch (Exception ex) { |
||||
throw new RuntimeException(ex); |
||||
} |
||||
return urls; |
||||
} |
||||
|
||||
private static String[] getClassPath(URL booterJar) throws Exception { |
||||
Attributes attributes = getManifestMainAttributesFromUrl(booterJar); |
||||
return StringUtils.delimitedListToStringArray(attributes.getValue(Attributes.Name.CLASS_PATH), " "); |
||||
} |
||||
|
||||
private static Attributes getManifestMainAttributesFromUrl(URL url) throws Exception { |
||||
try (JarFile jarFile = new JarFile(new File(url.toURI()))) { |
||||
return jarFile.getManifest().getMainAttributes(); |
||||
} |
||||
} |
||||
|
||||
private static URL[] processUrls(URL[] urls, List<MergedAnnotations> annotations) { |
||||
ClassPathEntryFilter filter = new ClassPathEntryFilter(annotations); |
||||
List<URL> additionalUrls = getAdditionalUrls(annotations); |
||||
List<URL> processedUrls = new ArrayList<>(additionalUrls); |
||||
for (URL url : urls) { |
||||
if (!filter.isExcluded(url)) { |
||||
processedUrls.add(url); |
||||
} |
||||
} |
||||
return processedUrls.toArray(new URL[0]); |
||||
} |
||||
|
||||
private static List<URL> getAdditionalUrls(List<MergedAnnotations> annotations) { |
||||
Set<URL> urls = new LinkedHashSet<>(); |
||||
for (MergedAnnotations candidate : annotations) { |
||||
MergedAnnotation<ClassPathOverrides> annotation = candidate.get(ClassPathOverrides.class); |
||||
if (annotation.isPresent()) { |
||||
urls.addAll(resolveCoordinates(annotation.getStringArray(MergedAnnotation.VALUE))); |
||||
} |
||||
} |
||||
return urls.stream().toList(); |
||||
} |
||||
|
||||
private static List<URL> resolveCoordinates(String[] coordinates) { |
||||
Exception latestFailure = null; |
||||
DefaultServiceLocator serviceLocator = MavenRepositorySystemUtils.newServiceLocator(); |
||||
serviceLocator.addService(RepositoryConnectorFactory.class, BasicRepositoryConnectorFactory.class); |
||||
serviceLocator.addService(TransporterFactory.class, HttpTransporterFactory.class); |
||||
RepositorySystem repositorySystem = serviceLocator.getService(RepositorySystem.class); |
||||
DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession(); |
||||
LocalRepository localRepository = new LocalRepository(System.getProperty("user.home") + "/.m2/repository"); |
||||
RemoteRepository remoteRepository = new RemoteRepository.Builder("central", "default", |
||||
"https://repo.maven.apache.org/maven2").build(); |
||||
session.setLocalRepositoryManager(repositorySystem.newLocalRepositoryManager(session, localRepository)); |
||||
for (int i = 0; i < MAX_RESOLUTION_ATTEMPTS; i++) { |
||||
CollectRequest collectRequest = new CollectRequest(null, Arrays.asList(remoteRepository)); |
||||
collectRequest.setDependencies(createDependencies(coordinates)); |
||||
DependencyRequest dependencyRequest = new DependencyRequest(collectRequest, null); |
||||
try { |
||||
DependencyResult result = repositorySystem.resolveDependencies(session, dependencyRequest); |
||||
List<URL> resolvedArtifacts = new ArrayList<>(); |
||||
for (ArtifactResult artifact : result.getArtifactResults()) { |
||||
resolvedArtifacts.add(artifact.getArtifact().getFile().toURI().toURL()); |
||||
} |
||||
return resolvedArtifacts; |
||||
} |
||||
catch (Exception ex) { |
||||
latestFailure = ex; |
||||
} |
||||
} |
||||
throw new IllegalStateException("Resolution failed after " + MAX_RESOLUTION_ATTEMPTS + " attempts", |
||||
latestFailure); |
||||
} |
||||
|
||||
private static List<Dependency> createDependencies(String[] allCoordinates) { |
||||
List<Dependency> dependencies = new ArrayList<>(); |
||||
for (String coordinate : allCoordinates) { |
||||
dependencies.add(new Dependency(new DefaultArtifact(coordinate), null)); |
||||
} |
||||
return dependencies; |
||||
} |
||||
|
||||
/** |
||||
* Filter for class path entries. |
||||
*/ |
||||
private static final class ClassPathEntryFilter { |
||||
|
||||
private final List<String> exclusions; |
||||
|
||||
private final AntPathMatcher matcher = new AntPathMatcher(); |
||||
|
||||
private ClassPathEntryFilter(List<MergedAnnotations> annotations) { |
||||
Set<String> exclusions = new LinkedHashSet<>(); |
||||
for (MergedAnnotations candidate : annotations) { |
||||
MergedAnnotation<ClassPathExclusions> annotation = candidate.get(ClassPathExclusions.class); |
||||
if (annotation.isPresent()) { |
||||
exclusions.addAll(Arrays.asList(annotation.getStringArray(MergedAnnotation.VALUE))); |
||||
} |
||||
} |
||||
this.exclusions = exclusions.stream().toList(); |
||||
} |
||||
|
||||
private boolean isExcluded(URL url) { |
||||
if ("file".equals(url.getProtocol())) { |
||||
try { |
||||
String name = new File(url.toURI()).getName(); |
||||
for (String exclusion : this.exclusions) { |
||||
if (this.matcher.match(exclusion, name)) { |
||||
return true; |
||||
} |
||||
} |
||||
} |
||||
catch (URISyntaxException ex) { |
||||
} |
||||
} |
||||
return false; |
||||
} |
||||
|
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,140 @@
@@ -0,0 +1,140 @@
|
||||
/* |
||||
* Copyright 2012-2022 the original author or authors. |
||||
* |
||||
* 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 |
||||
* |
||||
* https://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 org.springframework.cloud.test; |
||||
|
||||
import java.lang.reflect.Method; |
||||
import java.net.URLClassLoader; |
||||
|
||||
import org.junit.jupiter.api.extension.Extension; |
||||
import org.junit.jupiter.api.extension.ExtensionContext; |
||||
import org.junit.jupiter.api.extension.InvocationInterceptor; |
||||
import org.junit.jupiter.api.extension.ReflectiveInvocationContext; |
||||
import org.junit.platform.engine.discovery.DiscoverySelectors; |
||||
import org.junit.platform.launcher.Launcher; |
||||
import org.junit.platform.launcher.LauncherDiscoveryRequest; |
||||
import org.junit.platform.launcher.TestPlan; |
||||
import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder; |
||||
import org.junit.platform.launcher.core.LauncherFactory; |
||||
import org.junit.platform.launcher.listeners.SummaryGeneratingListener; |
||||
import org.junit.platform.launcher.listeners.TestExecutionSummary; |
||||
|
||||
import org.springframework.util.CollectionUtils; |
||||
|
||||
/** |
||||
* A custom {@link Extension} that runs tests using a modified class path. Entries are |
||||
* excluded from the class path using {@link ClassPathExclusions @ClassPathExclusions} and |
||||
* overridden using {@link ClassPathOverrides @ClassPathOverrides} on the test class. |
||||
* A class loader is created with the customized class path and is used both to load |
||||
* the test class and as the thread context class loader while the test is being run. |
||||
* |
||||
* @author Christoph Dreis |
||||
* @author Siva Krishna Battu |
||||
* @see <a href= |
||||
* "https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/classpath/ModifiedClassPathExtension.java">ModifiedClassPathExtension.java</a> |
||||
*/ |
||||
class ModifiedClassPathExtension implements InvocationInterceptor { |
||||
|
||||
@Override |
||||
public void interceptBeforeAllMethod(Invocation<Void> invocation, |
||||
ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable { |
||||
intercept(invocation, extensionContext); |
||||
} |
||||
|
||||
@Override |
||||
public void interceptBeforeEachMethod(Invocation<Void> invocation, |
||||
ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable { |
||||
intercept(invocation, extensionContext); |
||||
} |
||||
|
||||
@Override |
||||
public void interceptAfterEachMethod(Invocation<Void> invocation, |
||||
ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable { |
||||
intercept(invocation, extensionContext); |
||||
} |
||||
|
||||
@Override |
||||
public void interceptAfterAllMethod(Invocation<Void> invocation, |
||||
ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable { |
||||
intercept(invocation, extensionContext); |
||||
} |
||||
|
||||
@Override |
||||
public void interceptTestMethod(Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, |
||||
ExtensionContext extensionContext) throws Throwable { |
||||
interceptMethod(invocation, invocationContext, extensionContext); |
||||
} |
||||
|
||||
@Override |
||||
public void interceptTestTemplateMethod(Invocation<Void> invocation, |
||||
ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable { |
||||
interceptMethod(invocation, invocationContext, extensionContext); |
||||
} |
||||
|
||||
private void interceptMethod(Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, |
||||
ExtensionContext extensionContext) throws Throwable { |
||||
if (isModifiedClassPathClassLoader(extensionContext)) { |
||||
invocation.proceed(); |
||||
return; |
||||
} |
||||
Class<?> testClass = extensionContext.getRequiredTestClass(); |
||||
Method testMethod = invocationContext.getExecutable(); |
||||
URLClassLoader modifiedClassLoader = ModifiedClassPathClassLoader.get(testClass, testMethod, |
||||
invocationContext.getArguments()); |
||||
if (modifiedClassLoader == null) { |
||||
invocation.proceed(); |
||||
return; |
||||
} |
||||
invocation.skip(); |
||||
ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader(); |
||||
Thread.currentThread().setContextClassLoader(modifiedClassLoader); |
||||
try { |
||||
runTest(extensionContext.getUniqueId()); |
||||
} |
||||
finally { |
||||
Thread.currentThread().setContextClassLoader(originalClassLoader); |
||||
} |
||||
} |
||||
|
||||
private void runTest(String testId) throws Throwable { |
||||
LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request() |
||||
.selectors(DiscoverySelectors.selectUniqueId(testId)).build(); |
||||
Launcher launcher = LauncherFactory.create(); |
||||
TestPlan testPlan = launcher.discover(request); |
||||
SummaryGeneratingListener listener = new SummaryGeneratingListener(); |
||||
launcher.registerTestExecutionListeners(listener); |
||||
launcher.execute(testPlan); |
||||
TestExecutionSummary summary = listener.getSummary(); |
||||
if (!CollectionUtils.isEmpty(summary.getFailures())) { |
||||
throw summary.getFailures().get(0).getException(); |
||||
} |
||||
} |
||||
|
||||
private void intercept(Invocation<Void> invocation, ExtensionContext extensionContext) throws Throwable { |
||||
if (isModifiedClassPathClassLoader(extensionContext)) { |
||||
invocation.proceed(); |
||||
return; |
||||
} |
||||
invocation.skip(); |
||||
} |
||||
|
||||
private boolean isModifiedClassPathClassLoader(ExtensionContext extensionContext) { |
||||
Class<?> testClass = extensionContext.getRequiredTestClass(); |
||||
ClassLoader classLoader = testClass.getClassLoader(); |
||||
return classLoader.getClass().getName().equals(ModifiedClassPathClassLoader.class.getName()); |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue