Skip to content

Commit

Permalink
Implemented the ability to specify flexible patterns for merging reports
Browse files Browse the repository at this point in the history
Is it now possible to use wildcards in the `mergeWith` function `?` and `*` and the check has become case-insensitive.

Relates #373
  • Loading branch information
shanshin committed Jul 14, 2023
1 parent 4d33d76 commit a6d5129
Show file tree
Hide file tree
Showing 31 changed files with 574 additions and 20 deletions.
20 changes: 19 additions & 1 deletion docs/gradle-plugin/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ The `GroupingEntityType` type is used for this:
If it is necessary to generate a report for a specific build variant using the Kover default report tasks, it is possible to combine the contents of the Android report and the default report.

This is done by configuring default reports
```
```kotlin
koverReport {
defaults {
mergeWith("release")
Expand All @@ -539,6 +539,24 @@ koverReport {
```
This will add the reports contents of `release` Android build variant to default reports.

Is it acceptable to use wildcards `*` (zero or several arbitrary characters) and `?` (strictly one arbitrary character).
The pattern is case-insensitive: `release` and `RelEase` processed the same way.

Examples:
- add coverage only of release build variant
```kotlin
mergeWith("Release")
```
- add coverage of all build variants in the project
```kotlin
mergeWith("*")
```
- add coverage of all build variants with build type `release` when there are different flavors
```kotlin
mergeWith("*release")
```


This can be useful if only one command is run in a multimodule project for uniformity, instead of many different ones for each module.
Or if in a multiplatform project it is necessary to generate a single report for JVM and Android targets.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
plugins {
id ("com.android.application")
id ("org.jetbrains.kotlin.android")
id ("org.jetbrains.kotlinx.kover")
}

android {
namespace = "kotlinx.kover.test.android"
compileSdk = 32

defaultConfig {
applicationId = "kotlinx.kover.test.android"
minSdk = 21
targetSdk = 31
versionCode = 1
versionName = "1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
}

buildTypes {
release {
isMinifyEnabled = true
}
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
buildFeatures {
viewBinding = true
}
}

dependencies {
implementation("androidx.core:core-ktx:1.8.0")
implementation("androidx.appcompat:appcompat:1.5.0")
implementation("com.google.android.material:material:1.6.1")
implementation("androidx.constraintlayout:constraintlayout:2.1.4")
testImplementation("junit:junit:4.13.2")
}

koverReport {
// filters for all report types of all build variants
filters {
excludes {
classes(
"*Fragment",
"*Fragment\$*",
"*Activity",
"*Activity\$*",
"*.databinding.*",
"*.BuildConfig"
)
}
}

defaults {
/**
* Tests, sources, classes, and compilation tasks of all build variants will be included in the default reports.
* Thus, information from all variants will be included in the default report for this project and any project that specifies this project as a dependency.
*/
mergeWith("*")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package kotlinx.kover.test.android

object DebugAppClass {
fun foo() {
println("LIB DEBUG")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<application android:label="@string/app_name">
<uses-library android:name="com.google.android.things" android:required="false" />

<activity android:name=".MainActivity"
android:exported="true">
<intent-filter>
<action android:name="android.intent.action.MAIN" />

<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
<!-- Make this the first activity that is displayed when the device boots. -->
<intent-filter>
<action android:name="android.intent.action.MAIN" />

<category android:name="android.intent.category.HOME" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
</application>

</manifest>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package kotlinx.kover.test.android

object DebugUtil {
fun log(message: String) {
println("DEBUG: $message")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package kotlinx.kover.test.android

import android.os.Bundle
import android.app.Activity

class MainActivity : Activity() {

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package kotlinx.kover.test.android

object Maths {
fun sum(a: Int, b: Int): Int {
DebugUtil.log("invoked sum")
return a + b
}

fun sub(a: Int, b: Int): Int {
DebugUtil.log("invoked sub")
return a - b
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">

<TextView
android:id="@+id/main_label"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="104dp"
android:layout_marginTop="28dp"
android:text="SERIALIZATION TEST"
android:textSize="20sp"
android:textStyle="bold"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />

<EditText
android:id="@+id/encoded_text"
android:layout_width="373dp"
android:layout_height="411dp"
android:layout_marginStart="16dp"
android:layout_marginTop="16dp"
android:editable="false"
android:ems="10"
android:gravity="start|top"
android:inputType="textMultiLine"
android:textAlignment="viewStart"
android:textSize="12sp"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@+id/main_label" />

</androidx.constraintlayout.widget.ConstraintLayout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<color name="purple_200">#FFBB86FC</color>
<color name="purple_500">#FF6200EE</color>
<color name="purple_700">#FF3700B3</color>
<color name="teal_200">#FF03DAC5</color>
<color name="teal_700">#FF018786</color>
<color name="black">#FF000000</color>
<color name="white">#FFFFFFFF</color>
</resources>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<resources>
<string name="app_name">Android Test</string>
</resources>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<resources>

<style name="Theme.App" parent="android:Theme.Material.Light.DarkActionBar" />
</resources>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package kotlinx.kover.test.android

import org.junit.Test

import org.junit.Assert.*


class LocalTests {
@Test
fun testDebugUtils() {
assertEquals(3, Maths.sum(1, 2))
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
plugins {
id("com.android.application") version "7.4.0" apply false
id("com.android.library") version "7.4.0" apply false
id("org.jetbrains.kotlin.android") version "1.8.20" apply false
id("org.jetbrains.kotlinx.kover") version "0.7.2" apply false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Project-wide Gradle settings.
# IDE (e.g. Android Studio) users:
# Gradle settings configured through the IDE *will override*
# any settings specified in this file.
# For more details on how to configure your build environment visit
# http://www.gradle.org/docs/current/userguide/build_environment.html
# Specifies the JVM arguments used for the daemon process.
# The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
# When configured, Gradle will run in incubating parallel mode.
# This option should only be used with decoupled projects. More details, visit
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
# org.gradle.parallel=true
# AndroidX package structure to make it clearer which packages are bundled with the
# Android operating system, and which are packaged with your app's APK
# https://developer.android.com/topic/libraries/support-library/androidx-rn
android.useAndroidX=true
# Kotlin code style for this project: "official" or "obsolete":
kotlin.code.style=official
# Enables namespacing of each library's R class so that its R class includes only the
# resources declared in the library itself and none from the library's dependencies,
# thereby reducing the size of the R class for that library
android.nonTransitiveRClass=true
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
pluginManagement {
repositories {
google()
mavenCentral()
gradlePluginPortal()
}
}

dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
gradlePluginPortal()
}
}

rootProject.name = "all-variants-usage"
include(":app")
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
plugins {
id ("com.android.application")
id ("org.jetbrains.kotlin.android")
id ("org.jetbrains.kotlinx.kover")
}

android {
namespace = "kotlinx.kover.test.android"
compileSdk = 32

defaultConfig {
applicationId = "kotlinx.kover.test.android"
minSdk = 21
targetSdk = 31
versionCode = 1
versionName = "1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"

flavorDimensions += "dimension"
productFlavors {
create("first") {
dimension = "dimension"
}
create("second") {
dimension = "dimension"
}
}
}

buildTypes {
release {
isMinifyEnabled = true
}
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
buildFeatures {
viewBinding = true
}
}

dependencies {
implementation("androidx.core:core-ktx:1.8.0")
implementation("androidx.appcompat:appcompat:1.5.0")
implementation("com.google.android.material:material:1.6.1")
implementation("androidx.constraintlayout:constraintlayout:2.1.4")
testImplementation("junit:junit:4.13.2")
}

koverReport {
// filters for all report types of all build variants
filters {
excludes {
classes(
"*Fragment",
"*Fragment\$*",
"*Activity",
"*Activity\$*",
"*.databinding.*",
"*.BuildConfig"
)
}
}

defaults {
/**
* Tests, sources, classes, and compilation tasks of all build variants will be included in the default reports.
* Thus, information from all variants will be included in the default report for this project and any project that specifies this project as a dependency.
*/
mergeWith("*release")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package kotlinx.kover.test.android

object DebugAppClass {
fun foo() {
println("LIB DEBUG")
}
}
Loading

0 comments on commit a6d5129

Please sign in to comment.