README.md
1# Wifi Unit Tests
2This package contains unit tests for the android wifi service based on the
3[Android Testing Support Library](http://developer.android.com/tools/testing-support-library/index.html).
4The test cases are built using the [JUnit](http://junit.org/) and [Mockito](http://mockito.org/)
5libraries.
6
7## Running Tests
8The easiest way to run tests is simply run
9
10```
11runtest frameworks-wifi
12```
13
14`runtest` will build the test project and push the APK to the connected device. It will then run the
15tests on the device. See `runtest --help` for options to specify individual test classes or methods.
16
17**WARNING:** You have to build the components under test (wifi-service, etc) first before you run
18runtest for changes there to take effect. You can use the following command from your build root to
19build the wifi service and run tests.
20
21```
22mmma frameworks/opt/net/wifi/tests && runtest frameworks-wifi
23```
24
25
26If you manually build and push the test APK to the device you can run tests using
27
28```
29adb shell am instrument -w 'com.android.server.wifi.test/android.support.test.runner.AndroidJUnitRunner'
30```
31
32## Adding Tests
33Tests can be added by adding classes to the src directory. JUnit4 style test cases can
34be written by simply annotating test methods with `org.junit.Test`.
35
36## Debugging Tests
37If you are trying to debug why tests are not doing what you expected, you can add android log
38statements and use logcat to view them. The beginning and end of every tests is automatically logged
39with the tag `TestRunner`.
40
41## Code Coverage
42If you would like to collect code coverage information you can run the `coverage.sh` script located
43in this directory. It will rebuild parts of your tree with coverage enabled and then run the tests,
44similar to runtest. If you have multiple devices connected to your machine make sure to set the
45`ANDROID_SERIAL` environment variable before running the script. You must supply an output directory
46for results. By default the results are generated as a set of HTML pages. For example, you can use
47the following from the root out your source tree to generate results in the wifi_coverage directory
48
49```
50frameworks/opt/net/wifi/tests/wifitests/coverage.sh wifi_coverage
51```
52