README.md
1<a name="README">[<img src="https://rawgithub.com/robolectric/robolectric/master/images/robolectric-horizontal.png"/>](http://robolectric.org)</a>
2
3[](https://travis-ci.org/robolectric/robolectric)
4[](https://github.com/robolectric/robolectric/releases)
5
6Robolectric is the industry-standard unit testing framework for Android. With Robolectric, your tests run in a simulated Android environment inside a JVM, without the overhead of an emulator.
7
8## Usage
9
10Here's an example of a simple test written using Robolectric:
11
12```java
13@RunWith(RobolectricTestRunner.class)
14@Config(constants = BuildConfig.class)
15public class MyActivityTest {
16
17 @Test
18 public void clickingButton_shouldChangeResultsViewText() throws Exception {
19 Activity activity = Robolectric.setupActivity(MyActivity.class);
20
21 Button button = (Button) activity.findViewById(R.id.press_me_button);
22 TextView results = (TextView) activity.findViewById(R.id.results_text_view);
23
24 button.performClick();
25 assertThat(results.getText().toString(), equalTo("Testing Android Rocks!"));
26 }
27}
28```
29
30For more information about how to install and use Robolectric on your project, extend its functionality, and join the community of contributors, please visit [http://robolectric.org](http://robolectric.org).
31
32## Install
33
34### Starting a New Project
35
36If you'd like to start a new project with Robolectric tests you can refer to `deckard` (for either [maven](http://github.com/robolectric/deckard-maven) or [gradle](http://github.com/robolectric/deckard-gradle)) as a guide to setting up both Android and Robolectric on your machine.
37
38#### build.gradle:
39
40```groovy
41testCompile "org.robolectric:robolectric:3.6.1"
42```
43
44## Building And Contributing
45
46Robolectric is built using Gradle. Both IntelliJ and Android Studio can import the top-level `build.gradle` file and will automatically generate their project files from it.
47
48You will need to have portions of the Android SDK available in your local Maven artifact repository in order to build Robolectric. Copy all required Android dependencies to your local Maven repo by running:
49
50 ./scripts/install-dependencies.rb
51
52*Note*: You'll need Maven installed, `ANDROID_HOME` set and to have the SDK and Google APIs for API Level 23 downloaded to do this.
53
54Robolectric supports running tests against multiple Android API levels. The work it must do to support each API level is slightly different, so its shadows are built separately for each. To build shadows for every API version, run:
55
56 ./gradlew clean assemble install compileTest
57
58### Using Snapshots
59
60If you would like to live on the bleeding edge, you can try running against a snapshot build. Keep in mind that snapshots represent the most recent changes on master and may contain bugs.
61
62#### build.gradle:
63
64```groovy
65repositories {
66 maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
67}
68
69dependencies {
70 testCompile "org.robolectric:robolectric:3.7-SNAPSHOT"
71}
72```
73
