MonitoringInstrumentation
class MonitoringInstrumentation : Instrumentation
AndroidJUnitRunner |
An |
AndroidBenchmarkRunner |
Instrumentation runner for benchmarks, used to increase stability of measurements and minimize interference. |
An instrumentation that enables several advanced features and makes some hard guarantees about the state of the application under instrumentation.
A short list of these capabilities:
- Forces Application.onCreate() to happen before Instrumentation.onStart() runs (ensuring your code always runs in a sane state).
- Logs application death due to exceptions.
- Allows tracking of activity lifecycle states.
- Registers instrumentation arguments in an easy to access place.
- Ensures your activities are creating themselves in reasonable amounts of time.
- Provides facilities to dump current app threads to test outputs.
- Ensures all activities finish before instrumentation exits.
Summary
Nested types |
|---|
inner class MonitoringInstrumentation.ActivityFinisher : RunnableLoops through all the activities that have not yet finished and explicitly calls finish on them. |
Public constructors |
|---|
Public functions |
|
|---|---|
Unit |
callActivityOnCreate(activity: Activity!, bundle: Bundle!) |
Unit |
callActivityOnDestroy(activity: Activity!) |
Unit |
callActivityOnPause(activity: Activity!) |
Unit |
callActivityOnRestart(activity: Activity!) |
Unit |
callActivityOnResume(activity: Activity!) |
Unit |
callActivityOnStart(activity: Activity!) |
Unit |
callActivityOnStop(activity: Activity!) |
Unit |
|
Unit |
|
Instrumentation.ActivityResult! |
|
Instrumentation.ActivityResult! |
|
Instrumentation.ActivityResult! |
|
Instrumentation.ActivityResult! |
execStartActivity(This API was added in Android API 23 (M) |
Instrumentation.ActivityResult! |
execStartActivity(This API was added in Android API 17 (JELLY_BEAN_MR1) |
Unit |
Ensures all activities launched in this instrumentation are finished before the instrumentation exits. |
Unit |
interceptActivityUsing(Use the given InterceptingActivityFactory to create Activity instance in |
Activity! |
newActivity(cl: ClassLoader!, className: String!, intent: Intent!) |
Activity! |
newActivity( |
Application! |
newApplication(cl: ClassLoader!, className: String!, context: Context!)Does initialization before creating the application. |
Unit |
Sets up lifecycle monitoring, and argument registry. |
Unit |
|
Boolean |
onException(obj: Any!, e: Throwable!) |
Unit |
onStart()This implementation of onStart() will guarantee that the Application's onCreate method has completed when it returns. |
Unit |
runOnMainSync(runnable: Runnable!)Posts a runnable to the main thread and blocks the caller's thread until the runnable is executed. |
Activity! |
startActivitySync(intent: Intent!) |
Unit |
Use default mechanism of creating activity instance in |
Protected functions |
|
|---|---|
Unit |
dumpThreadStateToOutputs(outputFileName: String!) |
String! |
|
Unit |
|
Unit |
installOldMultiDex(multidexClass: Class<Any!>!)Perform application MultiDex installation only when instrumentation installation is not available. |
Boolean |
Checks whether this instance of instrumentation should be considered as a primary instrumentation process. |
Boolean |
This function is deprecated. use isPrimaryInstrProcess() |
Unit |
|
Unit |
setJsBridgeClassName(className: String!) |
Boolean |
|
Unit |
|
Throwable! |
unwrapException(t: Throwable!)Unwraps an exception from certain wrapper types, e.g. RuntimeException. |
Unit |
Ensures we've onStopped() all activities which were onStarted(). |
Inherited Constants |
||||
|---|---|---|---|---|
|
Public constructors
Public functions
execStartActivities
fun execStartActivities(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: Activity!,
intents: Array<Intent!>!,
options: Bundle!
): Unit
execStartActivity
fun execStartActivity(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: Activity!,
intent: Intent!,
requestCode: Int
): Instrumentation.ActivityResult!
execStartActivity
fun execStartActivity(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: Activity!,
intent: Intent!,
requestCode: Int,
options: Bundle!
): Instrumentation.ActivityResult!
execStartActivity
fun execStartActivity(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: Fragment!,
intent: Intent!,
requestCode: Int,
options: Bundle!
): Instrumentation.ActivityResult!
execStartActivity
fun execStartActivity(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: String!,
intent: Intent!,
requestCode: Int,
options: Bundle!
): Instrumentation.ActivityResult!
This API was added in Android API 23 (M)
execStartActivity
fun execStartActivity(
who: Context!,
contextThread: IBinder!,
token: IBinder!,
target: Activity!,
intent: Intent!,
requestCode: Int,
options: Bundle!,
user: UserHandle!
): Instrumentation.ActivityResult!
This API was added in Android API 17 (JELLY_BEAN_MR1)
finish
fun finish(resultCode: Int, results: Bundle!): Unit
Ensures all activities launched in this instrumentation are finished before the instrumentation exits.
Subclasses who override this method should do their finish processing and then call super.finish to invoke this logic. Not waiting for all activities to finish() before exiting can cause device wide instability.
interceptActivityUsing
fun interceptActivityUsing(
interceptingActivityFactory: InterceptingActivityFactory!
): Unit
Use the given InterceptingActivityFactory to create Activity instance in newActivity. This can be used to override default behavior of activity in tests e.g. mocking startService() method in Activity under test, to avoid starting the real service and instead verifying that a particular service was started.
| Parameters | |
|---|---|
interceptingActivityFactory: InterceptingActivityFactory! |
InterceptingActivityFactory to be used for creating activity instance in |
newActivity
fun newActivity(
clazz: Class<Any!>!,
context: Context!,
token: IBinder!,
application: Application!,
intent: Intent!,
info: ActivityInfo!,
title: CharSequence!,
parent: Activity!,
id: String!,
lastNonConfigurationInstance: Any!
): Activity!
newApplication
fun newApplication(cl: ClassLoader!, className: String!, context: Context!): Application!
Does initialization before creating the application.
Note, newApplication is called before onCreate on API >15. For API <= 15, onCreate is called first.
onCreate
fun onCreate(arguments: Bundle!): Unit
Sets up lifecycle monitoring, and argument registry.
Subclasses must call up to onCreate(). This onCreate method does not call start() it is the subclasses responsibility to call start if it desires.
onStart
fun onStart(): Unit
This implementation of onStart() will guarantee that the Application's onCreate method has completed when it returns.
Subclasses should call super.onStart() before executing any code that touches the application and it's state.
runOnMainSync
fun runOnMainSync(runnable: Runnable!): Unit
Posts a runnable to the main thread and blocks the caller's thread until the runnable is executed. When a Throwable is thrown in the runnable, the exception is propagated back to the caller's thread. If it is an unchecked throwable, it will be rethrown as is. If it is a checked exception, it will be rethrown as a RuntimeException.
| Parameters | |
|---|---|
runnable: Runnable! |
a runnable to be executed on the main thread |
useDefaultInterceptingActivityFactory
fun useDefaultInterceptingActivityFactory(): Unit
Use default mechanism of creating activity instance in newActivity
Protected functions
installOldMultiDex
protected fun installOldMultiDex(multidexClass: Class<Any!>!): Unit
Perform application MultiDex installation only when instrumentation installation is not available. Called when MultiDex class is available but MultiDex.installInstrumentation is not.
isPrimaryInstrProcess
protected fun isPrimaryInstrProcess(): Boolean
Checks whether this instance of instrumentation should be considered as a primary instrumentation process.
Prior to API 26, instrumentation could only run in a single process and that would be the primary process. Post API 26, the primary process is the first process listed in android:targetProcesses or the default process of the targetPackage.
| Returns | |
|---|---|
Boolean |
|
isPrimaryInstrProcess
protected funisPrimaryInstrProcess(argsProcessName: String?): Boolean
Checks whether this instance of instrumentation should be considered as a primary instrumentation process.
Prior to API 26, instrumentation could only run in a single process and that would be the primary process. Post API 26, the primary process is the first process listed in android:targetProcesses or the default process of the targetPackage.
| Parameters | |
|---|---|
argsProcessName: String? |
unused. |
| Returns | |
|---|---|
Boolean |
|
unwrapException
protected fun unwrapException(t: Throwable!): Throwable!
Unwraps an exception from certain wrapper types, e.g. RuntimeException.
We consider two exceptions the same if they are caused by the same root cause. For example, when an exception occurs on the main thread, the #onException method is first called to handle it, and the exception is wrapped with RuntimeException and re-thrown, which is then caught by the uncaught exception handler. In this case, the exception should only be handled once.
| Returns | |
|---|---|
Throwable! |
the root cause of the given exception |
waitForActivitiesToComplete
protected fun waitForActivitiesToComplete(): Unit
Ensures we've onStopped() all activities which were onStarted().
According to Activity's contract, the process is not killable between onStart and onStop. Breaking this contract (which finish() will if you let it) can cause bad behaviour (including a full restart of system_server).
We give the app 2 seconds to stop all its activities, then we proceed.
This should never be run on the main thread.