Replace permission rule with custom rule to skip tests on missing permissions

Author: rfc2822

lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsStyleProvidersTaskTest.kt

@@ -7,17 +7,13 @@
 package at.bitfire.ical4android
 
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.test.rule.GrantPermissionRule
+import at.bitfire.synctools.GrantPermissionOrSkipRule
 import org.junit.After
 import org.junit.Assert.assertNotNull
-import org.junit.Assume
 import org.junit.Before
 import org.junit.Rule
-import org.junit.rules.TestRule
-import org.junit.runner.Description
 import org.junit.runner.RunWith
 import org.junit.runners.Parameterized
-import org.junit.runners.model.Statement
 import java.util.logging.Logger
 
 @RunWith(Parameterized::class)
@@ -33,21 +29,7 @@ abstract class DmfsStyleProvidersTaskTest(
     }
 
     @get:Rule
-    val permissionRule: TestRule = object : TestRule {
-        val rule = GrantPermissionRule.grant(*providerName.permissions)
-
-        override fun apply(base: Statement, description: Description) =
-            object: Statement() {
-                override fun evaluate() {
-                    val innerStatement = rule.apply(base, description)
-                    try {
-                        innerStatement.evaluate()
-                    } catch (e: SecurityException) {
-                        Assume.assumeNoException(e)
-                    }
-                }
-            }
-    }
+    val permissionRule = GrantPermissionOrSkipRule(providerName.permissions.toSet())
 
     var providerOrNull: TaskProvider? = null
     lateinit var provider: TaskProvider

lib/src/androidTest/kotlin/at/bitfire/ical4android/JtxCollectionTest.kt

@@ -10,9 +10,9 @@ import android.accounts.Account
 import android.content.ContentProviderClient
 import android.content.ContentValues
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.test.rule.GrantPermissionRule
 import at.bitfire.ical4android.impl.TestJtxCollection
 import at.bitfire.ical4android.util.MiscUtils.closeCompat
+import at.bitfire.synctools.GrantPermissionOrSkipRule
 import at.techbee.jtx.JtxContract
 import at.techbee.jtx.JtxContract.asSyncAdapter
 import junit.framework.TestCase.assertEquals
@@ -37,7 +37,7 @@ class JtxCollectionTest {
 
         @JvmField
         @ClassRule
-        val permissionRule = GrantPermissionRule.grant(*TaskProvider.PERMISSIONS_JTX)
+        val permissionRule = GrantPermissionOrSkipRule(TaskProvider.PERMISSIONS_JTX.toSet())
 
         @BeforeClass
         @JvmStatic

lib/src/androidTest/kotlin/at/bitfire/ical4android/JtxICalObjectTest.kt

@@ -15,17 +15,27 @@ import android.database.DatabaseUtils
 import android.os.ParcelFileDescriptor
 import androidx.core.content.pm.PackageInfoCompat
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.test.rule.GrantPermissionRule
 import at.bitfire.ical4android.impl.TestJtxCollection
 import at.bitfire.ical4android.util.MiscUtils.closeCompat
+import at.bitfire.synctools.GrantPermissionOrSkipRule
 import at.techbee.jtx.JtxContract
 import at.techbee.jtx.JtxContract.JtxICalObject
 import at.techbee.jtx.JtxContract.JtxICalObject.Component
 import at.techbee.jtx.JtxContract.asSyncAdapter
-import junit.framework.TestCase.*
+import junit.framework.TestCase.assertEquals
+import junit.framework.TestCase.assertNotNull
+import junit.framework.TestCase.assertNull
+import junit.framework.TestCase.assertTrue
 import net.fortuna.ical4j.model.Calendar
 import net.fortuna.ical4j.model.Property
-import org.junit.*
+import org.junit.After
+import org.junit.AfterClass
+import org.junit.Assert
+import org.junit.Assume
+import org.junit.Before
+import org.junit.BeforeClass
+import org.junit.ClassRule
+import org.junit.Test
 import java.io.ByteArrayOutputStream
 import java.io.InputStreamReader
 
@@ -40,7 +50,7 @@ class JtxICalObjectTest {
 
         @JvmField
         @ClassRule
-        val permissionRule: GrantPermissionRule = GrantPermissionRule.grant(*TaskProvider.PERMISSIONS_JTX)
+        val permissionRule = GrantPermissionOrSkipRule(TaskProvider.PERMISSIONS_JTX.toSet())
 
         @BeforeClass
         @JvmStatic

lib/src/androidTest/kotlin/at/bitfire/synctools/GrantPermissionOrSkipRule.kt

@@ -0,0 +1,36 @@
+/*
+ * This file is part of ical4android which is released under GPLv3.
+ * Copyright © All Contributors. See the LICENSE and AUTHOR files in the root directory for details.
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package at.bitfire.synctools
+
+import androidx.test.rule.GrantPermissionRule
+import org.junit.Assume
+import org.junit.rules.TestRule
+import org.junit.runner.Description
+import org.junit.runners.model.Statement
+
+/**
+ * Requests the given permissions for testing. If the permissions are not available/granted,
+ * the tests are skipped.
+ *
+ * @param permissions   requested permissions
+ */
+class GrantPermissionOrSkipRule(permissions: Set<String>): TestRule {
+
+    val grantRule: TestRule = GrantPermissionRule.grant(*permissions.toTypedArray())
+
+    override fun apply(base: Statement, description: Description) =
+        object: Statement() {
+            override fun evaluate() {
+                val innerStatement = grantRule.apply(base, description)
+                try {
+                    innerStatement.evaluate()
+                } catch (e: SecurityException) {
+                    Assume.assumeNoException(e)
+                }
+            }
+        }
+}