[#718] Use variables for Test Lab
This will make it easier for team members to find links to test results
This commit is contained in:
Carter Jernigan
GitHub
parent
bb9a7e2a02
commit
811e2cd5ce
|
|
@ -1,9 +1,11 @@
|
|||
# Expected secrets
|
||||
# EMULATOR_WTF_API_KEY - Optional API key for emulator.wtf
|
||||
# FIREBASE_TEST_LAB_PROJECT - Firebase Test Lab project name
|
||||
# FIREBASE_TEST_LAB_SERVICE_ACCOUNT - Email address of Firebase Test Lab service account
|
||||
# FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER - Workload identity provider to generate temporary service account key
|
||||
|
||||
# Expected variables
|
||||
# FIREBASE_TEST_LAB_PROJECT - Firebase Test Lab project name
|
||||
|
||||
name: Pull Request
|
||||
|
||||
on:
|
||||
|
|
@ -55,7 +57,7 @@ jobs:
|
|||
steps:
|
||||
- id: check_firebase_secrets
|
||||
env:
|
||||
FIREBASE_TEST_LAB_PROJECT: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
FIREBASE_TEST_LAB_PROJECT: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
FIREBASE_TEST_LAB_SERVICE_ACCOUNT: ${{ secrets.FIREBASE_TEST_LAB_SERVICE_ACCOUNT }}
|
||||
FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER: ${{ secrets.FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER }}
|
||||
if: "${{ env.FIREBASE_TEST_LAB_PROJECT != '' && env.FIREBASE_TEST_LAB_SERVICE_ACCOUNT != '' && env.FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER != '' }}"
|
||||
|
|
@ -239,7 +241,7 @@ jobs:
|
|||
uses: google-github-actions/auth@ef5d53e30bbcd8d0836f4288f5e50ff3e086997d
|
||||
with:
|
||||
create_credentials_file: true
|
||||
project_id: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
project_id: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
service_account: ${{ secrets.FIREBASE_TEST_LAB_SERVICE_ACCOUNT }}
|
||||
workload_identity_provider: ${{ secrets.FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER }}
|
||||
access_token_lifetime: '1200s'
|
||||
|
|
@ -249,7 +251,7 @@ jobs:
|
|||
# Force blank suffix for screenshot tests
|
||||
ORG_GRADLE_PROJECT_ZCASH_DEBUG_APP_NAME_SUFFIX: ""
|
||||
# Used by Flank, since the temporary token is missing the project name
|
||||
GOOGLE_CLOUD_PROJECT: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
GOOGLE_CLOUD_PROJECT: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
ORG_GRADLE_PROJECT_ZCASH_FIREBASE_TEST_LAB_API_KEY_PATH: ${{ steps.auth_test_lab.outputs.credentials_file_path }}
|
||||
# Because Fulladle doesn't allow Test Orchestrator to be enabled/disabled for a specific submodule, it must be enabled for all modules
|
||||
ORG_GRADLE_PROJECT_IS_USE_TEST_ORCHESTRATOR: true
|
||||
|
|
@ -342,7 +344,7 @@ jobs:
|
|||
uses: google-github-actions/auth@ef5d53e30bbcd8d0836f4288f5e50ff3e086997d
|
||||
with:
|
||||
create_credentials_file: true
|
||||
project_id: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
project_id: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
service_account: ${{ secrets.FIREBASE_TEST_LAB_SERVICE_ACCOUNT }}
|
||||
workload_identity_provider: ${{ secrets.FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER }}
|
||||
access_token_lifetime: '900s'
|
||||
|
|
@ -350,7 +352,7 @@ jobs:
|
|||
timeout-minutes: 20
|
||||
env:
|
||||
# This first environment variable is used by Flank, since the temporary token is missing the project name
|
||||
GOOGLE_CLOUD_PROJECT: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
GOOGLE_CLOUD_PROJECT: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
ORG_GRADLE_PROJECT_ZCASH_FIREBASE_TEST_LAB_API_KEY_PATH: ${{ steps.auth_test_lab.outputs.credentials_file_path }}
|
||||
run: |
|
||||
./gradlew :app:runFlankSanityConfigDebug
|
||||
|
|
@ -423,7 +425,7 @@ jobs:
|
|||
uses: google-github-actions/auth@ef5d53e30bbcd8d0836f4288f5e50ff3e086997d
|
||||
with:
|
||||
create_credentials_file: true
|
||||
project_id: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
project_id: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
service_account: ${{ secrets.FIREBASE_TEST_LAB_SERVICE_ACCOUNT }}
|
||||
workload_identity_provider: ${{ secrets.FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER }}
|
||||
access_token_lifetime: '900s'
|
||||
|
|
@ -437,7 +439,7 @@ jobs:
|
|||
# Path depends on `release_build` job, plus path of `Download a single artifact` step
|
||||
BINARIES_ZIP_PATH: binaries.zip
|
||||
# This first environment variable is used by Flank, since the temporary token is missing the project name
|
||||
GOOGLE_CLOUD_PROJECT: ${{ secrets.FIREBASE_TEST_LAB_PROJECT }}
|
||||
GOOGLE_CLOUD_PROJECT: ${{ vars.FIREBASE_TEST_LAB_PROJECT }}
|
||||
ORG_GRADLE_PROJECT_ZCASH_FIREBASE_TEST_LAB_API_KEY_PATH: ${{ steps.auth_test_lab.outputs.credentials_file_path }}
|
||||
run: |
|
||||
unzip ${BINARIES_ZIP_PATH}
|
||||
|
|
|
|||
29
docs/CI.md
29
docs/CI.md
|
|
@ -6,17 +6,19 @@ Workflows exist for:
|
|||
* Deploy - Work in progress. On merge to the main branch, a release build is automatically deployed. Concurrency limits are in place, to ensure that only one release deployment can happen at a time.
|
||||
|
||||
## Setup
|
||||
When forking this repository, some secrets need to be defined to set up new continuous integration builds.
|
||||
When forking this repository, some variables/secrets need to be defined to set up new continuous integration builds.
|
||||
|
||||
The secrets passed to GitHub Actions then map to Gradle properties set up within our build scripts. Necessary secrets are documented at the top of each GitHub workflow yml file, as well as reiterated here.
|
||||
The variables/secrets passed to GitHub Actions then map to Gradle properties set up within our build scripts. Necessary secrets are documented at the top of each GitHub workflow yml file, as well as reiterated here.
|
||||
|
||||
To enhance security, [OpenID Connect](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform) is used to generate temporary access tokens for each build.
|
||||
|
||||
### Pull request
|
||||
* `EMULATOR_WTF_API_KEY` - API key for [Emulator.wtf](https://emulator.wtf)
|
||||
* `FIREBASE_TEST_LAB_PROJECT` - Firebase Test Lab project name.
|
||||
* `FIREBASE_TEST_LAB_SERVICE_ACCOUNT` - Email address of Firebase Test Lab service account.
|
||||
* `FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER` - Workload identity provider to generate temporary service account key.
|
||||
* Variables
|
||||
* `FIREBASE_TEST_LAB_PROJECT` - Firebase Test Lab project name.
|
||||
* Secrets
|
||||
* `EMULATOR_WTF_API_KEY` - API key for [Emulator.wtf](https://emulator.wtf)
|
||||
* `FIREBASE_TEST_LAB_SERVICE_ACCOUNT` - Email address of Firebase Test Lab service account.
|
||||
* `FIREBASE_TEST_LAB_WORKLOAD_IDENTITY_PROVIDER` - Workload identity provider to generate temporary service account key.
|
||||
|
||||
The Pull Request workflow supports testing of the app and libraries with both Emulator.wtf and Firebase Test Lab. By default, Emulator.wtf is used for library instrumentation tests, while Firebase Test Lab is used for a robo test.
|
||||
|
||||
|
|
@ -29,13 +31,14 @@ Note that pull requests will create a "release" build with a temporary fake sign
|
|||
- Firebase, Google Play Services, and Google Maps won't work since they use the signing key to restrict API access. The app does not currently use these services, so this is a non-issue for now.
|
||||
|
||||
### Release deployment
|
||||
* `GOOGLE_PLAY_CLOUD_PROJECT` - Google Cloud project associated with Google Play.
|
||||
* `GOOGLE_PLAY_SERVICE_ACCOUNT` - Email address of service account.
|
||||
* `GOOGLE_PLAY_WORKLOAD_IDENTITY_PROVIDER` - Workload identity provider to generate temporary service account key
|
||||
* `UPLOAD_KEYSTORE_BASE_64` — Base64 encoded upload keystore.
|
||||
* `UPLOAD_KEYSTORE_PASSWORD` — Password for upload keystore.
|
||||
* `UPLOAD_KEY_ALIAS` — Name of key inside upload keystore.
|
||||
* `UPLOAD_KEY_ALIAS_PASSWORD` — Password for key alias.
|
||||
* Secrets
|
||||
* `GOOGLE_PLAY_CLOUD_PROJECT` - Google Cloud project associated with Google Play.
|
||||
* `GOOGLE_PLAY_SERVICE_ACCOUNT` - Email address of service account.
|
||||
* `GOOGLE_PLAY_WORKLOAD_IDENTITY_PROVIDER` - Workload identity provider to generate temporary service account key
|
||||
* `UPLOAD_KEYSTORE_BASE_64` — Base64 encoded upload keystore.
|
||||
* `UPLOAD_KEYSTORE_PASSWORD` — Password for upload keystore.
|
||||
* `UPLOAD_KEY_ALIAS` — Name of key inside upload keystore.
|
||||
* `UPLOAD_KEY_ALIAS_PASSWORD` — Password for key alias.
|
||||
|
||||
To obtain the values for the Google Play deployment, you'll need to
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue