secant-android-wallet/docs/testing/local_coverage.md

# Gathering Code Coverage
The app consists of different Gradle module types (e.g. Kotlin Multiplatform, Android).  Generating coverage for these different module types requires different command line invocations.

## Kotlin Multiplatform
Kotlin Multiplatform does not support coverage for all platforms.  Most of our code lives under commonMain, with a JVM target.  This effectively allows generation of coverage reports with Jacoco.  Coverage is enabled by default when running `./gradlew check`.

## Android
The Android Gradle plugin supports code coverage with Jacoco.  This integration can sometimes be buggy.  For that reason, coverage is disabled by default and can be enabled on a case-by-case basis, by passing `-PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true` as a command line argument for Gradle builds.  For example: `./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true`.

When coverage is enabled, running instrumentation tests will automatically generate coverage reports stored under `$module/build/reports/coverage`.
[#2] Add project documentation and templates 2021-09-13 12:57:05 -07:00			`# Gathering Code Coverage`
[#28] Initial SDK integration This sets up the infrastructure needed to continue implementing the onboarding UI for create and import of wallets. By fleshing out the global state management in the app now, we can better manage asynchronous IO to avoid blocking the UI. This adds: - Load and persistence a wallet in encrypted preferences - The stored data is written as a single JSON object, as opposed to multiple entries, to ensure atomic writes - The data is versioned, so that we can change the JSON format readily in the future - Detection of application state, e.g. onboarding versus loading the user's wallet - Touch points to initialize the SDK 2021-11-12 04:09:30 -08:00			`The app consists of different Gradle module types (e.g. Kotlin Multiplatform, Android). Generating coverage for these different module types requires different command line invocations.`

			`## Kotlin Multiplatform`
[#464] Use Kover for multiplatform coverage 2022-06-02 10:00:32 -07:00			Kotlin Multiplatform does not support coverage for all platforms. Most of our code lives under commonMain, with a JVM target. This effectively allows generation of coverage reports with Jacoco. Coverage is enabled by default when running `./gradlew check`.
[#28] Initial SDK integration This sets up the infrastructure needed to continue implementing the onboarding UI for create and import of wallets. By fleshing out the global state management in the app now, we can better manage asynchronous IO to avoid blocking the UI. This adds: - Load and persistence a wallet in encrypted preferences - The stored data is written as a single JSON object, as opposed to multiple entries, to ensure atomic writes - The data is versioned, so that we can change the JSON format readily in the future - Detection of application state, e.g. onboarding versus loading the user's wallet - Touch points to initialize the SDK 2021-11-12 04:09:30 -08:00
			`## Android`
[#464] Use Kover for multiplatform coverage 2022-06-02 10:00:32 -07:00			The Android Gradle plugin supports code coverage with Jacoco. This integration can sometimes be buggy. For that reason, coverage is disabled by default and can be enabled on a case-by-case basis, by passing `-PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true` as a command line argument for Gradle builds. For example: `./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true`.
[#2] Add project documentation and templates 2021-09-13 12:57:05 -07:00
[#464] Use Kover for multiplatform coverage 2022-06-02 10:00:32 -07:00			When coverage is enabled, running instrumentation tests will automatically generate coverage reports stored under `$module/build/reports/coverage`.