FileDocCategorySizeDatePackage
ActivityInstrumentationTestCase2.javaAPI DocAndroid 1.5 API7040Wed May 06 22:42:02 BST 2009android.test

ActivityInstrumentationTestCase2

public abstract class ActivityInstrumentationTestCase2 extends ActivityTestCase
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 {@link android.test.UiThreadTest}).
  • You can inject custom Intents into your Activity (see {@link #setActivityIntent(Intent)}).

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

If you prefer an isolated unit test, see {@link android.test.ActivityUnitTestCase}.

Fields Summary
String
mPackage
Class
mActivityClass
boolean
mInitialTouchMode
android.content.Intent
mActivityIntent
Constructors Summary
public ActivityInstrumentationTestCase2(String pkg, Class activityClass)
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.

param
pkg The package hosting the activity to be launched.
param
activityClass The activity to test.


                                                                
         
        mPackage = pkg;
        mActivityClass = activityClass;
Methods Summary
public TgetActivity()
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 {@link #setActivityIntent(Intent)} and/or {@link #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 {@link 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
the Activity under test

        Activity a = super.getActivity();
        if (a == null) {
            // set initial touch mode
            getInstrumentation().setInTouchMode(mInitialTouchMode);
            // inject custom intent, if provided
            if (mActivityIntent == null) {
                a = launchActivity(mPackage, mActivityClass, null);
            } else {
                a = launchActivityWithIntent(mPackage, mActivityClass, mActivityIntent);
            }
            setActivity(a);
        }
        return (T) a;
protected voidrunTest()
Runs the current unit test. If the unit test is annotated with {@link android.test.UiThreadTest}, force the Activity to be created before switching to the UI thread.

        try {
            Method method = getClass().getMethod(getName(), (Class[]) null);
            if (method.isAnnotationPresent(UiThreadTest.class)) {
                getActivity();
            }
        } catch (Exception e) {
            // eat the exception here; super.runTest() will catch it again and handle it properly
        }
        super.runTest();
public voidsetActivityInitialTouchMode(boolean initialTouchMode)
Call this method before the first call to {@link #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 {@link android.test.UiThreadTest}, then you must call {@link #setActivityInitialTouchMode(boolean)} from {@link #setUp()}.

param
initialTouchMode true if the Activity should be placed into "touch mode" when started

        mInitialTouchMode = initialTouchMode;
public voidsetActivityIntent(android.content.Intent i)
Call this method before the first call to {@link #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.

NOTE: Activities under test may not be started from within the UI thread. If your test method is annotated with {@link android.test.UiThreadTest}, then you must call {@link #setActivityIntent(Intent)} from {@link #setUp()}.

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

param
i The Intent to start the Activity with, or null to reset to the default Intent.

        mActivityIntent = i;
protected voidsetUp()

        super.setUp();
        
        boolean mInitialTouchMode = false;
        Intent mActivityIntent = null;
protected voidtearDown()

        // Finish the Activity off (unless was never launched anyway)
        Activity a = super.getActivity();
        if (a != null) {
            a.finish();
            setActivity(null);
        }
        
        // Scrub out members - protects against memory leaks in the case where someone 
        // creates a non-static inner class (thus referencing the test case) and gives it to
        // someone else to hold onto
        scrubClass(ActivityInstrumentationTestCase2.class);

        super.tearDown();