diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/html/guide/topics/testing/testing_android.jd | 468 |
1 files changed, 286 insertions, 182 deletions
diff --git a/docs/html/guide/topics/testing/testing_android.jd b/docs/html/guide/topics/testing/testing_android.jd index 46ba769..9ace1cb 100755 --- a/docs/html/guide/topics/testing/testing_android.jd +++ b/docs/html/guide/topics/testing/testing_android.jd @@ -23,9 +23,9 @@ page.title=Testing and Instrumentation <li> <a href="#MockObjects">Mock object classes</a> </li> - <li> - <a href="#InstrumentationTestRunner">Instrumentation Test Runner</a> - </li> + <li> + <a href="#InstrumentationTestRunner">Instrumentation Test Runner</a> + </li> </ol> </li> <li> @@ -64,7 +64,8 @@ page.title=Testing and Instrumentation <h2>Related Tutorials</h2> <ol> <li> - <a href="{@docRoot}resources/tutorials/testing/helloandroid_test.html">Hello, Testing</a> + <a href="{@docRoot}resources/tutorials/testing/helloandroid_test.html"> + Hello, Testing</a> </li> <li> <a href="{@docRoot}resources/tutorials/testing/activity_test.html">Activity Testing</a> @@ -73,10 +74,12 @@ page.title=Testing and Instrumentation <h2>See Also</h2> <ol> <li> - <a href="{@docRoot}guide/developing/testing/testing_eclipse.html">Testing in Eclipse, with ADT</a> + <a href="{@docRoot}guide/developing/testing/testing_eclipse.html"> + Testing in Eclipse, with ADT</a> </li> <li> - <a href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other IDEs</a> + <a href="{@docRoot}guide/developing/testing/testing_otheride.html"> + Testing in Other IDEs</a> </li> </ol> </div> @@ -118,45 +121,55 @@ accomplishes this by running both the main application and the test application in the same process. </p> <p>Your test application is linked to the application under test by means of an -<a -href="{@docRoot}guide/topics/manifest/instrumentation-element.html"><code><instrumentation></code></a> -element in the test application's manifest file. The attributes of the element -specify the package name of the application under test and also tell Android how -to run the test application. Instrumentation is described in more detail in the -section <a href="#InstrumentationTestRunner">Instrumentation Test -Runner</a>.</p> + <a + href="{@docRoot}guide/topics/manifest/instrumentation-element.html"> + <code><instrumentation></code></a> element in the test application's manifest file. + The attributes of the element specify the package name of the application under test and also + tell Android how to run the test application. Instrumentation is described in more detail + in the section <a href="#InstrumentationTestRunner">Instrumentation Test Runner</a>. +</p> <p>The following diagram summarizes the Android testing environment:</p> <img src="{@docRoot}images/testing/android_test_framework.png"/> -<p>In Android, test applications are themselves Android applications, so you -write them in much the same way as the application you are testing. The SDK -tools help you create a main application project and its test project at the same -time. You can run Android tests within Eclipse with ADT or from the command -line. Eclipse with ADT provides an extensive set of tools for creating tests, -running them, and viewing their results. You can also use the <code>adb</code> -tool to run tests, or use a built-in Ant target.</p> +<p> + In Android, test applications are themselves Android applications, so you + write them in much the same way as the application you are testing. The SDK + tools help you create a main application project and its test project at the same + time. You can run Android tests within Eclipse with ADT or from the command + line. Eclipse with ADT provides an extensive set of tools for creating tests, + running them, and viewing their results. You can also use the <code>adb</code> + tool to run tests, or use a built-in Ant target. +</p> -<p>To learn how to set up and run tests in Eclipse, please refer to <a -href="{@docRoot}guide/developing/testing/testing_eclipse.html">Testing in -Eclipse, with ADT</a>. If you're not working in Eclipse, refer to <a -href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other -IDEs</a>.</p> +<p> + To learn how to set up and run tests in Eclipse, please refer to <a + href="{@docRoot}guide/developing/testing/testing_eclipse.html">Testing in + Eclipse, with ADT</a>. If you're not working in Eclipse, refer to <a + href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other + IDEs</a>. +</p> -<p>If you want a step-by-step introduction to Android testing, try one of the -testing tutorials:</p> +<p> + If you want a step-by-step introduction to Android testing, try one of the + testing tutorials: +</p> <ul> - <li>The <a -href="{@docRoot}resources/tutorials/testing/helloandroid_test.html">Hello, -Testing</a> tutorial introduces basic testing concepts and procedures in the -context of the Hello, World application.</li> - <li>The <a -href="{@docRoot}resources/tutorials/testing/activity_test.html">Activity -Testing</a> tutorial is an excellent follow-up to the Hello, Testing tutorial. -It guides you through a more complex testing scenario that you develop against a -more realistic application.</li> + <li> + The <a + href="{@docRoot}resources/tutorials/testing/helloandroid_test.html">Hello, + Testing</a> tutorial introduces basic testing concepts and procedures in the + context of the Hello, World application. + </li> + <li> + The <a + href="{@docRoot}resources/tutorials/testing/activity_test.html">Activity + Testing</a> tutorial is an excellent follow-up to the Hello, Testing tutorial. + It guides you through a more complex testing scenario that you develop against a + more realistic application. + </li> </ul> <h2 id="TestAPI">The Testing API</h2> @@ -166,120 +179,156 @@ more realistic application.</li> a powerful instrumentation framework that lets your tests access the state and runtime objects of the application under tests. </p> -<p>The sections below describe the major components of the testing API available in Android.</p> +<p> + The sections below describe the major components of the testing API available in Android. +</p> <h3 id="Extensions">JUnit test case classes</h3> <p> - Some of the classes in the testing API extend the JUnit {@link junit.framework.TestCase TestCase} but do not use the instrumentation framework. These classes - contain methods for accessing system objects such as the Context of the application under test. With this Context, you can look at its resources, files, databases, - and so forth. The base class is {@link android.test.AndroidTestCase}, but you usually use a subclass associated with a particular component. + Some of the classes in the testing API extend the JUnit {@link junit.framework.TestCase TestCase} + but do not use the instrumentation framework. These classes contain methods for accessing system + objects such as the Context of the application under test. With this Context, you can look at its + resources, files, databases, and so forth. The base class is {@link android.test.AndroidTestCase}, + but you usually use a subclass associated with a particular component. <p> The subclasses are: </p> <ul> <li> - {@link android.test.ApplicationTestCase} - A class for testing an entire application. It allows you to inject a mock Context into the application, - set up initial test parameters before the application starts, and examine the application after it finishes but before it is destroyed. + {@link android.test.ApplicationTestCase} - A class for testing an entire application. + It allows you to inject a mock Context into the application, set up initial test parameters + before the application starts, and examine the application after it finishes but before it + is destroyed. </li> <li> - {@link android.test.ProviderTestCase2} - A class for isolated testing of a single {@link android.content.ContentProvider}. Since it is restricted to using a - {@link android.test.mock.MockContentResolver} for the provider, and it injects an {@link android.test.IsolatedContext}, your provider testing is isolated + {@link android.test.ProviderTestCase2} - A class for isolated testing of a single + {@link android.content.ContentProvider}. Since it is restricted to using a + {@link android.test.mock.MockContentResolver} for the provider, and it injects an + {@link android.test.IsolatedContext}, your provider testing is isolated from the rest of the OS. </li> <li> - {@link android.test.ServiceTestCase} - a class for isolated testing of a single {@link android.app.Service}. You can inject a mock Context or - mock Application (or both), or let Android provide you a full Context and a {@link android.test.mock.MockApplication}. + {@link android.test.ServiceTestCase} - a class for isolated testing of a single + {@link android.app.Service}. You can inject a mock Context or mock Application (or both), or + let Android provide you a full Context and a {@link android.test.mock.MockApplication}. </li> </ul> <h3 id="Instrumentation">Instrumentation test case classes</h3> <p> - The API for testing activities extends the JUnit {@link junit.framework.TestCase TestCase} class and also uses the instrumentation framework. With instrumentation, - Android can automate UI testing by sending events to the application under test, precisely control the start of an activity, and monitor the state of the - activity during its life cycle. + The API for testing activities extends the JUnit {@link junit.framework.TestCase TestCase} class + and also uses the instrumentation framework. With instrumentation, Android can automate UI + testing by sending events to the application under test, precisely control the start of an + activity, and monitor the state of the activity during its life cycle. </p> <p> - The base class is {@link android.test.InstrumentationTestCase}. All of its subclasses have the ability to send a keystroke or touch event to the UI of the application - under test. The subclasses can also inject a mock Intent. - The subclasses are: + The base class is {@link android.test.InstrumentationTestCase}. All of its subclasses have + the ability to send a keystroke or touch event to the UI of the application + under test. The subclasses can also inject a mock Intent. The subclasses are: </p> <ul> <li> {@link android.test.ActivityTestCase} - A base class for activity test classes. </li> <li> - {@link android.test.SingleLaunchActivityTestCase} - A convenience class for testing a single activity. - It invokes {@link junit.framework.TestCase#setUp() setUp()} and {@link junit.framework.TestCase#tearDown() tearDown()} only - once, instead of once per method call. Use it when all of your test methods run against the same activity. + {@link android.test.SingleLaunchActivityTestCase} - A convenience class for + testing a single activity. It invokes {@link junit.framework.TestCase#setUp() setUp()} and + {@link junit.framework.TestCase#tearDown() tearDown()} only once, instead of once per + method call. Use it when all of your test methods run against the same activity. </li> <li> - {@link android.test.SyncBaseInstrumentation} - A class that tests synchronization of a content provider. It uses instrumentation to cancel and disable - existing synchronizations before starting the test synchronization. + {@link android.test.SyncBaseInstrumentation} - A class that tests synchronization of a + content provider. It uses instrumentation to cancel and disable existing synchronizations + before starting the test synchronization. </li> <li> - {@link android.test.ActivityUnitTestCase} - This class does an isolated test of a single activity. With it, you can inject a mock context or application, or both. - It is intended for doing unit tests of an activity, and is the activity equivalent of the test classes described in <a href="#Extensions">JUnit test case classes</a>. - <p> Unlike the other instrumentation classes, this test class cannot inject a mock Intent.</p> + {@link android.test.ActivityUnitTestCase} - This class does an isolated test of a single + activity. With it, you can inject a mock context or application, or both. + It is intended for doing unit tests of an activity, and is the activity equivalent of the + test classes described in <a href="#Extensions">JUnit test case classes</a>. + <p> + Unlike the other instrumentation classes, this test class cannot inject a mock Intent. + </p> </li> <li> - {@link android.test.ActivityInstrumentationTestCase2} - This class tests a single activity within the normal system environment. - You cannot inject a mock Context, but you can inject mock Intents. Also, you can run a test method on the UI thread (the main thread of the application under test), - which allows you to send key and touch events to the application UI. + {@link android.test.ActivityInstrumentationTestCase2} - This class tests a single activity + within the normal system environment. You cannot inject a mock Context, but you can inject + mock Intents. Also, you can run a test method on the UI thread (the main thread of the + application under test), which allows you to send key and touch events to the + application UI. </li> </ul> <h3 id="Assert">Assert classes</h3> <p> - Android also extends the JUnit {@link junit.framework.Assert} class that is the basis of <code>assert()</code> calls in tests. - There are two extensions to this class, {@link android.test.MoreAsserts} and {@link android.test.ViewAsserts}: + Android also extends the JUnit {@link junit.framework.Assert} class that is the basis of + <code>assert()</code> calls in tests. There are two extensions to this class, + {@link android.test.MoreAsserts} and {@link android.test.ViewAsserts}: </p> <ul> <li> - The <code>MoreAsserts</code> class contains more powerful assertions such as {@link android.test.MoreAsserts#assertContainsRegex} that does regular expression matching. + The <code>MoreAsserts</code> class contains more powerful assertions such as + {@link android.test.MoreAsserts#assertContainsRegex} that does regular expression matching. </li> <li> - The {@link android.test.ViewAsserts} class contains useful assertions about Android Views, such as {@link android.test.ViewAsserts#assertHasScreenCoordinates} that tests if a View has a particular X and Y - position on the visible screen. These asserts simplify testing of geometry and alignment in the UI. + The {@link android.test.ViewAsserts} class contains useful assertions about Android Views, + such as {@link android.test.ViewAsserts#assertHasScreenCoordinates} that tests if a View has a + particular X and Y position on the visible screen. These asserts simplify testing of geometry + and alignment in the UI. </li> </ul> <h3 id="MockObjects">Mock object classes</h3> <p> - Android has convenience classes for creating mock system objects such as applications, contexts, content resolvers, and resources. Android also provides - methods in some test classes for creating mock Intents. Use these mocks to facilitate dependency injection, since they are easier to use than creating their - real counterparts. These convenience classes are found in {@link android.test} and {@link android.test.mock}. They are: + Android has convenience classes for creating mock system objects such as applications, contexts, + content resolvers, and resources. Android also provides methods in some test classes for + creating mock Intents. Use these mocks to facilitate dependency injection, since they are + easier to use than creating their real counterparts. These convenience classes are found in + {@link android.test} and {@link android.test.mock}. They are: </p> <ul> <li> - {@link android.test.IsolatedContext} - Mocks a Context so that the application using it runs in isolation. - At the same time, it has enough stub code to satisfy OS code that tries to communicate with contexts. This class is useful in unit testing. + {@link android.test.IsolatedContext} - Mocks a Context so that the application using it + runs in isolation. At the same time, it has enough stub code to satisfy OS code that tries + to communicate with contexts. This class is useful in unit testing. </li> <li> - {@link android.test.RenamingDelegatingContext} - Delegates most context functions to an existing, normal context while changing the default file and database - names in the context. Use this to test file and database operations with a normal system context, using test names. + {@link android.test.RenamingDelegatingContext} - Delegates most context functions to an + existing, normal context while changing the default file and database + names in the context. Use this to test file and database operations with a normal system + context, using test names. </li> <li> - {@link android.test.mock.MockApplication}, {@link android.test.mock.MockContentResolver}, {@link android.test.mock.MockContext}, - {@link android.test.mock.MockDialogInterface}, {@link android.test.mock.MockPackageManager}, - {@link android.test.mock.MockResources} - Classes that create mock Android system objects for use in testing. They expose only those methods that are - useful in managing the object. The default implementations of these methods simply throw an Exception. You are expected to extend the classes and - override any methods that are called by the application under test. + {@link android.test.mock.MockApplication}, {@link android.test.mock.MockContentResolver}, + {@link android.test.mock.MockContext}, {@link android.test.mock.MockDialogInterface}, + {@link android.test.mock.MockPackageManager}, {@link android.test.mock.MockResources} - + Classes that create mock Android system objects for use in testing. They expose only those + methods that are useful in managing the object. The default implementations of these methods + simply throw an Exception. You are expected to extend the classes and override any methods ' + that are called by the application under test. </li> </ul> <h3 id="InstrumentationTestRunner">Instrumentation Test Runner</h3> <p> Android provides a custom class for running tests with instrumentation called called {@link android.test.InstrumentationTestRunner}. This class - controls of the application under test, runs the test application and the main application in the same process, and routes - test output to the appropriate place. Using instrumentation is key to the ability of <code>InstrumentationTestRunner</code> to control the entire test - environment at runtime. Notice that you use this test runner even if your test class does not itself use instrumentation. + controls of the application under test, runs the test application and the main application in the + same process, and routes test output to the appropriate place. Using instrumentation is key to the + ability of <code>InstrumentationTestRunner</code> to control the entire test + environment at runtime. Notice that you use this test runner even if your test class does not + itself use instrumentation. </p> <p> - When you run a test application, you first run a system utility called Activity Manager. Activity Manager uses the instrumentation framework to start and control the test runner, which in turn uses instrumentation to shut down any running instances - of the main application, starts the test application, and then starts the main application in the same process. This allows various aspects of the test application to work directly with the main application. + When you run a test application, you first run a system utility called Activity Manager. Activity + Manager uses the instrumentation framework to start and control the test runner, which in turn + uses instrumentation to shut down any running instances of the main application, starts the test + application, and then starts the main application in the same process. This allows various + aspects of the test application to work directly with the main application. </p> <p> - If you are developing in Eclipse, the ADT plugin assists you in the setup of <code>InstrumentationTestRunner</code> or other test runners. - The plugin UI prompts you to specify the test runner class to use, as well as the package name of the application under test. - The plugin then adds an <code><instrumentation></code> element with appropriate attributes to the manifest file of the test application. - Eclipse with ADT automatically starts a test application under the control of Activity Manager using instrumentation, - and redirects the test output to the Eclipse window's JUnit view. + If you are developing in Eclipse, the ADT plugin assists you in the setup of + <code>InstrumentationTestRunner</code> or other test runners. The plugin UI prompts you to specify + the test runner class to use, as well as the package name of the application under test. + The plugin then adds an <code><instrumentation></code> element with appropriate attributes + to the manifest file of the test application. Eclipse with ADT automatically starts a test + application under the control of Activity Manager using instrumentation, and redirects the test + output to the Eclipse window's JUnit view. </p> <p> If you prefer working from the command line, you can use Ant and the <code>android</code> @@ -289,68 +338,105 @@ more realistic application.</li> </p> <h2 id="TestEnviroment">Working in the Test Environment</h2> <p> - The tests for an Android application are contained in a test application, which itself is an Android application. A test application resides in a separate Android project that has the - same files and directories as a regular Android application. The test project is linked to the project of the application it tests - (known as the application under test) by its manifest file. + The tests for an Android application are contained in a test application, which itself is an + Android application. A test application resides in a separate Android project that has the + same files and directories as a regular Android application. The test project is linked to the + project of the application it tests (known as the application under test) by its manifest file. </p> <p> Each test application contains one or more test case classes based on an Android class for a - particular type of component. The test case class contains methods that define tests on some part of the application under test. When you run the test application, Android - starts it, loads the application under test into the same process, and then invokes each method in the test case class. + particular type of component. The test case class contains methods that define tests on some + part of the application under test. When you run the test application, Android + starts it, loads the application under test into the same process, and then invokes each method + in the test case class. </p> <p> - The tools and procedures you use with testing depend on the development environment you are using. If you use Eclipse, then the ADT plug in for Eclipse provides tools that - allow you to develop and run tests entirely within Eclipse. This is documented in the topic <a href="{@docRoot}guide/developing/testing/testing_eclipse.html">Testing in Eclipse, with ADT</a>. - If you use another development environment, then you use Android's command-line tools, as documented in the topic <a href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other IDEs</a>. + The tools and procedures you use with testing depend on the development environment you are + using. If you use Eclipse, then the ADT plug in for Eclipse provides tools that allow you to + develop and run tests entirely within Eclipse. This is documented in the topic + <a href="{@docRoot}guide/developing/testing/testing_eclipse.html"> + Testing in Eclipse, with ADT</a>. If you use another development environment, then you use + Android's command-line tools, as documented in the topic + <a href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other IDEs</a>. </p> <h3 id="TestProjects">Working with test projects</h3> <p> - To start testing an Android application, you create a test project for it using Android tools. The tools create the project directory and the files and subdirectories needed. - The tools also create a manifest file that links the application in the test project to the application under test. The procedure for creating a test project in Eclipse with - ADT is documented in <a href="{@docRoot}guide/developing/testing/testing_eclipse.html">Testing in Eclipse, with ADT</a>. The procedure for creating a test project for use with development - tools other than Eclipse is documented in <a href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other IDEs</a>. + To start testing an Android application, you create a test project for it using Android tools. + The tools create the project directory and the files and subdirectories needed. + The tools also create a manifest file that links the application in the test project to the + application under test. The procedure for creating a test project in Eclipse with ADT is + documented in <a href="{@docRoot}guide/developing/testing/testing_eclipse.html"> + Testing in Eclipse, with ADT</a>. The procedure for creating a test project for use with + development tools other than Eclipse is documented in + <a href="{@docRoot}guide/developing/testing/testing_otheride.html">Testing in Other IDEs</a>. </p> <h3 id="TestClasses">Working with test case classes</h3> <p> - A test application contains one or more test case classes that extend an Android test case class. You choose a test case class based on the type of Android component you are testing and the - tests you are doing. A test application can test different components, but each test case class is designed to test a single type of component. - The Android test case classes are described in the section <a href="#TestAPI">The Testing API</a>. + A test application contains one or more test case classes that extend an Android test case + class. You choose a test case class based on the type of Android component you are testing and + the tests you are doing. A test application can test different components, but each test case + class is designed to test a single type of component. The Android test case classes are + described in the section <a href="#TestAPI">The Testing API</a>. </p> <p> - Some Android components have more than one associated test case class. In this case, you choose among the available classes based on the type of tests you want to do. For activities, - for example, you have the choice of either {@link android.test.ActivityInstrumentationTestCase2} or {@link android.test.ActivityUnitTestCase}. + Some Android components have more than one associated test case class. In this case, you choose + among the available classes based on the type of tests you want to do. For activities, for + example, you have the choice of either {@link android.test.ActivityInstrumentationTestCase2} or + {@link android.test.ActivityUnitTestCase}. <p> - <code>ActivityInstrumentationTestCase2</code> is designed to do functional testing, so it tests activities in a normal system infrastructure. You can inject mocked Intents, but not + <code>ActivityInstrumentationTestCase2</code> is designed to do functional testing, so it tests + activities in a normal system infrastructure. You can inject mocked Intents, but not mocked Contexts. In general, you can't mock dependencies for the activity under test. </p> <p> - In comparison, <code>ActivityUnitTestCase</code> is designed for unit testing, so it tests activities in an isolated system infrastructure. You can inject mocked or wrappered dependencies for - the activity under test, particularly mocked Contexts. On the other hand, when you use this test case class the activity under test runs in isolation and can't interact with other activities. + In comparison, <code>ActivityUnitTestCase</code> is designed for unit testing, so it tests + activities in an isolated system infrastructure. You can inject mocked or wrappered + dependencies for the activity under test, particularly mocked Contexts. On the other hand, + when you use this test case class the activity under test runs in isolation and can't interact + with other activities. </p> <p> - As a rule of thumb, if you wanted to test an activity's interaction with the rest of Android, you would use <code>ActivityInstrumentationTestCase2</code>. If you wanted to do regression testing - on an activity, you would use <code>ActivityUnitTestCase</code>. + As a rule of thumb, if you wanted to test an activity's interaction with the rest of Android, + you would use <code>ActivityInstrumentationTestCase2</code>. If you wanted to do regression + testing on an activity, you would use <code>ActivityUnitTestCase</code>. </p> <h3 id="Tests">Working with test methods</h3> <p> - Each test case class provides methods that you use to set up the test environment and control the application under test. For example, all test case classes provide the JUnit {@link junit.framework.TestCase#setUp() setUp()} - method that you can override to set up fixtures. In addition, you add methods to the class to define individual tests. Each method you add is run once each time you run the test application. If you override the <code>setUp()</code> - method, it runs before each of your methods. Similarly, the JUnit {@link junit.framework.TestCase#tearDown() tearDown()} method is run once after each of your methods. -</p> -<p> - The test case classes give you substantial control over starting and stopping components. For this reason, you have to specifically tell Android to start a component before you run tests against it. For example, you use the - {@link android.test.ActivityInstrumentationTestCase2#getActivity()} method to start the activity under test. You can call this method once during the entire test case, or once for each test method. You can even destroy the - activity under test by calling its {@link android.app.Activity#finish()} method and then restart it with <code>getActivity()</code> within a single test method. + Each test case class provides methods that you use to set up the test environment and control + the application under test. For example, all test case classes provide the JUnit + {@link junit.framework.TestCase#setUp() setUp()} method that you can override to set up + fixtures. In addition, you add methods to the class to define individual tests. Each method you + add is run once each time you run the test application. If you override the <code>setUp()</code> + method, it runs before each of your methods. Similarly, the JUnit + {@link junit.framework.TestCase#tearDown() tearDown()} method is run once after each of + your methods. +</p> +<p> + The test case classes give you substantial control over starting and stopping components. For + this reason, you have to specifically tell Android to start a component before you run tests + against it. For example, you use the + {@link android.test.ActivityInstrumentationTestCase2#getActivity()} method to start the activity + under test. You can call this method once during the entire test case, or once for each test + method. You can even destroy the activity under test by calling its + {@link android.app.Activity#finish()} method and then restart it with + <code>getActivity()</code> within a single test method. </p> <h3 id="RunTests">Running tests and seeing the results</h3> <p> - To run your tests, you build your test project and then run the test application using the system utility Activity Manager with instrumentation. You provide to Activity Manager the name of the test runner (usually - {@link android.test.InstrumentationTestRunner}) you specified for your application; the name includes both your test application's package name and the test runner class name. Activity Manager loads and starts your - test application, kills any instances of the application under test, loads an instance of the application under test into the same process as the test application, and then passes control to the first test case - class in your test application. The test runner then takes control of the tests, running each of your test methods against the application under test until all the methods in all the classes have been run. + To run your tests, you build your test project and then run the test application using the + system utility Activity Manager with instrumentation. You provide to Activity Manager the name + of the test runner (usually {@link android.test.InstrumentationTestRunner}) you specified for + your application; the name includes both your test application's package name and the test + runner class name. Activity Manager loads and starts your test application, kills any instances + of the application under test, loads an instance of the application under test into the same + process as the test application, and then passes control to the first test case class in your + test application. The test runner then takes control of the tests, running each of your test + methods against the application under test until all the methods in all the classes have been + run. </p> <p> - If you run a test within Eclipse with ADT, the output appears in a new JUnit view pane. If you run a test from the command line, the output goes to STDOUT. + If you run a test within Eclipse with ADT, the output appears in a new JUnit view pane. If you + run a test from the command line, the output goes to STDOUT. </p> <h2 id="TestAreas">What to Test</h2> <p> @@ -359,58 +445,64 @@ more realistic application.</li> </p> <ul> <li> - Activity lifecycle events: You should test that your activities handle lifecycle events correctly. For example - an activity should respond to pause or destroy events by saving its state. Remember that even a change in screen orientation - causes the current activity to be destroyed, so you should test that accidental device movements don't accidentally lose the + Activity lifecycle events: You should test that your activities handle lifecycle events + correctly. For example, an activity should respond to pause or destroy events by saving its + state. Remember that even a change in screen orientation causes the current activity to be + destroyed, so you should test that accidental device movements don't accidentally lose the application state. </li> <li> - Database operations: You should ensure that database operations correctly handle changes to the application's state. - To do this, use mock objects from the package {@link android.test.mock android.test.mock}. + Database operations: You should ensure that database operations correctly handle changes to + the application's state. To do this, use mock objects from the package + {@link android.test.mock android.test.mock}. </li> <li> - Screen sizes and resolutions: Before you publish your application, make sure to test it on all of the - screen sizes and densities on which you want it to run. You can test the application on multiple sizes and densities using - AVDs, or you can test your application directly on the devices that you are targeting. For more information, see - the topic <a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple Screens</a>. + Screen sizes and resolutions: Before you publish your application, make sure to test it on + all of the screen sizes and densities on which you want it to run. You can test the + application on multiple sizes and densities using AVDs, or you can test your application + directly on the devices that you are targeting. For more information, see the topic + <a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple Screens</a>. </li> </ul> <p> - When possible, you should run these tests on an actual device. If this is not possible, you can - use the <a href="{@docRoot}guide/developing/tools/emulator.html">Android Emulator</a> with - <a href="{@docRoot}guide/developing/tools/avd.html">Android Virtual Devices</a> configured for - the hardware, screens, and versions you want to test. + When possible, you should run these tests on an actual device. If this is not possible, you can + use the <a href="{@docRoot}guide/developing/tools/emulator.html">Android Emulator</a> with + <a href="{@docRoot}guide/developing/tools/avd.html">Android Virtual Devices</a> configured for + the hardware, screens, and versions you want to test. </p> <h2 id="UITesting">Appendix: UI Testing Notes</h2> <p> - The following sections have tips for testing the UI of your Android application, specifically - to help you handle actions that run in the UI thread, touch screen and keyboard events, and home - screen unlock during testing. + The following sections have tips for testing the UI of your Android application, specifically + to help you handle actions that run in the UI thread, touch screen and keyboard events, and home + screen unlock during testing. </p> <h3 id="RunOnUIThread">Testing on the UI thread</h3> <p> - An application's activities run on the application's <strong>UI thread</strong>. Once the - UI is instantiated, for example in the activity's <code>onCreate()</code> method, then all - interactions with the UI must run in the UI thread. When you run the application normally, it - has access to the thread and does not have to do anything special. + An application's activities run on the application's <strong>UI thread</strong>. Once the + UI is instantiated, for example in the activity's <code>onCreate()</code> method, then all + interactions with the UI must run in the UI thread. When you run the application normally, it + has access to the thread and does not have to do anything special. </p> <p> - This changes when you run tests against the application. With instrumentation-based classes, - you can invoke methods against the UI of the application under test. The other test classes don't allow this. - To run an entire test method on the UI thread, you can annotate the thread with <code>@UIThreadTest</code>. - Notice that this will run <em>all</em> of the method statements on the UI thread. Methods that do not interact with the UI - are not allowed; for example, you can't invoke <code>Instrumentation.waitForIdleSync()</code>. + This changes when you run tests against the application. With instrumentation-based classes, + you can invoke methods against the UI of the application under test. The other test classes + don't allow this. To run an entire test method on the UI thread, you can annotate the thread + with <code>@UIThreadTest</code>. Notice that this will run <em>all</em> of the method statements + on the UI thread. Methods that do not interact with the UI are not allowed; for example, you + can't invoke <code>Instrumentation.waitForIdleSync()</code>. </p> <p> - To run a subset of a test method on the UI thread, create an anonymous class of type - <code>Runnable</code>, put the statements you want in the <code>run()</code> method, and instantiate a new - instance of the class as a parameter to the method <code><em>appActivity</em>.runOnUiThread()</code>, where - <code><em>appActivity</em></code> is the instance of the app you are testing. + To run a subset of a test method on the UI thread, create an anonymous class of type + <code>Runnable</code>, put the statements you want in the <code>run()</code> method, and + instantiate a new instance of the class as a parameter to the method + <code><em>appActivity</em>.runOnUiThread()</code>, where <code><em>appActivity</em></code> is + the instance of the app you are testing. </p> <p> - For example, this code instantiates an activity to test, requests focus (a UI action) for the Spinner displayed - by the activity, and then sends a key to it. Notice that the calls to <code>waitForIdleSync</code> and <code>sendKeys</code> - aren't allowed to run on the UI thread:</p> + For example, this code instantiates an activity to test, requests focus (a UI action) for the + Spinner displayed by the activity, and then sends a key to it. Notice that the calls to + <code>waitForIdleSync</code> and <code>sendKeys</code> aren't allowed to run on the UI thread: +</p> <pre> private MyActivity mActivity; // MyActivity is the class name of the app under test private Spinner mSpinner; @@ -449,31 +541,36 @@ more realistic application.</li> <h3 id="NotouchMode">Turning off touch mode</h3> <p> - To control the emulator or a device with key events you send from your tests, you must turn off - touch mode. If you do not do this, the key events are ignored. + To control the emulator or a device with key events you send from your tests, you must turn off + touch mode. If you do not do this, the key events are ignored. </p> <p> - To turn off touch mode, you invoke <code>ActivityInstrumentationTestCase2.setActivityTouchMode(false)</code> - <em>before</em> you call <code>getActivity()</code> to start the activity. You must invoke the method in a test method - that is <em>not</em> running on the UI thread. For this reason, you can't invoke the touch mode method - from a test method that is annotated with <code>@UIThread</code>. Instead, invoke the touch mode method from <code>setUp()</code>. + To turn off touch mode, you invoke + <code>ActivityInstrumentationTestCase2.setActivityTouchMode(false)</code> + <em>before</em> you call <code>getActivity()</code> to start the activity. You must invoke the + method in a test method that is <em>not</em> running on the UI thread. For this reason, you + can't invoke the touch mode method from a test method that is annotated with + <code>@UIThread</code>. Instead, invoke the touch mode method from <code>setUp()</code>. </p> <h3 id="UnlockDevice">Unlocking the emulator or device</h3> <p> - You may find that UI tests don't work if the emulator's or device's home screen is disabled with the keyguard pattern. - This is because the application under test can't receive key events sent by <code>sendKeys()</code>. The best - way to avoid this is to start your emulator or device first and then disable the keyguard for the home screen. + You may find that UI tests don't work if the emulator's or device's home screen is disabled with + the keyguard pattern. This is because the application under test can't receive key events sent ' + by <code>sendKeys()</code>. The best way to avoid this is to start your emulator or device + first and then disable the keyguard for the home screen. </p> <p> - You can also explicitly disable the keyguard. To do this, - you need to add a permission in the manifest file (<code>AndroidManifest.xml</code>) and - then disable the keyguard in your application under test. Note, though, that you either have to remove this before - you publish your application, or you have to disable it programmatically in the published app. + You can also explicitly disable the keyguard. To do this, + you need to add a permission in the manifest file (<code>AndroidManifest.xml</code>) and + then disable the keyguard in your application under test. Note, though, that you either have to + remove this before you publish your application, or you have to disable it programmatically in + the published app. </p> <p> - To add the the permission, add the element <code><uses-permission android:name="android.permission.DISABLE_KEYGUARD"/></code> - as a child of the <code><manifest></code> element. To disable the KeyGuard, add the following code - to the <code>onCreate()</code> method of activities you intend to test: + To add the the permission, add the element + <code><uses-permission android:name="android.permission.DISABLE_KEYGUARD"/></code> + as a child of the <code><manifest></code> element. To disable the KeyGuard, add the + following code to the <code>onCreate()</code> method of activities you intend to test: </p> <pre> mKeyGuardManager = (KeyguardManager) getSystemService(KEYGUARD_SERVICE); @@ -483,7 +580,8 @@ more realistic application.</li> <p>where <code><em>activity_classname</em></code> is the class name of the activity.</p> <h3 id="UITestTroubleshooting">Troubleshooting UI tests</h3> <p> - This section lists some of the common test failures you may encounter in UI testing, and their causes: + This section lists some of the common test failures you may encounter in UI testing, and their + causes: </p> <dl> <dt><code>WrongThreadException</code></dt> @@ -491,27 +589,33 @@ more realistic application.</li> <p><strong>Problem:</strong></p> For a failed test, the Failure Trace contains the following error message: <code> - android.view.ViewRoot$CalledFromWrongThreadException: Only the original thread that created a view hierarchy can touch its views. + android.view.ViewRoot$CalledFromWrongThreadException: Only the original thread that created + a view hierarchy can touch its views. </code> <p><strong>Probable Cause:</strong></p> - This error is common if you tried to send UI events to the UI thread from outside the UI thread. This commonly happens if you send UI events - from the test application, but you don't use the <code>@UIThread</code> annotation or the <code>runOnUiThread()</code> method. The test method tried to interact with the UI outside the UI thread. + This error is common if you tried to send UI events to the UI thread from outside the UI + thread. This commonly happens if you send UI events from the test application, but you don't + use the <code>@UIThread</code> annotation or the <code>runOnUiThread()</code> method. The + test method tried to interact with the UI outside the UI thread. <p><strong>Suggested Resolution:</strong></p> - Run the interaction on the UI thread. Use a test class that provides instrumentation. See the previous section <a href="#RunOnUIThread">Testing on the UI Thread</a> + Run the interaction on the UI thread. Use a test class that provides instrumentation. See + the previous section <a href="#RunOnUIThread">Testing on the UI Thread</a> for more details. </dd> <dt><code>java.lang.RuntimeException</code></dt> <dd> <p><strong>Problem:</strong></p> - For a failed test, the Failure Trace contains the following error message: + For a failed test, the Failure Trace contains the following error message: <code> java.lang.RuntimeException: This method can not be called from the main application thread </code> <p><strong>Probable Cause:</strong></p> - This error is common if your test method is annotated with <code>@UiThreadTest</code> but then tries to - do something outside the UI thread or tries to invoke <code>runOnUiThread()</code>. + This error is common if your test method is annotated with <code>@UiThreadTest</code> but + then tries to do something outside the UI thread or tries to invoke + <code>runOnUiThread()</code>. <p><strong>Suggested Resolution:</strong></p> - Remove the <code>@UiThreadTest</code> annotation, remove the <code>runOnUiThread()</code> call, or re-factor your tests. + Remove the <code>@UiThreadTest</code> annotation, remove the <code>runOnUiThread()</code> + call, or re-factor your tests. </dd> </dl> |