Failpoints

An implementation of failpoints for Java. Fail points are used to add code points where errors may be injected in a user controlled fashion. Fail point is a code snippet that is only executed when the corresponding failpoint is active.

Quick Start

1. Add failpoints library in dependencies.

<dependencies>
<dependency>
<groupId>org.tisonkun.failpoints</groupId>
<artifactId>failpoints-api</artifactId>
<version>2.1.1</version>
</dependency>
<dependency>
<groupId>org.tisonkun.failpoints</groupId>
<artifactId>failpoints-simple</artifactId>
<version>2.1.1</version>
<scope>test</scope>
</dependency>
</dependencies>

2. Inject failpoints to your program, eg:

importorg.tisonkun.failpoints.Failpoints;
publicclassTestingObject {
publicvoidtestInject(Runnabler) {
Failpoints.inject(getClass(), "testing-object", v -> {
if (v != null && (boolean) v) {
r.run();
}
});
}
}

3. In testing code, enable the failpoint:

importjava.util.concurrent.CountDownLatch;
importjava.util.concurrent.TimeUnit;
importorg.junit.jupiter.api.Assertions;
importorg.junit.jupiter.api.Test;
importorg.tisonkun.failpoints.FailpointGuard;
importorg.tisonkun.failpoints.Failpoints;
publicclassSimpleFailpointDriverTest {
publicvoidtestInjectFailpoint() throwsException {
try (finalFailpointGuardignored = Failpoints.enable(TestingObject, "testing-object", true)) {
finalCountDownLatchlatch = newCountDownLatch(1);
newTestingObject().testInject(latch::countDown);
Assertions.assertTrue(latch.await(1000, TimeUnit.MILLISECONDS));
}
finalCountDownLatchlatch = newCountDownLatch(1);
newTestingObject().testInject(latch::countDown);
Assertions.assertFalse(latch.await(1000, TimeUnit.MILLISECONDS));
}
}