org.springframework.test.annotation.IfProfileValue Maven / Gradle / Ivy
Show all versions of spring-test Show documentation
/*
* Copyright 2002-2018 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.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Test annotation to indicate whether a test is enabled or disabled for a
* specific testing profile.
*
* In the context of this annotation, the term profile refers to
* a Java system property by default; however, the semantics can be changed
* by implementing a custom {@link ProfileValueSource}. If the configured
* {@code ProfileValueSource} returns a matching {@link #value} for the
* declared {@link #name}, the test will be enabled. Otherwise, the test
* will be disabled and effectively ignored.
*
*
{@code @IfProfileValue} can be applied at the class level, the method
* level, or both. Class-level usage of {@code @IfProfileValue} takes
* precedence over method-level usage for any methods within that class or
* its subclasses. Specifically, a test is enabled if it is enabled both at
* the class level and at the method level; the absence of
* {@code @IfProfileValue} means the test is implicitly enabled. This is
* analogous to the semantics of JUnit's {@link org.junit.Ignore @Ignore}
* annotation, except that the presence of {@code @Ignore} always disables
* a test.
*
*
Example
* When using {@link SystemProfileValueSource} as the {@code ProfileValueSource}
* implementation (which is configured by default), you can configure a test
* method to run only on Java VMs from Oracle as follows:
*
*
* @IfProfileValue(name = "java.vendor", value = "Oracle Corporation")
* public void testSomething() {
* // ...
* }
*
* 'OR' Semantics
* You can alternatively configure {@code @IfProfileValue} with OR
* semantics for multiple {@link #values}. The following test will be enabled
* if a {@code ProfileValueSource} has been appropriately configured for the
* {@code "test-groups"} profile with a value of either {@code unit-tests}
* or {@code integration-tests}. This functionality is similar to
* TestNG's support for test groups and JUnit's experimental support
* for test categories.
*
*
* @IfProfileValue(name = "test-groups", values = { "unit-tests", "integration-tests" })
* public void testWhichRunsForUnitOrIntegrationTestGroups() {
* // ...
* }
*
* {@code @IfProfileValue} vs. {@code @Profile}
* Although the {@code @IfProfileValue} and
* {@link org.springframework.context.annotation.Profile @Profile} annotations
* both involve profiles, they are not directly related. {@code @Profile}
* involves bean definition profiles configured in the
* {@link org.springframework.core.env.Environment Environment}; whereas,
* {@code @IfProfileValue} is used to enable or disable tests.
*
*
Meta-annotation Support
* As of Spring Framework 4.0, this annotation may be used as a
* meta-annotation to create custom composed annotations.
*
* @author Rod Johnson
* @author Sam Brannen
* @since 2.0
* @see ProfileValueSource
* @see SystemProfileValueSource
* @see ProfileValueSourceConfiguration
* @see ProfileValueUtils
* @see org.springframework.test.context.junit4.AbstractJUnit4SpringContextTests
* @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner
* @see org.springframework.test.context.junit4.statements.ProfileValueChecker
* @see org.springframework.context.annotation.Profile
* @see org.springframework.test.context.ActiveProfiles
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface IfProfileValue {
/**
* The {@code name} of the profile value against which to test.
*/
String name();
/**
* A single, permissible {@code value} of the profile value
* for the given {@link #name}.
*
Note: Assigning values to both {@code #value} and {@link #values}
* will lead to a configuration conflict.
*/
String value() default "";
/**
* A list of all permissible {@code values} of the profile value
* for the given {@link #name}.
*
Note: Assigning values to both {@link #value} and {@code #values}
* will lead to a configuration conflict.
*/
String[] values() default {};
}