All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.test.context.MergedContextConfiguration Maven / Gradle / Ivy

There is a newer version: 6.1.13
Show newest version
/*
 * Copyright 2002-2017 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
 *
 *      http://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;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;

import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.core.style.ToStringCreator;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

/**
 * {@code MergedContextConfiguration} encapsulates the merged
 * context configuration declared on a test class and all of its superclasses
 * via {@link ContextConfiguration @ContextConfiguration},
 * {@link ActiveProfiles @ActiveProfiles}, and
 * {@link TestPropertySource @TestPropertySource}.
 *
 * 

Merged context resource locations, annotated classes, active profiles, * property resource locations, and in-lined properties represent all declared * values in the test class hierarchy taking into consideration the semantics * of the {@link ContextConfiguration#inheritLocations}, * {@link ActiveProfiles#inheritProfiles}, * {@link TestPropertySource#inheritLocations}, and * {@link TestPropertySource#inheritProperties} flags. * *

A {@link SmartContextLoader} uses {@code MergedContextConfiguration} * to load an {@link org.springframework.context.ApplicationContext ApplicationContext}. * *

{@code MergedContextConfiguration} is also used by the * {@link org.springframework.test.context.cache.ContextCache ContextCache} * as the key for caching an * {@link org.springframework.context.ApplicationContext ApplicationContext} * that was loaded using properties of this {@code MergedContextConfiguration}. * * @author Sam Brannen * @author Phillip Webb * @since 3.1 * @see ContextConfiguration * @see ContextHierarchy * @see ActiveProfiles * @see TestPropertySource * @see ContextConfigurationAttributes * @see SmartContextLoader#loadContext(MergedContextConfiguration) */ public class MergedContextConfiguration implements Serializable { private static final long serialVersionUID = -3290560718464957422L; private static final String[] EMPTY_STRING_ARRAY = new String[0]; private static final Class[] EMPTY_CLASS_ARRAY = new Class[0]; private static final Set>> EMPTY_INITIALIZER_CLASSES = Collections.>> emptySet(); private static final Set EMPTY_CONTEXT_CUSTOMIZERS = Collections. emptySet(); private final Class testClass; private final String[] locations; private final Class[] classes; private final Set>> contextInitializerClasses; private final String[] activeProfiles; private final String[] propertySourceLocations; private final String[] propertySourceProperties; private final Set contextCustomizers; private final ContextLoader contextLoader; @Nullable private final CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate; @Nullable private final MergedContextConfiguration parent; /** * Create a new {@code MergedContextConfiguration} instance for the * supplied parameters. * @param testClass the test class for which the configuration was merged * @param locations the merged context resource locations * @param classes the merged annotated classes * @param activeProfiles the merged active bean definition profiles * @param contextLoader the resolved {@code ContextLoader} */ public MergedContextConfiguration(Class testClass, String[] locations, Class[] classes, String[] activeProfiles, ContextLoader contextLoader) { this(testClass, locations, classes, null, activeProfiles, contextLoader); } /** * Create a new {@code MergedContextConfiguration} instance for the * supplied parameters. * @param testClass the test class for which the configuration was merged * @param locations the merged context resource locations * @param classes the merged annotated classes * @param contextInitializerClasses the merged context initializer classes * @param activeProfiles the merged active bean definition profiles * @param contextLoader the resolved {@code ContextLoader} */ public MergedContextConfiguration(Class testClass, String[] locations, Class[] classes, @Nullable Set>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) { this(testClass, locations, classes, contextInitializerClasses, activeProfiles, contextLoader, null, null); } /** * Create a new {@code MergedContextConfiguration} instance for the * supplied parameters. * @param testClass the test class for which the configuration was merged * @param locations the merged context resource locations * @param classes the merged annotated classes * @param contextInitializerClasses the merged context initializer classes * @param activeProfiles the merged active bean definition profiles * @param contextLoader the resolved {@code ContextLoader} * @param cacheAwareContextLoaderDelegate a cache-aware context loader * delegate with which to retrieve the parent context * @param parent the parent configuration or {@code null} if there is no parent * @since 3.2.2 */ public MergedContextConfiguration(Class testClass, String[] locations, Class[] classes, @Nullable Set>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, @Nullable CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent) { this(testClass, locations, classes, contextInitializerClasses, activeProfiles, null, null, contextLoader, cacheAwareContextLoaderDelegate, parent); } /** * Create a new {@code MergedContextConfiguration} instance by copying * all fields from the supplied {@code MergedContextConfiguration}. * @since 4.1 */ public MergedContextConfiguration(MergedContextConfiguration mergedConfig) { this(mergedConfig.testClass, mergedConfig.locations, mergedConfig.classes, mergedConfig.contextInitializerClasses, mergedConfig.activeProfiles, mergedConfig.propertySourceLocations, mergedConfig.propertySourceProperties, mergedConfig.contextCustomizers, mergedConfig.contextLoader, mergedConfig.cacheAwareContextLoaderDelegate, mergedConfig.parent); } /** * Create a new {@code MergedContextConfiguration} instance for the * supplied parameters. *

If a {@code null} value is supplied for {@code locations}, * {@code classes}, {@code activeProfiles}, {@code propertySourceLocations}, * or {@code propertySourceProperties} an empty array will be stored instead. * If a {@code null} value is supplied for the * {@code contextInitializerClasses} an empty set will be stored instead. * Furthermore, active profiles will be sorted, and duplicate profiles * will be removed. * @param testClass the test class for which the configuration was merged * @param locations the merged context resource locations * @param classes the merged annotated classes * @param contextInitializerClasses the merged context initializer classes * @param activeProfiles the merged active bean definition profiles * @param propertySourceLocations the merged {@code PropertySource} locations * @param propertySourceProperties the merged {@code PropertySource} properties * @param contextLoader the resolved {@code ContextLoader} * @param cacheAwareContextLoaderDelegate a cache-aware context loader * delegate with which to retrieve the parent context * @param parent the parent configuration or {@code null} if there is no parent * @since 4.1 */ public MergedContextConfiguration(Class testClass, @Nullable String[] locations, @Nullable Class[] classes, @Nullable Set>> contextInitializerClasses, @Nullable String[] activeProfiles, @Nullable String[] propertySourceLocations, @Nullable String[] propertySourceProperties, ContextLoader contextLoader, @Nullable CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent) { this(testClass, locations, classes, contextInitializerClasses, activeProfiles, propertySourceLocations, propertySourceProperties, EMPTY_CONTEXT_CUSTOMIZERS, contextLoader, cacheAwareContextLoaderDelegate, parent); } /** * Create a new {@code MergedContextConfiguration} instance for the * supplied parameters. *

If a {@code null} value is supplied for {@code locations}, * {@code classes}, {@code activeProfiles}, {@code propertySourceLocations}, * or {@code propertySourceProperties} an empty array will be stored instead. * If a {@code null} value is supplied for {@code contextInitializerClasses} * or {@code contextCustomizers}, an empty set will be stored instead. * Furthermore, active profiles will be sorted, and duplicate profiles * will be removed. * @param testClass the test class for which the configuration was merged * @param locations the merged context resource locations * @param classes the merged annotated classes * @param contextInitializerClasses the merged context initializer classes * @param activeProfiles the merged active bean definition profiles * @param propertySourceLocations the merged {@code PropertySource} locations * @param propertySourceProperties the merged {@code PropertySource} properties * @param contextCustomizers the context customizers * @param contextLoader the resolved {@code ContextLoader} * @param cacheAwareContextLoaderDelegate a cache-aware context loader * delegate with which to retrieve the parent context * @param parent the parent configuration or {@code null} if there is no parent * @since 4.3 */ public MergedContextConfiguration(Class testClass, @Nullable String[] locations, @Nullable Class[] classes, @Nullable Set>> contextInitializerClasses, @Nullable String[] activeProfiles, @Nullable String[] propertySourceLocations, @Nullable String[] propertySourceProperties, @Nullable Set contextCustomizers, ContextLoader contextLoader, @Nullable CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent) { this.testClass = testClass; this.locations = processStrings(locations); this.classes = processClasses(classes); this.contextInitializerClasses = processContextInitializerClasses(contextInitializerClasses); this.activeProfiles = processActiveProfiles(activeProfiles); this.propertySourceLocations = processStrings(propertySourceLocations); this.propertySourceProperties = processStrings(propertySourceProperties); this.contextCustomizers = processContextCustomizers(contextCustomizers); this.contextLoader = contextLoader; this.cacheAwareContextLoaderDelegate = cacheAwareContextLoaderDelegate; this.parent = parent; } /** * Get the {@linkplain Class test class} associated with this * {@code MergedContextConfiguration}. */ public Class getTestClass() { return this.testClass; } /** * Get the merged resource locations for {@code ApplicationContext} * configuration files for the {@linkplain #getTestClass() test class}. *

Context resource locations typically represent XML configuration * files or Groovy scripts. */ public String[] getLocations() { return this.locations; } /** * Get the merged annotated classes for the {@linkplain #getTestClass() test class}. */ public Class[] getClasses() { return this.classes; } /** * Determine if this {@code MergedContextConfiguration} instance has * path-based context resource locations. * @return {@code true} if the {@link #getLocations() locations} array is not empty * @since 4.0.4 * @see #hasResources() * @see #hasClasses() */ public boolean hasLocations() { return !ObjectUtils.isEmpty(getLocations()); } /** * Determine if this {@code MergedContextConfiguration} instance has * class-based resources. * @return {@code true} if the {@link #getClasses() classes} array is not empty * @since 4.0.4 * @see #hasResources() * @see #hasLocations() */ public boolean hasClasses() { return !ObjectUtils.isEmpty(getClasses()); } /** * Determine if this {@code MergedContextConfiguration} instance has * either path-based context resource locations or class-based resources. * @return {@code true} if either the {@link #getLocations() locations} * or the {@link #getClasses() classes} array is not empty * @since 4.0.4 * @see #hasLocations() * @see #hasClasses() */ public boolean hasResources() { return (hasLocations() || hasClasses()); } /** * Get the merged {@code ApplicationContextInitializer} classes for the * {@linkplain #getTestClass() test class}. */ public Set>> getContextInitializerClasses() { return this.contextInitializerClasses; } /** * Get the merged active bean definition profiles for the * {@linkplain #getTestClass() test class}. * @see ActiveProfiles */ public String[] getActiveProfiles() { return this.activeProfiles; } /** * Get the merged resource locations for test {@code PropertySources} * for the {@linkplain #getTestClass() test class}. * @see TestPropertySource#locations * @see java.util.Properties */ public String[] getPropertySourceLocations() { return this.propertySourceLocations; } /** * Get the merged test {@code PropertySource} properties for the * {@linkplain #getTestClass() test class}. *

Properties will be loaded into the {@code Environment}'s set of * {@code PropertySources}. * @see TestPropertySource#properties * @see java.util.Properties */ public String[] getPropertySourceProperties() { return this.propertySourceProperties; } /** * Get the merged {@link ContextCustomizer ContextCustomizers} that will be applied * when the application context is loaded. */ public Set getContextCustomizers() { return this.contextCustomizers; } /** * Get the resolved {@link ContextLoader} for the {@linkplain #getTestClass() test class}. */ public ContextLoader getContextLoader() { return this.contextLoader; } /** * Get the {@link MergedContextConfiguration} for the parent application context * in a context hierarchy. * @return the parent configuration or {@code null} if there is no parent * @see #getParentApplicationContext() * @since 3.2.2 */ @Nullable public MergedContextConfiguration getParent() { return this.parent; } /** * Get the parent {@link ApplicationContext} for the context defined by this * {@code MergedContextConfiguration} from the context cache. *

If the parent context has not yet been loaded, it will be loaded, stored * in the cache, and then returned. * @return the parent {@code ApplicationContext} or {@code null} if there is no parent * @see #getParent() * @since 3.2.2 */ @Nullable public ApplicationContext getParentApplicationContext() { if (this.parent == null) { return null; } Assert.state(this.cacheAwareContextLoaderDelegate != null, "Cannot retrieve a parent application context without access to the CacheAwareContextLoaderDelegate"); return this.cacheAwareContextLoaderDelegate.loadContext(this.parent); } /** * Determine if the supplied object is equal to this {@code MergedContextConfiguration} * instance by comparing both object's {@linkplain #getLocations() locations}, * {@linkplain #getClasses() annotated classes}, * {@linkplain #getContextInitializerClasses() context initializer classes}, * {@linkplain #getActiveProfiles() active profiles}, * {@linkplain #getPropertySourceLocations() property source locations}, * {@linkplain #getPropertySourceProperties() property source properties}, * {@linkplain #getParent() parents}, and the fully qualified names of their * {@link #getContextLoader() ContextLoaders}. */ @Override public boolean equals(@Nullable Object other) { if (this == other) { return true; } if (other == null || other.getClass() != getClass()) { return false; } MergedContextConfiguration otherConfig = (MergedContextConfiguration) other; if (!Arrays.equals(this.locations, otherConfig.locations)) { return false; } if (!Arrays.equals(this.classes, otherConfig.classes)) { return false; } if (!this.contextInitializerClasses.equals(otherConfig.contextInitializerClasses)) { return false; } if (!Arrays.equals(this.activeProfiles, otherConfig.activeProfiles)) { return false; } if (!Arrays.equals(this.propertySourceLocations, otherConfig.propertySourceLocations)) { return false; } if (!Arrays.equals(this.propertySourceProperties, otherConfig.propertySourceProperties)) { return false; } if (!this.contextCustomizers.equals(otherConfig.contextCustomizers)) { return false; } if (this.parent == null) { if (otherConfig.parent != null) { return false; } } else if (!this.parent.equals(otherConfig.parent)) { return false; } if (!nullSafeClassName(this.contextLoader).equals(nullSafeClassName(otherConfig.contextLoader))) { return false; } return true; } /** * Generate a unique hash code for all properties of this * {@code MergedContextConfiguration} excluding the * {@linkplain #getTestClass() test class}. */ @Override public int hashCode() { int result = Arrays.hashCode(this.locations); result = 31 * result + Arrays.hashCode(this.classes); result = 31 * result + this.contextInitializerClasses.hashCode(); result = 31 * result + Arrays.hashCode(this.activeProfiles); result = 31 * result + Arrays.hashCode(this.propertySourceLocations); result = 31 * result + Arrays.hashCode(this.propertySourceProperties); result = 31 * result + this.contextCustomizers.hashCode(); result = 31 * result + (this.parent != null ? this.parent.hashCode() : 0); result = 31 * result + nullSafeClassName(this.contextLoader).hashCode(); return result; } /** * Provide a String representation of the {@linkplain #getTestClass() test class}, * {@linkplain #getLocations() locations}, {@linkplain #getClasses() annotated classes}, * {@linkplain #getContextInitializerClasses() context initializer classes}, * {@linkplain #getActiveProfiles() active profiles}, * {@linkplain #getPropertySourceLocations() property source locations}, * {@linkplain #getPropertySourceProperties() property source properties}, * {@linkplain #getContextCustomizers() context customizers}, * the name of the {@link #getContextLoader() ContextLoader}, and the * {@linkplain #getParent() parent configuration}. */ @Override public String toString() { return new ToStringCreator(this) .append("testClass", this.testClass) .append("locations", ObjectUtils.nullSafeToString(this.locations)) .append("classes", ObjectUtils.nullSafeToString(this.classes)) .append("contextInitializerClasses", ObjectUtils.nullSafeToString(this.contextInitializerClasses)) .append("activeProfiles", ObjectUtils.nullSafeToString(this.activeProfiles)) .append("propertySourceLocations", ObjectUtils.nullSafeToString(this.propertySourceLocations)) .append("propertySourceProperties", ObjectUtils.nullSafeToString(this.propertySourceProperties)) .append("contextCustomizers", this.contextCustomizers) .append("contextLoader", nullSafeClassName(this.contextLoader)) .append("parent", this.parent) .toString(); } private static String[] processStrings(@Nullable String[] array) { return (array != null ? array : EMPTY_STRING_ARRAY); } private static Class[] processClasses(@Nullable Class[] classes) { return (classes != null ? classes : EMPTY_CLASS_ARRAY); } private static Set>> processContextInitializerClasses( @Nullable Set>> contextInitializerClasses) { return (contextInitializerClasses != null ? Collections.unmodifiableSet(contextInitializerClasses) : EMPTY_INITIALIZER_CLASSES); } private static Set processContextCustomizers( @Nullable Set contextCustomizers) { return (contextCustomizers != null ? Collections.unmodifiableSet(contextCustomizers) : EMPTY_CONTEXT_CUSTOMIZERS); } private static String[] processActiveProfiles(@Nullable String[] activeProfiles) { if (activeProfiles == null) { return EMPTY_STRING_ARRAY; } // Active profiles must be unique Set profilesSet = new LinkedHashSet<>(Arrays.asList(activeProfiles)); return StringUtils.toStringArray(profilesSet); } /** * Generate a null-safe {@link String} representation of the supplied * {@link ContextLoader} based solely on the fully qualified name of the * loader or "null" if the supplied loader is {@code null}. */ protected static String nullSafeClassName(@Nullable ContextLoader contextLoader) { return (contextLoader != null ? contextLoader.getClass().getName() : "null"); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy