Instrumentation

REPORT_KEY_IDENTIFIER

public static final String REPORT_KEY_IDENTIFIER

If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies the class that is writing the report. This can be used to provide more structured logging or reporting capabilities in the IInstrumentationWatcher.

Constant Value: "id"

REPORT_KEY_STREAMRESULT

public static final String REPORT_KEY_STREAMRESULT

If included in the status or final bundle sent to an IInstrumentationWatcher, this key identifies a string which can simply be printed to the output stream. Using these streams provides a "pretty printer" version of the status & final packets. Any bundles including this key should also include the complete set of raw key/value pairs, so that the instrumentation can also be launched, and results collected, by an automated system.

Constant Value: "stream"

Instrumentation

public Instrumentation ()

acquireLooperManager

public TestLooperManager acquireLooperManager (Looper looper)

Takes control of the execution of messages on the specified looper until TestLooperManager.release is called.

addMonitor

public Instrumentation.ActivityMonitor addMonitor (String cls, 
                Instrumentation.ActivityResult result, 
                boolean block)

A convenience wrapper for addMonitor(android.app.Instrumentation.ActivityMonitor) that creates a class matching ActivityMonitor for you and returns it.

addMonitor

public Instrumentation.ActivityMonitor addMonitor (IntentFilter filter, 
                Instrumentation.ActivityResult result, 
                boolean block)

A convenience wrapper for addMonitor(android.app.Instrumentation.ActivityMonitor) that creates an intent filter matching ActivityMonitor for you and returns it.

addMonitor

public void addMonitor (Instrumentation.ActivityMonitor monitor)

Add a new ActivityMonitor that will be checked whenever an activity is started. The monitor is added after any existing ones; the monitor will be hit only if none of the existing monitors can themselves handle the Intent.

addResults

public void addResults (Bundle results)

Report some results in the middle of instrumentation execution. Later results (including those provided by finish(int, Bundle)) will be combined with Bundle.putAll.

callActivityOnCreate

public void callActivityOnCreate (Activity activity, 
                Bundle icicle)

Perform calling of an activity's Activity.onCreate method. The default implementation simply calls through to that method.

callActivityOnCreate

public void callActivityOnCreate (Activity activity, 
                Bundle icicle, 
                PersistableBundle persistentState)

Perform calling of an activity's Activity.onCreate method. The default implementation simply calls through to that method.

callActivityOnDestroy

public void callActivityOnDestroy (Activity activity)

callActivityOnNewIntent

public void callActivityOnNewIntent (Activity activity, 
                Intent intent, 
                ComponentCaller caller)

Same as callActivityOnNewIntent(android.app.Activity, android.content.Intent), but with an extra parameter for the ComponentCaller instance associated with the app that sent the intent.

callActivityOnNewIntent

public void callActivityOnNewIntent (Activity activity, 
                Intent intent)

Perform calling of an activity's Activity.onNewIntent method. The default implementation simply calls through to that method.

callActivityOnPause

public void callActivityOnPause (Activity activity)

Perform calling of an activity's Activity.onPause method. The default implementation simply calls through to that method.

callActivityOnPictureInPictureRequested

public void callActivityOnPictureInPictureRequested (Activity activity)

Perform calling of an activity's Activity.onPictureInPictureRequested method. The default implementation simply calls through to that method.

callActivityOnPostCreate

public void callActivityOnPostCreate (Activity activity, 
                Bundle savedInstanceState, 
                PersistableBundle persistentState)

Perform calling of an activity's Activity.onPostCreate method. The default implementation simply calls through to that method.

callActivityOnPostCreate

public void callActivityOnPostCreate (Activity activity, 
                Bundle savedInstanceState)

Perform calling of an activity's Activity.onPostCreate method. The default implementation simply calls through to that method.

callActivityOnRestart

public void callActivityOnRestart (Activity activity)

Perform calling of an activity's Activity.onRestart method. The default implementation simply calls through to that method.

callActivityOnRestoreInstanceState

public void callActivityOnRestoreInstanceState (Activity activity, 
                Bundle savedInstanceState)

Perform calling of an activity's Activity.onRestoreInstanceState method. The default implementation simply calls through to that method.

callActivityOnRestoreInstanceState

public void callActivityOnRestoreInstanceState (Activity activity, 
                Bundle savedInstanceState, 
                PersistableBundle persistentState)

Perform calling of an activity's Activity.onRestoreInstanceState method. The default implementation simply calls through to that method.

callActivityOnResume

public void callActivityOnResume (Activity activity)

Perform calling of an activity's Activity.onResume method. The default implementation simply calls through to that method.

callActivityOnSaveInstanceState

public void callActivityOnSaveInstanceState (Activity activity, 
                Bundle outState, 
                PersistableBundle outPersistentState)

Perform calling of an activity's Activity.onSaveInstanceState method. The default implementation simply calls through to that method.

callActivityOnSaveInstanceState

public void callActivityOnSaveInstanceState (Activity activity, 
                Bundle outState)

Perform calling of an activity's Activity.onSaveInstanceState method. The default implementation simply calls through to that method.

callActivityOnStart

public void callActivityOnStart (Activity activity)

Perform calling of an activity's Activity.onStart method. The default implementation simply calls through to that method.

callActivityOnStop

public void callActivityOnStop (Activity activity)

Perform calling of an activity's Activity.onStop method. The default implementation simply calls through to that method.

callActivityOnUserLeaving

public void callActivityOnUserLeaving (Activity activity)

Perform calling of an activity's Activity.onUserLeaveHint method. The default implementation simply calls through to that method.

callApplicationOnCreate

public void callApplicationOnCreate (Application app)

Perform calling of the application's Application.onCreate method. The default implementation simply calls through to that method.

Note: This method will be called immediately after onCreate(android.os.Bundle). Often instrumentation tests start their test thread in onCreate(); you need to be careful of races between these. (Well between it and everything else, but let's start here.)

checkMonitorHit

public boolean checkMonitorHit (Instrumentation.ActivityMonitor monitor, 
                int minHits)

Test whether an existing ActivityMonitor has been hit. If the monitor has been hit at least minHits times, then it will be removed from the activity monitor list and true returned. Otherwise it is left as-is and false is returned.

endPerformanceSnapshot

public void endPerformanceSnapshot ()

finish

public void finish (int resultCode, 
                Bundle results)

Terminate instrumentation of the application. This will cause the application process to exit, removing this instrumentation from the next time the application is started. If multiple processes are currently running for this instrumentation, all of those processes will be killed.

getAllocCounts

public Bundle getAllocCounts ()

Returns a bundle with the current results from the allocation counting.

getBinderCounts

public Bundle getBinderCounts ()

Returns a bundle with the counts for various binder counts for this process. Currently the only two that are reported are the number of send and the number of received transactions.

getComponentName

public ComponentName getComponentName ()

Returns complete component name of this instrumentation.

getContext

public Context getContext ()

Return the Context of this instrumentation's package. Note that this is often different than the Context of the application being instrumentated, since the instrumentation code often lives is a different package than that of the application it is running against. See getTargetContext() to retrieve a Context for the target application.

getProcessName

public String getProcessName ()

Return the name of the process this instrumentation is running in. Note this should only be used for testing and debugging. If you are thinking about using this to, for example, conditionalize what is initialized in an Application class, it is strongly recommended to instead use lazy initialization (such as a getter for the state that only creates it when requested). This can greatly reduce the work your process does when created for secondary things, such as to receive a broadcast.

getTargetContext

public Context getTargetContext ()

Return a Context for the target application being instrumented. Note that this is often different than the Context of the instrumentation code, since the instrumentation code often lives is a different package than that of the application it is running against. See getContext() to retrieve a Context for the instrumentation code.

getUiAutomation

public UiAutomation getUiAutomation (int flags)

Gets the UiAutomation instance with flags set.

Note: The APIs exposed via the returned UiAutomation work across application boundaries while the APIs exposed by the instrumentation do not. For example, Instrumentation.sendPointerSync(MotionEvent) will not allow you to inject the event in an app different from the instrumentation target, while UiAutomation.injectInputEvent(android.view.InputEvent, boolean) will work regardless of the current application.

A typical test case should be using either the UiAutomation or Instrumentation APIs. Using both APIs at the same time is not a mistake by itself but a client has to be aware of the APIs limitations.

If a UiAutomation exists with different flags, the flags on that instance will be changed, and then it will be returned.

Compatibility mode: This method is infallible for apps targeted for Build.VERSION_CODES.R and earlier versions; for apps targeted for later versions, it will return null if UiAutomation fails to connect. The caller can check the return value and retry on error.

getUiAutomation

public UiAutomation getUiAutomation ()

Gets the UiAutomation instance with no flags set.

Note: The APIs exposed via the returned UiAutomation work across application boundaries while the APIs exposed by the instrumentation do not. For example, Instrumentation.sendPointerSync(MotionEvent) will not allow you to inject the event in an app different from the instrumentation target, while UiAutomation.injectInputEvent(android.view.InputEvent, boolean) will work regardless of the current application.

A typical test case should be using either the UiAutomation or Instrumentation APIs. Using both APIs at the same time is not a mistake by itself but a client has to be aware of the APIs limitations.

Equivalent to getUiAutomation(0). If a UiAutomation exists with different flags, the flags on that instance will be changed, and then it will be returned.

Compatibility mode: This method is infallible for apps targeted for Build.VERSION_CODES.R and earlier versions; for apps targeted for later versions, it will return null if UiAutomation fails to connect. The caller can check the return value and retry on error.

invokeContextMenuAction

public boolean invokeContextMenuAction (Activity targetActivity, 
                int id, 
                int flag)

Show the context menu for the currently focused view and executes a particular context menu item.

invokeMenuActionSync

public boolean invokeMenuActionSync (Activity targetActivity, 
                int id, 
                int flag)

Execute a particular menu item.

isProfiling

public boolean isProfiling ()

Check whether this instrumentation was started with profiling enabled.

newActivity

public Activity newActivity (Class<?> clazz, 
                Context context, 
                IBinder token, 
                Application application, 
                Intent intent, 
                ActivityInfo info, 
                CharSequence title, 
                Activity parent, 
                String id, 
                Object lastNonConfigurationInstance)

Perform instantiation of an Activity object. This method is intended for use with unit tests, such as android.test.ActivityUnitTestCase. The activity will be useable locally but will be missing some of the linkages necessary for use within the system.

newActivity

public Activity newActivity (ClassLoader cl, 
                String className, 
                Intent intent)

Perform instantiation of the process's Activity object. The default implementation provides the normal system behavior.

newApplication

public Application newApplication (ClassLoader cl, 
                String className, 
                Context context)

Perform instantiation of the process's Application object. The default implementation provides the normal system behavior.

newApplication

public static Application newApplication (Class<?> clazz, 
                Context context)

Perform instantiation of the process's Application object. The default implementation provides the normal system behavior.

onCreate

public void onCreate (Bundle arguments)

Called when the instrumentation is starting, before any application code has been loaded. Usually this will be implemented to simply call start() to begin the instrumentation thread, which will then continue execution in onStart().

If you do not need your own thread -- that is you are writing your instrumentation to be completely asynchronous (returning to the event loop so that the application can run), you can simply begin your instrumentation here, for example call Context.startActivity to begin the appropriate first activity of the application.

onDestroy

public void onDestroy ()

Called when the instrumented application is stopping, after all of the normal application cleanup has occurred.

onException

public boolean onException (Object obj, 
                Throwable e)

This is called whenever the system captures an unhandled exception that was thrown by the application. The default implementation simply returns false, allowing normal system handling of the exception to take place.

onStart

public void onStart ()

Method where the instrumentation thread enters execution. This allows you to run your instrumentation code in a separate thread than the application, so that it can perform blocking operation such as sendKeySync(KeyEvent) or startActivitySync(Intent).

You will typically want to call finish() when this function is done, to end your instrumentation.

removeMonitor

public void removeMonitor (Instrumentation.ActivityMonitor monitor)

Remove an ActivityMonitor that was previously added with addMonitor(ActivityMonitor).

resetInTouchMode

public void resetInTouchMode ()

Resets the touch mode to the device default.

runOnMainSync

public void runOnMainSync (Runnable runner)

Execute a call on the application's main thread, blocking until it is complete. Useful for doing things that are not thread-safe, such as looking at or modifying the view hierarchy.

sendCharacterSync

public void sendCharacterSync (int keyCode)

Sends up and down key events with the given key code to the currently focused window, and waits for it to be processed.

Equivalent to sendKeyDownUpSync(int).

sendKeyDownUpSync

public void sendKeyDownUpSync (int keyCode)

Sends up and down key events with the given key code to the currently focused window, and waits for it to be processed.

sendKeySync

public void sendKeySync (KeyEvent event)

Sends a key event to the currently focused window, and waits for it to be processed.

This method blocks until the recipient has finished handling the event. Note that the recipient may not have completely finished reacting from the event when this method returns. For example, it may still be in the process of updating its display or UI contents upon reacting to the injected event.

sendPointerSync

public void sendPointerSync (MotionEvent event)

Dispatches a pointer event into a window owned by the instrumented application, and waits for it to be processed.

If the motion event being injected is targeted at a window that is not owned by the instrumented application, the input injection will fail. See getUiAutomation() for injecting events into all windows.

This method blocks until the recipient has finished handling the event. Note that the recipient may not have completely finished reacting from the event when this method returns. For example, it may still be in the process of updating its display or UI contents upon reacting to the injected event.

sendStatus

public void sendStatus (int resultCode, 
                Bundle results)

Provide a status report about the application.

sendStringSync

public void sendStringSync (String text)

Sends the key events that result in the given text being typed into the currently focused window, and waits for it to be processed.

sendTrackballEventSync

public void sendTrackballEventSync (MotionEvent event)

Dispatches a trackball event into the currently focused window, and waits for it to be processed.

This method blocks until the recipient has finished handling the event. Note that the recipient may not have completely finished reacting from the event when this method returns. For example, it may still be in the process of updating its display or UI contents upon reacting to the injected event.

setAutomaticPerformanceSnapshots

public void setAutomaticPerformanceSnapshots ()

setInTouchMode

public void setInTouchMode (boolean inTouch)

Force the global system in or out of touch mode. This can be used if your instrumentation relies on the UI being in one more or the other when it starts.

Note: Starting from Android Build.VERSION_CODES.TIRAMISU, this method will only take effect if the instrumentation was sourced from a process with MODIFY_TOUCH_MODE_STATE internal permission granted (shell already have it).

start

public void start ()

Create and start a new thread in which to run instrumentation. This new thread will call to onStart() where you can implement the instrumentation.

startActivitySync

public Activity startActivitySync (Intent intent, 
                Bundle options)

Start a new activity and wait for it to begin running before returning. In addition to being synchronous, this method as some semantic differences from the standard Context.startActivity call: the activity component is resolved before talking with the activity manager (its class name is specified in the Intent that this method ultimately starts), and it does not allow you to start activities that run in a different process. In addition, if the given Intent resolves to multiple activities, instead of displaying a dialog for the user to select an activity, an exception will be thrown.

The function returns as soon as the activity goes idle following the call to its Activity.onCreate. Generally this means it has gone through the full initialization including Activity.onResume and drawn and displayed its initial window.

startActivitySync

public Activity startActivitySync (Intent intent)

Start a new activity and wait for it to begin running before returning. In addition to being synchronous, this method as some semantic differences from the standard Context.startActivity call: the activity component is resolved before talking with the activity manager (its class name is specified in the Intent that this method ultimately starts), and it does not allow you to start activities that run in a different process. In addition, if the given Intent resolves to multiple activities, instead of displaying a dialog for the user to select an activity, an exception will be thrown.

The function returns as soon as the activity goes idle following the call to its Activity.onCreate. Generally this means it has gone through the full initialization including Activity.onResume and drawn and displayed its initial window.

startAllocCounting

public void startAllocCounting ()

startPerformanceSnapshot

public void startPerformanceSnapshot ()

startProfiling

public void startProfiling ()

This method will start profiling if isProfiling() returns true. You should only call this method if you set the handleProfiling attribute in the manifest file for this Instrumentation to true.

stopAllocCounting

public void stopAllocCounting ()

stopProfiling

public void stopProfiling ()

Stops profiling if isProfiling() returns true.

waitForIdle

public void waitForIdle (Runnable recipient)

Schedule a callback for when the application's main thread goes idle (has no more events to process).

waitForIdleSync

public void waitForIdleSync ()

Synchronously wait for the application to be idle. Can not be called from the main application thread -- use start() to execute instrumentation in its own thread.

waitForMonitor

public Activity waitForMonitor (Instrumentation.ActivityMonitor monitor)

Wait for an existing ActivityMonitor to be hit. Once the monitor has been hit, it is removed from the activity monitor list and the first created Activity object that matched it is returned.

waitForMonitorWithTimeout

public Activity waitForMonitorWithTimeout (Instrumentation.ActivityMonitor monitor, 
                long timeOut)

Wait for an existing ActivityMonitor to be hit till the timeout expires. Once the monitor has been hit, it is removed from the activity monitor list and the first created Activity object that matched it is returned. If the timeout expires, a null object is returned.