Merge pull request #233 from yschimke/grant_permission

Add a permission grant sample

MacrobenchmarkSample/app/src/main/AndroidManifest.xml

@@ -18,6 +18,8 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools">
 
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
+
     <application
         android:allowBackup="false"
         android:icon="@mipmap/ic_launcher"

MacrobenchmarkSample/gradle/libs.versions.toml

@@ -1,5 +1,6 @@
 [versions]
 agp = "8.0.0"
+rules = "1.5.0"
 targetSdk = "34"
 minSdk = "21"
 compileSdk = "34"
@@ -26,6 +27,7 @@ tracing = "1.1.0"
 uiAutomator = "2.2.0"
 
 [libraries]
+androidx-rules = { module = "androidx.test:rules", version.ref = "rules" }
 compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
 activity = { group = "androidx.activity", name = "activity-ktx", version.ref = "activity" }
 androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "jUnit" }

MacrobenchmarkSample/macrobenchmark/build.gradle.kts

@@ -63,4 +63,5 @@ dependencies {
     implementation(libs.espresso)
     implementation(libs.ui.automator)
     implementation(libs.kotlin.stdlib)
+    implementation(libs.androidx.rules)
 }

MacrobenchmarkSample/macrobenchmark/src/main/java/com/example/macrobenchmark/LoginBenchmark.kt

@@ -28,6 +28,7 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.uiautomator.By
 import com.example.benchmark.macro.base.util.DEFAULT_ITERATIONS
 import com.example.benchmark.macro.base.util.TARGET_PACKAGE
+import com.example.macrobenchmark.permissions.allowNotifications
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -62,6 +63,16 @@ class LoginBenchmark {
         }
     }
 
+    @Test
+    fun loginInAfterPermissionsGranted() {
+        benchmarkLoginActivity(setupBlock = {
+            allowNotifications()
+
+            startActivityAndWait(Intent("$packageName.LOGIN_ACTIVITY"))
+            login()
+        })
+    }
+
     private fun MacrobenchmarkScope.login() {
         device.findObject(By.res("userName")).text = "user"
         device.findObject(By.res("password")).text = "password"
@@ -90,5 +101,4 @@ class LoginBenchmark {
             measureBlock()
         }
     }
-
 }

MacrobenchmarkSample/macrobenchmark/src/main/java/com/example/macrobenchmark/permissions/Permissions.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.macrobenchmark.permissions
+
+import android.Manifest.permission
+import android.os.Build.VERSION.SDK_INT
+import android.os.Build.VERSION_CODES.TIRAMISU
+import androidx.benchmark.macro.MacrobenchmarkScope
+import org.junit.Assert
+
+/**
+ * Because the app under test runs in a different process from the one running the instrumentation test,
+ * the permission has to be granted manually by either:
+ *
+ * - tapping the Allow button
+ *    ```kotlin
+ *    val obj = By.text("Allow")
+ *    val dialog = device.wait(Until.findObject(obj), TIMEOUT)
+ *    dialog?.let {
+ *        it.click()
+ *        device.wait(Until.gone(obj), 5_000)
+ *    }
+ *    ```
+ * - or (preferred) executing the grant command on the target package.
+ */
+fun MacrobenchmarkScope.allowNotifications() {
+    if (SDK_INT >= TIRAMISU) {
+        val command = "pm grant $packageName ${permission.POST_NOTIFICATIONS}"
+        val output = device.executeShellCommand(command)
+        Assert.assertEquals("", output)
+    }
+}