Skip to content

Latest commit

 

History

History
134 lines (102 loc) · 4.65 KB

CONTRIBUTING.md

File metadata and controls

134 lines (102 loc) · 4.65 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Building and Testing

AndroidX Test uses the Bazel build system.

Currently only Linux is fully supported. For Mac and windows users, you may be able to build and run the Robolectric tests.

One time setup

  • Fork and clone the AndroidX Test repo
  • Install Bazel. Version 4.2.2 is recommended. For instrumentation testing on Linux make sure your environment meets the following prerequisites
  • Install maven and make it available on PATH.
  • Install the Android SDK and run the following command to ensure you have the necessary components: ./tools/bin/sdkmanager --install 'build-tools;30.0.3' 'platforms;android-30' 'platforms;android-31' 'emulator' 'platform-tools' 'system-images;android-19;default;x86' 'system-images;android-21;default;x86' 'system-images;android-22;default;x86' 'system-images;android-23;default;x86'
  • Set the ANDROID_HOME environment variable to point to the SDK install location. For example
    • On Linux: export ANDROID_HOME=/home/$USER/Android/Sdk
    • On Mac: export ANDROID_HOME=/Users/$USER/Library/Android/sdk You can also add this command to your ~/.bashrc, ~/.zshrc, or ~/.profile file to make it permanent.

IDE setup

Android Studio is recommended.

  • Install the Bazel Android Studio plugin.
  • Setup Bazel Android Studio plugin:
    • Navigate to Settings > Other Settings > Bazel Settings
    • Update Bazel binary location to /path/to/bazel/binary (on Mac it's usually /usr/local/bin/bazel)
  • Select 'Import Bazel project' and set workspace location to android-test github repo
  • Select 'Import project view' and select /.bazelproject

Check Troubleshooting for tips on resolving common build issues.

Building

bazel build <target path>

For example, to build the AndroidX Test maven repository:

bazel build :axt_m2repository

Testing

bazel test <target path> --spawn_strategy=local

eg to run the androidx-test-core tests

bazel test //core/javatests/... --spawn_strategy=local --host_force_python=PY2

To run all the robolectric local tests (and thus replicate the Google Cloud Build CI) bazel test ... --test_tag_filters=robolectric --build_tag_filters=robolectric

Troubleshooting

Unresolved imports after build

If your project fails to build because of unresolved imports two things might be wrong.

  1. Missing Android SDK components. Open SDK Manager in Android Studio and check that the platform and build tools versions specified in the WORKSPACE file are installed. Look at the following variables:

    android_sdk_repository(
    ...
    api_level = 30,
    build_tools_version = "30.0.2",
    ...
)

  2. Something might be wrong with ANDROID_HOME environment variable setup. Try adding the path of the android-sdk to the WORKSPACE file:

    android_sdk_repository(
    ...
    path = "/Users/$USER/Library/Android/sdk",
    ...
)

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

AndroidX Test follows the Google Java Style Guide

Community Guidelines

This project follows Google's Open Source Community Guidelines.