Maven plugin to handle multi module projects for PiTest
on command line
mvn install
mvn eu.stamp-projectrun
mvn eu.stamp-project
with Maven
Modify your pom.xml,
<plugin><groupId>eu.stamp-project</groupId><artifactId>pitmp-maven-plugin</artifactId><version>1.3.7</version></plugin>
<plugin><groupId>eu.stamp-project</groupId><artifactId>pitmp-maven-plugin</artifactId><version>1.3.7</version><configuration><mutationEngine>descartes</mutationEngine></configuration></plugin>
run” will NOT work.c.f. properties targetModules and skippedModules to specify in which directories you want to run PitMP.
## What is PitMP?PitMP (PIT for Multi-module Project) is a Maven plugin able to run PIT on multi-module projects.PIT is a mutation testing system for Java applications, which allows you to evaluatethe quality of your test suites.To know more about PIT: http://pitest.org## How does PitMP work?PIT takes a test suite, a set of classes to be mutated and a set of mutation operatorsand computes a line coverage and a mutation coverage:PIT mutates only the classes defined in the same module than thetest suite:PitMP runs PIT on every test suite, mutating classes of all dependencies of moduleslocated in the same project tree:then:etc...PitMP just extends PIT, it doesn't rewrite any feature, so all PIT's properties canbe used.PitMP runs test suite as PIT does, just extending the list of classes to bemutated to the whole project tree, instead of mutating only the classes ofthe test suite module.## PitMP OutputPIT produces a report that includes:* a summary of line coverage and mutation coverage scores:* a detail report for each class combining line coverage and mutation coverageinformation:*Light green shows line coverage, dark green shows mutation coverage.**Light pink show lack of line coverage, dark pink shows lack of mutation coverage.*## Running PitMP on your project* Go to the project on which you want to apply PIT* Compile your project
mvn install
* Run PIT on your multi module project :-)
mvn eu.stamp-projectrun
##### Install the plugin for releases earlier than 1.1.4Since 1.1.4 PitMP is available on Maven Central, so this step is required onlyfor releases before 1.1.4.
git clone https://github.com/STAMP-project/pitmp-maven-plugin.git
cd pitmp-maven-plugin
mvn install
### Configure PitMPYou can configure your project in the root pom.xml, in the section \<plugins\>:
a.package.of.classes
another.package.of.classes
### PitMP properties* targetModules: to run PIT only on specified modules, thisattribute filters directories where to run PIT, not classesto be mutatedYou can use the property "targetModules" in the pom.xml:
<targetModules><param>yourFirstModule</param><param>anotherModule</param></targetModules>
or on the command line, use:
mvn “-DtargetModules=yourFirstModule,anotherModule” pitmp:run
Running PitMP from a module directory will NOT work.* skippedModules: to skip specified modules when running PIT, thisattribute filters directories where to run PIT, not classesto be mutatedYou can use the property "skippedModules" in the pom.xml:
<skippedModules><param>aModuleToSkip</param><param>anotherModuleToSkip</param></skippedModules>
or on the command line, use:
mvn “-DtargetModules=aModuleToSkip,anotherModuleToSkip” pitmp:run
* targetDependencies: take only into account classes of targetDependencies, i.e.only code in targetDependencies will be mutated; it impacts PIT's targetClassesNote that only targetDependencies shall contains only modules of the project* ignoredDependencies: ignore classes of ignoredDependencies, i.e.code in targetDependencies will not be mutated; it impacts PIT's targetClassesIf a module is both in targetDependencies and ignoredDependencies, it will be ignored.* continueFromModule: to run PIT starting from a given project (because continuing an aborted execution with Maven -rf is not working)
<continueFromModule>aModule</continueFromModule>
## Running DescartesIf you want to run Descartes:
mvn eu.stamp-projectdescartes
If you want to configure Descartes, add to your root project pom.xml, in the section \<plugins\>:
a.package.of.classes
another.package.of.classes
For complete instructions about Descartes see the [Descartes github](https://github.com/STAMP-project/pitest-descartes).For an example of multi module project using PitMP see the [dnoo github](https://github.com/STAMP-project/dnoo).### Check Pseudo/Partially Tested Methods numberIf you want to check the number of Pseudo Tested Methods and/or Partially TestedMethods, you can add specific thresholds **pseudoTestedThreshold** and/or **partiallyTestedThreshold** in the configuration:
a.package.of.classes
another.package.of.classes
### Break the build upon threshold crossing (mutation score or line coverage)The plugin can break the build, when the mutation score and/or line coverage is considered too poor.The example below breaks the build if mutation score is less than 40% or line coverage less than 60 %, according to "mutationThreshold" and "coverageThreshold" options:
```
Notes concerning additional options:
| For PIT release… | use PitMP release… | how to use PitMP |
|---|---|---|
| 1.4.7 | 1.3.7 | Maven Central |
| 1.4.2 | 1.3.5, 1.3.6 | Maven Central |
| 1.4.0 | 1.3.4, 1.3.3, 1.3.2, 1.3.1, 1.3.0, 1.2.0 | Maven Central |
| 1.3.2 | 1.1.6, 1.1.5 | Maven Central |
| 1.3.1 | 1.1.4 | Maven Central |
| 1.2.1, 1.2.2, 1.2.4, 1.2.5, 1.3.0 | not tested | |
| 1.2.0, 1.2.3 | 1.0.1 | git clone & mvn install |
pitmp-maven-plugin-1.3.7
pitmp-maven-plugin-1.3.6
pitmp-maven-plugin-1.3.5
pitmp-maven-plugin-1.3.4
pitmp-maven-plugin-1.3.3
pitmp-maven-plugin-1.3.2
pitmp-maven-plugin-1.3.1
pitmp-maven-plugin-1.3.0
pitmp-maven-plugin-1.2.0
pitmp-maven-plugin-1.1.6
pitmp-maven-plugin-1.1.5
v1.1.0, pitmp-maven-plugin-1.1.4
v1.0.1
Feedbacks are welcome ! :-)