Skip to content

Commit

Permalink
Update "Build system integration" (robolectric#254)
Browse files Browse the repository at this point in the history
  • Loading branch information
MGaetan89 authored Jun 29, 2024
1 parent 476d7d9 commit 1093917
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions docs/build-system-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,34 @@ hide:

# Build System Integration

Starting with Robolectric 3.3, the test runner will look for a file named `/com/android/tools/test_config.properties` on the classpath. If it is found, it will be used to provide the default manifest, resource, and asset locations for tests, without the need to specify `@Config(constants=BuildConfig.class)` or `@Config(manifest="...", res="...", assetDir="...")` in your tests.
Starting with [Robolectric 3.3](https://github.com/robolectric/robolectric/releases/tag/robolectric-3.3), the test runner will look for a file named `/com/android/tools/test_config.properties` on the classpath. If it is found, it will be used to provide the default manifest, resource, and asset locations for tests, without the need to specify `@Config(manifest = "...", resourceDir = "...", assetDir = "...")` in your tests.

This gives build system implementors the ability to perform manifest, asset and resource preprocessing and merging for tests using the same strategy it would when building the APK, rather than leaving it up to Robolectric.

This supersedes Robolectric's support for merging multiple libraries specified via `@Config(libraries = {"lib1", "lib2"})` and `project.properties` support from legacy Eclipse ADT projects.
This supersedes Robolectric's support for merging multiple libraries specified via `@Config(libraries = {"lib1", "lib2"})`.

Keys in the file:
## Supported keys

* `android_merged_manifest`: Full path to the project's merged `AndroidManifest.xml` file.
* `android_merged_resources`: Full path to the project's merged resources.
* `android_merged_assets`: Full path to the project's merged assets.
* `android_custom_package`: Java package name for the applications R class.
* `android_resource_apk`: Path to a resources.ap_ file that contains binary resources and XML files produced by `aapt` tool, as well as merged assets.
* `android_merged_manifest`: full path to the project's merged `AndroidManifest.xml` file.
* `android_merged_resources`: full path to the project's merged resources.
* `android_merged_assets`: full path to the project's merged assets.
* `android_custom_package`: Java package name for the applications `R` class.
* `android_resource_apk`: path to a `resources.ap_` file that contains binary resources and XML files produced by the `aapt` tool, as well as merged assets.

Note that Robolectric expects that build systems will have performed final `R.class` generation by the time unit tests are run.
> [!NOTE]
> Robolectric expects that build systems have generated the final `R.class` file by the time unit tests are run.
For merged Raw resource support:
For merged raw resources support:

```properties
android_merged_assets=/some/path/MyApp/app/build/intermediates/assets/debug
android_merged_resources=/some/path/MyApp/app/build/intermediates/res/merged/debug
android_merged_manifest=/some/path/MyApp/app/build/intermediates/manifests/full/debug/AndroidManifest.xml
android_merged_assets=/some/path/to/app/build/intermediates/assets/debug
android_merged_resources=/some/path/to/app/build/intermediates/merged_res/debug
android_merged_manifest=/some/path/to/app/build/intermediates/merged_manifests/debug/processDebugManifest/AndroidManifest.xml
android_custom_package=com.example.app
```
For Binary resource support:

```
For binary resources support:

```properties
android_resource_apk=/some/path/to/app/resources.ap_
```

0 comments on commit 1093917

Please sign in to comment.