ActivityInstrumentationTestCase2.java revision 9066cfe9886ac131c34d59ed0e2d287b0e3c0087
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.test; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Method; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class provides functional testing of a single activity. The activity under test will 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be created using the system infrastructure (by calling InstrumentationTestCase.launchActivity()) 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and you will then be able to manipulate your Activity directly. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Other options supported by this test case include: 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>You can run any test method on the UI thread (see {@link android.test.UiThreadTest}).</li> 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>You can inject custom Intents into your Activity (see 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #setActivityIntent(Intent)}).</li> 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This class replaces {@link android.test.ActivityInstrumentationTestCase}, which is deprecated. 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * New tests should be written using this base class. 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If you prefer an isolated unit test, see {@link android.test.ActivityUnitTestCase}. 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic abstract class ActivityInstrumentationTestCase2<T extends Activity> 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project extends ActivityTestCase { 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String mPackage; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Class<T> mActivityClass; 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mInitialTouchMode = false; 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Intent mActivityIntent = null; 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param pkg The package of the instrumentation. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param activityClass The activity to test. 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public ActivityInstrumentationTestCase2(String pkg, Class<T> activityClass) { 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPackage = pkg; 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mActivityClass = activityClass; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the Activity under test, starting it if necessary. 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For each test method invocation, the Activity will not actually be created until the first 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * time this method is called. 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If you wish to provide custom setup values to your Activity, you may call 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #setActivityIntent(Intent)} and/or {@link #setActivityInitialTouchMode(boolean)} 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before your first call to getActivity(). Calling them after your Activity has 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * started will have no effect. 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>NOTE:</b> Activities under test may not be started from within the UI thread. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If your test method is annotated with {@link android.test.UiThreadTest}, then your Activity 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be started automatically just before your test method is run. You still call this 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * method in order to get the Activity under test. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the Activity under test 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public T getActivity() { 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Activity a = super.getActivity(); 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (a == null) { 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // set initial touch mode 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project getInstrumentation().setInTouchMode(mInitialTouchMode); 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // inject custom intent, if provided 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mActivityIntent == null) { 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project a = launchActivity(mPackage, mActivityClass, null); 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project a = launchActivityWithIntent(mPackage, mActivityClass, mActivityIntent); 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setActivity(a); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return (T) a; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call this method before the first call to {@link #getActivity} to inject a customized Intent 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * into the Activity under test. 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If you do not call this, the default intent will be provided. If you call this after 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your Activity has been started, it will have no effect. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>NOTE:</b> Activities under test may not be started from within the UI thread. 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If your test method is annotated with {@link android.test.UiThreadTest}, then you must call 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #setActivityIntent(Intent)} from {@link #setUp()}. 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The default Intent (if this method is not called) is: 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action = {@link Intent#ACTION_MAIN} 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * flags = {@link Intent#FLAG_ACTIVITY_NEW_TASK} 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * All other fields are null or empty. 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param i The Intent to start the Activity with, or null to reset to the default Intent. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setActivityIntent(Intent i) { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mActivityIntent = i; 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call this method before the first call to {@link #getActivity} to set the initial touch 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mode for the Activity under test. 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If you do not call this, the touch mode will be false. If you call this after 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your Activity has been started, it will have no effect. 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>NOTE:</b> Activities under test may not be started from within the UI thread. 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If your test method is annotated with {@link android.test.UiThreadTest}, then you must call 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #setActivityInitialTouchMode(boolean)} from {@link #setUp()}. 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialTouchMode true if the Activity should be placed into "touch mode" when started 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setActivityInitialTouchMode(boolean initialTouchMode) { 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mInitialTouchMode = initialTouchMode; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void setUp() throws Exception { 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.setUp(); 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mInitialTouchMode = false; 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Intent mActivityIntent = null; 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void tearDown() throws Exception { 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Finish the Activity off (unless was never launched anyway) 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Activity a = super.getActivity(); 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (a != null) { 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project a.finish(); 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setActivity(null); 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Scrub out members - protects against memory leaks in the case where someone 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // creates a non-static inner class (thus referencing the test case) and gives it to 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // someone else to hold onto 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project scrubClass(ActivityInstrumentationTestCase2.class); 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.tearDown(); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Runs the current unit test. If the unit test is annotated with 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.test.UiThreadTest}, force the Activity to be created before switching to 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the UI thread. 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void runTest() throws Throwable { 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Method method = getClass().getMethod(getName(), (Class[]) null); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (method.isAnnotationPresent(UiThreadTest.class)) { 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project getActivity(); 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (Exception e) { 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // eat the exception here; super.runTest() will catch it again and handle it properly 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.runTest(); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 175