1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright (C) 2020 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
*
* http://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.
*/
@file:JvmName("TestPermissionUtil")
package com.android.testutils
import androidx.test.platform.app.InstrumentationRegistry
import com.android.modules.utils.build.SdkLevel
import com.android.testutils.FunctionalUtils.ThrowingRunnable
import com.android.testutils.FunctionalUtils.ThrowingSupplier
/**
* Run the specified [task] with the specified [permissions] obtained through shell
* permission identity.
*
* Passing in an empty list of permissions can grant all shell permissions, but this is
* discouraged as it also causes the process to temporarily lose non-shell permissions.
*/
fun <T> runAsShell(vararg permissions: String, task: () -> T): T {
val autom = InstrumentationRegistry.getInstrumentation().uiAutomation
// Calls to adoptShellPermissionIdentity do not nest, and dropShellPermissionIdentity drops all
// permissions. Thus, nesting calls will almost certainly cause test bugs, On S+, where we can
// detect this, refuse to do it.
//
// TODO: when R is deprecated, we could try to make this work instead.
// - Get the list of previously-adopted permissions.
// - Adopt the union of the previously-adopted and newly-requested permissions.
// - Run the task.
// - Adopt the previously-adopted permissions, dropping the ones just adopted.
//
// This would allow tests (and utility classes, such as the TestCarrierConfigReceiver attempted
// in aosp/2106007) to call runAsShell even within a test that has already adopted permissions.
if (SdkLevel.isAtLeastS() && !autom.getAdoptedShellPermissions().isNullOrEmpty()) {
throw IllegalStateException("adoptShellPermissionIdentity calls must not be nested")
}
autom.adoptShellPermissionIdentity(*permissions)
try {
return task()
} finally {
autom.dropShellPermissionIdentity()
}
}
/**
* Convenience overload of [runAsShell] that uses a [ThrowingSupplier] for Java callers, when
* only one/two/three permissions are needed.
*/
@JvmOverloads
fun <T> runAsShell(
perm1: String,
perm2: String = "",
perm3: String = "",
supplier: ThrowingSupplier<T>
): T = runAsShell(*getNonEmptyVarargs(perm1, perm2, perm3)) { supplier.get() }
/**
* Convenience overload of [runAsShell] that uses a [ThrowingRunnable] for Java callers, when
* only one/two/three permissions are needed.
*/
@JvmOverloads
fun runAsShell(
perm1: String,
perm2: String = "",
perm3: String = "",
runnable: ThrowingRunnable
): Unit = runAsShell(*getNonEmptyVarargs(perm1, perm2, perm3)) { runnable.run() }
/**
* Get an array containing the first consecutive non-empty arguments out of three arguments.
*
* The first argument is assumed to be non-empty.
*/
private fun getNonEmptyVarargs(arg1: String, arg2: String, arg3: String): Array<String> {
return when {
arg2 == "" -> arrayOf(arg1)
arg3 == "" -> arrayOf(arg1, arg2)
else -> arrayOf(arg1, arg2, arg3)
}
}
|
