Allow integration_tests workflow to run against a packaged SDK.

.github/workflows/cpp-packaging.yml

@@ -8,8 +8,6 @@ on:
  - cron: "0 9 * * *" # 9am UTC = 1am PST / 2am PDT
  workflow_dispatch:
  inputs:
- commitIdToPackage:
- description: 'commit ID to package'
  preserveIntermediateArtifacts:
  description: 'preserve intermediate artifacts?'
  default: 0
@@ -39,26 +37,9 @@ env:
  xcodeVersion: "12"
 
 jobs:
- prepare_matrix:
- runs-on: ubuntu-latest
- env:
- USE_EXPANDED_MATRIX: 0
- outputs:
- use_expanded_matrix: ${{ steps.export-result.outputs.use_expanded_matrix }}
- steps:
- - name: Use expanded matrix
- if: github.event_name == 'schedule' || github.event.inputs.use_expanded_matrix == '1'
- run: |
- echo "USE_EXPANDED_MATRIX=1" >> $GITHUB_ENV
- - id: export-result
- run: |
- echo "USE_EXPANDED_MATRIX: ${USE_EXPANDED_MATRIX}"
- echo "::set-output name=use_expanded_matrix::${USE_EXPANDED_MATRIX}"
-
  log_inputs:
  name: log-inputs
  runs-on: ubuntu-latest
- needs: prepare_matrix
  steps:
  - name: log run inputs
  run: |
@@ -67,13 +48,6 @@ jobs:
  elif [[ -n "${{ github.event.inputs.downloadPreviousRun }}" ]]; then
  echo "::warning ::Downloading SDK package from previous run at https://github.com/firebase/firebase-cpp-sdk/actions/runs/${{ github.event.inputs.downloadPreviousRun }}"
  fi
- if [[ -n "${{ github.event.inputs.commitIdToPackage }}" ]]; then
- if [[ -n "${{ github.event.inputs.downloadPublicVersion }}" || -n "${{ github.event.inputs.downloadPreviousRun }}" ]]; then
- echo "::warning ::Using commit ID '${{ github.event.inputs.commitIdToPackage }}' for building tests."
- else
- echo "::warning ::Using commit ID '${{ github.event.inputs.commitIdToPackage }}' for building and packaging SDK and tests."
- fi
- fi
 
  - name: log if skipping integration tests
  if: |
@@ -92,10 +66,13 @@ jobs:
  github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == ''
  run: echo "::warning ::Verbose build enabled."
 
+ - name: log if expanded matrix enabled
+ if: github.event_name == 'schedule' || github.event.inputs.use_expanded_matrix == '1'
+ run: echo "::warning ::Expanded test matrix enabled."
+
  build_tools:
  name: build-tools-${{ matrix.tools_platform }}
  runs-on: ${{ matrix.os }}
- needs: prepare_matrix
  if: ${{ github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == '' }}
  strategy:
  matrix:
@@ -168,7 +145,6 @@ jobs:
  build_and_package_ios:
  name: build-and-package-ios
  runs-on: macos-latest
- needs: prepare_matrix
  if: ${{ github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == '' }}
  steps:
  - name: setup Xcode version (macos)
@@ -179,7 +155,6 @@ jobs:
  uses: actions/checkout@v2.3.1
  with:
  path: sdk-src
- ref: ${{ github.event.inputs.commitIdToPackage }}
 
  - name: install prerequisites
  run: sdk-src/build_scripts/ios/install_prereqs.sh
@@ -215,7 +190,6 @@ jobs:
  build_and_package_android:
  name: build-and-package-android-${{matrix.stl}}
  runs-on: ubuntu-latest
- needs: prepare_matrix
  if: ${{ github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == '' }}
  strategy:
  fail-fast: false
@@ -226,7 +200,6 @@ jobs:
  uses: actions/checkout@v2.3.1
  with:
  path: sdk-src
- ref: ${{ github.event.inputs.commitIdToPackage }}
 
  - name: install prerequisites
  run: sdk-src/build_scripts/android/install_prereqs.sh
@@ -262,7 +235,6 @@ jobs:
  build_desktop:
  name: build-${{ matrix.sdk_platform }}-${{ matrix.architecture }}-${{ matrix.build_type }}-${{ matrix.msvc_runtime }}-${{ matrix.linux_abi }}
  runs-on: ${{ matrix.os }}
- needs: prepare_matrix
  if: ${{ github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == '' }}
  strategy:
  fail-fast: false
@@ -316,7 +288,6 @@ jobs:
  - uses: actions/checkout@v2
  with:
  submodules: true
- ref: ${{ github.event.inputs.commitIdToPackage }}
 
  - name: Set env variables for subsequent steps (all)
  shell: bash
@@ -445,7 +416,6 @@ jobs:
  uses: actions/checkout@v2.3.1
  with:
  path: sdk-src
- ref: ${{ github.event.inputs.commitIdToPackage }}
 
  - name: download artifact
  uses: actions/download-artifact@v2.0.8
@@ -594,7 +564,6 @@ jobs:
  uses: actions/checkout@v2.3.1
  with:
  path: sdk-src
- ref: ${{ github.event.inputs.commitIdToPackage }}
 
  - name: download artifact
  uses: actions/download-artifact@v2.0.8
@@ -668,88 +637,44 @@ jobs:
  failOnError: false
  useGlob: true
 
- tests:
- needs: [merge_packages, download_sdk_package]
+ trigger_integration_tests:
+ # Trigger the integration_tests workflow.
+ needs: [merge_packages, download_sdk_package, cleanup_packaging_artifacts]
  if: (github.event.inputs.skipIntegrationTests == 0 || github.event.inputs.skipIntegrationTests == '') && !cancelled()
- runs-on: ${{ matrix.os }}
- strategy:
- matrix:
- os: [ubuntu-latest, macos-latest, windows-latest]
- target_platform: [Desktop, Android, iOS]
- exclude:
- - os: ubuntu-latest
- target_platform: iOS
- - os: windows-latest
- target_platform: iOS
- fail-fast: false
- env:
- apis: admob,analytics,auth,database,dynamic_links,firestore,functions,installations,instance_id,messaging,remote_config,storage
- android_device: flame
- android_api: 29
- ios_device: iphone8
- ios_version: 11.4
+ runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
  uses: actions/checkout@v2.3.1
- with:
- ref: ${{ github.event.inputs.commitIdToPackage }}
- - name: Setup Xcode version (macos)
- if: runner.os == 'macOS'
- run: sudo xcode-select -s /Applications/Xcode_${{ env.xcodeVersion }}.app/Contents/Developer
- - name: Download Firebase C++ SDK
- uses: actions/download-artifact@v2.0.8
- with:
- name: firebase_cpp_sdk.zip
- - name: Unzip Firebase C++ SDK
- shell: bash
- run: |
- ls
- if [ "$RUNNER_OS" == "Windows" ]; then
- 7z x firebase_cpp_sdk.zip
- else
- unzip -q firebase_cpp_sdk.zip
- fi
+
  - name: Setup python
  uses: actions/setup-python@v2
  with:
  python-version: '3.7'
- - name: Add msbuild to PATH (windows)
- if: runner.os == 'Windows'
- uses: microsoft/setup-msbuild@v1.0.2
- - name: Prepare for integration tests
- run: |
- pip install -r scripts/gha/requirements.txt
- python scripts/gha/restore_secrets.py --passphrase "${{ secrets.TEST_SECRET }}"
- - name: Build integration tests
+ - name: Use expanded matrix
+ if: github.event_name == 'schedule' || github.event.inputs.use_expanded_matrix == '1'
  run: |
- python scripts/gha/build_testapps.py --t ${{ env.apis }} --p ${{ matrix.target_platform }} --packaged_sdk firebase_cpp_sdk --output_directory "${{ github.workspace }}" --noadd_timestamp
-
- - name: Run desktop integration tests
- if: matrix.target_platform == 'Desktop' && !cancelled()
- run: |
- python scripts/gha/desktop_tester.py --testapp_dir testapps
- # Workaround for https://github.com/GoogleCloudPlatform/github-actions/issues/100
- # Must be run after the Python setup action
- - name: Set CLOUDSDK_PYTHON (Windows)
- shell: bash
- if: runner.os == 'Windows' && !cancelled()
- run: echo "CLOUDSDK_PYTHON=${{env.pythonLocation}}\python.exe" >> $GITHUB_ENV
- - name: Install Cloud SDK
- if: ${{ !cancelled() }}
- uses: google-github-actions/setup-gcloud@master
- - name: Upload Desktop Artifacts to GCS
- if: ${{ !cancelled() }}
- run: |
- python scripts/gha/gcs_uploader.py --testapp_dir testapps --key_file scripts/gha-encrypted/gcs_key_file.json
- - name: Run mobile integration tests
- if: matrix.target_platform != 'Desktop' && !cancelled()
- run: |
- python scripts/gha/test_lab.py --android_model ${{ env.android_device }} --android_api ${{ env.android_api }} --ios_model ${{ env.ios_device }} --ios_version ${{ env.ios_version }} --testapp_dir testapps --code_platform cpp --key_file scripts/gha-encrypted/gcs_key_file.json
- - name: Summarize build and test results
- if: ${{ !cancelled() }}
+ echo "USE_EXPANDED_MATRIX=1" >> $GITHUB_ENV
+ - name: Generate token for GitHub API
+ # This step is necessary because the existing GITHUB_TOKEN cannot be used inside one workflow to trigger another.
+ # 
+ # Instead, generate a new token here, using our GitHub App's private key and App ID (saved as Secrets).
+ # 
+ # This method is preferred over the "personal access token" solution, as the GitHub App's scope is limited to just
+ # the firebase-cpp-sdk repository.
+ uses: tibdex/github-app-token@v1
+ id: generate-token
+ with:
+ app_id: ${{ secrets.WORKFLOW_TRIGGER_APP_ID }}
+ private_key: ${{ secrets.WORKFLOW_TRIGGER_APP_PRIVATE_KEY }}
+ - name: Use GitHub API to start workflow
  shell: bash
  run: |
- cat testapps/summary.log
- if [[ "${{ job.status }}" != "success" ]]; then
- exit 1
+ if [[ -z ${USE_EXPANDED_MATRIX} ]]; then
+ USE_EXPANDED_MATRIX=0
+ fi
+ verbose_flag=
+ if [[ -n "${{ github.event.inputs.verboseBuild }}" && "${{ github.event.inputs.verboseBuild }}" -ne 0 ]]; then
+ verbose_flag=-v
  fi
+ set -e
+ python scripts/gha/trigger_workflow.py -t ${{ steps.generate-token.outputs.token }} -w integration_tests.yml -p test_packaged_sdk ${{ github.run_id }} -p use_expanded_matrix ${USE_EXPANDED_MATRIX} -A ${verbose_flag}

.github/workflows/integration_tests.yml

@@ -36,7 +36,9 @@ on:
  use_expanded_matrix:
  description: 'Use an expanded matrix? Note: above config will be ignored.'
  default: '0'
- required: true 
+ required: true
+ test_packaged_sdk:
+ description: 'Optional: Packaging run # to build against?'
 
 jobs:
  # To feed input into the job matrix, we first need to convert to a JSON
@@ -65,13 +67,20 @@ jobs:
  run: |
  echo "::set-output name=matrix_platform::$( python scripts/gha/print_matrix_configuration.py -w integration_tests ${EXPANDED_MATRIX_PARAM} -k platform -o "${{github.event.inputs.platforms}}" )"
  echo "::set-output name=matrix_os::$( python scripts/gha/print_matrix_configuration.py -w integration_tests ${EXPANDED_MATRIX_PARAM} -k os -o "${{github.event.inputs.operating_systems}}" )"
- echo "::set-output name=matrix_ssl::$( python scripts/gha/print_matrix_configuration.py -w integration_tests ${EXPANDED_MATRIX_PARAM} -k ssl_lib -o "${{github.event.inputs.desktop_ssl_variants}}" )"
+ # If building against a packaged SDK, only use boringssl.
+ if [[ -n "${{ github.event.inputs.test_packaged_sdk }}" ]]; then
+ echo "::warning ::Downloading SDK package from previous run at https://github.com/firebase/firebase-cpp-sdk/actions/runs/${{ github.event.inputs.test_packaged_sdk }}"
+ # Because the mobile tests require this value to be set to 'openssl', set it to 'openssl' here but don't actually install openssl later.
+ echo "::set-output name=matrix_ssl::$( python scripts/gha/print_matrix_configuration.py -w integration_tests ${EXPANDED_MATRIX_PARAM} -k ssl_lib -o openssl )"
+ else
+ echo "::set-output name=matrix_ssl::$( python scripts/gha/print_matrix_configuration.py -w integration_tests ${EXPANDED_MATRIX_PARAM} -k ssl_lib -o "${{github.event.inputs.desktop_ssl_variants}}" )"
+ fi
  echo "::set-output name=apis::$( python scripts/gha/print_matrix_configuration.py -c -w integration_tests -k apis -o "${{github.event.inputs.apis}}" )"
  echo "::set-output name=android_device::$( python scripts/gha/print_matrix_configuration.py -c -w integration_tests -k android_device -o "${{github.event.inputs.android_device}}" )"
  echo "::set-output name=android_api::$( python scripts/gha/print_matrix_configuration.py -c -w integration_tests -k android_api -o "${{github.event.inputs.android_api}}" )"
  echo "::set-output name=ios_device::$( python scripts/gha/print_matrix_configuration.py -c -w integration_tests -k ios_device -o "${{github.event.inputs.ios_device}}" )"
  echo "::set-output name=ios_version::$( python scripts/gha/print_matrix_configuration.py -c -w integration_tests -k ios_version -o "${{github.event.inputs.ios_version}}" )"
- 
+
  tests:
  name: ${{ matrix.os }}-${{ matrix.target_platform }}-${{ matrix.ssl_variant }}
  needs: prepare_matrix
@@ -96,7 +105,6 @@ jobs:
  - uses: actions/checkout@v2
  with:
  submodules: true
-
  - name: Set env vars (ubuntu)
  if: startsWith(matrix.os, 'ubuntu')
  run: echo "VCPKG_TRIPLET=x64-linux" >> $GITHUB_ENV
@@ -172,15 +180,35 @@ jobs:
  run: |
  sudo apt install openssl
 
+ - name: fetch artifact from previous run
+ uses: dawidd6/action-download-artifact@v2
+ if: ${{ github.event.inputs.test_packaged_sdk != '' }}
+ with:
+ name: 'firebase_cpp_sdk.zip'
+ workflow: 'cpp-packaging.yml'
+ run_id: ${{ github.event.inputs.test_packaged_sdk }}
+
  - name: Build integration tests
  shell: bash
  run: |
- # Default SSL is openssl.
- ssl_option=
- if [[ "${{ matrix.ssl_variant }}" == "boringssl" ]]; then
- ssl_option=--cmake_flag=-DFIREBASE_USE_BORINGSSL=ON
+ declare -a additional_flags
+ if [[ -n "${{ github.event.inputs.test_packaged_sdk }}" ]]; then
+ # Building integration tests against a packaged SDK.
+ mkdir downloaded_sdk
+ cd downloaded_sdk
+ unzip -q ../firebase_cpp_sdk.zip
+ cd ..
+ additional_flags+=(--packaged_sdk downloaded_sdk/firebase_cpp_sdk)
+ else
+ # Building integration tests against the SDK source.
+ #
+ # When building the SDK from source, the default SSL is openssl.
+ # To build using boringssl, a cmake flag must be added:
+ if [[ "${{ matrix.ssl_variant }}" == "boringssl" ]]; then
+ additional_flags+=(--cmake_flag=-DFIREBASE_USE_BORINGSSL=ON)
+ fi
  fi
- python scripts/gha/build_testapps.py --t ${{ needs.prepare_matrix.outputs.apis }} --p ${{ matrix.target_platform }} --output_directory "${{ github.workspace }}" --noadd_timestamp ${ssl_option}
+ python scripts/gha/build_testapps.py --t ${{ needs.prepare_matrix.outputs.apis }} --p ${{ matrix.target_platform }} --output_directory "${{ github.workspace }}" --noadd_timestamp ${additional_flags[*]}
 
  - name: Run desktop integration tests
  if: matrix.target_platform == 'Desktop' && !cancelled()

database/integration_test/src/integration_test.cc

@@ -800,6 +800,8 @@ class LoggingValueListener : public firebase::database::ValueListener {
 };
 
 TEST_F(FirebaseDatabaseTest, TestAddAndRemoveListenerRace) {
+ SKIP_TEST_ON_MOBILE;
+
  const char* test_name = test_info_->name();
 
  SignIn();