https://github.com/nagyesta/abort-mission
A lightweight Java library providing flexible test abortion support for test groups to allow fast failures.
https://github.com/nagyesta/abort-mission
java junit junit-jupiter junit4 junit5 lightweight-java-library testing-tools testng
Last synced: 4 months ago
JSON representation
A lightweight Java library providing flexible test abortion support for test groups to allow fast failures.
- Host: GitHub
- URL: https://github.com/nagyesta/abort-mission
- Owner: nagyesta
- License: mit
- Created: 2020-10-25T21:13:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-08-05T04:53:28.000Z (11 months ago)
- Last Synced: 2025-08-05T06:24:37.374Z (11 months ago)
- Topics: java, junit, junit-jupiter, junit4, junit5, lightweight-java-library, testing-tools, testng
- Language: Java
- Homepage:
- Size: 11.1 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://raw.githubusercontent.com/nagyesta/abort-mission/main/LICENSE)
[](https://img.shields.io/badge/Java%20version-17-yellow?logo=java)
[](https://github.com/nagyesta/abort-mission/releases)
[](https://search.maven.org/search?q=com.github.nagyesta.abort-mission)
[](https://github.com/nagyesta/abort-mission/actions/workflows/gradle.yml)
[](https://bestpractices.coreinfrastructure.org/projects/6017)
[](https://sonarcloud.io/summary/new_code?id=nagyesta_abort-mission)
[](https://sonarcloud.io/summary/new_code?id=nagyesta_abort-mission)
[](https://sonarcloud.io/summary/new_code?id=nagyesta_abort-mission)
[](https://img.shields.io/github/last-commit/nagyesta/abort-mission?logo=git)
[](https://github.com/nagyesta/abort-mission/wiki)
Abort-Mission is a lightweight Java library providing flexible test abortion support for test groups to allow fast failures.
## What does this mean?
- Provides a way to group your tests
- Lets you define certain pre-requisites for your tests
- Tracks how each group succeeds or fails
- Uses the collected data to prevent test runs which are predicted to fail already
## Why is this good for you?
If you are using Abort-Mission well, you don't need to wait for long CI runs when you know which tests will fail already
because the DB became inaccessible or someone (not you) messed up...
Saving time on CI and local test runs adds up in small increments not only saving money but reducing the time and resources
used for build. This results in using less cloud runners, reducing electricity needs etc. by the end of the day we can help
save the Planet too! Cool, right?
If you are still not convinced, you can trust the ancient proverb saying:
> [!TIP]
> "Shoot for the Moon, and even if you miss, you can at least stop running your failing tests early."
## Installation
Abort-Mission can be downloaded from a few Maven repositories. Please head to
[this page](https://github.com/nagyesta/abort-mission/wiki/Configuring-our-repository-for-your-build-system)
to find out more.
To find out which Abort-Mission dependency will you need, it is recommended to start with the booster created for the
test framework you are using. Is your favorite framework missing? Let me know by creating an issue! No promises, but I
will at least take a look.
### Currently supported packages
- [Mission Control](mission-control)
- Boosters
- [Cucumber JVM](boosters/booster-cucumber-jvm)
- [JUnit 4](boosters/booster-junit4)
- [JUnit Jupiter](boosters/booster-junit-jupiter)
- [TestNG](boosters/booster-testng)
- [Booster Test Kit](boosters/testkit)
- Mission Report
- [Flight Evaluation Report](mission-report/flight-evaluation-report)
- Strongback (All modules removed in 4.1.x)
- Strongback functionality is completely removed in 4.1.x release as Strongbacks were very slow and hard to maintain.
## Terminology and Lifecycle
Abort-Mission views tests runs similarly to a space launch mission. Due to this, terminology mimics
certain phases of a rocket launch. This section can help you understand what happens when.
### Health metrics
Each test offers a slightly different situation, but the following list will cover all counters we
will rely on when using Abort-Mission.
| Measurement point | What happens there? |
| ----------------- | ----------------------------------------- |
| Countdown failed | Test instance post processing failed |
| Countdown abort | Test instance post processing prevented |
| Countdown success | Test instance post processed successfully |
| Mission abort | Test start prevented / abort after start |
| Mission failed | Test failed |
| Mission success | Test executed successfully |
## How it works
The oversimplified model used by this project relies on the following elements:
- A **Mission Outline** defining what Abort-Mission should do in which situation in scope of the **Mission Context**
- A number of **Mission Health Check Matchers** which allow the library to identify which category the test class belongs to
- A similar amount of **Mission Health Check Evaluators** which define thresholds for the decision-making
- A bunch of annotations to help with the configuration such as
- Defining which of the named Mission Contexts do we want to use
- Allowing suppression of abort decisions for certain tests
- Ignoring certain exceptions that are causing failures
From all of these, sooner or later you will need to have a Launch Sequence Template that will act as a controller
which knows how your specific test framework needs to bind with the lifecycle stages we need to maintain. This
is probably the hardest part to pull off, don't worry, if you are using a booster that was created for your
test framework, it should be easy, the booster will do the heavy-lifting (after all that is the job of a booster).
Once you have these, you are probably fine.