1 page.title=Activity Testing 2 @jd:body 3 <div id="qv-wrapper"> 4 <div id="qv"> 5 <h2>In this document</h2> 6 <ol> 7 <li> 8 <a href="#Prerequisites">Prerequisites</a> 9 </li> 10 <li> 11 <a href="#DownloadCode">Installing the Tutorial Sample Code</a> 12 </li> 13 <li> 14 <a href="#SetupEmulator">Setting Up the Emulator</a> 15 </li> 16 <li> 17 <a href="#SetupProjects">Setting Up the Projects</a> 18 </li> 19 <li> 20 <a href="#CreateTestCaseClass">Creating the Test Case Class</a> 21 <ol> 22 <li> 23 <a href="#AddTestCaseClass">Adding the test case class file</a> 24 </li> 25 <li> 26 <a href="#AddConstructor">Adding the test case constructor</a> 27 </li> 28 <li> 29 <a href="#AddSetupMethod">Adding the setup method</a> 30 </li> 31 <li> 32 <a href="#AddPreConditionsTest">Adding an initial conditions test</a> 33 </li> 34 <li> 35 <a href="#AddUITest">Adding a UI test</a> 36 </li> 37 <li> 38 <a href="#StateManagementTests">Adding state management tests</a> 39 </li> 40 </ol> 41 </li> 42 <li> 43 <a href="#RunTests">Running the Tests and Seeing the Results</a> 44 </li> 45 <li> 46 <a href="#TestFailure">Forcing Some Tests to Fail</a> 47 </li> 48 <li> 49 <a href="#NextSteps">Next Steps</a> 50 </li> 51 </ol> 52 <h2 id="#Appendix">Appendix</h2> 53 <ol> 54 <li> 55 <a href="#InstallCompletedTestApp">Installing the Completed Test Application Java File</a> 56 </li> 57 <li> 58 <a href="#EditorCommandLine">For Users Not Developing In Eclipse</a> 59 </li> 60 </ol> 61 <h2>Related Tutorials</h2> 62 <ol> 63 <li> 64 <a href="{@docRoot}resources/tutorials/testing/helloandroid_test.html">Hello, Testing</a> 65 </li> 66 </ol> 67 <h2>See Also</h2> 68 <ol> 69 <li> 70 <a href="{@docRoot}guide/topics/testing/testing_android.html">Testing Android Applications</a> 71 </li> 72 <li> 73 {@link android.test.ActivityInstrumentationTestCase2} 74 </li> 75 <li> 76 {@link junit.framework.Assert} 77 </li> 78 <li> 79 {@link android.test.InstrumentationTestRunner} 80 </li> 81 </ol> 82 </div> 83 </div> 84 <p> 85 Android includes powerful tools for testing applications. The tools extend JUnit with additional features, provide convenience classes for mock Android system objects, and use 86 instrumentation to give you control over your main application while you are testing it. The entire Android testing environment is discussed in the document 87 <a href="{@docRoot}guide/topics/testing/testing_android.html">Testing Android Applications</a>. 88 </p> 89 <p> 90 This tutorial demonstrates the Android testing tools by presenting a simple Android application and then leading you step-by-step through the creation of a test application for it. 91 The test application demonstrates these key points: 92 </p> 93 <ul> 94 <li> 95 An Android test is itself an Android application that is linked to the application under test by entries in its <code>AndroidManifest.xml</code> file. 96 </li> 97 <li> 98 Instead of Android components, an Android test application contains one or more test cases. Each of these is a separate class definition. 99 </li> 100 <li> 101 Android test case classes extend the JUnit {@link junit.framework.TestCase} class. 102 </li> 103 <li> 104 Android test case classes for activities extend JUnit and also connect you to the application under test with instrumentation. You can send keystroke or touch events directly to the UI. 105 </li> 106 <li> 107 You choose an Android test case class based on the type of component (application, activity, content provider, or service) you are testing. 108 </li> 109 <li> 110 Additional test tools in Eclipse/ADT provide integrated support for creating test applications, running them, and viewing the results. 111 </li> 112 </ul> 113 <p> 114 The test application contains methods that perform the following tests: 115 </p> 116 <ul> 117 <li> 118 Initial conditions test. Tests that the application under test initializes correctly. This is also a unit test of the application's 119 {@link android.app.Activity#onCreate(android.os.Bundle) onCreate()} method. Testing initial conditions also provides a confidence measure for subsequent tests. 120 </li> 121 <li> 122 UI test. Tests that the main UI operation works correctly. This test demonstrates the instrumentation features available in activity testing. 123 It shows that you can automate UI tests by sending key events from the test application to the main application. 124 </li> 125 <li> 126 State management tests. Test the application's code for saving state. This test demonstrates the instrumentation features of the test runner, which 127 are available for testing any component. 128 </li> 129 </ul> 130 <h2 id="Prerequisites">Prerequisites</h2> 131 <p> 132 The instructions and code in this tutorial depend on the following: 133 </p> 134 <ul> 135 <li> 136 Basic knowledge of Android programming. If you haven't yet written an Android application, do the 137 <a href="{@docRoot}resources/tutorials/hello-world.html">Hello, World</a> tutorial. If you 138 want to learn more about Spinner, the application under test, then you might want to visit the 139 <a href="{@docRoot}resources/tutorials/views/hello-spinner.html">Hello Views > Spinner</a> example. 140 </li> 141 <li> 142 Some familiarity with the Android testing framework and concepts. If you haven't explored 143 Android testing yet, start by reading the Developer Guide topic <a href="{@docRoot}guide/topics/testing/testing_android.html">Testing Android Applications</a> 144 or following the <a href="{@docRoot}resources/tutorials/testing/helloandroid_test.html"> 145 Hello, Testing</a> tutorial. 146 </li> 147 <li> 148 Eclipse with ADT. This tutorial describes how to set up and run a test application using 149 Eclipse with ADT. If you haven't yet installed Eclipse and the ADT plugin, 150 follow the steps in <a href="{@docRoot}sdk/installing.html">Installing the SDK</a> 151 to install them before continuing. If you are not developing in Eclipse, you will 152 find instructions for setting up and running the test application in the 153 <a href="#EditorCommandLine">appendix</a> of this document. 154 </li> 155 <li> 156 Android 1.5 platform (API Level 3) or higher. You must have the Android 1.5 platform 157 (API Level 3) or higher installed in your SDK, because this tutorial uses APIs that 158 were introduced in that version. 159 <p> 160 If you are not sure which platforms are installed in your SDK, 161 open the Android SDK and AVD Manager and check in the 162 <strong>Installed Packages</strong> panel. 163 If aren't sure how to download a platform into your SDK, 164 read <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>. 165 </p> 166 </li> 167 </ul> 168 <h2 id="DownloadCode">Installing the Tutorial Sample Code</h2> 169 <p> 170 During this tutorial, you will be working with sample code that is provided as part 171 of the downloadable Samples component of the SDK. Specifically, you will be working 172 with a pair of related sample applications — an application under test and a test 173 application: 174 </p> 175 <ul> 176 <li> 177 Spinner is the application under test. This tutorial focuses on the 178 common situation of writing tests for an application that already exists, so the main 179 application is provided to you. 180 </li> 181 <li> 182 SpinnerTest is the test application. In the tutorial, you create this application 183 step-by-step. If you want to run quickly through the tutorial, 184 you can install the completed SpinnerTest application first, and then follow the 185 text. You may get more from the tutorial, however, if you create the test application 186 as you go. The instructions for installing the completed test application are in the 187 section <a href="#InstallCompletedTestApp">Installing the Completed Test Application Java File</a>. 188 </li> 189 </ul> 190 <p> 191 The sample applications are provided in the SDK component named 192 "Samples for SDK API 8" and in later versions of the Samples. 193 </p> 194 <p> 195 To get started with the tutorial, first use the Android SDK and AVD manager to install an 196 appropriate version of the Samples: 197 </p> 198 <ol> 199 <li> 200 In Eclipse, select <strong>Window</strong> > <strong>Android SDK and AVD Manager</strong>. 201 </li> 202 <li> 203 Open the <strong>Installed Packages</strong> panel and check whether 204 "Samples for SDK API 8" (or higher version) is listed. 205 If so, skip to the next section, 206 <a href="#SetupProjects">Setting Up the Projects</a>, to get started with the tutorial. 207 Otherwise, continue with the next step. 208 </li> 209 <li> 210 Open the <strong>Available Packages</strong> panel. 211 </li> 212 <li> 213 Select the "Samples for SDK API 8" component and click <strong>Install Selected</strong>. 214 </li> 215 <li> 216 Verify and accept the component and then click <strong>Install Accepted</strong>. 217 The Samples component will now be installed into your SDK. 218 </li> 219 </ol> 220 <p> 221 When the installation is complete, the applications in the 222 Samples component are stored at this location on your computer: 223 </p> 224 <p style="margin-left:2em"> 225 <code><<em>sdk</em>>/samples/android-8/</code> 226 </p> 227 <p> 228 For general information about the Samples, see 229 <a href="{@docRoot}resources/samples/get.html">Getting the Samples</a> 230 </p> 231 <p class="note"> 232 <strong>Note:</strong> Although the sample code for this tutorial is provided in the 233 "Samples for SDK API 8" component, that does not imply that you need to build or 234 run the application against the corresponding platform (Android 2.2). 235 The API level referenced in the Samples component name indicates only the origin branch from 236 which the samples were built. 237 </p> 238 <h2 id="SetupEmulator">Setting Up the Emulator</h2> 239 <p> 240 In this tutorial, you will use the Android emulator to run applications. The emulator needs 241 an Android Virtual Device (AVD) with an API level equal to or higher than the one you set for the projects in the previous step. 242 To find out how to check this and create the right AVD if necessary, see <a href="{@docRoot}guide/developing/eclipse-adt.html#AVD">Creating an AVD</a>. 243 </p> 244 <p> 245 As a test of the AVD and emulator, run the SpinnerActivity application in Eclipse with ADT. When it starts, 246 click the large downward-pointing arrow to the right of the spinner text. You see the spinner expand and display the title "Select a planet" at the top. 247 Click one of the other planets. The spinner closes, and your selection appears below it on the screen. 248 </p> 249 <h2 id="SetupProjects">Setting Up the Projects</h2> 250 <p> 251 When you are ready to get started with the tutorial, begin by setting up Eclipse projects for 252 both Spinner (the application under test) and SpinnerTest (the test application). 253 </p> 254 <p> 255 You'll be using the Spinner application as-is, without modification, so you'll be loading it 256 into Eclipse as a new Android project from existing source. In the process, you'll be 257 creating a new test project associated with Spinner that will contain the SpinnerTest 258 application. The SpinnerTest application will be completely new and you'll be 259 using the code examples in this tutorial to add test classes and tests to it. 260 </p> 261 <p> 262 To install the Spinner app in a new Android project from existing source, following these steps: 263 </p> 264 <ol> 265 <li> 266 In Eclipse, select <strong>File</strong> > <strong>New</strong> > <strong>Project</strong> > <strong>Android</strong> > <strong>Android Project</strong>, 267 then click Next. The <strong>New Android Project</strong> dialog appears. 268 </li> 269 <li> 270 In the <em>Project name</em> text box, enter "SpinnerActivity". The <em>Properties</em> area is filled in automatically. 271 </li> 272 <li> 273 In the <em>Contents</em> area, set "Create project from existing source". 274 </li> 275 <li> 276 For <em>Location</em>, click <strong>Browse</strong>, navigate to the directory <code><SDK_path>/samples/android-8/Spinner</code>, 277 then click Open. The directory name <code><SDK_path>/samples/android-8/Spinner</code> now appears in the <em>Location</em> text box. 278 </li> 279 <li> 280 In the <em>Build Target</em> area, set a API level of 3 or higher. If you are already developing with a particular target, and it is API level 3 or higher, then use that target. 281 </li> 282 <li> 283 In the <em>Properties</em> area, in the <em>Min SDK Version:</em>, enter "3". 284 </li> 285 <li> 286 You should now see these values: 287 <ul> 288 <li><em>Project Name:</em> "SpinnerActivity"</li> 289 <li><em>Create project from existing source:</em> set</li> 290 <li><em>Location:</em> "<code><SDK_path>/samples/android-8/Spinner</code>"</li> 291 <li><em>Build Target:</em> "API level of 3 or higher" (<em>Target Name</em> "Android 1.5 or higher")</li> 292 <li><em>Package name:</em> (disabled, set to "<code>com.android.example.spinner</code>")</li> 293 <li><em>Create Activity:</em> (disabled, set to ".SpinnerActivity")</li> 294 <li><em>Min SDK Version:</em> "3"</li> 295 </ul> 296 <p> 297 The following screenshot summarizes these values: 298 </p> 299 <a href="{@docRoot}images/testing/eclipse_new_android_project_complete_callouts.png"> 300 <img src="{@docRoot}images/testing/eclipse_new_android_project_complete_callouts.png" alt="New Android Project dialog with filled-in values" style="height:230px"/> 301 </a> 302 303 </li> 304 </ol> 305 <p> 306 To create a new test project for the SpinnerTest application, follow these steps: 307 </p> 308 <ol> 309 <li> 310 Click Next. The <strong>New Android Test Project</strong> dialog appears. 311 </li> 312 <li> 313 Set "Create a Test Project". 314 </li> 315 <li> 316 Leave the other values unchanged. The result should be: 317 <ul> 318 <li><em>Create a Test Project:</em> checked</li> 319 <li><em>Test Project Name:</em> "SpinnerActivityTest"</li> 320 <li><em>Use default location:</em> checked (this should contain the directory name "<code>workspace/SpinnerActivityTest</code>").</li> 321 <li><em>Build Target:</em> Use the same API level you used in the previous step.</li> 322 <li><em>Application name:</em> "SpinnerActivityTest"</li> 323 <li><em>Package name:</em> "<code>com.android.example.spinner.test</code>"</li> 324 <li><em>Min SDK Version:</em> "3"</li> 325 </ul> 326 <p> 327 The following screenshot summarizes these values: 328 </p> 329 <a href="{@docRoot}images/testing/eclipse_new_android_testproject_complete_callouts.png"> 330 <img src="{@docRoot}images/testing/eclipse_new_android_testproject_complete_callouts.png" alt="New Android Test Project dialog with filled-in values" style="height:230px"/> 331 </a> 332 </li> 333 <li> 334 Click Finish. Entries for SpinnerActivity and SpinnerActivityTest should appear in the 335 <strong>Package Explorer</strong>. 336 <p class="note"> 337 <strong>Note:</strong> If you set <em>Build Target</em> to an API level higher than "3", you will see the warning 338 "The API level for the selected SDK target does not match the Min SDK version". You do not need to change the API level or the Min SDK version. 339 The message tells you that you are building the projects with one particular API level, but specifying that a lower API level is required. This may 340 occur if you have chosen not to install the optional earlier API levels. 341 </p> 342 <p> 343 If you see errors listed in the <strong>Problems</strong> pane at the bottom of the Eclipse window, or if a red error marker appears next to 344 the entry for SpinnerActivity in the Package Explorer, highlight the SpinnerActivity entry and then select 345 <strong>Project</strong> > <strong>Clean</strong>. This should fix any errors. 346 </p> 347 </li> 348 </ol> 349 <p> 350 You now have the application under test in the SpinnerActivity project, 351 and an empty test project in SpinnerActivityTest. You may 352 notice that the two projects are in different directories, but Eclipse with 353 ADT handles this automatically. You should have no problem in either building or running them. 354 </p> 355 <p> 356 Notice that Eclipse and ADT have already done some initial setup for your test application. 357 Expand the SpinnerActivityTest project, and notice that it already has an 358 Android manifest file <code>AndroidManifest.xml</code>. 359 Eclipse with ADT created this when you added the test project. 360 Also, the test application is already set up to use instrumentation. You can see this 361 by examining <code>AndroidManifest.xml</code>. 362 Open it, then at the bottom of the center pane click <strong>AndroidManifest.xml</strong> 363 to display the XML contents: 364 </p> 365 <pre> 366 <?xml version="1.0" encoding="utf-8"?> 367 <manifest xmlns:android="http://schemas.android.com/apk/res/android" 368 package="com.android.example.spinner.test" 369 android:versionCode="1" 370 android:versionName="1.0"> 371 <application android:icon="@drawable/icon" android:label="@string/app_name"> 372 373 <uses-library android:name="android.test.runner" /> 374 </application> 375 <uses-sdk android:minSdkVersion="3" /> 376 <instrumentation 377 android:targetPackage="com.android.example.spinner" 378 android:name="android.test.InstrumentationTestRunner" /> 379 </manifest> 380 </pre> 381 <p> 382 Notice the <code><instrumentation></code> element. The attribute 383 <code>android:targetPackage="com.android.example.spinner"</code> tells Android that the 384 application under test is defined in the Android package 385 <code>com.android.example.spinner</code>. Android now knows to use that 386 package's <code>AndroidManifest.xml</code> file to launch the application under test. 387 The <code><instrumentation></code> element also contains the attribute 388 <code>android:name="android.test.InstrumentationTestRunner"</code>, which tells Android 389 instrumentation to run the test application with Android's instrumentation-enabled test runner. 390 </p> 391 <h2 id="CreateTestCaseClass">Creating the Test Case Class</h2> 392 393 <p> 394 You now have a test project SpinnerActivityTest, and the basic structure of a test 395 application also called SpinnerActivityTest. The basic structure includes all the files and 396 directories you need to build and run a test application, except for the class that 397 contains your tests (the test case class). 398 </p> 399 <p> 400 The next step is to define the test case class. In this tutorial, you'll be creating a 401 test case class that includes: 402 </p> 403 <ul> 404 <li> 405 Test setup. This use of the JUnit {@link junit.framework.TestCase#setUp() setUp()} 406 method demonstrates some of the tasks you might perform before running an Android test. 407 </li> 408 <li> 409 Testing initial conditions. This test demonstrates a good testing technique. 410 It also demonstrates that with Android instrumentation you can look at the application 411 under test <em>before</em> the main activity starts. The test checks that the application's 412 important objects have been initialized. 413 If the test fails, you then know that any other tests against the application are 414 unreliable, since the application was running in an incorrect state. 415 <p class="note"> 416 <strong>Note:</strong> The purpose of testing initial conditions is not the same as 417 using <code>setUp()</code>. The JUnit {@link junit.framework.TestCase#setUp()} runs once 418 before <strong>each test method</strong>, and its purpose is to create a clean test 419 environment. The initial conditions test runs once, and its purpose is to verify that the 420 application under test is ready to be tested. 421 </p> 422 </li> 423 <li> 424 Testing the UI. This test shows how to control the main application's UI 425 with instrumentation, a powerful automation feature of Android testing. 426 </li> 427 <li> 428 Testing state management. This test shows some techniques for testing how 429 well the application maintains state in the Android environment. Remember that to 430 provide a satisfactory user experience, your application must never lose its current state, 431 even if it's interrupted by a phone call or destroyed because of memory constraints. 432 The Android activity lifecycle provides ways to maintain state, and the 433 <code>SpinnerActivity</code> application uses them. The test shows the techniques for 434 verifying that they work. 435 </li> 436 </ul> 437 <p> 438 Android tests are contained in a special type of Android application that contains one or more test class definitions. Each of these contains 439 one or more test methods that do the actual tests. In this tutorial, you will first add a test case class, and then add tests to it. 440 </p> 441 <p> 442 You first choose an Android test case class to extend. You choose from the base test case classes according to the Android component you are testing and the types of tests you are doing. 443 In this tutorial, the application under test has a single simple activity, so the test case class will be for an Activity component. Android offers several, but the one that tests in 444 the most realistic environment is {@link android.test.ActivityInstrumentationTestCase2}, so you will use it as the base class. Like all activity test case classes, 445 <code>ActivityInstrumentationTestCase2</code> offers convenience methods for interacting directly with the UI of the application under test. 446 </p> 447 <h3 id="AddTestCaseClass">Adding the test case class file</h3> 448 <p> 449 To add <code>ActivityInstrumentationTestCase2</code> as the base test case class, follow these steps: 450 </p> 451 <ol> 452 <li> 453 In the Package Explorer, expand the test project SpinnerActivityTest if it is not open already. 454 </li> 455 <li> 456 Within SpinnerActivityTest, expand the <code>src/</code> folder and then the package marker for 457 <code>com.android.example.spinner.test</code>. Right-click on the package name and select <strong>New</strong> > <strong>Class</strong>:<br/> 458 <a href="{@docRoot}images/testing/spinner_create_test_class_callouts.png"> 459 <img alt="Menu for creating a new class in the test application" src="{@docRoot}images/testing/spinner_create_test_class_callouts.png" style="height:230px"/> 460 </a> 461 <p> 462 The <strong>New Java Class</strong> wizard appears: 463 </p> 464 <a href="{@docRoot}images/testing/spinnertest_new_class_callouts.png"> 465 <img alt="New Java Class wizard dialog" src="{@docRoot}images/testing/spinnertest_new_class_callouts.png" style="height:230px"/> 466 </a> 467 </li> 468 <li> 469 In the wizard, enter the following: 470 <ul> 471 <li> 472 <em>Name:</em> "SpinnerActivityTest". This becomes the name of your test class. 473 </li> 474 <li> 475 <em>Superclass:</em> "<code>android.test.ActivityInstrumentationTestCase2<SpinnerActivity></code>". The superclass is parameterized, so 476 you have to provide it your main application's class name. 477 </li> 478 </ul> 479 <p> 480 Do not change any of the other settings. Click Finish. 481 </p> 482 </li> 483 <li> 484 You now have a new file <code>SpinnerActivityTest.java</code> in the project. 485 </li> 486 <li> 487 To resolve the reference to SpinnerActivity, add the following import: 488 <pre> 489 import com.android.example.spinner.SpinnerActivity; 490 </pre> 491 </li> 492 </ol> 493 <h3 id="AddConstructor">Adding the test case constructor</h3> 494 <p> 495 To ensure that the test application is instantiated correctly, you must set up a constructor that the test 496 runner will call when it instantiates your test class. This constructor has no parameters, and its sole 497 purpose is to pass information to the superclass's default constructor. To set up this constructor, enter the 498 following code in the class: 499 </p> 500 <pre> 501 public SpinnerActivityTest() { 502 super("com.android.example.spinner", SpinnerActivity.class); 503 } // end of SpinnerActivityTest constructor definition 504 </pre> 505 <p> 506 This calls the superclass constructor with the Android package name (<code>com.android.example.spinner</code>)and main activity's class 507 (<code>SpinnerActivity.class</code>) for the application under test. Android uses this information to find the application and activity to test. 508 </p> 509 <p> 510 You are now ready to add tests, by adding test methods to the class. 511 </p> 512 <h3 id="AddSetupMethod">Adding the setup method</h3> 513 <p> 514 The <code>setUp()</code> method is invoked before every test. You use it to initialize variables and clean up from previous tests. You can also use 515 the JUnit {@link junit.framework.TestCase#tearDown() tearDown()} method, which runs <strong>after</strong> every test method. The tutorial does not use it. 516 </p> 517 <p> 518 The method you are going to add does the following: 519 </p> 520 <ul> 521 <li> 522 <code>super.setUp()</code>. Invokes the superclass constructor for <code>setUp()</code>, which is required by JUnit. 523 </li> 524 <li> 525 Calls {@link android.test.ActivityInstrumentationTestCase2#setActivityInitialTouchMode(boolean) setActivityInitialTouchMode(false)}. 526 This turns off <strong>touch mode</strong> in the device or emulator. If any of your test methods send key events to the application, 527 you must turn off touch mode <em>before</em> you start any activities; otherwise, the call is ignored. 528 </li> 529 <li> 530 Stores references to system objects. Retrieves and stores a reference to the activity under test, the <code>Spinner</code> 531 widget used by the activity, the <code>SpinnerAdapter</code> that backs the widget, and the string value of the selection that is 532 set when the application is first installed. These objects are used in the state management test. The methods invoked are: 533 <ul> 534 <li> 535 {@link android.test.ActivityInstrumentationTestCase2#getActivity()}. Gets a reference to the activity under test (<code>SpinnerActivity</code>). 536 This call also starts the activity if it is not already running. 537 </li> 538 <li> 539 {@link android.app.Activity#findViewById(int)}. Gets a reference to the <code>Spinner</code> widget of the application under test. 540 </li> 541 <li> 542 {@link android.widget.AbsSpinner#getAdapter()}. Gets a reference to the adapter (an array of strings) backing the spinner. 543 </li> 544 </ul> 545 </li> 546 </ul> 547 <p> 548 Add this code to the definition of <code>SpinnerActivityTest</code>, after the constructor definition: 549 </p> 550 <pre> 551 @Override 552 protected void setUp() throws Exception { 553 super.setUp(); 554 555 setActivityInitialTouchMode(false); 556 557 mActivity = getActivity(); 558 559 mSpinner = 560 (Spinner) mActivity.findViewById( 561 com.android.example.spinner.R.id.Spinner01 562 ); 563 564 mPlanetData = mSpinner.getAdapter(); 565 566 } // end of setUp() method definition 567 </pre> 568 <p> 569 Add these members to the test case class: 570 </p> 571 <pre> 572 private SpinnerActivity mActivity; 573 private Spinner mSpinner; 574 private SpinnerAdapter mPlanetData; 575 </pre> 576 <p> 577 Add these imports: 578 </p> 579 <pre> 580 import android.widget.Spinner; 581 import android.widget.SpinnerAdapter; 582 </pre> 583 <p> 584 You now have the the complete <code>setUp()</code> method. 585 </p> 586 <h3 id="AddPreConditionsTest">Adding an initial conditions test</h3> 587 <p> 588 The initial conditions test verifies that the application under test is initialized correctly. It is an illustration of the types of tests you can run, so it is not comprehensive. 589 It verifies the following: 590 </p> 591 <ul> 592 <li> 593 The item select listener is initialized. This listener is called when a selection is made from the spinner. 594 </li> 595 <li> 596 The adapter that provides values to the spinner is initialized. 597 </li> 598 <li> 599 The adapter contains the right number of entries. 600 </li> 601 </ul> 602 <p> 603 The actual initialization of the application under test is done in <code>setUp()</code>, which the test runner calls automatically before every test. The verifications are 604 done with JUnit {@link junit.framework.Assert} calls. As a useful convention, the method name is <code>testPreConditions()</code>: 605 </p> 606 <pre> 607 public void testPreConditions() { 608 assertTrue(mSpinner.getOnItemSelectedListener() != null); 609 assertTrue(mPlanetData != null); 610 assertEquals(mPlanetData.getCount(),ADAPTER_COUNT); 611 } // end of testPreConditions() method definition 612 </pre> 613 <p> 614 Add this member: 615 </p> 616 <pre> 617 public static final int ADAPTER_COUNT = 9; 618 </pre> 619 <h3 id="AddUITest">Adding a UI test</h3> 620 <p> 621 Now create a UI test that selects an item from the <code>Spinner</code> widget. The test sends key events to the UI with key events. 622 The test confirms that the selection matches the result you expect. 623 </p> 624 <p> 625 This test demonstrates the power of using instrumentation in Android testing. Only an instrumentation-based test class allows you to send key events (or touch events) 626 to the application under test. With instrumentation, you can test your UI without having to take screenshots, record the screen, or do human-controlled testing. 627 </p> 628 <p> 629 To work with the spinner, the test has to request focus for it and then set it to a known position. The test uses {@link android.view.View#requestFocus() requestFocus()} and 630 {@link android.widget.AbsSpinner#setSelection(int) setSelection()} to do this. Both of these methods interact with a View in the application under test, so you have to call them 631 in a special way. 632 </p> 633 <p> 634 Code in a test application that interacts with a View of the application under test must run in the main application's thread, also 635 known as the <em>UI thread</em>. To do this, you use the {@link android.app.Activity#runOnUiThread(java.lang.Runnable) Activity.runOnUiThread()} 636 method. You pass the code to <code>runOnUiThread()</code>in an anonymous {@link java.lang.Runnable Runnable} object. To set 637 the Java statements in the <code>Runnable</code> object, you override the object's {@link java.lang.Runnable#run()} method. 638 </p> 639 <p> 640 To send key events to the UI of the application under test, you use the <a href="{@docRoot}reference/android/test/InstrumentationTestCase.html#sendKeys(int...)">sendKeys</a>() method. 641 This method does not have to run on the UI thread, since Android uses instrumentation to pass the key events to the application under test. 642 </p> 643 <p> 644 The last part of the test compares the selection made by sending the key events to a pre-determined value. This tests that the spinner is working as intended. 645 </p> 646 <p> 647 The following sections show you how to add the code for this test. 648 </p> 649 <ol> 650 <li> 651 Get focus and set selection. Create a new method <code>public void testSpinnerUI()</code>. Add 652 code to to request focus for the spinner and set its position to default or initial position, "Earth". This code is run on the UI thread of 653 the application under test: 654 <pre> 655 public void testSpinnerUI() { 656 657 mActivity.runOnUiThread( 658 new Runnable() { 659 public void run() { 660 mSpinner.requestFocus(); 661 mSpinner.setSelection(INITIAL_POSITION); 662 } // end of run() method definition 663 } // end of anonymous Runnable object instantiation 664 ); // end of invocation of runOnUiThread 665 </pre> 666 <p> 667 Add the following member to the test case class. 668 </p> 669 <pre> 670 public static final int INITIAL_POSITION = 0; 671 </pre> 672 </li> 673 <li> 674 Make a selection. Send key events to the spinner to select one of the items. To do this, open the spinner by 675 "clicking" the center keypad button (sending a DPAD_CENTER key event) and then clicking (sending) the down arrow keypad button five times. Finally, 676 click the center keypad button again to highlight the desired item. Add the following code: 677 <pre> 678 this.sendKeys(KeyEvent.KEYCODE_DPAD_CENTER); 679 for (int i = 1; i <= TEST_POSITION; i++) { 680 this.sendKeys(KeyEvent.KEYCODE_DPAD_DOWN); 681 } // end of for loop 682 683 this.sendKeys(KeyEvent.KEYCODE_DPAD_CENTER); 684 </pre> 685 <p> 686 Add the following member to the test case class: 687 </p> 688 <pre> 689 public static final int TEST_POSITION = 5; 690 </pre> 691 <p> 692 This sets the final position of the spinner to "Saturn" (the spinner's backing adapter is 0-based). 693 </p> 694 </li> 695 <li> 696 Check the result. Query the current state of the spinner, and compare its current selection to the expected value. 697 Call the method {@link android.widget.AdapterView#getSelectedItemPosition() getSelectedItemPosition()} to find out the current selection position, and then 698 {@link android.widget.AdapterView#getItemAtPosition(int) getItemAtPosition()} to get the object corresponding to that position (casting it to a String). Assert that 699 this string value matches the expected value of "Saturn": 700 <pre> 701 mPos = mSpinner.getSelectedItemPosition(); 702 mSelection = (String)mSpinner.getItemAtPosition(mPos); 703 TextView resultView = 704 (TextView) mActivity.findViewById( 705 com.android.example.spinner.R.id.SpinnerResult 706 ); 707 708 String resultText = (String) resultView.getText(); 709 710 assertEquals(resultText,mSelection); 711 712 } // end of testSpinnerUI() method definition 713 </pre> 714 <p> 715 Add the following members to the test case class: 716 </p> 717 <pre> 718 private String mSelection; 719 private int mPos; 720 </pre> 721 <p> 722 Add the following imports to the test case class: 723 </p> 724 <pre> 725 import android.view.KeyEvent; 726 import android.widget.TextView; 727 </pre> 728 </li> 729 </ol> 730 <p> 731 Pause here to run the tests you have. The procedure for running a test application is different 732 from running a regular Android application. You run a test application as an Android JUnit 733 application. To see how to do this, see <a href="#RunTests">Running the Tests and Seeing the Results</a>. 734 </p> 735 <p> 736 Eventually, you will see the <code>SpinnerActivity</code> application start, and the test 737 application controlling it by sending it key events. You will also see a new 738 <strong>JUnit</strong> view in the Explorer pane, showing the results of the 739 test. The JUnit view is documented in a following section, 740 <a href="#RunTests">Running the Test and Seeing the Results</a>. 741 </p> 742 <h3 id="StateManagementTests">Adding state management tests</h3> 743 <p> 744 You now write two tests that verify that SpinnerActivity maintains its state when it is paused or terminated. 745 The state, in this case, is the current selection in the spinner. When users make a selection, 746 pause or terminate the application, and then resume or restart it, they should see 747 the same selection. 748 </p> 749 <p> 750 Maintaining state is an important feature of an application. Users may switch from the current 751 application temporarily to answer the phone, and then switch back. Android may decide to 752 terminate and restart an activity to change the screen orientation, or terminate an unused 753 activity to regain storage. In each case, users are best served by having the UI return to its 754 previous state (except where the logic of the application dictates otherwise). 755 </p> 756 <p> 757 SpinnerActivity manages its state in these ways: 758 </p> 759 <ul> 760 <li> 761 Activity is hidden. When the spinner screen (the activity) is running but hidden by some other screen, it 762 stores the spinner's position and value in a form that persists while the application is running. 763 </li> 764 <li> 765 Application is terminated. When the activity is terminated, it stores the spinner's position and value in 766 a permanent form. The activity can read the position and value when it restarts, and restore the spinner to its previous state. 767 </li> 768 <li> 769 Activity re-appears. When the user returns to the spinner screen, the previous selection is restored. 770 </li> 771 <li> 772 Application is restarted. When the user starts the application again, the previous selection is restored. 773 </li> 774 </ul> 775 <p class="note"> 776 <strong>Note:</strong> An application can manage its state in other ways as well, but these are 777 not covered in this tutorial. 778 </p> 779 <p> 780 When an activity is hidden, it is <strong>paused</strong>. When it re-appears, it 781 <strong>resumes</strong>. Recognizing that these are key points in an activity's life cycle, 782 the Activity class provides two callback methods {@link android.app.Activity#onPause()} and 783 {@link android.app.Activity#onResume()} for handling pauses and resumes. 784 SpinnerActivity uses them for code that saves and restores state. 785 </p> 786 <p> 787 <strong>Note:</strong> If you would like to learn more about the difference between losing 788 focus/pausing and killing an application, 789 refer to the <a href="{@docRoot}guide/topics/fundamentals.html#actlife">Activity Lifecycle</a> 790 section. 791 </p> 792 <p> 793 The first test verifies that the spinner selection is maintained after the entire application is shut down and then restarted. The test uses instrumentation to 794 set the spinner's variables outside of the UI. It then terminates the activity by calling {@link android.app.Activity#finish() Activity.finish()}, and restarts it 795 using the instrumentation method {@link android.test.ActivityInstrumentationTestCase2#getActivity()}. The test then asserts that the current spinner state matches 796 the test values. 797 </p> 798 <p> 799 The second test verifies that the spinner selection is maintained after the activity is paused and then resumed. The test uses instrumentation to 800 set the spinner's variables outside of the UI and then force calls to the <code>onPause()</code> and <code>onResume()</code> methods. The test then 801 asserts that the current spinner state matches the test values. 802 </p> 803 <p> 804 Notice that these tests make limited assumptions about the mechanism by which the activity manages state. The tests use the activity's getters and 805 setters to control the spinner. The first test also knows that hiding an activity calls <code>onPause()</code>, and bringing it back to the foreground 806 calls <code>onResume()</code>. Other than this, the tests treat the activity as a "black box". 807 </p> 808 <p> 809 To add the code for testing state management across shutdown and restart, follow these steps: 810 </p> 811 <ol> 812 <li> 813 Add the test method <code>testStateDestroy()</code>, then 814 set the spinner selection to a test value: 815 <pre> 816 public void testStateDestroy() { 817 mActivity.setSpinnerPosition(TEST_STATE_DESTROY_POSITION); 818 mActivity.setSpinnerSelection(TEST_STATE_DESTROY_SELECTION); 819 </pre> 820 </li> 821 <li> 822 Terminate the activity and restart it: 823 <pre> 824 mActivity.finish(); 825 mActivity = this.getActivity(); 826 </pre> 827 </li> 828 <li> 829 Get the current spinner settings from the activity: 830 <pre> 831 int currentPosition = mActivity.getSpinnerPosition(); 832 String currentSelection = mActivity.getSpinnerSelection(); 833 </pre> 834 </li> 835 <li> 836 Test the current settings against the test values: 837 <pre> 838 assertEquals(TEST_STATE_DESTROY_POSITION, currentPosition); 839 assertEquals(TEST_STATE_DESTROY_SELECTION, currentSelection); 840 } // end of testStateDestroy() method definition 841 </pre> 842 <p> 843 Add the following members to the test case class: 844 <pre> 845 public static final int TEST_STATE_DESTROY_POSITION = 2; 846 public static final String TEST_STATE_DESTROY_SELECTION = "Earth"; 847 </pre> 848 </li> 849 </ol> 850 <p> 851 To add the code for testing state management across a pause and resume, follow these steps: 852 </p> 853 <ol> 854 <li> 855 Add the test method <code>testStatePause()</code>: 856 <pre> 857 @UiThreadTest 858 public void testStatePause() { 859 </pre> 860 <p> 861 The <code>@UiThreadTest</code> annotation tells Android to build this method so that it runs 862 on the UI thread. This allows the method to change the state of the spinner widget in the 863 application under test. This use of <code>@UiThreadTest</code> shows that, if necessary, you 864 can run an entire method on the UI thread. 865 </p> 866 </li> 867 <li> 868 Set up instrumentation. Get the instrumentation object 869 that is controlling the application under test. This is used later to 870 invoke the <code>onPause()</code> and <code>onResume()</code> methods: 871 <pre> 872 Instrumentation mInstr = this.getInstrumentation(); 873 </pre> 874 </li> 875 <li> 876 Set the spinner selection to a test value: 877 <pre> 878 mActivity.setSpinnerPosition(TEST_STATE_PAUSE_POSITION); 879 mActivity.setSpinnerSelection(TEST_STATE_PAUSE_SELECTION); 880 </pre> 881 </li> 882 <li> 883 Use instrumentation to call the Activity's <code>onPause()</code>: 884 <pre> 885 mInstr.callActivityOnPause(mActivity); 886 </pre> 887 <p> 888 Under test, the activity is waiting for input. The invocation of 889 {@link android.app.Instrumentation#callActivityOnPause(android.app.Activity)} 890 performs a call directly to the activity's <code>onPause()</code> instead 891 of manipulating the activity's UI to force it into a paused state. 892 </p> 893 </li> 894 <li> 895 Force the spinner to a different selection: 896 <pre> 897 mActivity.setSpinnerPosition(0); 898 mActivity.setSpinnerSelection(""); 899 </pre> 900 <p> 901 This ensures that resuming the activity actually restores the 902 spinner's state rather than simply leaving it as it was. 903 </p> 904 </li> 905 <li> 906 Use instrumentation to call the Activity's <code>onResume()</code>: 907 <pre> 908 mInstr.callActivityOnResume(mActivity); 909 </pre> 910 <p> 911 Invoking {@link android.app.Instrumentation#callActivityOnResume(android.app.Activity)} 912 affects the activity in a way similar to <code>callActivityOnPause</code>. The 913 activity's <code>onResume()</code> method is invoked instead of manipulating the 914 activity's UI to force it to resume. 915 </p> 916 </li> 917 <li> 918 Get the current state of the spinner: 919 <pre> 920 int currentPosition = mActivity.getSpinnerPosition(); 921 String currentSelection = mActivity.getSpinnerSelection(); 922 </pre> 923 </li> 924 <li> 925 Test the current spinner state against the test values: 926 <pre> 927 assertEquals(TEST_STATE_PAUSE_POSITION,currentPosition); 928 assertEquals(TEST_STATE_PAUSE_SELECTION,currentSelection); 929 } // end of testStatePause() method definition 930 </pre> 931 <p> 932 Add the following members to the test case class: 933 </p> 934 <pre> 935 public static final int TEST_STATE_PAUSE_POSITION = 4; 936 public static final String TEST_STATE_PAUSE_SELECTION = "Jupiter"; 937 </pre> 938 </li> 939 <li> 940 Add the following imports: 941 <pre> 942 import android.app.Instrumentation; 943 import android.test.UiThreadTest; 944 </pre> 945 </li> 946 </ol> 947 <h2 id="RunTests">Running the Tests and Seeing the Results</h2> 948 <p> 949 The most simple way to run the <code>SpinnerActivityTest</code> test case is to run it directly from the Package Explorer. 950 </p> 951 <p> 952 To run the <code>SpinnerActivityTest</code> test, follow these steps: 953 </p> 954 <ol> 955 <li> 956 In the Package Explorer, right-click the project SpinnerActivityTest at the top level, and then 957 select <strong>Run As</strong> > <strong>Android JUnit Test</strong>:<br/> 958 <a href="{@docRoot}images/testing/spinnertest_runas_menu_callouts.png"> 959 <img alt="Menu to run a test as an Android JUnit test" src="{@docRoot}images/testing/spinnertest_runas_menu_callouts.png" style="height:230px"> 960 </a> 961 </li> 962 <li> 963 You will see the emulator start. When the unlock option is displayed (its appearance depends on the API level you specified for the AVD), 964 unlock the home screen. 965 </li> 966 <li> 967 The test application starts. You see a new tab for the <strong>JUnit</strong> view, next to the Package Explorer tab:<br/> 968 <a href="{@docRoot}images/testing/spinnertest_junit_panel.png"> 969 <img alt="The JUnit window" src="{@docRoot}images/testing/spinnertest_junit_panel.png" style="height:230px"> 970 </a> 971 </li> 972 </ol> 973 <p> 974 This view contains two sub-panes. The top pane summarizes the tests that were run, and the bottom pane shows failure traces for 975 highlighted tests. 976 </p> 977 <p> 978 At the conclusion of a successful test run, this is the view's appearance:<br/> 979 <a href="{@docRoot}images/testing/spinnertest_junit_success.png"> 980 <img src="{@docRoot}images/testing/spinnertest_junit_success.png" alt="JUnit test run success" style="height:230px"/> 981 </a> 982 </p> 983 <p> 984 The upper pane summarizes the test: 985 </p> 986 <ul> 987 <li> 988 Total time elapsed for the test application(labeled <em>Finished after <x> seconds</em>). 989 </li> 990 <li> 991 Number of runs (<em>Runs:</em>) - the number of tests in the entire test class. 992 </li> 993 <li> 994 Number of errors (<em>Errors:</em>) - the number of program errors and exceptions encountered during 995 the test run. 996 </li> 997 <li> 998 Number of failures (<em>Failures:</em>) - the number of test failures encountered during the test 999 run. This is the number of assertion failures. A test can fail even if the program does not encounter an error. 1000 </li> 1001 <li> 1002 A progress bar. The progress bar extends from left to right as the tests run. 1003 <p> 1004 If all the tests succeed, the bar remains green. If a test fails, the bar turns from green to red. 1005 </p> 1006 </li> 1007 <li> 1008 A test method summary. Below the bar, you see a line for each class in the test application. To look at the results for the individual 1009 methods in a test, click the arrow at the left to expand the line. You see the name of each test method. To the 1010 right of the name, you see the time taken by the test. You can look at the test's code 1011 by double-clicking its name. 1012 </li> 1013 </ul> 1014 <p> 1015 The lower pane contains the failure trace. If all the tests are successful, this pane is empty. If some tests fail, 1016 then if you highlight a failed test in the upper pane, the lower view contains a stack trace for the test. This is 1017 demonstrated in the next section. 1018 </p> 1019 <p class="note"> 1020 <strong>Note:</strong> If you run the test application and nothing seems to happen, look for 1021 the JUnit view. If you do not see it, you may have run the test application 1022 as a regular Android application. 1023 Remember that you need to run it as an Android <strong>JUnit</strong> 1024 application. 1025 </p> 1026 <h2 id="TestFailure">Forcing Some Tests to Fail</h2> 1027 <p> 1028 A test is as useful when it fails as when it succeeds. This section shows what happens in Eclipse with ADT when a test fails. You 1029 can quickly see that a test class has failed, find the method or methods that failed, and then use a failure trace to find 1030 the exact problem. 1031 </p> 1032 <p> 1033 The example application SpinnerActivity that you downloaded passes all the tests in the test application SpinnerActivityTest. 1034 To force the test to fail, you must modify the example application. You change a line of setup code in the application under test. This 1035 causes the <code>testPreConditions()</code> and <code>testTextView()</code> test methods to fail. 1036 </p> 1037 <p> 1038 To force the tests to fail, follow these steps: 1039 </p> 1040 <ol> 1041 <li> 1042 In Eclipse with ADT, go to the SpinnerActivity project and open the file <code>SpinnerActivity.java</code>. 1043 </li> 1044 <li> 1045 At the top of <code>SpinnerActivity.java</code>, at the end of the <code>onCreate()</code> method, find the following line: 1046 <pre> 1047 // mySpinner.setOnItemSelectedListener(null); 1048 </pre> 1049 <p>Remove the forward slash characters at the beginning of the line to 1050 uncomment the line. This sets the listener callback to null: 1051 </p> 1052 <pre> 1053 mySpinner.setOnItemSelectedListener(null); 1054 </pre> 1055 </li> 1056 <li> 1057 The <code>testPreConditions()</code> method in <code>SpinnerActivityTest</code> contains the following test: 1058 <code>assertTrue(mSpinner.getOnItemSelectedListener() != null);</code>. This test asserts that the listener callback is <em>not</em> null. 1059 Since you have modified the application under test, this assertion now fails. 1060 </li> 1061 <li> 1062 Run the test, as described in the previous section <a href="#RunTests">Running the Tests and Seeing the Results</a>. 1063 </li> 1064 </ol> 1065 <p> 1066 The JUnit view is either created or updated with the results of the test. Now, however, the progress bar is red, 1067 the number of failures is 2, and small "x" icons appear in the list icons next to the testPreConditions and 1068 TestSpinnerUI tests. This indicates that the tests have failed. The display is similar to this:<br/> 1069 <a href="{@docRoot}images/testing/spinnertest_junit_panel_fail_callouts.png"> 1070 <img src="{@docRoot}images/testing/spinnertest_junit_panel_fail_callouts.png" alt="The JUnit Failure window" style="height:230px"/> 1071 </a> 1072 </p> 1073 <p> 1074 You now want to look at the failures to see exactly where they occurred. 1075 </p> 1076 <p> 1077 To examine the failures, follow these steps: 1078 </p> 1079 <ol> 1080 <li> 1081 Click the testPreconditions entry. In the lower pane entitled <strong>Failure Trace</strong>, 1082 you see a stack trace of the calls that led to the failure. This trace is similar to the following screenshot:<br/> 1083 <a href="{@docRoot}images/testing/spinnertest_junit_panel_failtrace_callouts.png"> 1084 <img src="{@docRoot}images/testing/spinnertest_junit_panel_failtrace_callouts.png" alt="The JUnit failure trace" style="height:230px"/> 1085 </a> 1086 </li> 1087 <li> 1088 The first line of the trace tells you the error. In this case, a JUnit assertion failed. To look at the 1089 assertion in the test code, double-click the next line (the first line of the trace). In the center pane 1090 a new tabbed window opens, containing the code for the test application <code>SpinnerActivityTest</code>. The failed assertion 1091 is highlighted in the middle of the window. 1092 </li> 1093 </ol> 1094 <p> 1095 The assertion failed because you modified the main application to set the <code>getOnItemSelectedListener</code> callback to <code>null</code>. 1096 </p> 1097 <p> 1098 You can look at the failure in <code>testTextView</code> if you want. Remember, though, that <code>testPreConditions</code> is meant to verify the 1099 initial setup of the application under test. If testPreConditions() fails, then succeeding tests can't be trusted. The best strategy to follow is to 1100 fix the problem and re-run all the tests. 1101 </p> 1102 <p> 1103 Remember to go back to <code>SpinnerActivity.java</code> and re-comment the line you uncommented in an earlier step. 1104 </p> 1105 <p> 1106 You have now completed the tutorial. 1107 </p> 1108 <h2 id="NextSteps">Next Steps</h2> 1109 <p> 1110 This example test application has shown you how to create a test project and link it to 1111 the application you want to test, how to choose and add a test case class, how to write 1112 UI and state management tests, and how to run the tests against the application under 1113 test. Now that you are familiar with the basics of testing Android applications, here 1114 are some suggested next steps: 1115 </p> 1116 <p> 1117 <strong>Learn more about testing on Android</strong> 1118 </p> 1119 <ul> 1120 <li> 1121 If you haven't done so already, read the 1122 <a href="{@docRoot}guide/topics/testing/testing_android.html">Testing Android Applications</a> 1123 document in the <em>Dev Guide</em>. It provides an overview of how testing on Android 1124 works. If you are just getting started with Android testing, reading that document will 1125 help you understand the tools available to you, so that you can develop effective 1126 tests. 1127 </li> 1128 </ul> 1129 <p> 1130 <strong>Review the main Android test case classes</strong> 1131 </p> 1132 <ul> 1133 <li> 1134 {@link android.test.ActivityInstrumentationTestCase2} 1135 </li> 1136 <li> 1137 {@link android.test.ActivityUnitTestCase} 1138 </li> 1139 <li> 1140 {@link android.test.ProviderTestCase2} 1141 </li> 1142 <li> 1143 {@link android.test.ServiceTestCase} 1144 </li> 1145 </ul> 1146 <p> 1147 <strong>Learn more about the assert and utility classes</strong> 1148 </p> 1149 <ul> 1150 <li> 1151 {@link junit.framework.Assert}, the JUnit Assert class. 1152 </li> 1153 <li> 1154 {@link android.test.MoreAsserts}, additional Android assert methods. 1155 </li> 1156 <li> 1157 {@link android.test.ViewAsserts}, useful assertion methods for testing Views. 1158 </li> 1159 <li> 1160 {@link android.test.TouchUtils}, utility methods for simulating touch events in an Activity. 1161 </li> 1162 </ul> 1163 <p> 1164 <strong>Learn about instrumentation and the instrumented test runner</strong> 1165 </p> 1166 <ul> 1167 <li> 1168 {@link android.app.Instrumentation}, the base instrumentation class. 1169 </li> 1170 <li> 1171 {@link android.test.InstrumentationTestCase}, the base instrumentation test case. 1172 </li> 1173 <li> 1174 {@link android.test.InstrumentationTestRunner}, the standard Android test runner. 1175 </li> 1176 </ul> 1177 <h2 id="Appendix">Appendix</h2> 1178 <h3 id="InstallCompletedTestApp">Installing the Completed Test Application Java File</h3> 1179 <p> 1180 The recommended approach to this tutorial is to follow the instructions step-by-step and 1181 write the test code as you go. However, if you want to do this tutorial quickly, 1182 you can install the entire Java file for the test application into the test project. 1183 </p> 1184 <p> 1185 To do this, you first create a test project with the necessary structure and files by using 1186 the automated tools in Eclipse. Then you exit Eclipse and copy the test application's Java file 1187 from the SpinnerTest sample project into your test project. The SpinnerTest sample project is 1188 part of the Samples component of the SDK. 1189 </p> 1190 <p> 1191 The result is a complete test application, ready to run against the Spinner sample application. 1192 </p> 1193 <p> 1194 To install the test application Java file, follow these steps: 1195 </p> 1196 <ol> 1197 <li> 1198 Set up the projects for the application under test and the test application, as described 1199 in the section section <a href="#SetupProjects">Setting Up the Projects</a>. 1200 </li> 1201 <li> 1202 Set up the emulator, as described in the section <a href="#SetupEmulator">Setting Up the Emulator</a>. 1203 </li> 1204 <li> 1205 Add the test case class, as described in the section <a href="#AddTestCaseClass">Adding the test case class file</a>. 1206 </li> 1207 <li> 1208 Close Eclipse with ADT. 1209 </li> 1210 <li> 1211 Copy the file <code><SDK_path>/samples/android-8/SpinnerTest/src/com/android/example/spinner/test/SpinnerActivityTest.java</code> 1212 to the directory <code>workspace/SpinnerActivityTest/src/com/android/example/spinner/test/</code>. 1213 </li> 1214 <li> 1215 Restart Eclipse with ADT. 1216 </li> 1217 <li> 1218 In Eclipse with ADT, re-build the project <code>SpinnerActivityTest</code> by selecting it in the Package Explorer, right-clicking, 1219 and selecting <em>Project</em> > <em>Clean</em>. 1220 </li> 1221 <li> 1222 The complete, working test application should now be in the <code>SpinnerActivityTest</code> project. 1223 </li> 1224 </ol> 1225 <p> 1226 You can now continue with the tutorial, starting at the section <a href="#AddConstructor">Adding the test case constructor</a> and 1227 following along in the text. 1228 </p> 1229 <h3 id="EditorCommandLine">For Users Not Developing In Eclipse</h3> 1230 <p> 1231 If you are not developing in Eclipse, you can still do this tutorial. Android provides tools for 1232 creating test applications using a code editor and command-line tools. You use the following tools: 1233 </p> 1234 <ul> 1235 <li> 1236 <a href="{@docRoot}guide/developing/tools/adb.html">adb</a> - Installs and uninstalls applications and test applications to a device or the emulator. You 1237 also use this tool to run the test application from the command line. 1238 </li> 1239 <li> 1240 <a href="{@docRoot}guide/developing/tools/othertools.html#android">android</a> - Manages projects and test projects. This tool also manages AVDs and Android platforms. 1241 </li> 1242 </ul> 1243 <p> 1244 You use the <code>emulator</code> tool to run the emulator from the command line. 1245 </p> 1246 <p> 1247 Here are the general steps for doing this tutorial using an editor and the command line: 1248 </p> 1249 <ol> 1250 <li> 1251 As described in the section <a href="#DownloadCode">Installing the Tutorial Sample Code</a>, get the sample code. You will then 1252 have a directory <code><SDK_path>/samples/android-8</code>, containing (among others) the directories <code>Spinner</code> 1253 and <code>SpinnerTest</code>: 1254 <ul> 1255 <li> 1256 <code>Spinner</code> contains the main application, also known as the <strong>application under test</strong>. This tutorial focuses on the 1257 common situation of writing tests for an application that already exists, so the main application is provided to you. 1258 </li> 1259 <li> 1260 <code>SpinnerTest</code> contains all the code for the test application. If you want to run quickly through the tutorial, you can 1261 install the test code and then follow the text. You may get more from the tutorial, however, if you write the code as you go. The instructions 1262 for installing the test code are in the section <a href="#InstallCompletedTestApp">Appendix: Installing the Completed Test Application</a>. 1263 </li> 1264 </ul> 1265 </li> 1266 <li> 1267 Navigate to the directory <code><SDK_path>/samples/android-8</code>. 1268 </li> 1269 <li> 1270 Create a new Android application project using <code>android create project</code>: 1271 <pre> 1272 $ android create project -t <APItarget> -k com.android.example.spinner -a SpinnerActivity -n SpinnerActivity -p Spinner 1273 </pre> 1274 <p> 1275 The value of <code><APItarget></code> should be "3" (API level 3) or higher. If you are already developing with a particular API level, and it is 1276 higher than 3, then use that API level. 1277 </p> 1278 <p> 1279 This a new Android project <code>SpinnerActivity</code> in the existing <code>Spinner</code> directory. The existing source and 1280 resource files are not touched, but the <code>android</code> tool adds the necessary build files. 1281 </p> 1282 </li> 1283 <li> 1284 Create a new Android test project using <code>android create test-project</code>: 1285 <pre> 1286 $ android create test-project -m ../Spinner -n SpinnerActivityTest -p SpinnerActivityTest 1287 </pre> 1288 <p> 1289 This will create a new Android test project in the <em>new</em> directory <code>SpinnerActivityTest</code>. You do this 1290 so that the solution to the tutorial that is in <code>SpinnerTest</code> is left untouched. If you want to use the solution 1291 code instead of entering it as you read through the tutorial, refer to the section 1292 <a href="#InstallCompletedTestApp">Appendix: Installing the Completed Test Application</a>. 1293 </p> 1294 <p class="Note"> 1295 <strong>Note:</strong> Running <code>android create test-project</code> will automatically create 1296 the file <code>AndroidManifest.xml</code> with the correct <code><instrumentation></code> element. 1297 </p> 1298 </li> 1299 <li> 1300 Build the sample application. If you are building with Ant, then it is easiest to use the command <code>ant debug</code> to build a debug version, since the SDK comes 1301 with a debug signing key. The result will be the file <code>Spinner/bin/SpinnerActivity-debug.apk</code>. 1302 You can install this to your device or emulator. Attach your device or start the emulator if you haven't already, and run the command: 1303 <pre> 1304 $ adb install Spinner/bin/SpinnerActivity-debug.apk 1305 </pre> 1306 </li> 1307 <li> 1308 To create the test application, create a file <code>SpinnerActivityTest.java</code> in the directory 1309 <code>SpinnerActivityTest/src/com/android/example/spinner/test/</code>. 1310 </li> 1311 <li> 1312 Follow the tutorial, starting with the section <a href="#CreateTestCaseClass">Creating the Test Case Class</a>. When you are prompted to 1313 run the sample application, go the the Launcher screen in your device or emulator and select SpinnerActivity. 1314 When you are prompted to run the test application, return here to continue with the following instructions. 1315 </li> 1316 <li> 1317 Build the test application. If you are building with Ant, then it is easiest to use the command <code>ant debug</code> to build a 1318 debug version, since the SDK comes with a debug signing key. The result will be the Android file 1319 <code>SpinnerActivityTest/bin/SpinnerActivityTest-debug.apk</code>. You can install this to your device or emulator. 1320 Attach your device or start the emulator if you haven't already, and run the command: 1321 <pre> 1322 $ adb install SpinnerActivityTest/bin/SpinnerActivityTest-debug.apk 1323 </pre> 1324 </li> 1325 <li> 1326 In your device or emulator, check that both the main application <code>SpinnerActivity</code> and the test application 1327 <code>SpinnerActivityTest</code> are installed. 1328 </li> 1329 <li> 1330 To run the test application, enter the following at the command line: 1331 <pre> 1332 $ adb shell am instrument -w com.android.example.spinner.test/android.test.InstrumentationTestRunner 1333 </pre> 1334 </li> 1335 </ol> 1336 <p> 1337 The result of a successful test looks like this: 1338 </p> 1339 <pre> 1340 com.android.example.spinner.test.SpinnerActivityTest:.... 1341 Test results for InstrumentationTestRunner=.... 1342 Time: 10.098 1343 OK (4 tests) 1344 </pre> 1345 <p> 1346 If you force the test to fail, as described in the previous section <a href="#TestFailure">Forcing Some Tests to Fail</a>, then 1347 the output looks like this: 1348 </p> 1349 <pre> 1350 com.android.example.spinner.test.SpinnerActivityTest: 1351 Failure in testPreConditions: 1352 junit.framework.AssertionFailedError 1353 at com.android.example.spinner.test.SpinnerActivityTest.testPreConditions(SpinnerActivityTest.java:104) 1354 at java.lang.reflect.Method.invokeNative(Native Method) 1355 at android.test.InstrumentationTestCase.runMethod(InstrumentationTestCase.java:205) 1356 at android.test.InstrumentationTestCase.runTest(InstrumentationTestCase.java:195) 1357 at android.test.ActivityInstrumentationTestCase2.runTest(ActivityInstrumentationTestCase2.java:175) 1358 at android.test.AndroidTestRunner.runTest(AndroidTestRunner.java:169) 1359 at android.test.AndroidTestRunner.runTest(AndroidTestRunner.java:154) 1360 at android.test.InstrumentationTestRunner.onStart(InstrumentationTestRunner.java:430) 1361 at android.app.Instrumentation$InstrumentationThread.run(Instrumentation.java:1447) 1362 Failure in testSpinnerUI: 1363 junit.framework.ComparisonFailure: expected:<Result> but was:<Saturn> 1364 at com.android.example.spinner.test.SpinnerActivityTest.testSpinnerUI(SpinnerActivityTest.java:153) 1365 at java.lang.reflect.Method.invokeNative(Native Method) 1366 at android.test.InstrumentationTestCase.runMethod(InstrumentationTestCase.java:205) 1367 at android.test.InstrumentationTestCase.runTest(InstrumentationTestCase.java:195) 1368 at android.test.ActivityInstrumentationTestCase2.runTest(ActivityInstrumentationTestCase2.java:175) 1369 at android.test.AndroidTestRunner.runTest(AndroidTestRunner.java:169) 1370 at android.test.AndroidTestRunner.runTest(AndroidTestRunner.java:154) 1371 at android.test.InstrumentationTestRunner.onStart(InstrumentationTestRunner.java:430) 1372 at android.app.Instrumentation$InstrumentationThread.run(Instrumentation.java:1447) 1373 .. 1374 Test results for InstrumentationTestRunner=.F.F.. 1375 Time: 9.377 1376 FAILURES!!! 1377 Tests run: 4, Failures: 2, Errors: 0 1378 </pre> 1379
