# Change History

## Release 0.8.1 (2018/03/21)

### New Features

- JaCoCo now supports Java 10 (GitHub #629).
- Empty constructor without parameters in enum is filtered out during generation of report (GitHub #649).

## Release 0.8.0 (2018/01/02)

### New Features

- JaCoCo now officially supports Java 9 (GitHub #600).
- JaCoCo now comes with a simple command line interface (GitHub #525).
- Limit configuration of Maven `check` goal and Ant `check` element now also supports percentage values (GitHub #534).
- Manifests of JAR files now have `Automatic-Module-Name` for Java 9 (GitHub #565).
- Maven aggregated reports will now also include modules of `runtime` and `provided` dependencies (GitHub #498, #572).

During creation of reports various compiler generated artifacts are filtered out, which otherwise require unnecessary and sometimes impossible tricks to not have partial or missed coverage:

- Methods `valueOf` and `values` of enum types (GitHub #491).
- Private empty no-argument constructors (GitHub #529).
- Methods annotated with `@lombok.Generated` to better integrate with Lombok >= 1.16.14. Initial analysis and contribution by Rüdiger zu Dohna (GitHub #513).
- Methods annotated with `@groovy.transform.Generated` to better integrate with Groovy >= 2.5.0. Thanks to Andres Almiray for adding the annotation to Groovy (GitHub #610).
- Part of bytecode for `synchronized` blocks (GitHub #501).
- Part of bytecode for try-with-resources statements (GitHub #500).
- Part of bytecode for `finally` blocks (GitHub #604).
- Part of bytecode for `switch` statements on `java.lang.String` values (GitHub #596).

Note: Tools that directly read `exec` files and embed JaCoCo for this (such as SonarQube or Jenkins) will provide filtering functionality only after they updated to this version of JaCoCo.

### Fixed Bugs

- Fixed bug in instrumentation of exception handlers, which was causing damage of structured locking in certain situations and as consequence poor performance of instrumented methods, analysis and fix contributed by Allen Hair (GitHub #627).
- `dump` commands now report error when server unexpectedly closes connection without sending response (GitHub #538).
- Reduced chance of conflict with other agents (GitHub #555).
- Restored Maven `help` goal that was missing in version 0.7.9 (GitHub #559).
- `NullPointerException` during offline instrumentation of `module-info.class` (GitHub #600, GitHub #634).
- Incorrect update of frames caused by bug in ASM library (GitHub #600).
- Loss of `InnerClasses` attribute caused by bug in ASM library (GitHub #600).
- `NegativeArraySizeException` during instrumentation caused by bug in ASM library (GitHub #600).

### Non-functional Changes

- JaCoCo now depends on ASM 6.0 (GitHub #600).
- More information about context is provided when unable to read input during instrumentation (GitHub #527).
- More information about context is provided when unable to read stream during analysis (GitHub #541).

## Release 0.7.9 (2017/02/05)

### Fixed Bugs

- "`java.lang.ClassFormatError: Short length on BootstrapMethods in class file`" caused by bug in ASM library (GitHub #462).
- Do not recompute frames in case of large methods, otherwise `java.lang.ClassNotFoundException` might be thrown (GitHub #177).
- `ExecutionDataWriter.FORMAT_VERSION` is not a compile-time constant (GitHub #474).
- Maven goal "prepare-agent" should not overwrite existing property value if execution was skipped (GitHub #486).

### API Changes

- `JaCoCo.ASM_API_VERSION` removed (GitHub #474).

### Non-functional Changes

- JaCoCo now depends on ASM 5.2.
- OSGi metadata now generated automatically and additionally include `uses` directives, `Require-Capability` attribute, and export of all internal packages with `x-internal:=true` directive (GitHub #211).
- Removed OSGi attributes that were mistakenly added in version 0.6.1 into `jacocoant.jar` that contains all dependencies (GitHub #211).

## Release 0.7.8 (2016/12/09)

### New Features

- User property `jacoco.dataFile` for parameter `dataFile` of Maven `report` goal (GitHub #322).

### Fixed Bugs

- Use `RoundingMode#FLOOR` instead of `RoundingMode#HALF_EVEN` for percentages in HTML report, so that "99.5" is displayed as "99%", not as "100%" (GitHub #452).
- Do not add useless members into Java 8 interfaces that have only interface initialization and abstract methods (GitHub #441).
- Fix instrumentation to not violate Java Virtual Machine Specification regarding initialization of final fields, otherwise `IllegalAccessError` will be thrown starting from OpenJDK 9 EA b127 (GitHub #434).
- Fix instrumentation of interfaces with default methods to not create incorrect constant pool entries, which lead to `IncompatibleClassChangeError` starting from OpenJDK 9 EA b122 (GitHub #428).
- Add Maven goal `report-aggregate` to lifecycle-mapping-metadata.xml (GitHub #427).

### Non-functional Changes

- Released JaCoCo JARs are not signed any more. Signed versions of JaCoCo are now available from the Eclipse Orbit project (GitHub #466).
- Simplified numbering of versions - JaCoCo JARs in Maven Central repository do not have qualifier any more (GitHub #468).

## Release 0.7.7 (2016/06/06)

### New Features

- New Maven goal `report-aggregate` to create reports for multi-module projects (GitHub #388).
- New parameters `title` and `footer` for Maven reporting goals allow customization of generated reports.
- Renamed "dot" resources in generated HTML reports to become more web hosting friendly (GitHub #401).
- Experimental support for Java 9 class files (GitHub #406).

### Fixed Bugs

- Don't suppress EOF errors in case of truncated execution data files (GitHub #397).

### Non-functional Changes

- JaCoCo now depends on ASM 5.1.
- Empty probe arrays are not written to execution data files any more. This reduces exec file size significantly for per-test data dumps. (GitHub #387).
- More information about context is provided when unable to read input during analysis. (GitHub #400).
- Require at least Maven 3.0 for build of JaCoCo.

## Release 0.7.6 (2016/02/18)

### New Features

- New agent option `inclnolocationclasses` to support execution environments like Android where no source location is provided with classes (GitHub #288).
- Improved error message in case of incompatible execution data files. (GitHub #319).
- Command line agent options now supports comma in file names. Contributed by Jochen Berger. (GitHub #358).

### Fixed Bugs

- Fix `MBeanClient` example (GitHub #333).
- Avoid `ConcurrentModificationException` during shutdown (GitHub #364).

### API Changes

- In case of incompatible execution data formats read from another JaCoCo version `ExecutionDataReader.read()` now throws a `IncompatibleExecDataVersionException`.

### Non-functional Changes

- JaCoCo now depends on ASM 5.0.4.

## Release 0.7.5 (2015/05/24)

### New Features

- Better detection of coverage in code blocks with implicit exceptions. (GitHub #310).
- Added lifecycle-mapping-metadata.xml for M2E (GitHub #203).
- Allow locales with country and variant for Ant report task (GitHub #289).

### Fixed Bugs

- For the Ant tasks `coverage` and `agent` the `destfile` attribute is now passed as an absolute path also in the default case (GitHub #301).

### API Changes

- The exec file version has been updated and is not compatible with previous versions.

## Release 0.7.4 (2015/02/26)

### Fixed Bugs

- Restored exec file compatibility with version 0.7.2 by fixing missing probes in case of try/catch blocks which are jump targets. (GitHub #286).

## Release 0.7.3 (2015/02/19)

### New Features

- For offline instrumemtation agent configuration supports system properties replacements. Implementation based on pull request of GitHub user 'debugger' (GitHub #262).
- Exclude dynamically generated classes from instrumentation for better interoperability with JMockit, analysis contributed by Rogério Liesenfeld (GitHub #272).

### Fixed Bugs

- Instrumented bytecode now compatible with Android ART runtime, analysis and fix contributed by Allen Hair (GitHub #265).

## Release 0.7.2 (2014/09/12)

### Fixed Bugs

- Do not ignore synthetic lambda methods to get code coverage for Java 8 lambda expressions (GitHub #232).

### New Features

- New configuration option for the JaCoCo agent `inclbootstrapclasses` to also instrument classes from the bootstrap class loader (GitHub #49).
- Agent uses unique file names to dump class files (GitHub #225).

## Release 0.7.1 (2014/05/08)

### Fixed Bugs

- Fixed failure with default methods in Java 8 interfaces (GitHub #201).
- Better interoperability with JMockit, analysis and fix contributed by Rogério Liesenfeld (GitHub #35 and #54).

### Non-functional Changes

- JaCoCo now depends on ASM 5.0.1 (GitHub #201).

## Release 0.7.0 (2014/03/18)

### New Features

- JaCoCo now supports Java 8 (GitHub #74).

### Non-functional Changes

- JaCoCo now depends on ASM 5.0 using asm-debug-all instead of asm-all (GitHub #199).

## Release 0.6.5 (2014/03/03)

### New Features

- Warnings are logged during report generation if different versions of classes are used than at runtime (GitHub #185).
- Signatures are removed from instrumented JAR files (GitHub #186).

### Fixed Bugs

- Skip jacoco instrumentation for mvn modules with package type ear (GitHub #169).
- Align skip conditions and messages for Maven goals and give reasons. This includes removal of the specific skip condition for packages e.g. POMs and instead checks existence of `target/classes` in appropriate goals (GitHub #171).
- GitHub #44: (Regression) Agent Mojo should set empty property, if execution was skipped (GitHub #192).

### API Changes

- Restrict visibility of methods in abstract classes of jacoco-maven-plugin (GitHub #175).

## Release 0.6.4 (2013/12/10)

### New Features

- Support for Android Strict Mode (GitHub #113).
- New dump Mojo for Maven plug-in (GitHub #107).
- New merge Mojo for Maven plug-in, contributed by Mads Mohr Christensen (GitHub #126).
- Additional list of source files for every package in HTML report (GitHub #142).
- Additional report-integration and prepare-agent-integration goals for integration tests. (GitHub #152, #161).

### Fixed Bugs

- Multiple executions of Maven goal "prepare-agent" should not lead to incorrect configuration (GitHub #40).
- Avoid direct dependency on java.lang.management APIs to allow usage on Android (GitHub #150).
- All JaCoCo Maven goals are marked as thread-safe (GitHub #133).
- check and merge goal failures in jacoco-maven-plugin with Maven 2.2.1 due to incompatible configuration (GitHub #129).

### API Changes

- New API package `org.jacoco.core.tools` for shared high-level tools. (GitHub #159).

## Release 0.6.3 (2013/06/03)

### New Features

- Support for archives in Pack200 format (GitHub #91).
- The coverage check has been reworked to allow checks on all counter values on all element types (GitHub #106).
- Coverage checks are now also available in Ant (GitHub #106).

### Fixed Bugs

- Fixed inconsistent stackmap frames when instrumenting class files produced by certain tools like ProGuard (GitHub #85).

### Non-functional Changes

- More context information when exceptions occur during analysis or instrumentation (GitHub #104).
- If analysis is performed on offline instrumented classes - which is an build configuration error - an exception is now thrown (GitHub #108).

### API Changes

- The configuration of the Maven check goal has been reworked to support checks on any element type (GitHub #106).
- `Analyzer` and `Instrumenter` expect resource name as additional parameter for better error messages (GitHub #104).

## Release 0.6.2 (2013/02/03)

### New Features

- Support for offline instrumentation (GitHub #4, #64).
- JaCoCo agent exposes runtime API for direct integration with application under test (GitHub #61).
- Support for parallel test execution: Different agents can now safely write to the same `*.exec` file (GitHub #52).
- New output mode 'none' can be used when agent is only controlled via JMX or its new runtime API (GitHub #63).
- Better error message in case of invalid stackmap frames (GitHub #73).
- jacoco-maven-plugin: default phase for goal "report" - "verify" (GitHub #72).

### Non-functional Changes

- For every build the corresponding Git commit hash is included as `Eclipse-SourceReferences` manifest headers (GitHub #7, #59).
- Adjust saturation of red source highlighting in HTML reports to make JaCoCo reports more accessible to red/green blind users.

### API Changes

- The `output` mode `mbean` of the agent has been dropped in favor of the new boolean option `jmx`. This allows to combine JMX access with any other output mode (GitHub #62).

## Release 0.6.1 (2012/12/23)

### New Features

- Add a coverage check Mojo, contributed by Kyle Lieber (GitHub #6).

### Fixed Bugs

- jacocoant.jar should not conflict with ASM 3.x (GitHub #39).
- Agent Mojo should set empty property, if execution was skipped (GitHub #44).

### Non-functional Changes

- Upgrade to ASM 4.1 (GitHub #37).
- Log location of merged execution data file in Ant `merge` task (GitHub #29).

## Release 0.6.0 (2012/10/06)

### New Features

- Full support for Java 7 including INVOKEDYNAMIC as JaCoCo is now based on ASM 4.0 (GitHub #5).

### Fixed Bugs

- Maven plugin should skip creation of report if the execution data file is missing. This avoids appearance of stack traces in case when JVM was not forked, e.g. if there are no tests to run (SF #3563431, GitHub #19).
- Maven plugin should fail if unable to read execution data file or create report (GitHub #19).

### API Changes

- Only colon as separator character supported in agent parameters. The deprecated pipe character is no longer supported.

## Release 0.5.10 (2012/08/31)

### Fixed Bugs

- Correct stackmap frames for new `long[]` arrays (SF #3553210).
- Properly resolve the `fork` variable for tasks wrapped by the `coverage` Ant task (Trac #213).

### Non-functional Changes

- Source tree has been migrated to Git and is now hosted on Github at https://github.com/jacoco/jacoco.

## Release 0.5.9 (2012/07/30)

### Fixed Bugs

- Don't produce invalid class files in case of unexpected stackmap frames (SF #3543758).

## Release 0.5.8 (2012/07/11)

### New Features

- Support for parallel Maven builds (Trac #191).
- New agent option `classdumpdir` to dump all class files seen by the JaCoCo agent to disk. This option is also available for Ant and Maven (Trac #208).

### Fixed Bugs

- Allow instrumentation of classes with dead code (SF #3538112).
- Reworked instrumentation strategy to avoid verifier error "Uninitialized object exists on backward branch" with certain Java 7 class files (Trac #154).

### Non-functional Changes

- Documentation now includes Maven example and Maven goal documentation (Trac #201, #202).

## Release 0.5.7 (2012/04/19)

### New Features

- Support for class redefinitions by other agents like JMockit (SF #3509409).
- Remove class file attributes with invalid code offsets caused by other byte code processing tools to avoid verifier errors (Trac #196).
- Improved logging for Ant tasks (SF #3518429).

### Fixed Bugs

- In case of failures the agent should log the original exception.

## Release 0.5.6 (2012/01/23)

### New Features

- jacoco-maven-plugin can be used together with maven-site-plugin (Trac #181).
- The `report` Ant task now also supports directory resources to specify source folders. This allows reading source files from multiple directories. Contributed by Dominik Stadler (Trac #119).

### Fixed Bugs

- Don't insert stackmap frames for class files before version 1.6.
- Regression, which was introduced in 0.5.4 - restored compatibility of jacoco-maven-plugin with Maven 2 (Trac #182).

## Release 0.5.5 (2011/12/15)

### Fixed Bugs

- Correct default value for the `append` property of the `dump` Ant task is `true` (Trac #178).
- Try/catch blocks must not be counted as instructions (Trac #179).

### Non-functional Changes

- Upgrade to ASM 3.3.1.

## Release 0.5.4 (2011/11/11)

### New Features

- Maven plug-in: respect `includes` and `excludes` properties in report Mojo (Trac #160). Also note that:

      <configuration>
        <includes>org.foo.*:org.bar.*</includes>
        <excludes>com.foo.*:com.bar.*</excludes>
      </configuration>

  must be replaced on:

      <configuration>
        <includes>
          <include>org.foo.*</include>
          <include>org.bar.*</include>
        </includes>
        <excludes>
          <exclude>com.foo.*</exclude>
          <exclude>com.bar.*</exclude>
        </excludes>
      </configuration>

### API Changes

- `Instrumenter` now only requires `IExecutionDataAccessorGenerator` instead of `IRuntime` (Trac #174).
- Removed reference to internal implementation classes from `CoverageBuilder` API.

### Non-functional Changes

- Release bundles from now on signed again.
- Several documentation updates.

## Release 0.5.3 (2011/07/06)

### New Features

- New Maven plug-in for JaCoCo agent setup and basic reporting (Trac #25).
- Additional output mode implementation for JaCoCo agent based on JMX.

### Fixed Bugs

- Fixed problem with reporting of nested group structures (Trac #157).

### Non-functional Changes

- JaCoCo build based on Maven (Trac #136).
- JaCoCo published to Maven repository (Trac #149).

## Release 0.5.2 (2011/05/19)

### New Features

- JaCoCo reports cyclomatic complexity numbers (Trac #129).
- For HTML reports the tab width can be specified on the `sourcefiles` attribute of the `report` Ant task (Track #152).

### Fixed Bugs

- Removed duplicate counters in the root node of XML reports (Trac #155).
- Avoid `StackOverflowException` when analyzing methods with very long instruction sequences (Trac #156). Many thanks to Jean-Eric Cuendet for reporting and analyzing this!

### API Changes

- `ICoverageNode` API has been extended for cyclomatic complexity (Trac #129).
- XML and CSV report includes new counter type `COMPLEXITY` (Trac #129).
- New method `getTabWidth()` in callback interface `ISourceFileLocator` instead of `HTMLReportFormatter.setTabWidth()` which has been removed. (Trac #152).

## Release 0.5.1 (2011/03/21)

### New Features

- Duplicate classes with identical identifiers are now ignored during analysis.
- Added support for TestNG to Ant task Coverage (Track #144).

### Fixed Bugs

- Calculate correct stackmap frames for Java 1.6 branches (Trac #139).
- Link source files also for classes in default package (Trac #151).

### Non-functional Changes

- API documentation cleanup (Track #140).
- Removed obsolete examples from documentation (Trac #141).
- Added reporting API example (Trac #146).
- Reduced file size of HTML report source pages (Trac #148).

### API Changes

- Simplified reporting API (Trac #53).
- Use colon as separator character in agent parameters (Trac #143).
- Now also empty files are accepted as `*.exec` files (Trac #150).

## Release 0.5.0 (2011/01/19)

### New Features

- JaCoCo now reports branch coverage (Track #66).

### Fixed Bugs

- Only process actual Java class files during analysis (SF #3106102).
- Fix broken source links due to sort hash (Track #125).
- Fixed invalid OSGi headers in MANIFEST.MF files (Track #127).
- Try to avoid interference with Hibernate (SF #3134190).
- Provide proper error message in case of duplicate class names in the same group (SF #3110219).
- Allow any number of probes in static interface initializers (SF #3161106).

### API Changes

- All analysis specific APIs have been moved to package `org.jacoco.core.analysis`.
- The `IStructureVisitor` interface has been replaced by a simplified version called `ICoverageVisitor` (Track #132).
- All counter creation and update APIs now accept missed items and covered items as parameters (Track #131).
- Instructions are now counted on a per line basis. Therefore some interfaces in the `org.jacoco.core.analysis` package have changed as well as the `line` element in the XML report (Track #130).
- Several internal implementation classes have removed from the core APIs or have been replaced by new interfaces (Track #133).

## Release 0.4.1 (2010/10/07)

### New Features

- New attribute `line` for `method` elements in the XML report containing the first source line number of the method. (Track #120).
- Optional `locale` attribute for number rendering HTML reports, also available as an attribute of the `html` tag of the `report` Ant task (Track #122).
- Coverage tables in HTML report are now sortable (Track #98).
- The `report` Ant task issues a warning if source files are provided but class files do not contain debug information to collect line numbers (SF #3024486).

### Non-functional Changes

- Reduced memory footprint for coverage data by 30% (Track #106).
- Moved to Eclipse 3.6.x as development environment (Trac #115).
- All delivered bundles and JAR files are signed (Trac #118).

### Fixed Bugs

- Better error message when multiple JaCoCo agents are specified (Track #103).
- Fixed potential NPE at shutdown when running agent in `tcpserver` mode (Track #117).
- Agent now fails at startup when execution data file can't be opened (Track #121).

## Release 0.4.0 (2010/06/04)

### New Features

- Execution data now includes session information: an arbitrary identifier, the start time and dump time (Trac #88).
- Added session information to XML report (Trac #92).
- New "Sessions" page in the HTML report shows information about each sessions wherein execution data has been collected for the report (Trac #93). Additionally all classes with execution data available are listed on this page (Trac #94).
- The agent now supports remote dumps via TCP/IP connections (Trac #82).
- New Ant task `dump` to remotely collect coverage data from agents (Trac #100).

### API Changes

- Execution data file header is written and read in any case (Trac #72).
- Added `dumponexit` to agent options (Trac #82).
- Added `sessionid` to agent options (Trac #88).
- Added `output, address and port` to agent options (Trac #82).
- Additional and modified methods in `IRuntime` to produce session information (Trac #88).
- Coverage element type `SESSION` removed (Trac #95).
- Removed several internal APIs from package `org.jacoco.core.instr` used for class instrumentation.
- Renamed class `org.jacoco.report.csv.CsvFormatter` to `CSVFormatter` (upper case) for consistency with other formatters.

## Release 0.3.3 (2010/04/19)

### New Features

- Support for different archives (jar, war, ear etc.) and nested archives (Trac #78).
- XML report with line level coverage information (requested for Sonar).

### Fixed Bugs

- Correct stackmap frames for Java 1.6 class files. (Track #81).
- Avoid usage of `LocalVariableSorter` due to ASM bug #314563 (Track #69).
- Nested Java/JUnit Ant tasks not being executed when coverage task disabled. (Track #85).

## Release 0.3.2 (2010/04/01)

### New Features

- New HTML report option to directly create a zip file containing the report (Trac #12).
- Code coverage for static initializers in interfaces (Trac #21).
- Better error handling for `report` Ant task (Trac #71).
- Classes without instructions are excluded from reports (Trac #73).

### Fixed Bugs

- XML and CSV report output now also works for structures without groups (Track #76).

### API Changes

- Consistent usage of the term "Missed" instead of "NotCovered" in all APIs (Trac #72).
- To support "off-line" instrumentation scenarios it is not required any more to register instrumented classes with the runtime (Trac #74).

## Release 0.3.1 (2010/02/09)

### Fixed Bugs

- Ant tasks broken on Linux (Trac #68).

## Release 0.3.0 (2010/02/02)

### New Features

- Report renders anonymous classes with type information (Trac #46).
- `enabled` property added to `agent` and `coverage` Ant tasks (Trac #63).
- Ant task `merge` added (Trac #52).

### Fixed Bugs

- New `IRuntime` implementation enables JaCoCo usage for J2EE application servers like Glassfish.

### API Changes

- Agent option and Ant task parameter `file` changed to `destfile` (Trac #59).
- Agent option and Ant task parameter `merge` changed to `append` (Trac #51).

## Release 0.2.0 (2010/01/08)

### New Features

- Simplified probe data structure reduces memory usage (Trac #47).
- Performance test becomes part of the build.
- New bundle `org.jacoco.agent` that provides the Java agent as a resource (Trac #50).

### Fixed Bugs

- `ArrayIndexOutOfBoundsException` due to inconsistent processing while instrumentation and analysis (Trac #44).

## Release 0.1.0 (2009/10/28)

The very first JaCoCo release.