Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use Framework's MockSpringFactoriesLoader

Browse Source 
Closes gh-31406
This commit is contained in:
Andy Wilkinson
2022-06-16 15:35:28 +01:00
parent bde06a3115
commit 4f3180540c
7 changed files with 13 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/mock/MockSpringFactoriesLoader.java
View File

@@ -1,137 +0,0 @@
/*
* 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.boot.testsupport.mock;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import org.springframework.core.io.support.SpringFactoriesLoader;
/**
* Simple mock {@link SpringFactoriesLoader} implementation that can be used for testing
* purposes.
*
* @author Phillip Webb
* @since 3.0.0
*/
public class MockSpringFactoriesLoader extends SpringFactoriesLoader {
private final AtomicInteger sequence = new AtomicInteger();
private final Map<String, List<String>> factories;
private final Map<String, Object> implementations = new HashMap<>();
/**
* Create a new {@link MockSpringFactoriesLoader} instance with the default
* classloader.
*/
public MockSpringFactoriesLoader() {
this(null);
}
/**
* Create a new {@link MockSpringFactoriesLoader} instance with the given classloader.
* @param classLoader the classloader to use
*/
public MockSpringFactoriesLoader(ClassLoader classLoader) {
this(classLoader, new LinkedHashMap<>());
}
protected MockSpringFactoriesLoader(ClassLoader classLoader, Map<String, List<String>> factories) {
super(classLoader, factories);
this.factories = factories;
}
@Override
@SuppressWarnings("unchecked")
protected <T> T instantiateFactory(String implementationName, Class<T> type, ArgumentResolver argumentResolver,
FailureHandler failureHandler) {
if (implementationName.startsWith("!")) {
Object implementation = this.implementations.get(implementationName);
if (implementation != null) {
return (T) implementation;
}
}
return super.instantiateFactory(implementationName, type, argumentResolver, failureHandler);
}
/**
* Add factory implementations to this instance.
* @param factoryType the factory type class
* @param factoryImplementations the implementation classes
* @param <T> the factory type
* @return {@code this}, to facilitate method chaining
*/
@SafeVarargs
public final <T> MockSpringFactoriesLoader add(Class<T> factoryType, Class<? extends T>... factoryImplementations) {
for (Class<? extends T> factoryImplementation : factoryImplementations) {
add(factoryType.getName(), factoryImplementation.getName());
}
return this;
}
/**
* Add factory implementations to this instance.
* @param factoryType the factory type class name
* @param factoryImplementations the implementation class names
* @return {@code this}, to facilitate method chaining
*/
public MockSpringFactoriesLoader add(String factoryType, String... factoryImplementations) {
List<String> implementations = this.factories.computeIfAbsent(factoryType, (key) -> new ArrayList<>());
for (String factoryImplementation : factoryImplementations) {
implementations.add(factoryImplementation);
}
return this;
}
/**
* Add factory instances to this instance.
* @param factoryType the factory type class
* @param factoryInstances the implementation instances to add
* @param <T> the factory type
* @return {@code this}, to facilitate method chaining
*/
@SuppressWarnings("unchecked")
public <T> MockSpringFactoriesLoader addInstance(Class<T> factoryType, T... factoryInstances) {
return addInstance(factoryType.getName(), factoryInstances);
}
/**
* Add factory instances to this instance.
* @param factoryType the factory type class name
* @param factoryInstance the implementation instances to add
* @param <T> the factory instance type
* @return {@code this}, to facilitate method chaining
*/
@SuppressWarnings("unchecked")
public <T> MockSpringFactoriesLoader addInstance(String factoryType, T... factoryInstance) {
List<String> implementations = this.factories.computeIfAbsent(factoryType, (key) -> new ArrayList<>());
for (T factoryImplementation : factoryInstance) {
String reference = "!" + factoryType + ":" + factoryImplementation.getClass().getName()
+ this.sequence.getAndIncrement();
implementations.add(reference);
this.implementations.put(reference, factoryImplementation);
}
return this;
}
}

20
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/mock/package-info.java
View File

@@ -1,20 +0,0 @@
/*
* 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.
*/
/**
* Mock implementations of commonly used classes.
*/
package org.springframework.boot.testsupport.mock;

1
spring-boot-project/spring-boot/build.gradle
View File

@@ -130,6 +130,7 @@ dependencies {
testImplementation("org.mockito:mockito-core")
testImplementation("org.mockito:mockito-junit-jupiter")
testImplementation("org.springframework:spring-context-support")
testImplementation("org.springframework:spring-core-test")
testImplementation("org.springframework.data:spring-data-redis")
testImplementation("org.springframework.data:spring-data-r2dbc")
testImplementation("org.xerial:sqlite-jdbc")

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLoadersTests.java
View File

@@ -32,8 +32,8 @@ import org.springframework.boot.BootstrapRegistry.InstanceSupplier;
import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.DefaultBootstrapContext;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.boot.testsupport.mock.MockSpringFactoriesLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.mock.MockSpringFactoriesLoader;
import org.springframework.mock.env.MockPropertySource;
import static org.assertj.core.api.Assertions.assertThat;

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationResolversTests.java
View File

@@ -34,10 +34,10 @@ import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.DefaultBootstrapContext;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.boot.testsupport.mock.MockSpringFactoriesLoader;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.mock.MockSpringFactoriesLoader;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;

12
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationRuntimeHintsRegistrarTests.java
View File

@@ -28,8 +28,8 @@ import org.springframework.aot.hint.RuntimeHints;
import org.springframework.boot.env.PropertiesPropertySourceLoader;
import org.springframework.boot.env.PropertySourceLoader;
import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.boot.testsupport.mock.MockSpringFactoriesLoader;
import org.springframework.core.io.support.SpringFactoriesLoader;
import org.springframework.core.mock.MockSpringFactoriesLoader;
import static org.assertj.core.api.Assertions.assertThat;
@@ -121,8 +121,14 @@ class ConfigDataLocationRuntimeHintsRegistrarTests {
}
TestConfigDataLocationRuntimeHintsRegistrar() {
this(new MockSpringFactoriesLoader().add(PropertySourceLoader.class, PropertiesPropertySourceLoader.class,
YamlPropertySourceLoader.class));
this(springFactoriesLoader());
}
private static MockSpringFactoriesLoader springFactoriesLoader() {
MockSpringFactoriesLoader springFactoriesLoader = new MockSpringFactoriesLoader();
springFactoriesLoader.add(PropertySourceLoader.class, PropertiesPropertySourceLoader.class,
YamlPropertySourceLoader.class);
return springFactoriesLoader;
}
@Override

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/FailureAnalyzersTests.java
View File

@@ -22,12 +22,12 @@ import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.boot.testsupport.mock.MockSpringFactoriesLoader;
import org.springframework.boot.testsupport.system.CapturedOutput;
import org.springframework.boot.testsupport.system.OutputCaptureExtension;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.core.env.Environment;
import org.springframework.core.mock.MockSpringFactoriesLoader;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.same;