InstrumentationTestCase.java revision d7ed9175aa269db8977ef05b095cfc2fabcc9c7a
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 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 junit.framework.TestCase; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Instrumentation; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.KeyEvent; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Field; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Method; 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Modifier; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.InvocationTargetException; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A test case that has access to {@link Instrumentation}. 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class InstrumentationTestCase extends TestCase { 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Instrumentation mInstrumentation; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Injects instrumentation into this test case. This method is 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * called by the test runner during test setup. 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param instrumentation the instrumentation to use with this instance 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void injectInsrumentation(Instrumentation instrumentation) { 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mInstrumentation = instrumentation; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Inheritors can access the instrumentation using this. 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return instrumentation 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Instrumentation getInstrumentation() { 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mInstrumentation; 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Utility method for launching an activity. 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The {@link Intent} used to launch the Activity is: 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action = {@link Intent#ACTION_MAIN} 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * extras = null, unless a custom bundle is provided here 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * All other fields are null or empty. 65df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * 66df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * <p><b>NOTE:</b> The parameter <i>pkg</i> must refer to the package identifier of the 67df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * package hosting the activity to be launched, which is specified in the AndroidManifest.xml 68df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * file. This is not necessarily the same as the java package name. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param pkg The package hosting the activity to be launched. 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param activityCls The activity class to launch. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param extras Optional extra stuff to pass to the activity. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The activity, or null if non launched. 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @SuppressWarnings("unchecked") 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final <T extends Activity> T launchActivity( 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String pkg, 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Class<T> activityCls, 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Bundle extras) { 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Intent intent = new Intent(Intent.ACTION_MAIN); 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (extras != null) { 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project intent.putExtras(extras); 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return launchActivityWithIntent(pkg, activityCls, intent); 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Utility method for launching an activity with a specific Intent. 89df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * 90df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * <p><b>NOTE:</b> The parameter <i>pkg</i> must refer to the package identifier of the 91df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * package hosting the activity to be launched, which is specified in the AndroidManifest.xml 92df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * file. This is not necessarily the same as the java package name. 93df2a463b01fe5222e377828225ca6710d5c14743Andy Stadler * 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param pkg The package hosting the activity to be launched. 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param activityCls The activity class to launch. 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The intent to launch with 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The activity, or null if non launched. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @SuppressWarnings("unchecked") 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final <T extends Activity> T launchActivityWithIntent( 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String pkg, 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Class<T> activityCls, 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Intent intent) { 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project intent.setClassName(pkg, activityCls.getName()); 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project T activity = (T) getInstrumentation().startActivitySync(intent); 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project getInstrumentation().waitForIdleSync(); 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return activity; 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Helper for running portions of a test on the UI thread. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Note, in most cases it is simpler to annotate the test method with 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.test.UiThreadTest}, which will run the entire test method on the UI thread. 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Use this method if you need to switch in and out of the UI thread to perform your test. 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r runnable containing test code in the {@link Runnable#run()} method 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void runTestOnUiThread(final Runnable r) throws Throwable { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Throwable[] exceptions = new Throwable[1]; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project getInstrumentation().runOnMainSync(new Runnable() { 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void run() { 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project r.run(); 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (Throwable throwable) { 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project exceptions[0] = throwable; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }); 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (exceptions[0] != null) { 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw exceptions[0]; 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Runs the current unit test. If the unit test is annotated with 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.test.UiThreadTest}, the test is run on the UI thread. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void runTest() throws Throwable { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String fName = getName(); 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project assertNotNull(fName); 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Method method = null; 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // use getMethod to get all public inherited 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // methods. getDeclaredMethods returns all 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // methods of this class but excludes the 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // inherited ones. 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project method = getClass().getMethod(fName, (Class[]) null); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (NoSuchMethodException e) { 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project fail("Method \""+fName+"\" not found"); 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!Modifier.isPublic(method.getModifiers())) { 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project fail("Method \""+fName+"\" should be public"); 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int runCount = 1; 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (method.isAnnotationPresent(FlakyTest.class)) { 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project runCount = method.getAnnotation(FlakyTest.class).tolerance(); 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (method.isAnnotationPresent(UiThreadTest.class)) { 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int tolerance = runCount; 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Method testMethod = method; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Throwable[] exceptions = new Throwable[1]; 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project getInstrumentation().runOnMainSync(new Runnable() { 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void run() { 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project runMethod(testMethod, tolerance); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (Throwable throwable) { 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project exceptions[0] = throwable; 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }); 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (exceptions[0] != null) { 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw exceptions[0]; 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project runMethod(method, runCount); 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void runMethod(Method runMethod, int tolerance) throws Throwable { 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Throwable exception = null; 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int runCount = 0; 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project do { 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project runMethod.invoke(this, (Object[]) null); 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project exception = null; 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (InvocationTargetException e) { 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.fillInStackTrace(); 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project exception = e.getTargetException(); 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalAccessException e) { 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.fillInStackTrace(); 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project exception = e; 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project runCount++; 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } while ((runCount < tolerance) && (exception != null)); 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (exception != null) { 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw exception; 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a series of key events through instrumentation and waits for idle. The sequence 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of keys is a string containing the key names as specified in KeyEvent, without the 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * KEYCODE_ prefix. For instance: sendKeys("DPAD_LEFT A B C DPAD_CENTER"). Each key can 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be repeated by using the N* prefix. For instance, to send two KEYCODE_DPAD_LEFT, use 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the following: sendKeys("2*DPAD_LEFT"). 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param keysSequence The sequence of keys. 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void sendKeys(String keysSequence) { 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final String[] keys = keysSequence.split(" "); 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int count = keys.length; 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Instrumentation instrumentation = getInstrumentation(); 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < count; i++) { 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String key = keys[i]; 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int repeater = key.indexOf('*'); 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int keyCount; 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project keyCount = repeater == -1 ? 1 : Integer.parseInt(key.substring(0, repeater)); 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (NumberFormatException e) { 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("ActivityTestCase", "Invalid repeat count: " + key); 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project continue; 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (repeater != -1) { 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project key = key.substring(repeater + 1); 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int j = 0; j < keyCount; j++) { 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Field keyCodeField = KeyEvent.class.getField("KEYCODE_" + key); 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int keyCode = keyCodeField.getInt(null); 244d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn try { 245d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn instrumentation.sendKeyDownUpSync(keyCode); 246d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } catch (SecurityException e) { 247d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // Ignore security exceptions that are now thrown 248d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // when trying to send to another app, to retain 249d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // compatibility with existing tests. 250d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (NoSuchFieldException e) { 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("ActivityTestCase", "Unknown keycode: KEYCODE_" + key); 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalAccessException e) { 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("ActivityTestCase", "Unknown keycode: KEYCODE_" + key); 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project instrumentation.waitForIdleSync(); 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a series of key events through instrumentation and waits for idle. For instance: 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sendKeys(KEYCODE_DPAD_LEFT, KEYCODE_DPAD_CENTER). 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param keys The series of key codes to send through instrumentation. 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void sendKeys(int... keys) { 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int count = keys.length; 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Instrumentation instrumentation = getInstrumentation(); 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < count; i++) { 275d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn try { 276d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn instrumentation.sendKeyDownUpSync(keys[i]); 277d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } catch (SecurityException e) { 278d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // Ignore security exceptions that are now thrown 279d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // when trying to send to another app, to retain 280d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // compatibility with existing tests. 281d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project instrumentation.waitForIdleSync(); 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a series of key events through instrumentation and waits for idle. Each key code 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * must be preceded by the number of times the key code must be sent. For instance: 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sendRepeatedKeys(1, KEYCODE_DPAD_CENTER, 2, KEYCODE_DPAD_LEFT). 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param keys The series of key repeats and codes to send through instrumentation. 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void sendRepeatedKeys(int... keys) { 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int count = keys.length; 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((count & 0x1) == 0x1) { 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("The size of the keys array must " 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "be a multiple of 2"); 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Instrumentation instrumentation = getInstrumentation(); 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < count; i += 2) { 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int keyCount = keys[i]; 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int keyCode = keys[i + 1]; 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int j = 0; j < keyCount; j++) { 307d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn try { 308d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn instrumentation.sendKeyDownUpSync(keyCode); 309d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } catch (SecurityException e) { 310d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // Ignore security exceptions that are now thrown 311d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // when trying to send to another app, to retain 312d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn // compatibility with existing tests. 313d7ed9175aa269db8977ef05b095cfc2fabcc9c7aDianne Hackborn } 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project instrumentation.waitForIdleSync(); 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Make sure all resources are cleaned up and garbage collected before moving on to the next 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * test. Subclasses that override this method should make sure they call super.tearDown() 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at the end of the overriding method. 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws Exception 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void tearDown() throws Exception { 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Runtime.getRuntime().gc(); 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Runtime.getRuntime().runFinalization(); 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Runtime.getRuntime().gc(); 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.tearDown(); 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 334