bld-pitest/README.md

2.6 KiB
Executable file

PIT Mutation Testing Extension for bld

License Java bld Release Snapshot GitHub CI

To install the latest version, add the following to the lib/bld/bld-wrapper.properties file:

bld.extension-pitest=com.uwyn.rife2:bld-pitest

For more information, please refer to the extensions documentation.

Mutation Testing with PIT

To run mutation tests and coverage, add the following to your build file:

@BuildCommand(summary = "Run PIT mutation tests")
public void pit() throws Exception {
    new PitestOperation()
        .fromProject(this)
        .reportDir(Path.of("reports", "mutations"))
        .targetClasses(pkg + ".*")
        .targetTests(pkg + ".*")
        .verbose(true)
        .execute();
    }
./bld compile pit

Please check the PitestOperation documentation for all available configuration options.

Pitest (PIT) Dependency

Don't forget to add the Pitest test dependencies to your build file, as they are not provided by the extension. For example:

repositories = List.of(MAVEN_CENTRAL);
scope(test)
    .include(dependency("org.pitest", "pitest", version(1, 19, 1)))
    .include(dependency("org.pitest", "pitest-command-line", version(1, 17, 4)))
    .include(dependency("org.pitest", "pitest-junit5-plugin", version(1, 2, 2)))
    .include(dependency("org.pitest", "pitest-testng-plugin", version(1, 0, 0)));