https://github.com/tisonkun/failpoints
An implementation of failpoints for Java.
https://github.com/tisonkun/failpoints
failpoint failure-injection fault-injection java testing
Last synced: 3 months ago
JSON representation
An implementation of failpoints for Java.
- Host: GitHub
- URL: https://github.com/tisonkun/failpoints
- Owner: tisonkun
- License: apache-2.0
- Created: 2022-08-10T14:21:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T02:53:19.000Z (over 1 year ago)
- Last Synced: 2025-04-15T02:53:46.309Z (3 months ago)
- Topics: failpoint, failure-injection, fault-injection, java, testing
- Language: Java
- Homepage:
- Size: 102 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Failpoints
An implementation of [failpoints](http://www.freebsd.org/cgi/man.cgi?query=fail) 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.
```xml
org.tisonkun.failpoints
failpoints-api
2.1.1
org.tisonkun.failpoints
failpoints-simple
2.1.1
test
```
2. Inject failpoints to your program, eg:
```java
import org.tisonkun.failpoints.Failpoints;
public class TestingObject {
public void testInject(Runnable r) {
Failpoints.inject(getClass(), "testing-object", v -> {
if (v != null && (boolean) v) {
r.run();
}
});
}
}
```
3. In testing code, enable the failpoint:
```java
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.tisonkun.failpoints.FailpointGuard;
import org.tisonkun.failpoints.Failpoints;
public class SimpleFailpointDriverTest {
public void testInjectFailpoint() throws Exception {
try (final FailpointGuard ignored = Failpoints.enable(TestingObject, "testing-object", true)) {
final CountDownLatch latch = new CountDownLatch(1);
new TestingObject().testInject(latch::countDown);
Assertions.assertTrue(latch.await(1000, TimeUnit.MILLISECONDS));
}
final CountDownLatch latch = new CountDownLatch(1);
new TestingObject().testInject(latch::countDown);
Assertions.assertFalse(latch.await(1000, TimeUnit.MILLISECONDS));
}
}
```