Sam Brannen
3 years ago
5 changed files with 173 additions and 153 deletions
@ -0,0 +1,68 @@
@@ -0,0 +1,68 @@
|
||||
/* |
||||
* Copyright 2002-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.test.context.util; |
||||
|
||||
import java.lang.reflect.InvocationTargetException; |
||||
|
||||
import org.apache.commons.logging.Log; |
||||
import org.apache.commons.logging.LogFactory; |
||||
|
||||
import org.springframework.core.io.support.SpringFactoriesLoader.FailureHandler; |
||||
|
||||
/** |
||||
* Spring factories {@link FailureHandler} used within the <em>Spring TestContext |
||||
* Framework</em>. |
||||
* |
||||
* @author Sam Brannen |
||||
* @since 6.0 |
||||
*/ |
||||
class TestContextFailureHandler implements FailureHandler { |
||||
|
||||
private final Log logger = LogFactory.getLog(TestContextSpringFactoriesUtils.class); |
||||
|
||||
@Override |
||||
public void handleFailure(Class<?> factoryType, String factoryImplementationName, Throwable failure) { |
||||
Throwable ex = (failure instanceof InvocationTargetException ite ? ite.getTargetException() : failure); |
||||
if (ex instanceof ClassNotFoundException || ex instanceof NoClassDefFoundError) { |
||||
if (logger.isDebugEnabled()) { |
||||
logger.debug(""" |
||||
Skipping candidate %1$s [%2$s] due to a missing dependency. \ |
||||
Specify custom %1$s classes or make the default %1$s classes \ |
||||
and their required dependencies available. Offending class: [%3$s]""" |
||||
.formatted(factoryType.getSimpleName(), factoryImplementationName, ex.getMessage())); |
||||
} |
||||
} |
||||
else if (ex instanceof LinkageError) { |
||||
if (logger.isDebugEnabled()) { |
||||
logger.debug(""" |
||||
Could not load %1$s [%2$s]. Specify custom %1$s classes or make the default %1$s classes \ |
||||
available.""".formatted(factoryType.getSimpleName(), factoryImplementationName), ex); |
||||
} |
||||
} |
||||
else { |
||||
if (ex instanceof RuntimeException runtimeException) { |
||||
throw runtimeException; |
||||
} |
||||
if (ex instanceof Error error) { |
||||
throw error; |
||||
} |
||||
throw new IllegalStateException( |
||||
"Failed to load %s [%s]".formatted(factoryType.getSimpleName(), factoryImplementationName), ex); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,83 @@
@@ -0,0 +1,83 @@
|
||||
/* |
||||
* Copyright 2002-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.test.context.util; |
||||
|
||||
import java.util.Collection; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
|
||||
import org.apache.commons.logging.Log; |
||||
import org.apache.commons.logging.LogFactory; |
||||
|
||||
import org.springframework.core.io.support.SpringFactoriesLoader; |
||||
import org.springframework.core.io.support.SpringFactoriesLoader.FailureHandler; |
||||
|
||||
import static org.springframework.core.io.support.SpringFactoriesLoader.FACTORIES_RESOURCE_LOCATION; |
||||
|
||||
/** |
||||
* Collection of utilities for working with {@link SpringFactoriesLoader} within |
||||
* the <em>Spring TestContext Framework</em>. |
||||
* |
||||
* <p>Primarily intended for use within the TestContext framework. |
||||
* |
||||
* @author Sam Brannen |
||||
* @since 6.0 |
||||
*/ |
||||
public abstract class TestContextSpringFactoriesUtils { |
||||
|
||||
private static final Log logger = LogFactory.getLog(TestContextSpringFactoriesUtils.class); |
||||
|
||||
|
||||
private TestContextSpringFactoriesUtils() { |
||||
// no-op
|
||||
} |
||||
|
||||
|
||||
/** |
||||
* Load factory implementations of the given type via the |
||||
* {@link SpringFactoriesLoader} mechanism. |
||||
* <p>This method utilizes a custom {@link FailureHandler} and DEBUG/TRACE logging |
||||
* that are specific to the needs of the <em>Spring TestContext Framework</em>. |
||||
* <p>Specifically, this method looks up and instantiates all {@code factoryType} |
||||
* entries configured in all {@code META-INF/spring.factories} files on the classpath. |
||||
* <p>If a particular factory implementation cannot be loaded due to a {@link LinkageError} |
||||
* or {@link ClassNotFoundException}, a {@code DEBUG} message will be logged, |
||||
* but the associated exception will not be rethrown. A {@link RuntimeException} |
||||
* or any other {@link Error} will be rethrown. Any other exception will be |
||||
* thrown wrapped in an {@link IllegalStateException}. |
||||
* @param <T> the factory type |
||||
* @param factoryType the interface or abstract class representing the factory |
||||
* @return an unmodifiable list of factory implementations |
||||
* @see SpringFactoriesLoader#forDefaultResourceLocation(ClassLoader) |
||||
* @see SpringFactoriesLoader#load(Class, org.springframework.core.io.support.SpringFactoriesLoader.FailureHandler) |
||||
*/ |
||||
public static <T> List<T> loadFactoryImplementations(Class<T> factoryType) { |
||||
SpringFactoriesLoader loader = SpringFactoriesLoader.forDefaultResourceLocation( |
||||
TestContextSpringFactoriesUtils.class.getClassLoader()); |
||||
List<T> implementations = loader.load(factoryType, new TestContextFailureHandler()); |
||||
if (logger.isTraceEnabled()) { |
||||
logger.trace("Loaded %s implementations from location [%s]: %s" |
||||
.formatted(factoryType.getSimpleName(), FACTORIES_RESOURCE_LOCATION, classNames(implementations))); |
||||
} |
||||
return Collections.unmodifiableList(implementations); |
||||
} |
||||
|
||||
private static List<String> classNames(Collection<?> components) { |
||||
return components.stream().map(Object::getClass).map(Class::getName).toList(); |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue