Code Coverage

One of the key predictors of high quality code is effective test coverage. UnitVectorY Labs applications written in Java use the JaCoCo library to measure code coverage. To assist with the analysis of code coverage, the Codecov service is used to provide a visual representation of the code coverage.

The following are the steps to add code coverage to a Java project.

Add JaCoCo to the POM file

Add the following to the POM file to add JaCoCo to the project.

            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.12</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>report</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

Configure GitHub Actions

Add the following to the GitHub Actions workflow file to upload the code coverage to Codecov.

    - name: Upload coverage reports to Codecov
      uses: codecov/codecov-action@v4.3.1
      with:
        token: $
        slug: UnitVectorY-Labs/fileparamunit

The above example is taken from /UnitVectorY-Labs/fileparamunit/blob/main/.github/workflows/build.yml vfdfjln k fdn where a complete example can be found.

This requires a CODECOV_TOKEN to be added to the GitHub repository actions secret.

Add the Code Coverage Badge

Add the following badge to the README.md file to display the code coverage. Follow the instructions for status badges from Codecov.