spock.lang.Requires Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spock-core Show documentation

Spock is a testing and specification framework for Java and Groovy applications. What makes it stand out from the crowd is its beautiful and highly expressive specification language. Thanks to its JUnit runner, Spock is compatible with most IDEs, build tools, and continuous integration servers. Spock is inspired from JUnit, jMock, RSpec, Groovy, Scala, Vulcans, and other fascinating life forms.

There is a newer version: 2.4-M4-groovy-4.0

Show newest version

/*
 * Copyright 2012 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 spock.lang;

import java.lang.annotation.*;

import groovy.lang.*;

import org.spockframework.runtime.extension.ExtensionAnnotation;
import org.spockframework.runtime.extension.builtin.PreconditionContext;
import org.spockframework.runtime.extension.builtin.RequiresExtension;
import org.spockframework.util.Beta;

/**
 * Ignores the annotated spec, feature or selected iterations unless the given condition holds.
 * Same as {@link IgnoreIf} except that the condition is inverted.
 *
 * The configured closure is called with a delegate of type {@link PreconditionContext}
 * which provides access to system properties, environment variables, the type
 * of operating system and JVM.
 *
 * If applied to a data driven feature, the closure can also access the data variables.
 * If the closure does not reference any actual data variables or is applied to a spec,
 * the whole annotated element is skipped up-front, no fixtures, data providers or anything
 * else will be executed. But if the closure actually does reference valid data variables,
 * the whole workflow is followed up to the feature method invocation, where then the closure
 * is checked, and it is decided whether to abort the specific iteration or not.
 *
 * @see IgnoreIf
 * @see PreconditionContext
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@ExtensionAnnotation(RequiresExtension.class)
@Repeatable(Requires.Container.class)
public @interface Requires {
  /**
   * The reason for ignoring this element.
   *
   * @return the string to use for the skip message
   */
  String reason() default "";

  /**
   * The condition to check, {@link PreconditionContext} will be set as delegate and argument.
   *
   * @return the closure to evaluate
   */
  Class value();

  /**
   * Whether this annotation should be inherited by child classes.
   *
   * For historic reasons, this is false by default.
   * It has no special effect if used on a feature.
   *
   * @since 2.1
   * @return whether this annotation applies to child classes
   */
  boolean inherited() default false;

  /**
   * @since 2.0
   */
  @Beta
  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.METHOD})
  @interface Container {
    Requires[] value();
  }
}