Skip to content

antublue/test-engine

Build Codacy Badge


AntuBLUE logo

Test Engine

The AntuBLUE Test Engine is a JUnit 5-based test engine designed specifically for parameterized container (class) testing.

Common usage scenarios

Releases

The Test Engine is published to Maven Central.

Release information can be found in GitHub Releases

Test classes may require migration between major releases.

Documentation

Documentation is specific to a release.

For the current branch, reference the manual

For a specific release, reference the release-<VERSION> branch for relevant documentation.

Support

GitHub's Discussions is the current mechanism for help / support.

FAQ

Building and Installing

Java 8 or greater is required to build the project. The project targets Java 8 as a baseline.

git clone https://github.com/antublue/test-engine
cd test-engine
./mvnw clean install

Contributing

Contributions to the Test Engine are both welcomed and appreciated.

The project uses a GitHub Flow branching strategy, with release branches for versioned documentation.

Release branch code is considered "locked" - no code changes accepted, but documentation changes are allowed.

  • The main branch contains the latest unreleased code
  • Release branches release-<VERSION> contain code and documentation for a specific release
  • Google checkstyle format is required
  • Google Java Style is required
  • Spotless for checking/applying Google Java Style
  • PMD is used for static analysis
  • Expand all Java imports
  • Tags are used for releases

For changes, you should...

  • Fork the repository
  • Create a branch for your work off of main
  • Make changes on your branch
  • Build and test your changes
  • Open a pull request targeting main, tagging @antublue for review
  • A Developer Certificate of Origin (DCO) is required for all contributions

Support

YourKit logo

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications.

YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.