{"id":2024,"date":"2014-11-20T11:35:00","date_gmt":"2014-11-20T16:35:00","guid":{"rendered":"http:\/\/qxf2.com\/blog\/?p=2024"},"modified":"2017-06-14T01:58:18","modified_gmt":"2017-06-14T05:58:18","slug":"android-unit-testing-robolectric-tutorial","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/android-unit-testing-robolectric-tutorial\/","title":{"rendered":"Android unit testing: Android testing framework and Robolectric"},"content":{"rendered":"

Problem:<\/strong> There are not many good tutorials on Android unit testing
\n
\nAndroid applications are written in Java. So you probably think if you know JUnit, you can unit test Android applications. Surprise! JUnit is not sufficient for unit testing Android applications. Junit works when the code runs within a JVM. Android applications interact with the Android OS. So you need to learn and use a different testing framework.
\n<\/p>\n

\n

Why this post?<\/h3>\n

Qxf2<\/a> likes unit testing<\/a>. Unit testing is one component of an effective testing strategy. Good unit testing<\/a> rocks. Android unit testing is still in its early days. There are not too many good tutorials that help testers get started with Android unit testing. This post is aimed at helping hands on testers get started with Android unit testing.
\n
\nNOTE:<\/strong> You can read our other posts on mobile app testing here<\/a>.
\n<\/p>\n

\n

Overview<\/h3>\n

In this post we will show you two ways of writing and executing unit tests for Android applications:
\n1) Android testing framework<\/strong>: Android provides a testing framework<\/a> to run unit tests on both emulators and physical devices.
\n2) Robolectric<\/strong>: Robolectric<\/a> provides a unit test framework that allows you to run tests inside the JVM on your computer.<\/p>\n

We will use Mileage Tracker<\/a> app as our the application under test. We chose it because it was open source, the code base was relatively small and came with some unit tests. We will write a simple unit test and run it using both Android test framework and Robolectric.<\/p>\n

\n

Part I: Android testing framework<\/h3>\n

The Android framework<\/a> provides a testing framework to test your application. Android test suites are based on JUnit 3. We can use JUnit to test a class that doesn’t call the Android API. We should use Android’s JUnit extensions to test Android components. At a high level our steps are:
\n
\n1. Set up Eclipse ADT
\n2. Import the test app to eclipse
\n3. Select a test and check the method
\n4. Run the test
\n
\n1. Set up Eclipse ADT<\/strong>
\nDownload the Eclipse ADT and follow the instructions mentioned here<\/a><\/p>\n

2. Import the test app to eclipse<\/strong>
\nCreate a new “Android Project from Existing Code” and import the downloaded Mileage Tracker app to your eclipse. The Mileage Tracker app also has some sample tests which are already written. Set your root directory and check the projects to import as shown below.<\/p>\n

\"Import<\/a><\/p>\n

3. Select a test and check the method<\/strong>
\nThe test project already has some tests written to check some of the apps functionality. We will focus on the test VehicleListActivityTest.java<\/em> which checks the canDelete()<\/em> method in VehicleListActivity.java<\/em> in the package com.evancharlton.mileage<\/em>. <\/p>\n

This method returns true if the getAdapter().getCount()<\/em> is more than 1, else it returns false. This means that in the Vehicle tab you can delete any vehicle information only if there are more than one vehicle information present, else the delete option is not available.<\/p>\n

\r\n@Override\r\n\tpublic boolean canDelete(int position) {\r\n        return getAdapter().getCount() > 1;\r\n    }\r\n<\/pre>\n
\"Delete<\/a><\/p>\n
VehicleListActivityTest.java:<\/p>\n
\r\npackage com.evancharlton.mileage;\r\n\r\n\/**\r\n * Test to check that canDelete() in VehicleListActivity.java in the package com.evancharlton.mileage returns true if the getAdapter().getCount() is more than 1, else returns false. \r\n*A FakeAdapter class is created which extends BaseAdapter class so that we can set the count using setCount() function \r\n *\/\r\n\r\nimport com.evancharlton.mileage.adapters.FakeAdapter;\r\nimport com.evancharlton.mileage.tests.TestCase;\r\n\r\npublic class VehicleListActivityTest extends TestCase {\r\n\tprotected VehicleListActivity activity;\r\n\t\/\/ Creating an object of FakeAdaptor class\r\n\tprivate final FakeAdapter mMockAdapter = new FakeAdapter();\r\n\r\n\tprotected void setUp() throws Exception {\r\n\t\tsuper.setUp();\r\n\r\n\t\tactivity = new VehicleListActivity(mMockAdapter);\r\n\t}\r\n\r\n\tpublic void testCanDelete() {\r\n\t\tmMockAdapter.setCount(1); \r\n\t\t\/\/Since the vehicle count is set to 1 this will return false\r\n\t\tassertFalse(activity.canDelete(0));\r\n\r\n\t\tmMockAdapter.setCount(2);\r\n\t\t\/\/Since the vehicle count is set to 2 this will return true\r\n\t\tassertTrue(activity.canDelete(0));\r\n\t}\r\n}\r\n\r\n<\/pre>\n
 4. Run the test<\/strong>
\nRunning the test as Android JUnit involves building, deploying, and launching the app in an Android emulator or a physical device, hence the directory structure of MileageTest project is similar to that of Mileage Project. Please refer to this link<\/a> to set up the run configuration to run your tests either in device or an emulator. If you are running your test using emulator, follow this link<\/a> for the process on how to create an emulator. <\/p>\n
Here is the snapshot of the test run as Android JUnit Test<\/strong>.
\n– VehicleListActivityTest for the mileage app.
\n\"AndroidJunit_run\"<\/a><\/p>\n
-Result of the test (using an emulator)
\n\"androidjunittest_result\"<\/a><\/p>\n
The console output as shown in the above screenshot shows that the MileageTest.apk is installed on the emulator for the test to be executed. <\/p>\n
\n
Part II: Android unit testing using Robolectric<\/h3>\n
Robolectric<\/a> is a unit testing framework that allows you to write and run tests inside the JVM on your workstation. Robolectric makes this possible by rewriting Android SDK classes as they are being loaded and making it possible for them to run on a regular JVM. Running tests using the Android testing framework involves building, deploying and launching the app in an Android emulator or a physical device. The process is a bit slow. Robolectric addresses some of these concerns. At a high level our steps are:
\n
\n1. Download Robolectric jar and set up the test app in eclipse
\n2. Select a method to test
\n3. Write the test
\n4. Setting up the Run configuration
\n5. Running the test
\n
\n1. Download Robolectric jar and set up the test app in eclipse<\/strong>
\nFollow the detailed steps given here<\/a> to download the required jar and set up the Mileage Tracker app. In some cases you may require fest.jar and maps.jar files, you can refer to link<\/a> to set up Robolectric with these jars.<\/p>\n
\"robolectric_dir_structure\"<\/a><\/p>\n
2. Select a method to test<\/strong>
\nWe will test the same canDelete()<\/em> method as mentioned above for Android unit test.<\/p>\n
3. Write the test<\/strong>
\nTo run our test using Robolectric, we will annotate the test using the @RunWith annotation.<\/p>\n
\r\npackage com.evancharlton.mileage;\r\n* Test to check that CanDelete() in VehicleListActivity.java in the package com.evancharlton.mileage returns true if the getAdapter().getCount() is more than 1, \r\n * else it returns false. A FakeAdapter class is created which extends BaseAdapter class so that we can set the count using setCount() function \r\n *\/\r\nimport static org.junit.Assert.*;\r\nimport org.junit.Before;\r\nimport org.junit.Test;\r\nimport org.junit.runner.RunWith;\r\nimport org.robolectric.Robolectric;\r\nimport org.robolectric.RobolectricTestRunner;\r\nimport org.robolectric.annotation.Config;\r\nimport com.evancharlton.mileage.VehicleListActivity;\r\n\r\n\/\/@Config annotation so that Robolectric emulate an SDK version, since Robolectric doesn't support API level 19 and above\r\n@Config(emulateSdk = 18) \r\n\/\/To run your test with Robolectric, you need to tell JUnit use the @RunWith annotation\r\n@RunWith(RobolectricTestRunner.class)\r\n\r\npublic class VehicleListActivityTest  {\r\n\t\r\n\tprotected VehicleListActivity activity;\r\n        private final MyAdapter testAdapter = new MyAdapter();\r\n\t\r\n\r\n    @Before\r\n    public void setup() throws Exception {\r\n\t\t\r\n        activity = new VehicleListActivity(testAdapter);\r\n    }\r\n    @Test\r\n    public void testCanDelete() throws Exception \r\n    {\r\n    \ttestAdapter.setCount(1);\r\n        \/\/Since the vehicle count is set to 1 this will return false\r\n        assertFalse(activity.canDelete(0));\r\n        testAdapter.setCount(2);\r\n\t\/\/Since the vehicle count is set to 2 this will return true\r\n\tassertTrue(activity.canDelete(0));\r\n    \t\r\n    }\r\n\r\n}\r\n<\/pre>\n
4. Setting up the Run configuration<\/strong>
\nYou can refer to the Setup Run Configuration<\/strong> section in this link<\/a> to configure it properly. Here is snapshot of the test run configuration for our test project.
\n\"Robolectric_run\"<\/a><\/p>\n
5. Running the test<\/strong>
\nSelect the Run configuration which you created, run the test and verify the JUnit test result.
\n\"Robolectric_result\"<\/a><\/p>\n
\n
There you go. Android unit testing is not rocket science.<\/p>\n
\n