Skip to content

Improve contributor documentation for Android #9913

@GregoryComer

Description

@GregoryComer

🚀 The feature, motivation and pitch

When trying to run Android tests, I ran into a few issues. It would be good to document the full process to run Android tests from a clean checkout, in order to help contributors.

Specifically, I had a bit of trouble with the following:

  • I was missing the PTEs, and dug through the CI scripts to learn that I needed to run a CI script to generate them and then copy them to the build directory.
  • I had difficultly getting the AAR bundled with the app. I was able to build it, but wasn't sure how to bundle it in a way that the tests can access. When running the tests, it would fail due to it being unable to find the AAR.

It would be great if we could include some information, either in CONTRIBUTING.md or in a readme under the Android test directory on the full process to run the tests locally from a clean checkout.

It would be great if we could go even further and integrate them seamlessly into the gradle build such that you could just run from Android Studio, but I'm not sure how practical that is. Even if we need to build the AAR separately, could we integrate the test PTE generation as a build step in gradle?

Alternatives

No response

Additional context

No response

RFC (Optional)

No response

cc @mergennachin @byjlw @kirklandsign @cbilgin

Metadata

Metadata

Assignees

Labels

module: androidIssues related to Android code, build, and executionmodule: docIssues related to documentation, both in docs/ and inlined in codetriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions