Wyświetlanie raportów dotyczących pokrycia kodu

Wtyczka Androida do obsługi Gradle może tworzyć raporty o pokryciu kodu, które śledzą odsetek kodu objętego testami. Z tej strony dowiesz się, jak włączyć raportowanie pokrycia i generować raporty.

Możesz generować raporty o pokryciu dla każdego typu testu (jednostkowego i instrumentacyjnego) w przypadku każdego wariantu. Możesz też generować ujednolicone raporty o pokryciu obejmujące różne typy testów, moduły i warianty kompilacji.

Włączanie pokrycia kodu

Pokrycie kodu musi być włączone przez ustawienie wartości true w przypadku parametrów enableAndroidTestCoverage i enableUnitTestCoverage w plikach kompilacji na poziomie modułu dla każdego wariantu, dla którego chcesz uzyskać raporty o pokryciu:

Kotlin

android {
    // ...
    buildTypes {
        debug {
            // Enable coverage for unit tests
            enableUnitTestCoverage = true
            // Enable coverage for instrumentation tests
            enableAndroidTestCoverage = true
        }
    }
}

Dynamiczny

android {
    // ...
    buildTypes {
        debug {
            // Enable coverage for unit tests
            enableUnitTestCoverage true
            // Enable coverage for instrumentation tests
            enableAndroidTestCoverage true
        }
    }
}

Zmienianie wersji Jacoco (opcjonalnie)

Gdy włączysz pokrycie w modułach, AGP automatycznie zastosuje Jacoco. Jeśli jednak musisz użyć określonej wersji Jacoco, możesz ją określić w pliku kompilacji na poziomie modułu:

Kotlin

android {
    testCoverage {
        jacocoVersion = "JACOCO_VERSION"
    }
}

Dynamiczny

android {
    testCoverage {
        jacocoVersion = 'JACOCO_VERSION'
    }
}

Generowanie raportów o pokryciu dla konkretnego wariantu

Aby wygenerować raporty o pokryciu tylko dla testów jednostkowych lub tylko dla testów z instrumentacją w przypadku konkretnego wariantu, uruchom odpowiednie zadania.

Typ testu Polecenie Lokalizacja raportu
Testy jednostkowe ./gradlew :module-name:createVariantNameUnitTestCoverageReport path-to-your-project/module-name/build/reports/coverage/test/variant/index.html
Testy instrumentacyjne ./gradlew :module-name:createVariantNameAndroidTestCoverageReport path-to-your-project/module-name/build/reports/coverage/androidTest/variant/connected/index.html

Generowanie ujednoliconych raportów o pokryciu kodu

Ujednolicone raporty o pokryciu kodu możesz generować za pomocą zadań Gradle testAllSuites i testAllSuitesWithDependencies. Te zadania wygenerują jeden raport HTML, który zawiera dane o pokryciu z różnych typów testów (jednostkowych i instrumentacyjnych), modułów i wariantów kompilacji. Dzięki temu w jednym panelu możesz uzyskać kompleksowy wgląd w pokrycie kodu projektu.

Wymagania wstępne

Aby wygenerować ujednolicony raport, uruchom w wierszu poleceń jedno z tych zadań:

Zakres pokrycia Polecenie Opis Lokalizacja raportu
Bieżący moduł ./gradlew :module-name:testAllSuites --continue Testuje wszystkie pakiety testów i generuje ujednolicony raport o pokryciu dla bieżącego modułu, łącząc dane ze wszystkich typów testów. path-to-your-project/module-name/build/reports/testAllSuites/coverage-report/
Bieżący moduł i zależności ./gradlew :module-name:testAllSuitesWithDependencies --continue Testuje wszystkie zestawy testów i generuje ujednolicony raport o pokryciu dla bieżącego modułu i wszystkich jego zależności. To zadanie jest dostępne w przypadku modułów aplikacji i modułów biblioteki z włączoną publikacją. path-to-your-project/module-name/build/reports/testAllSuitesWithDependencies/coverage-report/

Strona docelowa wygenerowanego raportu HTML zawiera ogólne podsumowanie wszystkich modułów. Możesz przejść od modułu do pakietu, od pakietu do klasy, a od klasy do pliku źródłowego. Kliknij dowolny plik, aby wyświetlić kod z wyróżnieniem pokrycia wierszy i gałęzi:

  • Zielony: objęte wiersze.
  • Czerwony: nieobjęte wiersze.
  • Żółty: częściowe pokrycie (pominięto niektóre instrukcje lub gałęzie).