1. Introduction
For all test cases, it is important that coverage always analyses the whole code. This is a definitive and statistical proof that all testable code is indeed tested. In this example, I’ll be showcasing how a developer can turn on and off their code coverage on their unit test cases.
2. Tools
For this example, we’ll be using the following:
3. Step by Step
3.1 Setup your Eclipse and install EclEmma
Install EclEmma on your Eclipse. You can download from the Eclipse Marketplace or go to here. As soon as you manage to install the plugin, an additional option on the project execution context menu will be available for code coverage.
3.2 Source code
The project that comes along with this example will have 2 sets of JUnit test cases. This is a Maven project and can be imported from an Eclipse work space with Maven plugin installed. Here is an example of the JUnit Test source code that we will use for this post.
JUnitTestAssertThatAssertions.java
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | package com.areyes1.junitassertthat.sample;import static org.junit.Assert.*;import static org.hamcrest.CoreMatchers.*;import static org.hamcrest.BaseMatcher.*;import java.util.ArrayList;import java.util.List;import org.junit.Before;import org.junit.Test;public class JUnitTestAssertThatAssertions { int totalNumberOfApplicants = 0; int totalNumberOfAcceptableApplicants = 10; ArrayList listOfValidStrings = new ArrayList(); @Before public void setData(){ this.totalNumberOfApplicants = 9; listOfValidStrings.add("object_1"); listOfValidStrings.add("object_2"); listOfValidStrings.add("object_3"); } @Test public void testAssertThatEqual() { assertThat("123",is("123")); } @Test public void testAssertThatNotEqual() { assertThat(totalNumberOfApplicants,is(123)); } @Test public void testAssertThatObject() { assertThat("123",isA(String.class)); } @Test public void testAssertThatWMessage(){ assertThat("They are not equal!","123",is("1234")); }} |
3.3 Code Coverage
Basically, the tool runs the junit test and documents all source code (both junit and project source) and display the coverage level of each implementation method / class. This is extremely helpful in measuring the code quality and stability of your code. In this examples project, I ran the code coverage tool to see if the test cases I did, covered all the implementation methods of the project sources.
Not only there is a tabular representation, it also highlights the lines of codes that are covered (green) and not as shown below.
3.4 Running JaCoCo to generate code coverage results via maven
We can actually create a code coverage report via maven by using JaCoCo plugin. Specify the following plugins in your pom.xml below and run the test cases.
pom.xml
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | <build> <plugins> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.6.5.201403032054</version> <executions> <execution> <id>pre-unit-test</id> <goals> <goal>prepare-agent</goal> </goals> <configuration> <destFile>${project.build.directory}/coverage-reports/jacoco-ut.exec</destFile> <propertyName>surefireArgLine</propertyName> </configuration> </execution> <execution> <id>post-unit-test</id> <phase>test</phase> <goals> <goal>report</goal> </goals> <configuration> <!-- Sets the path to the file which contains the execution data. --> <dataFile>${project.build.directory}/coverage-reports/jacoco-ut.exec</dataFile> <!-- Sets the output directory for the code coverage report. --> <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory> </configuration> </execution> </executions> <dependencies> <dependency> <groupId>commons-collections</groupId> <artifactId>commons-collections</artifactId> <version>3.2.1</version> </dependency> </dependencies> </plugin> </plugins> </build> |
Run you test in maven using the following command:
1 | mvn clean test |
4. Download the Eclipse project
This was an example of JUnit Code Coverage
You can download the full source code of this example here: junit-assert-coverage-example
