Split unified benchmark module to individual library benchmark modules (

#2139)

* Split benchmark module to individual benchmarks in particular library modules

* Removed benchmark module

* Updated kokoro script to run benchmarks

* spotless apply

* Review comment changes

engine/benchmark/.gitignore

@@ -0,0 +1 @@
+/build

engine/benchmark/README.md

@@ -0,0 +1,34 @@
+# Android FHIR SDK Engine Benchmark module
+
+Contains test cases that evaluate the performance of individual tasks executed for the first time directly on hardware. 
+
+The test cases are designed to run in sequence of their alphabetic order to make sure larger tasks do not build cache for smaller ones. Their class names are prefixed by an extra letter to inform their position relative to others in the list.
+
+# How to run the benchmark
+
+In Android Studio, set your build variants to `release` and run your benchmark as you would any `@Test` using the gutter action next to your test class or method.
+
+![gutter test action](https://developer.android.com/static/topic/performance/images/benchmark_images/microbenchmark_run.png)
+
+The results will be similar to this:
+```
+1,297,374 ns 5345 allocs trace EngineDatabaseBenchmark.createAndGet
+1,114,474,793 ns 4922289 allocs trace FhirSyncWorkerBenchmark.oneTimeSync_50patients
+15,251,125 ns 100542 allocs trace FhirSyncWorkerBenchmark.oneTimeSync_1patient
+179,806,709 ns 986017 allocs trace FhirSyncWorkerBenchmark.oneTimeSync_10patients
+1,451,758 ns 11883 allocs trace GzipUploadInterceptorBenchmark.upload_10patientsWithGzip
+1,537,559 ns 11829 allocs trace GzipUploadInterceptorBenchmark.upload_10patientsWithoutGzip
+73,640,833 ns 1074360 allocs trace GzipUploadInterceptorBenchmark.upload_1000patientsWithGzip
+7,493,642 ns 108428 allocs trace GzipUploadInterceptorBenchmark.upload_100patientsWithoutGzip
+7,799,264 ns 108465 allocs trace GzipUploadInterceptorBenchmark.upload_100patientsWithGzip
+71,189,333 ns 1074466 allocs trace GzipUploadInterceptorBenchmark.upload_1000patientsWithoutGzip
+
+```
+
+Alternatively, from the command line, run the connectedCheck to run all of the tests from specified Gradle module:
+
+```bash
+./gradlew :engine:benchmark:connectedReleaseAndroidTest
+```
+
+In this case, results will be saved to the `outputs/androidTest-results/connected/<device>/test-result.pb`. To visualize on Android Studio, click Run / Import Tests From File and find the `.pb` file

benchmark/proguard-rules.pro → engine/benchmark/benchmark-proguard-rules.pro

@@ -19,3 +19,19 @@
 # If you keep the line number information, uncomment this to
 # hide the original source file name.
 #-renamesourcefileattribute SourceFile
+
+-dontobfuscate
+
+-ignorewarnings
+
+-keepattributes *Annotation*
+
+-dontnote junit.framework.**
+-dontnote junit.runner.**
+
+-dontwarn androidx.test.**
+-dontwarn org.junit.**
+-dontwarn org.hamcrest.**
+-dontwarn com.squareup.javawriter.JavaWriter
+
+-keepclasseswithmembers @org.junit.runner.RunWith public class *

engine/benchmark/build.gradle.kts

@@ -0,0 +1,80 @@
+import Dependencies.forceHapiVersion
+import Dependencies.forceJacksonVersion
+import Dependencies.removeIncompatibleDependencies
+
+plugins {
+ id(Plugins.BuildPlugins.androidLib)
+ id(Plugins.BuildPlugins.kotlinAndroid)
+ id(Plugins.BuildPlugins.benchmark)
+}
+
+android {
+ namespace = "com.google.android.fhir.benchmark"
+ compileSdk = Sdk.compileSdk
+ defaultConfig {
+ minSdk = Sdk.minSdk
+ testInstrumentationRunner = Dependencies.androidBenchmarkRunner
+ }
+
+ testBuildType = "release"
+ buildTypes { release {} }
+ packaging {
+ resources.excludes.addAll(
+ listOf(
+ "license.html",
+ "META-INF/ASL2.0",
+ "META-INF/ASL-2.0.txt",
+ "META-INF/DEPENDENCIES",
+ "META-INF/LGPL-3.0.txt",
+ "META-INF/LICENSE",
+ "META-INF/LICENSE.txt",
+ "META-INF/license.txt",
+ "META-INF/license.html",
+ "META-INF/LICENSE.md",
+ "META-INF/NOTICE",
+ "META-INF/NOTICE.txt",
+ "META-INF/NOTICE.md",
+ "META-INF/notice.txt",
+ "META-INF/LGPL-3.0.txt",
+ "META-INF/sun-jaxb.episode",
+ "META-INF/*.kotlin_module",
+ "readme.html",
+ )
+ )
+ }
+ kotlin { jvmToolchain(11) }
+ compileOptions {
+ sourceCompatibility = javaVersion
+ targetCompatibility = javaVersion
+ }
+}
+
+afterEvaluate { configureFirebaseTestLabForMicroBenchmark() }
+
+configurations {
+ all {
+ removeIncompatibleDependencies()
+ forceHapiVersion()
+ forceJacksonVersion()
+ }
+}
+
+dependencies {
+ androidTestImplementation(Dependencies.AndroidxTest.benchmarkJunit)
+ androidTestImplementation(Dependencies.AndroidxTest.extJunit)
+ androidTestImplementation(Dependencies.AndroidxTest.runner)
+ androidTestImplementation(Dependencies.Cql.engineJackson)
+ androidTestImplementation(Dependencies.Cql.evaluator)
+ androidTestImplementation(Dependencies.Cql.evaluatorBuilder)
+ androidTestImplementation(Dependencies.junit)
+ androidTestImplementation(Dependencies.Kotlin.kotlinCoroutinesAndroid)
+ androidTestImplementation(Dependencies.truth)
+ androidTestImplementation(Dependencies.Androidx.workRuntimeKtx)
+ androidTestImplementation(Dependencies.AndroidxTest.workTestingRuntimeKtx)
+ androidTestImplementation(Dependencies.mockWebServer)
+ androidTestImplementation(Dependencies.Retrofit.coreRetrofit)
+
+ androidTestImplementation(project(":engine"))
+ // for test json files only
+ androidTestImplementation(project(":workflow-testing"))
+}

benchmark/src/androidTest/AndroidManifest.xml → engine/benchmark/src/androidTest/AndroidManifest.xml

@@ -11,10 +11,13 @@
  manifest, as it is not possible to override this flag from Gradle.
  -->
  <application
+ android:debuggable="false"
+ tools:ignore="HardcodedDebugMode"
+ tools:replace="android:debuggable"
  android:usesCleartextTraffic="true"
  android:requestLegacyExternalStorage="true"
  >
-  <profileable android:shell="true" />
+ <profileable android:shell="true" />
  </application>
  <uses-permission android:name="android.permission.INTERNET" />
 </manifest>

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/F_EngineDatabaseBenchmark.kt → engine/benchmark/src/androidTest/java/com/google/android/fhir/benchmark/EngineDatabaseBenchmark.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Google LLC
+ * Copyright 2022-2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ import org.junit.Test
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
-class F_EngineDatabaseBenchmark {
+class EngineDatabaseBenchmark {
 
  @get:Rule val benchmarkRule = BenchmarkRule()
 

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/H_FhirSyncWorkerBenchmark.kt → engine/benchmark/src/androidTest/java/com/google/android/fhir/benchmark/FhirSyncWorkerBenchmark.kt

@@ -71,7 +71,7 @@ import org.junit.Test
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
-class H_FhirSyncWorkerBenchmark {
+class FhirSyncWorkerBenchmark {
 
  @get:Rule val benchmarkRule = BenchmarkRule()
 

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/I_GzipUploadInterceptorBenchmark.kt → engine/benchmark/src/androidTest/java/com/google/android/fhir/benchmark/GzipUploadInterceptorBenchmark.kt

@@ -49,7 +49,7 @@ import retrofit2.http.GET
 import retrofit2.http.POST
 import retrofit2.http.Url
 
-class I_GzipUploadInterceptorBenchmark {
+class GzipUploadInterceptorBenchmark {
 
  @get:Rule val benchmarkRule = BenchmarkRule()
 

engine/benchmark/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<manifest />

kokoro/gcp_ubuntu/kokoro_build.sh

@@ -92,7 +92,7 @@ function build_only() {
 function device_tests() {
  ./gradlew packageDebugAndroidTest --scan --stacktrace
  ./gradlew packageReleaseAndroidTest --scan --stacktrace
- local lib_names=("benchmark" "datacapture" "engine" "knowledge" "workflow")
+ local lib_names=("workflow:benchmark" "engine:benchmark" "datacapture" "engine" "knowledge" "workflow")
  firebase_pids=()
  for lib_name in "${lib_names[@]}"; do
  ./gradlew :$lib_name:runFlank --scan --stacktrace &

settings.gradle.kts

@@ -28,8 +28,6 @@ if (kokoroRun == true) {
  }
 }
 
-include(":benchmark")
-
 include(":catalog")
 
 include(":common")
@@ -47,3 +45,7 @@ include(":knowledge")
 include(":workflow")
 
 include(":workflow-testing")
+
+include(":workflow:benchmark")
+
+include(":engine:benchmark")

workflow/benchmark/.gitignore

@@ -0,0 +1 @@
+/build

benchmark/README.md → workflow/benchmark/README.md

@@ -1,4 +1,4 @@
-# Android FHIR SDK Benchmark module
+# Android FHIR SDK Workflow Benchmark module
 
 Contains test cases that evaluate the performance of individual tasks executed for the first time directly on hardware. 
 
@@ -24,14 +24,13 @@ The results will be similar to this:
 1,238,212,883 ns trace D_FhirJsonParserBenchmark.parseLightFhirBundle
 2,785,964,288 ns trace E_ElmJsonLibraryLoaderBenchmark.parseImmunityCheckCqlFromFhirLibrary
  713,779,915 ns trace E_ElmJsonLibraryLoaderBenchmark.parseFhirHelpersCqlFromFhirLibrary
- 121,204,232 ns trace F_EngineDatabaseBenchmark.createAndGet
-9,833,892,387 ns trace G_CqlEvaluatorBenchmark.evaluatesLibrary
+9,833,892,387 ns trace F_CqlEvaluatorBenchmark.evaluatesLibrary
 ```
 
 Alternatively, from the command line, run the connectedCheck to run all of the tests from specified Gradle module:
 
 ```bash
-./gradlew benchmark:connectedReleaseAndroidTest
+./gradlew workflow:benchmark:connectedReleaseAndroidTest
 ```
 
 In this case, results will be saved to the `outputs/androidTest-results/connected/<device>/test-result.pb`. To visualize on Android Studio, click Run / Import Tests From File and find the `.pb` file

workflow/benchmark/benchmark-proguard-rules.pro

@@ -0,0 +1,37 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+# http:https://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+# public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
+
+-dontobfuscate
+
+-ignorewarnings
+
+-keepattributes *Annotation*
+
+-dontnote junit.framework.**
+-dontnote junit.runner.**
+
+-dontwarn androidx.test.**
+-dontwarn org.junit.**
+-dontwarn org.hamcrest.**
+-dontwarn com.squareup.javawriter.JavaWriter
+
+-keepclasseswithmembers @org.junit.runner.RunWith public class *

benchmark/build.gradle.kts → workflow/benchmark/build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 android {
- namespace = "com.google.android.fhir.benchmark"
+ namespace = "com.google.android.fhir.workflow.benchmark"
  compileSdk = Sdk.compileSdk
  defaultConfig {
  minSdk = Sdk.minSdk
@@ -71,10 +71,7 @@ dependencies {
  androidTestImplementation(Dependencies.truth)
  androidTestImplementation(Dependencies.Androidx.workRuntimeKtx)
  androidTestImplementation(Dependencies.AndroidxTest.workTestingRuntimeKtx)
- androidTestImplementation(Dependencies.mockWebServer)
- androidTestImplementation(Dependencies.Retrofit.coreRetrofit)
-
- androidTestImplementation(project(":engine"))
+ androidTestImplementation(Dependencies.androidFhirEngine) { exclude(module = "truth") }
  androidTestImplementation(project(":knowledge")) {
  exclude(group = Dependencies.androidFhirGroup, module = Dependencies.androidFhirEngineModule)
  }

workflow/benchmark/src/androidTest/AndroidManifest.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<manifest
+ xmlns:android="http:https://schemas.android.com/apk/res/android"
+ xmlns:tools="http:https://schemas.android.com/tools"
+>
+
+ <!--
+ Important: disable debugging for accurate performance results
+
+ In a com.android.library project, this flag must be disabled from this
+ manifest, as it is not possible to override this flag from Gradle.
+ -->
+ <application
+ android:debuggable="false"
+ tools:ignore="HardcodedDebugMode"
+ tools:replace="android:debuggable"
+ android:usesCleartextTraffic="true"
+ android:requestLegacyExternalStorage="true"
+ >
+ <profileable android:shell="true" />
+ </application>
+ <uses-permission android:name="android.permission.INTERNET" />
+</manifest>

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/A_JacksonMapperBenchmark.kt → workflow/benchmark/src/androidTest/java/com/google/android/fhir/workflow/benchmark/A_JacksonMapperBenchmark.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Google LLC
+ * Copyright 2022-2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.google.android.fhir.benchmark
+package com.google.android.fhir.workflow.benchmark
 
 import androidx.benchmark.junit4.BenchmarkRule
 import androidx.benchmark.junit4.measureRepeated

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/B_FhirContextLoaderBenchmark.kt → workflow/benchmark/src/androidTest/java/com/google/android/fhir/workflow/benchmark/B_FhirContextLoaderBenchmark.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Google LLC
+ * Copyright 2022-2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.google.android.fhir.benchmark
+package com.google.android.fhir.workflow.benchmark
 
 import androidx.benchmark.junit4.BenchmarkRule
 import androidx.benchmark.junit4.measureRepeated

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/C_CqlEngineFhirContextLoaderBenchmark.kt → workflow/benchmark/src/androidTest/java/com/google/android/fhir/workflow/benchmark/C_CqlEngineFhirContextLoaderBenchmark.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Google LLC
+ * Copyright 2022-2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.google.android.fhir.benchmark
+package com.google.android.fhir.workflow.benchmark
 
 import androidx.benchmark.junit4.BenchmarkRule
 import androidx.benchmark.junit4.measureRepeated

benchmark/src/androidTest/java/com/google/android/fhir/benchmark/D_FhirJsonParserBenchmark.kt → workflow/benchmark/src/androidTest/java/com/google/android/fhir/workflow/benchmark/D_FhirJsonParserBenchmark.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Google LLC
+ * Copyright 2022-2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.google.android.fhir.benchmark
+package com.google.android.fhir.workflow.benchmark
 
 import androidx.benchmark.junit4.BenchmarkRule
 import androidx.benchmark.junit4.measureRepeated