[JAVA] Ausgabe Testabdeckung mit Klee + Gradle

Über dieses Dokument

• Ich habe versucht, festzulegen, wie bei der Ausgabe der Testabdeckung mit Klee + Gradle
• Wird im Spring-Boot-Projekt verwendet

Repository

Ich habe den Inhalt, den ich beim Ausprobieren erstellt habe, im folgenden Repository belassen mitsuya-saida/clover-sample

Abhängigkeit

Versuchen Sie vorerst, die Abdeckung auszugeben

Bewegen Sie sich vorerst

Schreiben Sie, dass es von build.gradle abhängt

Fügen Sie Gradle-Clover-Plugin zu Abhängigkeiten in Buildscript hinzu, wie unten gezeigt

buildscript {
	dependencies {
		classpath 'com.bmuschko:gradle-clover-plugin:2.1.3'
	}
}

Hinzufügen von Einstellungen zum Anwenden des Plugins

apply plugin: 'com.bmuschko.clover'

Klee zu Abhängigkeiten hinzugefügt

dependencies {
	clover 'org.openclover:clover:4.2.0'
}

Beschreiben Sie die Kleeeinstellungen

clover {
	report {
		html = true
	}
}

Das endgültige build.gradle des mit Spring boot erstellten Projekts lautet wie folgt

buildscript {
	ext {
		springBootVersion = '1.5.8.RELEASE'
	}
	repositories {
		mavenCentral()
	}
	dependencies {
		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
		classpath 'com.bmuschko:gradle-clover-plugin:2.1.3'
	}
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'com.bmuschko.clover'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
	mavenCentral()
}

clover {
	report {
		html = true
		filter = 'main'
	}
}

dependencies {
	compile('org.springframework.boot:spring-boot-starter-web')
	compileOnly('org.projectlombok:lombok')
	testCompile('org.springframework.boot:spring-boot-starter-test')
	clover 'org.openclover:clover:4.2.0'
}

Schreiben Sie einen geeigneten Test

Bitte

Ausgangsabdeckung

Der Test wird mit dem folgenden Befehl ausgeführt und die Coverage-Datei wird ausgegeben.

$ gradle clean cloverGenerateReport

Zeigen Sie das Ausgabeergebnis an

Da der HTML-Bericht im Build-Ergebnis generiert wird, sehen Sie ihn sich mit einem Browser an Bei diesem Projekt befindet es sich im folgenden Pfad

clover-sample/build/reports/clover/index.html

Wenn man den Browser betrachtet, sieht es so aus

Kommentar

Um die Kleeeinstellungen

• Wenn Sie es vorerst nur verschieben, wird die Abdeckung problemlos nur mit dem diesmal festgelegten Inhalt ausgegeben.
• Standardmäßig wird die Abdeckung nicht in HTML ausgegeben, daher wurde clover {report {html = true}} festgelegt.

Befehle von Klee

Die verfügbaren Befehle lauten wie folgt

Filtern Sie das Testziel

Versuchen Sie, die Hauptfunktion, Getter und Setter von der Abdeckung auszuschließen

Bewegen Sie sich vorerst

Geben Sie die Abdeckung aus, indem Sie Folgendes in die Kleeeinstellungen schreiben

clover {
	contexts {
		method {
			name = 'main'
			regexp = 'public static void main\\(String\\[\\] args\\).*'
		}
	}
	report {
		html = true
		filter = 'main,property'
	}
}

Ausgabeergebnis

Kommentar

• Hier habe ich versucht, den Filter zu verwenden, der ursprünglich von Clover hergestellt wurde, und den, den ich selbst eingestellt habe.
• Wenn Sie Ihre eigenen erstellen, können Sie sie verwenden, indem Sie eine Methode in Kontexten vorbereiten
• Eine Liste der verfügbaren Filter finden Sie in der offiziellen Dokumentation (https://confluence.atlassian.com/clover/using-coverage-contexts-72548355.html).

Verschiedene Gefühle

• Ich fand es praktisch, ohne viele Einstellungen filtern zu können
• Gradle-Plugin von Atlassian ist ebenfalls vorhanden, diesmal jedoch Alpha Nicht benutzt
• Da es nur wenige Beispiele für die Verwendung von Gradle gab, dachte ich zunächst, dass dies problematisch sein würde, aber die README-Datei des Plugins, das ich dieses Mal verwendet habe, war leicht zu verstehen, sodass ich es reibungslos verwenden konnte.