Wie würde ich eine Anmerkung hinzufügen, um eine Methode aus einem JACOCO-Codeabdeckungsbericht auszuschließen?

Question 1

Ich habe Code in Java, den ich von der Codeabdeckung ausschließen möchte. Wie würde ich das tun? Ich möchte eine Anmerkung hinzufügen können. Gibt es eine Möglichkeit, jacoco (wie in Gradle verwendet) zu konfigurieren oder zu erweitern, um dies zu verwenden?

Beispiel:

public class Something
{
    @ExcludeFromCodeCoverage
    public void someMethod() {}
}

Question 2

Da es darauf keine direkten Antworten gibt, habe ich ein bisschen recherchiert und bin auf diese PR gestoßen.

https://github.com/jacoco/jacoco/pull/822/files

  private static boolean matches(final String annotation) {
    final String name = annotation
            .substring(Math.max(annotation.lastIndexOf("https://stackoverflow.com/"),
                    annotation.lastIndexOf('$')) + 1);
    return name.contains("Generated")
  }

Sie können eine beliebige Anmerkung erstellen, deren Name „Generiert“ enthält. Ich habe Folgendes in meiner Codebasis erstellt, um Methoden von der Aufnahme in den Jacoco-Bericht auszuschließen.

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ExcludeFromJacocoGeneratedReport {}

Verwenden Sie diese Anmerkung in Ihren Methoden, um sie wie unten beschrieben von der Abdeckung auszunehmen.

public class Something
{
    @ExcludeFromJacocoGeneratedReport
    public void someMethod() {}
}

Question 3

Die neue Funktion wurde in der Version 0.8.2 von JaCoCo hinzugefügt, die die mit @Generated annotierten Klassen und Methoden herausfiltert. Einzelheiten entnehmen Sie bitte der folgenden Dokumentation:

Mit Anmerkung versehene Klassen und Methoden, deren Aufbewahrungsrichtlinie runtime oder class ist und deren einfacher Name Generated ist, werden während der Generierung des Berichts herausgefiltert (GitHub #731).

Versionshinweise zu JaCoCo 0.8.2

Question 4

Ich habe Code in Java, den ich von der Codeabdeckung ausschließen möchte. Wie würde ich das tun? Ich möchte eine Anmerkung hinzufügen können. Gibt es eine Möglichkeit, jacoco (wie in Gradle verwendet) zu konfigurieren oder zu erweitern, um dies zu verwenden?

Bis heute gibt es keine solche Funktion in der neuesten veröffentlichten Version von JaCoCo (0.7.9). Es können nur ganze Klassen ausgeschlossen werden.

Auf Seite https://github.com/jacoco/jacoco/wiki/FilteringOptions#annotation-based-filtering (das für Entwickler bestimmt ist) wird dies als Idee für zukünftige Versionen aufgezeichnet.

Die offizielle JaCoCo-Dokumentation enthält Informationen darüber, wie Sie den neuesten unveröffentlichten Build erhalten, sowie eine Liste von unveröffentlichte Änderungen für die nächste Version – http://www.jacoco.org/jacoco/trunk/doc/changes.html das verschiedene Filter enthält, darunter das Filtern von Methoden, die von Lombok und Groovy generiert und durch Annotationen gekennzeichnet sind lombok.Generated und groovy.transform.Generated beziehungsweise. Möglicherweise können Sie dies missbrauchen, aber ich würde dies aus vielen verschiedenen Gründen nicht empfehlen.

Question 5

Tl; dr

Anmerkung verwenden @lombok.Generated aus Lombok.

Erläuterung

Jacoco integriert sich mit Lombok. Von Lombok generierter Code ist standardmäßig von der Abdeckung durch Jacoco ausgeschlossen (siehe Release 0.8.0 im Jacoco-Änderungsprotokoll). Sie können missbrauchen lombok.Generated nach Ihrer Methode, damit es aus dem Deckungsbericht ausgeschlossen wird.

Question 6

Sie können einstellen lombok.addLombokGeneratedAnnotation = true hinein lombok.config im Stammverzeichnis des Projekts. Danach wird der gesamte von Lombok generierte Code von Jacoco ignoriert.

Weitere Informationen finden Sie in der Dokumentation zum Projekt Lombok: https://projectlombok.org/features/configuration

Question 7

Nach dem @mohamed-anees-a-Ansatz bin ich zu dieser Kotlin-Version gekommen:

@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class ExcludeFromJacocoGeneratedReport