Deprecate `shadows-multidex`

Robolectric's min SDK version has been set to 21 since version 4.13.
Using Multidex is therefore no longer necessary.
This PR deprecates the `shadows-multidex` module,
so it can be removed in Robolectric 4.15.
3 files changed
tree: 44d1e3324f55e245f503467c237975f17fba4521
  1. .devcontainer/
  2. .github/
  3. annotations/
  4. buildSrc/
  5. errorprone/
  6. gradle/
  7. images/
  8. integration_tests/
  9. junit/
  10. nativeruntime/
  11. pluginapi/
  12. plugins/
  13. preinstrumented/
  14. processor/
  15. resources/
  16. robolectric/
  17. sandbox/
  18. scripts/
  19. shadowapi/
  20. shadows/
  21. testapp/
  22. utils/
  23. .gitignore
  24. ARCHITECTURE.md
  25. build.gradle.kts
  26. CODE_OF_CONDUCT.md
  27. gradle.properties
  28. gradlew
  29. gradlew.bat
  30. LICENSE
  31. README.md
  32. settings.gradle.kts
  33. WORKSPACE
README.md

Build Status GitHub release

Robolectric 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 and flakiness of an emulator. Robolectric tests routinely run 10x faster than those on cold-started emulators.

Robolectric supports running unit tests for 14 different versions of Android, ranging from Lollipop (API level 21) to U (API level 34).

Usage

Here's an example of a simple test written using Robolectric:

@RunWith(AndroidJUnit4.class)
public class MyActivityTest {

  @Test
  public void clickingButton_shouldChangeResultsViewText() {
    Activity activity = Robolectric.setupActivity(MyActivity.class);

    Button button = (Button) activity.findViewById(R.id.press_me_button);
    TextView results = (TextView) activity.findViewById(R.id.results_text_view);

    button.performClick();
    assertThat(results.getText().toString(), equalTo("Testing Android Rocks!"));
  }
}

For more information about how to install and use Robolectric on your project, extend its functionality, and join the community of contributors, please visit robolectric.org.

Install

Starting a New Project

If you'd like to start a new project with Robolectric tests, you can refer to deckard (for either Maven or Gradle) as a guide to setting up both Android and Robolectric on your machine.

build.gradle

testImplementation "junit:junit:4.13.2"
testImplementation "org.robolectric:robolectric:4.13"

Building and Contributing

Robolectric is built using Gradle. Both Android Studio and IntelliJ can import the top-level build.gradle.kts file and will automatically generate their project files from it.

To get Robolectric up and running on your machine, check out this guide.

To get a high-level overview of Robolectric's architecture, check out robolectric.org.

Development model

Robolectric is actively developed in several locations. The primary location is this GitHub repository, which is considered the source-of-truth for Robolectric code. It is where contributions from the broader Android developer community occur. There is also an active development tree of Robolectric internally at Google, where contributions from first-party Android developers occur. By having a development tree of Robolectric internally at Google, it enables first-party Android developers to more efficiently make contributions to Robolectric. This tree is synced directly to the google branch every time a change occurs using the Copybara code sync tool. Bidirectional merges of this branch and the master branch occur regularly.

Robolectric also has usage in the Android platform via the external/robolectric repo project. Contributions to this source tree are typically related to new SDK support and evolving platform APIs. Changes from this branch are upstreamed to the internal Robolectric tree at Google, which eventually propagate to the GitHub branches.

Although complex, this distributed development model enables Android developers in different environments to use and contribute to Robolectric, while allowing changes to eventually make their way to public Robolectric releases.

Using Snapshots

If 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 the master and may contain bugs.

build.gradle

repositories {
    maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
}

dependencies {
    testImplementation "org.robolectric:robolectric:4.15-SNAPSHOT"
}