spock-retry

KO | EN

gitlite — search

#javascript #typescript #golang #android #rust #macos #nodejs #java #awesome #cli #kubernetes #awesome-list #pytorch #ios

(★ 33)

Spock extension to allow test features and specifications to be retried before failed

spock-retry Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Spock Extensions

Really just one: `@RetryOnFailure`, which allows your tests to be a little more resilient to transient failures.

## Why
If you've ever written tests that run in the browser (Geb, Selenium, etc.), or depend on external systems where response times aren't guaranteed, you may encounter transient errors that are difficult to track down.

There's a valid argument that if your tests are failing in a transient way, they're too brittle and should be rewritten. This is often a problem of unknown complexity - you might figure it out in five minutes or you might spend five days trying to find it and not have any luck. At that point, you can ignore it, live with the failing test, or throw this annotation on it.

## Usage

The annotation can be applied to a particular feature:
```groovy
class ExampleSpec extends Specification {
	
	@RetryOnFailure
	void 'does something'() {
		// will try to run twice before failing
	}
}
```

It can be applied to a particular Specification:

```groovy
@RetryOnFailure(times=3)
class ExampleSpec extends Specification {
	
	void 'does something'() {
		// will try to run three times before failing
	}
}
```

It can be applied to a super class:
```groovy

@RetryOnFailure
class BaseSpec extends Specification {
    void beforeRetryAfterFailure(){
       // will before every repeat of the test ( if child class will not override it )
    }
}

class ChildSpec extends BaseSpec {
	
	void 'do something flaky'() {
		// will try to run four times before failing
	}
	
	void beforeRetryAfterFailure(){
	   // will before every repeat of the test
	}
}
```

If you need to pause between runs, you can:
```groovy
    @RetryOnFailure(delaySeconds=2)
    void 'does something but might fail because it\'s been throttled'() {
        // will pause two seconds before trying to run again
    }
```

The `times` argument is optional; with none specified, the runner will attempt the feature twice before failing. Annotations of greater specificity *should* override annotations of lesser specificity, i.e. subclass annotations override superclass annotations, feature (i.e. method) annotations override class annotations. I say *should* because it's based on observed behavior, not a deep dive into the Spock internals to understand the order in which the annotations are visited.

If you want to retry only for some exceptions:
```groovy
    @RetryOnFailure(times=3, include={MyException1.class, MyException2.class})
    void 'does something flaky'() {
    }
```

If you don't want to retry for some exceptions:
```groovy
    @RetryOnFailure(times=3, exclude={MyException1.class, MyException2.class})
    void 'does something flaky'() {
    }
```

## Installation
The latest release of this extension works with Spock 1.0 and is available on [bintray](https://bintray.com/anotherchrisberry/spock-retry/spock-retry).

If you are using Spock 0.7, you'll need to grab the code from the [initial commit](https://github.com/anotherchrisberry/spock-retry/tree/e3135038fb796b2c44efda3adc29970dc40b09d5). Sorry, I'm not sure the best way to go about this. You could grab the three files in [this directory](https://github.com/anotherchrisberry/spock-retry/tree/e3135038fb796b2c44efda3adc29970dc40b09d5/src/main/groovy/com/anotherchrisberry/spock/extensions/retry) and include them in your project.

spock-retry

spock-retry Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

spock-retry

spock-retry Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README