Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 4.61 KB

README.md

File metadata and controls

67 lines (50 loc) · 4.61 KB
Raw

Abort-Mission

GitHub license Java version latest-release JavaCI

Mission Control

codecov core Stable

This module contains the core functionality offered by Abort-Mission. While the right kind of booster module is the recommended way to integrate Abort-Mission into your tests, this module can come handy in case you would like to create your own booster or use the low level API hidden by the boosters because you need more control. Either way, I hope you will find the one-page quick-start leaflet below.

In case you don't find enough information here, consider checking the wiki which will (eventually) give a full reference guide.

Quick-start

Dependency

Abort-Mission can be downloaded from a few Maven repositories. Please head to this page to find out more.

Maven

<dependency>
  <groupId>com.github.nagyesta.abort-mission</groupId>
  <artifactId>abort.mission-control</artifactId>
  <version>RELEASE</version>
  <scope>test</scope>
</dependency>

Gradle

testImplementation "com.github.nagyesta.abort-mission:abort.mission-control:+"

Configuration

In order to configure Abort-Mission, the easiest option would be to follow these steps

  1. Implement MissionOutline named as MissionOutlineDefinition preferably in your root package
  2. Use the annotations we provide here
  3. Make sure to hook our lifecycle methods by either
    1. using a LaunchSequenceTemplate
    2. or one of the Callable/runnable implementations here
  4. Figure out how to group your tests and limit the blast radius of each dependency as you go
  5. If you want filter the information collected related to the exceptions thrown by each test, make sure to configure using AbortMissionGlobalConfiguration. Please ensure that it will execute before your tests start (e.g. you can use your MissionOutlineDefinition or set these values in a snippet running exactly once at the beginning of your test suite).

System properties

Property Type Meaning
abort-mission.disarm.countdown boolean Disables countdown aborts for all tests. Default: false
abort-mission.disarm.mission boolean Disables mission aborts for all tests. Default: false
abort-mission.report.directory String Output directory path where we want to save telemetry output. Default: null
abort-mission.force.abort.evaluators String Comma separated list of key words identifying evaluators which need to always abort. Default: null
abort-mission.suppress.abort.evaluators String Comma separated list of key words identifying evaluators which need to suppress abort. Default: null