spock.lang.Retry 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 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
 *
 *     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 org.spockframework.runtime.extension.ExtensionAnnotation;
import org.spockframework.runtime.extension.builtin.RetryExtension;
import org.spockframework.util.Beta;

import java.lang.annotation.*;

import groovy.lang.Closure;


/**
 * Retries the given feature if an exception occurs during execution.
 *
 * Retries can be applied to feature methods and spec classes. Applying it to
 * a spec class has the same effect as applying it to each feature method that
 * isn't already annotated with {@code @Retry}.
 *
 * A {@code @Retry} annotation that is declared on a spec class is applied to
 * all features in all subclasses as well, unless a subclass declares its own
 * annotation. If so, the retries defined in the subclass are applied to all
 * feature methods declared in the subclass as well as inherited ones.
 *
 * @author Leonard Brünings
 * @since 1.2
 */
@Beta
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@ExtensionAnnotation(RetryExtension.class)
public @interface Retry {
  /**
   * Configures which types of Exceptions should be retried.
   *
   * Subclasses are included if their parent class is listed.
   *
   * @return array of Exception classes to retry.
   */
  Class[] exceptions() default {Exception.class, AssertionError.class};

  /**
   * Condition that is evaluated to decide whether the feature should be
   * retried.
   *
   * The configured closure is called with a delegate of type
   * {@link org.spockframework.runtime.extension.builtin.RetryConditionContext}
   * which provides access to the current exception and {@code Specification}
   * instance.
   *
   * The feature is retried if the exception class passes the type check and the
   * specified condition holds true. If no condition is specified, only the type
   * check is performed.
   *
   * @return predicate that must hold for the feature to be retried.
   */
  Class condition() default Closure.class;

  /**
   * The number of retries.
   *
   * @return number of retries.
   */
  int count() default 3;

  /**
   * Delay between retries in millis, 0 to disable.
   *
   * @return number of millis to wait.
   */
  int delay() default 0;

  /**
   * Retry mode, controls what is retried.
   *
   * @return retry mode
   */
  Mode mode() default Mode.ITERATION;

  enum Mode {
    /**
     * Retry the iterations individually.
     */
    ITERATION,

    /**
     * Retry the the feature together with the setup and cleanup methods.
     */
    SETUP_FEATURE_CLEANUP
  }
}