MavenMultiModule

Maven Multi-Module Builds

Support for Maven multi-module build is a long outstanding feature request for JaCoCo. This page tries to collect all information about this feature.

Related Feature Requests

• Issue #18 Multi-report merging
• Issue #69 Multiply repot file merging with multimodule project reports aggregation
• Pull Request #97 Add aggregate-report that reports cross module code coverage for the maven plugin
• Pull Request #217 Allows the report mojo to reference binary/source files in other modules

Current Situation

The current JaCoCo Maven goals work on single modules only: Tests are executed within the module and contribute coverage only to code within the same module. Coverage reports are created for each module separately. There is no built-in support for cross-module coverage or combined reports for multiple modules.

Work-Arounds

• TODO

Use Cases

TODO

• units tests in separate module (e.g. Eclipse/tycho)
• structured report for multiple modules
• integration tests covering multiple modules

Aspects:

• parent POM vs. aggregator POM
• separate vs. combined reports for different test test levels (unit, it)
• transitive coverage (e.g. test for A causes code coverage on B when A depends on B): this might be desireable or not

Implementation

• Maven Doc: Guide to Working with Multiple Modules

Other Maven Goals Supporting Multi-Module Reports

TODO