Added in API level 3
Deprecated in API level 24

ActivityInstrumentationTestCase2

Kotlin |Java

abstract class ActivityInstrumentationTestCase2<T : Activity!> : ActivityTestCase

kotlin.Any
↳	android.test.InstrumentationTestCase
	↳	android.test.ActivityTestCase
		↳	android.test.ActivityInstrumentationTestCase2

This class provides functional testing of a single activity. The activity under test will be created using the system infrastructure (by calling InstrumentationTestCase.launchActivity()) and you will then be able to manipulate your Activity directly.

Other options supported by this test case include:

You can run any test method on the UI thread (see android.test.UiThreadTest).
You can inject custom Intents into your Activity (see setActivityIntent(android.content.Intent)).

This class replaces android.test.ActivityInstrumentationTestCase, which is deprecated. New tests should be written using this base class.

If you prefer an isolated unit test, see android.test.ActivityUnitTestCase.

Summary

Public constructors
`ActivityInstrumentationTestCase2(activityClass: Class<T>!)` Creates an `ActivityInstrumentationTestCase2`.
`ActivityInstrumentationTestCase2(pkg: String!, activityClass: Class<T>!)` Creates an `ActivityInstrumentationTestCase2`.

Public methods
open T	`getActivity()` Get the Activity under test, starting it if necessary.
open Unit	`setActivityInitialTouchMode(initialTouchMode: Boolean)` Call this method before the first call to `getActivity` to set the initial touch mode for the Activity under test.
open Unit	`setActivityIntent(i: Intent!)` Call this method before the first call to `getActivity` to inject a customized Intent into the Activity under test.

Protected methods
open Unit	`runTest()` Runs the current unit test.
open Unit	`setUp()`
open Unit	`tearDown()`

Inherited functions

From class InstrumentationTestCase

`Instrumentation!`	`getInstrumentation()` Inheritors can access the instrumentation using this.
`Unit`	`injectInsrumentation(instrumentation: Instrumentation!)` Injects instrumentation into this test case. This method is called by the test runner during test setup.
`Unit`	`injectInstrumentation(instrumentation: Instrumentation!)` Injects instrumentation into this test case. This method is called by the test runner during test setup.
`T`	`launchActivity(pkg: String!, activityCls: Class<T>!, extras: Bundle!)` Utility method for launching an activity. The `Intent` used to launch the Activity is: action = `Intent.ACTION_MAIN` extras = null, unless a custom bundle is provided here All other fields are null or empty. NOTE: The parameter pkg must refer to the package identifier of the package hosting the activity to be launched, which is specified in the AndroidManifest.xml file. This is not necessarily the same as the java package name.
`T`	`launchActivityWithIntent(pkg: String!, activityCls: Class<T>!, intent: Intent!)` Utility method for launching an activity with a specific Intent. NOTE: The parameter pkg must refer to the package identifier of the package hosting the activity to be launched, which is specified in the AndroidManifest.xml file. This is not necessarily the same as the java package name.
`Unit`	`runTest()` Runs the current unit test. If the unit test is annotated with `android.test.UiThreadTest`, the test is run on the UI thread.
`Unit`	`runTestOnUiThread(r: Runnable!)` Helper for running portions of a test on the UI thread. Note, in most cases it is simpler to annotate the test method with `android.test.UiThreadTest`, which will run the entire test method on the UI thread. Use this method if you need to switch in and out of the UI thread to perform your test.
`Unit`	`sendKeys(vararg keys: Int)` Sends a series of key events through instrumentation and waits for idle. For instance: sendKeys(KEYCODE_DPAD_LEFT, KEYCODE_DPAD_CENTER).
`Unit`	`sendKeys(keysSequence: String!)` Sends a series of key events through instrumentation and waits for idle. The sequence of keys is a string containing the key names as specified in KeyEvent, without the KEYCODE_ prefix. For instance: sendKeys("DPAD_LEFT A B C DPAD_CENTER"). Each key can be repeated by using the N* prefix. For instance, to send two KEYCODE_DPAD_LEFT, use the following: sendKeys("2*DPAD_LEFT").
`Unit`	`sendRepeatedKeys(vararg keys: Int)` Sends a series of key events through instrumentation and waits for idle. Each key code must be preceded by the number of times the key code must be sent. For instance: sendRepeatedKeys(1, KEYCODE_DPAD_CENTER, 2, KEYCODE_DPAD_LEFT).
`Unit`	`tearDown()` Make sure all resources are cleaned up and garbage collected before moving on to the next test. Subclasses that override this method should make sure they call super.tearDown() at the end of the overriding method.

From class ActivityTestCase

Unit

scrubClass(testCaseClass: Class<*>!)

This function is called by various TestCase implementations, at tearDown() time, in order to scrub out any class variables. This protects against memory leaks in the case where a test case creates a non-static inner class (thus referencing the test case) and gives it to someone else to hold onto.

Unit

setActivity(testActivity: Activity!)

Set the activity under test.

Public constructors

ActivityInstrumentationTestCase2

Added in API level 8

ActivityInstrumentationTestCase2(activityClass: Class<T>!)

Creates an ActivityInstrumentationTestCase2.

Parameters
`activityClass`	Class<T>!: The activity to test. This must be a class in the instrumentation targetPackage specified in the AndroidManifest.xml

ActivityInstrumentationTestCase2

Added in API level 3

ActivityInstrumentationTestCase2(
    pkg: String!, 
    activityClass: Class<T>!)

Deprecated: use ActivityInstrumentationTestCase2(java.lang.Class) instead

Creates an ActivityInstrumentationTestCase2.

Parameters
`pkg`	String!: ignored - no longer in use.
`activityClass`	Class<T>!: The activity to test. This must be a class in the instrumentation targetPackage specified in the AndroidManifest.xml

Public methods

getActivity

Added in API level 3

open fun getActivity(): T

Deprecated: Deprecated in Java.

Get the Activity under test, starting it if necessary. For each test method invocation, the Activity will not actually be created until the first time this method is called.

If you wish to provide custom setup values to your Activity, you may call setActivityIntent(android.content.Intent) and/or setActivityInitialTouchMode(boolean) before your first call to getActivity(). Calling them after your Activity has started will have no effect.

NOTE: Activities under test may not be started from within the UI thread. If your test method is annotated with android.test.UiThreadTest, then your Activity will be started automatically just before your test method is run. You still call this method in order to get the Activity under test.

Return
`T`	the Activity under test

setActivityInitialTouchMode

Added in API level 3

open fun setActivityInitialTouchMode(initialTouchMode: Boolean): Unit

Deprecated: Deprecated in Java.

Call this method before the first call to getActivity to set the initial touch mode for the Activity under test.

If you do not call this, the touch mode will be false. If you call this after your Activity has been started, it will have no effect.

NOTE: Activities under test may not be started from within the UI thread. If your test method is annotated with android.test.UiThreadTest, then you must call setActivityInitialTouchMode(boolean) from setUp().

Parameters
`initialTouchMode`	Boolean: true if the Activity should be placed into "touch mode" when started

setActivityIntent

Added in API level 3

open fun setActivityIntent(i: Intent!): Unit

Deprecated: Deprecated in Java.

Call this method before the first call to getActivity to inject a customized Intent into the Activity under test.

If you do not call this, the default intent will be provided. If you call this after your Activity has been started, it will have no effect.

The default Intent (if this method is not called) is: action = Intent.ACTION_MAIN flags = Intent.FLAG_ACTIVITY_NEW_TASK All other fields are null or empty.

Parameters
`i`	Intent!: The Intent to start the Activity with, or null to reset to the default Intent.

Protected methods

runTest

Added in API level 3

protected open fun runTest(): Unit

Deprecated: Deprecated in Java.

Runs the current unit test. If the unit test is annotated with android.test.UiThreadTest, force the Activity to be created before switching to the UI thread.

setUp

Added in API level 3

protected open fun setUp(): Unit

Deprecated: Deprecated in Java.

tearDown

Added in API level 3

protected open fun tearDown(): Unit

Deprecated: Deprecated in Java.

Exceptions
`java.lang.Exception`