de.weltraumschaf.commons.testing.rules

Class Repeater

java.lang.Object

de.weltraumschaf.commons.testing.rules.Repeater

All Implemented Interfaces:

org.junit.rules.TestRule

public final class Repeater
extends Object
implements org.junit.rules.TestRule

Rule which runs tests annotated with RunTimes or RunMaxTimes multiple times.

The rule does not stop on any exceptions, but save them to throw a combined AssertionError at the end of the evaluation of the Repeater.RepeatStatement. So you will see how many tests failed of how many runs. Also you see the stack trace of all failures.

Example:

 
  public class TestSomething {

      @Rule
      public final Repeater repeater = new Repeater();

      @Test
      @RunTimes(10) // Runs the test method ten times.
      public void someTestMethod() {
          // ...
      }

      @Test
      @RunMaxTimes(3) // Runs the test method until success, max five times.
      public void someOtherTestMethod() {
          // ...
      }
 }
 

Based on Blog post by Frank Appel.

Since:

2.1.0

Author:

Sven Strittmatter <weltraumschaf@googlemail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Repeater.BaseRepeatStatement This statement executes the given base statement repeatedly.
private static class	Repeater.RepeatStatement This statement executes the given base statement repeatedly.
private static class	Repeater.RepeatUntilSuccessStatement This statement executes the given base statement repeatedly until it succeeds or reaches times.

Constructor Summary

Constructors

Constructor and Description
Repeater()

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, Description description)
(package private) boolean	hasRunMaxTimesAnnotation(Description description) Whether the description has a RunMaxTimes annotation or not.
(package private) boolean	hasRunTimesAnnotation(Description description) Whether the description has a RunTimes annotation or not.
private void	validateTimes(int times, Class<? extends Annotation> annotation) Validates that the given times value is not less than zero.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Repeater

public Repeater()

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               Description description)

Specified by:

apply in interface org.junit.rules.TestRule

validateTimes

private void validateTimes(int times,
                           Class<? extends Annotation> annotation)

Validates that the given times value is not less than zero.

This method throws an IllegalArgumentException with an user friendly error message to help test writers which accidentally used a wrong annotation value.

Parameters:

times - the current annotation value

annotation - the current annotation type

hasRunTimesAnnotation

boolean hasRunTimesAnnotation(Description description)

Whether the description has a RunTimes annotation or not.

Parameters:

description - must not be null

Returns:

true if present, else false

hasRunMaxTimesAnnotation

boolean hasRunMaxTimesAnnotation(Description description)

Whether the description has a RunMaxTimes annotation or not.

Parameters:

description - must not be null

Returns:

true if present, else false