TOC

Maven - Beispiel für die JaCoCo-Codeabdeckung

Bild://wp-content/uploads/2018/11/Jacoco.png[Bild]

In diesem Artikel zeigen wir Ihnen, wie Sie ein JaCoCo Maven-Plugin verwenden, um einen Bericht zur Codeabdeckung für ein Java-Projekt zu erstellen.

Getestet mit

  1. Maven 3.5.3

  2. JUnit 5.3.1

  3. jacoco-maven-plugin 0.8.2

1. JaCoCo Maven Plugin

1.1 Deklarieren Sie das folgende JaCoCo-Plugin in der pom.xml -Datei.

pom.xml 

    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.8.2</version>
        <executions>
            <execution>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <!-- attached to Maven test phase -->
            <execution>
                <id>report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

Während der Testphase von Maven wird das JaCoCo-Berichtsziel ausgeführt

2. Unit Test

2.1 Ein einfacher Java-Code, um eine Nachricht zurückzugeben, und eine leere Zeichenfolge.

MessageBuilder.java 

package com.mkyong.examples;

public class MessageBuilder {

    public String getMessage(String name) {

        StringBuilder result = new StringBuilder();

        if (name == null || name.trim().length() == 0) {

            result.append("Please provide a name!");

        } else {

            result.append("Hello " + name);

        }
        return result.toString();
    }

}

2.2 Komponententest über der Klasse.

TestMessageBuilder.java 

package com.mkyong.examples;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class TestMessageBuilder {

    @Test
    public void testNameMkyong() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Hello mkyong", obj.getMessage("mkyong"));

    }

}

2.3 Führen Sie mvn test 'aus. Der JaCoCo-Code-Bericht wird unter target/site/jacoco/** `erstellt

Terminal 

$ mvn clean test
[INFO]-------------------------------------------------------[INFO] T E S T S[INFO]-------------------------------------------------------[INFO]Running com.mkyong.examples.TestMessageBuilder[INFO]Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.012 s - in com.mkyong.examples.TestMessageBuilder[INFO][INFO]Results:[INFO][INFO]Tests run: 1, Failures: 0, Errors: 0, Skipped: 0[INFO][INFO][INFO]--- jacoco-maven-plugin:0.8.2:report (report) @ maven-code-coverage ---[INFO]Loading execution data file D:\maven-examples\maven-code-coverage\target\jacoco.exec[INFO]Analyzed bundle 'maven-code-coverage' with 1 classes[INFO]------------------------------------------------------------------------[INFO]BUILD SUCCESS[INFO]------------------------------------------------------------------------[INFO]Total time: 4.164 s[INFO]Finished at: 2018-11-14T16:48:39+08:00[INFO]------------------------------------------------------------------------

2.4 Öffnen Sie die Datei target/site/jacoco/index.html und überprüfen Sie den Code-Abdeckungsbericht:

image

image

  1. Green-Code wird getestet oder abgedeckt.

  2. Red-Code wird nicht getestet oder abgedeckt.

  3. Gelb - Code ist teilweise getestet oder abgedeckt.

3. Verbesserung des Komponententests

3.1 Hinzufügen eines weiteren Tests für die rote Linie.

TestMessageBuilder.java 

package com.mkyong.examples;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class TestMessageBuilder {

    @Test
    public void testNameMkyong() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Hello mkyong", obj.getMessage("mkyong"));

    }

    @Test
    public void testNameEmpty() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Please provide a name!", obj.getMessage(" "));

    }
}

Überprüfen Sie den Bericht erneut.

Terminal 

$ mvn clean test

target/site/jacoco/index.html

image

3.2 Fügen Sie einen weiteren Test für die gelbe Linie hinzu, wenn Bedingung.

TestMessageBuilder.java 

package com.mkyong.examples;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class TestMessageBuilder {

    @Test
    public void testNameMkyong() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Hello mkyong", obj.getMessage("mkyong"));

    }

    @Test
    public void testNameEmpty() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Please provide a name!", obj.getMessage(" "));

    }

    @Test
    public void testNameNull() {

        MessageBuilder obj = new MessageBuilder();
        assertEquals("Please provide a name!", obj.getMessage(null));

    }

}

Überprüfen Sie den Bericht erneut.

Terminal 

$ mvn clean test

target/site/jacoco/index.html

image

image

Zum Schluss werden alle Leitungen mit 100% iger Abdeckung getestet.

4. FAQs

4.1 Stellen Sie sicher, dass die Leitungsreichweite mindestens 90% beträgt.

pom.xml 

    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>${jacoco.version}</version>
        <executions>
            <execution>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <execution>
                <id>jacoco-report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
            <!-- Add this checking -->
            <execution>
                <id>jacoco-check</id>
                <goals>
                    <goal>check</goal>
                </goals>
                <configuration>
                    <rules>
                        <rule>
                            <element>PACKAGE</element>
                            <limits>
                                <limit>
                                    <counter>LINE</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>0.9</minimum>
                                </limit>
                            </limits>
                        </rule>
                    </rules>
                </configuration>
            </execution>

        </executions>
    </plugin>

Das Ziel "jacoco: check" ist der Maven-Überprüfungsphase zugeordnet.

Terminal 

$ mvn clean verify
[INFO]Analyzed bundle 'maven-code-coverage' with 1 classes[WARNING]Rule violated for package com.mkyong.examples: lines covered ratio is 0.8, but expected minimum is 0.9

4.2 Wie aktualisiere ich den Standard-JaCoCo-Ausgabeordner?

pom.xml 

    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>${jacoco.version}</version>
        <executions>
            <execution>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <execution>
                <id>jacoco-report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
                <!-- default target/jscoco/site/**  -->
                <configuration>
                    <outputDirectory>target/jacoco-report</outputDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>

Quellcode herunterladen

$ git clone https://github.com/mkyong/maven-examples.git + $ cd Maven-Code-Abdeckung

$ mvn clean test # view report unter "target/site/jacoco/index.html"

Referenzen

  1. https://en.wikipedia.org/wiki/Java code coverage__toolsgliches Wiki:

Java-Codeabdeckungstools]. JaCoCo Java Code Coverage Library

  1. link://maven/jacoco-java-code-abdeckung-maven-beispiel/[JaCoCo in

Eclipse IDE]

Code-Abdeckung Link://Tag/jacoco/[jacoco] maven

Related