Gitiles
Code Review Sign In
LeafOS / LeafOS-Project / android_frameworks_base / 0ebfd8bed2f9af973cc48b8d2ad8ce63f53bd771 / . / ravenwood
tree: e4b08a37ea9dbe23184b172c796c2ab05db02850 [path history] [tgz]
  1. annotations-src/
  2. junit-impl-src/
  3. junit-src/
  4. junit-stub-src/
  5. minimum-test/
  6. mockito/
  7. Android.bp
  8. api-maintainers.md
  9. framework-minus-apex-ravenwood-policies.txt
  10. OWNERS
  11. ravenwood-annotation-allowed-classes.txt
  12. ravenwood-standard-options.txt
  13. README-ravenwood+mockito.md
  14. README.md
  15. test-authors.md
  16. TEST_MAPPING
ravenwood/README.md

Ravenwood

Ravenwood is an officially-supported lightweight unit testing environment for Android platform code that runs on the host.

Ravenwood’s focus on Android platform use-cases, improved maintainability, and device consistency distinguishes it from Robolectric, which remains a popular choice for app testing.

Background

Executing tests on a typical Android device has substantial overhead, such as flashing the build, waiting for the boot to complete, and retrying tests that fail due to general flakiness.

In contrast, defining a lightweight unit testing environment mitigates these issues by running directly from build artifacts (no flashing required), runs immediately (no booting required), and runs in an isolated environment (less flakiness).

Guiding principles

Here’s a summary of the guiding principles for Ravenwood, aimed at addressing Robolectric design concerns and better supporting Android platform developers:

  • API support for Ravenwood is opt-in. Teams that own APIs decide exactly what, and how, they support their API functionality being available to tests. When an API hasn’t opted-in, the API signatures remain available for tests to compile against and/or mock, but they throw when called under a Ravenwood environment.
    • Contrasted with Robolectric which attempts to run API implementations as-is, causing maintenance pains as teams maintain or redesign their API internals.
  • API support and customizations for Ravenwood appear directly inline with relevant code. This improves maintenance of APIs by providing awareness of what code runs under Ravenwood, including the ability to replace code at a per-method level when Ravenwood-specific customization is needed.
    • Contrasted with Robolectric which maintains customized behavior in separate “Shadow” classes that are difficult for maintainers to be aware of.
  • APIs supported under Ravenwood are tested to remain consistent with physical devices. As teams progressively opt-in supporting APIs under Ravenwood, we’re requiring they bring along “bivalent” tests (such as the relevant CTS) to validate that Ravenwood behaves just like a physical device.
    • Contrasted with Robolectric, which has limited (and forked) testing of their environment, increasing their risk of accidental divergence over time and misleading “passing” signals.
  • Ravenwood aims to support more “real” code. As API owners progressively opt-in their code, they have the freedom to provide either a limited “fake” that is a faithful emulation of how a device behaves, or they can bring more “real” code that runs on physical devices.
    • Contrasted with Robolectric, where support for “real” code ends at the app process boundary, such as a call into system_server.

More details