[AI] Few more generable structured output tests #471
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2020 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: sdk.firestore | |
| permissions: | |
| contents: read | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| schedule: | |
| # Run every day at 1am (PDT) / 4am (EDT) - cron uses UTC times | |
| - cron: '0 8 * * *' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| changes: | |
| runs-on: macos-14 | |
| outputs: | |
| changed: ${{ steps.firestore_src_changes.outputs.sources == 'true' || steps.related_changes.outputs.other_changes == 'true' }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | |
| id: firestore_src_changes | |
| with: | |
| predicate-quantifier: 'every' | |
| filters: | | |
| sources: | |
| # Firestore sources | |
| - 'Firestore/**' | |
| - '!Firestore/**/*.md' | |
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | |
| id: related_changes | |
| with: | |
| filters: | | |
| other_changes: | |
| # Interop headers | |
| - 'FirebaseAuth/Interop/*.h' | |
| # FirebaseCore header change | |
| - 'FirebaseCore/Internal' | |
| - 'FirebaseCore/Sources/Public' | |
| # Podspec | |
| - 'FirebaseFirestoreInternal.podspec' | |
| - 'FirebaseFirestore.podspec' | |
| # Package.swift | |
| - 'Package.swift' | |
| # CMake | |
| - '**CMakeLists.txt' | |
| - 'cmake/**' | |
| # Build scripts to which Firestore is sensitive | |
| # | |
| # Note that this doesn't include check scripts because changing those will | |
| # already trigger the check workflow. | |
| - 'scripts/binary_to_array.py' | |
| - 'scripts/build.sh' | |
| - 'scripts/install_prereqs.sh' | |
| - 'scripts/localize_podfile.swift' | |
| - 'scripts/pod_lib_lint.rb' | |
| - 'scripts/run_firestore_emulator.sh' | |
| - 'scripts/setup_*' | |
| - 'scripts/sync_project.rb' | |
| - 'scripts/test_quickstart.sh' | |
| - 'scripts/xcresult_logs.py' | |
| # This workflow | |
| - '.github/workflows/sdk.firestore.yml' | |
| # Workflows this one depends on. | |
| - '.github/workflows/_spm.yml' | |
| - '.github/workflows/_cocoapods.yml' | |
| # Rebuild on Ruby infrastructure changes. | |
| - 'Gemfile*' | |
| check: | |
| needs: changes | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request' && needs.changes.outputs.changed == 'true') | |
| runs-on: macos-14 | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: 3.11 | |
| - name: Setup check | |
| run: scripts/setup_check.sh | |
| - name: Run check | |
| run: scripts/check.sh --test-only | |
| cmake: | |
| needs: [changes, check] | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request' && needs.changes.outputs.changed == 'true') | |
| strategy: | |
| matrix: | |
| os: [macos-14, ubuntu-latest] | |
| env: | |
| MINT_PATH: ${{ github.workspace }}/mint | |
| USE_LATEST_CMAKE: false | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Prepare ccache | |
| uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 | |
| with: | |
| path: ${{ runner.temp }}/ccache | |
| key: firestore-ccache-${{ runner.os }}-${{ github.sha }} | |
| restore-keys: | | |
| firestore-ccache-${{ runner.os }}- | |
| - name: Cache Mint packages | |
| uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 | |
| with: | |
| path: ${{ env.MINT_PATH }} | |
| key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }} | |
| restore-keys: ${{ runner.os }}-mint- | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: '3.11' | |
| - name: Setup cmake | |
| uses: jwlawson/actions-setup-cmake@802fa1a2c4e212495c05bf94dba2704a92a472be | |
| with: | |
| cmake-version: '3.31.1' | |
| - name: Setup build | |
| run: scripts/install_prereqs.sh Firestore ${{ runner.os }} cmake | |
| - name: Build and test | |
| run: | | |
| export CCACHE_DIR=${{ runner.temp }}/ccache | |
| scripts/third_party/travis/retry.sh scripts/build.sh Firestore ${{ runner.os }} cmake | |
| sanitizers-mac: | |
| needs: [changes, check] | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request' && needs.changes.outputs.changed == 'true') | |
| strategy: | |
| matrix: | |
| os: [macos-14] | |
| sanitizer: [asan, tsan] | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| SANITIZERS: ${{ matrix.sanitizer }} | |
| USE_LATEST_CMAKE: false | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Prepare ccache | |
| uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 | |
| with: | |
| path: ${{ runner.temp }}/ccache | |
| key: ${{ matrix.sanitizer }}-firestore-ccache-${{ runner.os }}-${{ github.sha }} | |
| restore-keys: | | |
| ${{ matrix.sanitizer }}-firestore-ccache-${{ runner.os }}- | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: '3.11' | |
| - name: Setup cmake | |
| uses: jwlawson/actions-setup-cmake@802fa1a2c4e212495c05bf94dba2704a92a472be | |
| with: | |
| cmake-version: '3.31.1' | |
| - name: Setup build | |
| run: scripts/install_prereqs.sh Firestore ${{ runner.os }} cmake | |
| - name: Build and test | |
| run: | | |
| export CCACHE_DIR=${{ runner.temp }}/ccache | |
| scripts/third_party/travis/retry.sh scripts/build.sh Firestore ${{ runner.os }} cmake | |
| sanitizers-ubuntu: | |
| needs: [changes, check] | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request' && needs.changes.outputs.changed == 'true') | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| # Excluding TSAN on ubuntu because of the warnings it generates around schedule.cc. | |
| # This could be due to Apple Clang provide additional support for synchronization | |
| # on Apple platforms, which is what we primarily care about. | |
| sanitizer: [asan] | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| SANITIZERS: ${{ matrix.sanitizer }} | |
| ASAN_OPTIONS: detect_leaks=0 | |
| USE_LATEST_CMAKE: false | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Prepare ccache | |
| uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 | |
| with: | |
| path: ${{ runner.temp }}/ccache | |
| key: ${{ matrix.sanitizer }}-firestore-ccache-${{ runner.os }}-${{ github.sha }} | |
| restore-keys: | | |
| ${{ matrix.sanitizer }}-firestore-ccache-${{ runner.os }}- | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: '3.11' | |
| - name: Setup cmake | |
| uses: jwlawson/actions-setup-cmake@802fa1a2c4e212495c05bf94dba2704a92a472be | |
| with: | |
| cmake-version: '3.31.1' | |
| - name: Setup build | |
| run: scripts/install_prereqs.sh Firestore ${{ runner.os }} cmake | |
| - name: Build and test | |
| run: | | |
| export CCACHE_DIR=${{ runner.temp }}/ccache | |
| scripts/third_party/travis/retry.sh scripts/build.sh Firestore ${{ runner.os }} cmake | |
| xcodetest_prod: | |
| needs: check | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false) | |
| runs-on: macos-15 | |
| strategy: | |
| matrix: | |
| target: [iOS, macOS, tvOS] | |
| scheme: [Firestore, FirestoreEnterprise] | |
| env: | |
| plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1 | |
| - name: Install Secret GoogleService-Info.plist | |
| run: scripts/decrypt_gha_secret.sh scripts/gha-encrypted/firestore.plist.gpg \ | |
| Firestore/Example/App/GoogleService-Info.plist "$plist_secret" | |
| - name: Select Xcode | |
| run: sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer | |
| - name: Install simulators in case they are missing. | |
| if: matrix.target != 'macOS' | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 15 | |
| max_attempts: 5 | |
| retry_wait_seconds: 120 | |
| command: sudo xcodebuild -downloadPlatform ${{ matrix.target }} | |
| # 'FirestoreEnterprise' is used as product name for `build.sh` to select the enterprise build variant. `install_prereqs.sh` does not require this distinction, so 'Firestore' is used. | |
| - name: Setup build | |
| run: scripts/install_prereqs.sh Firestore ${{ matrix.target }} xcodebuild | |
| - name: Build | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 60 | |
| command: scripts/build.sh ${{ matrix.scheme }} ${{ matrix.target }} xcodebuild | |
| - name: Test | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 60 | |
| max_attempts: 3 | |
| retry_wait_seconds: 120 | |
| command: scripts/build.sh ${{ matrix.scheme }} ${{ matrix.target }} xcodetest | |
| xcodetest_emulator: | |
| needs: check | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request') | |
| runs-on: macos-15 | |
| strategy: | |
| matrix: | |
| target: [iOS, macOS, tvOS] | |
| # Skip the FirestoreEnterprise test against emulator since emulator is under development. | |
| scheme: [Firestore] | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1 | |
| - name: Select Xcode | |
| run: sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer | |
| - name: Install simulators in case they are missing. | |
| if: matrix.target != 'macOS' | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 15 | |
| max_attempts: 5 | |
| retry_wait_seconds: 120 | |
| command: sudo xcodebuild -downloadPlatform ${{ matrix.target }} | |
| - name: Setup build | |
| # 'FirestoreEnterprise' is used as product name for `build.sh` to select the enterprise build variant. `install_prereqs.sh` does not require this distinction, so 'Firestore' is used. | |
| run: scripts/install_prereqs.sh Firestore ${{ matrix.target }} xcodebuild | |
| - name: Build | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 120 | |
| command: scripts/build.sh ${{ matrix.scheme }} ${{ matrix.target }} xcodebuild | |
| - name: Test | |
| uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3 | |
| with: | |
| timeout_minutes: 120 | |
| max_attempts: 3 | |
| retry_wait_seconds: 120 | |
| command: scripts/build.sh ${{ matrix.scheme }} ${{ matrix.target }} xcodetest | |
| pod_lib_lint: | |
| needs: check | |
| strategy: | |
| matrix: | |
| product: ['FirebaseFirestoreInternal', 'FirebaseFirestore'] | |
| uses: ./.github/workflows/_cocoapods.yml | |
| with: | |
| product: ${{ matrix.product }} | |
| platforms: iOS | |
| allow_warnings: true | |
| analyze: false # TODO(#9565, b/227461966): Remove when absl is fixed. | |
| timeout_minutes: 40 | |
| # `pod lib lint` takes a long time so only run the other platforms and static frameworks build in the cron. | |
| pod-lib-lint-cron: | |
| needs: check | |
| if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk' | |
| strategy: | |
| matrix: | |
| podspec: [ | |
| 'FirebaseFirestoreInternal.podspec', | |
| 'FirebaseFirestore.podspec', | |
| ] | |
| platforms: [ | |
| 'macos', | |
| 'tvos', | |
| 'ios', | |
| ] | |
| flags: [ | |
| '--use-static-frameworks', | |
| '', | |
| ] | |
| os: [macos-15] | |
| xcode: [Xcode_16.4] | |
| # Skip matrix cells covered by pod-lib-lint job. | |
| exclude: | |
| - os: macos-15 | |
| platforms: 'ios' | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1 | |
| - name: Setup Bundler | |
| run: ./scripts/setup_bundler.sh | |
| - name: Xcode | |
| run: sudo xcode-select -s /Applications/${{ matrix.xcode }}.app/Contents/Developer | |
| - name: Pod lib lint | |
| # TODO(#9565, b/227461966): Remove --no-analyze when absl is fixed. | |
| run: | | |
| scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb ${{ matrix.podspec }}\ | |
| ${{ matrix.flags }} \ | |
| --platforms=${{ matrix.platforms }} \ | |
| --allow-warnings \ | |
| --no-analyze | |
| spm-package-resolved: | |
| runs-on: macos-14 | |
| env: | |
| FIREBASECI_USE_LATEST_GOOGLEAPPMEASUREMENT: 1 | |
| FIREBASE_SOURCE_FIRESTORE: 1 | |
| outputs: | |
| cache_key: ${{ steps.generate_cache_key.outputs.cache_key }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Xcode | |
| run: sudo xcode-select -s /Applications/Xcode_16.2.app/Contents/Developer | |
| - name: Generate Swift Package.resolved | |
| id: swift_package_resolve | |
| run: | | |
| swift package resolve | |
| - name: Generate cache key | |
| id: generate_cache_key | |
| run: | | |
| cache_key="${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}" | |
| echo "cache_key=${cache_key}" >> "$GITHUB_OUTPUT" | |
| - uses: actions/cache/save@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 | |
| id: cache | |
| with: | |
| path: .build | |
| key: ${{ steps.generate_cache_key.outputs.cache_key }} | |
| spm-source: | |
| needs: [check, spm-package-resolved] | |
| # Either a scheduled run from public repo, or a pull request with firestore changes. | |
| if: | | |
| (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || | |
| (github.event_name == 'pull_request') | |
| strategy: | |
| matrix: | |
| include: | |
| - os: macos-14 | |
| xcode: Xcode_16.2 | |
| target: iOS | |
| - os: macos-15 | |
| xcode: Xcode_16.4 | |
| target: iOS | |
| - os: macos-15 | |
| xcode: Xcode_16.4 | |
| target: tvOS | |
| - os: macos-15 | |
| xcode: Xcode_16.4 | |
| target: macOS | |
| - os: macos-15 | |
| xcode: Xcode_16.4 | |
| target: catalyst | |
| - os: macos-15 | |
| xcode: Xcode_16.4 | |
| target: visionOS | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| FIREBASE_SOURCE_FIRESTORE: 1 | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Xcode | |
| run: sudo xcode-select -s /Applications/${{ matrix.xcode }}.app/Contents/Developer | |
| - name: Initialize xcodebuild | |
| run: scripts/setup_spm_tests.sh | |
| - name: iOS Build Test | |
| run: scripts/third_party/travis/retry.sh ./scripts/build.sh FirebaseFirestore ${{ matrix.target }} spmbuildonly | |
| spm-binary: | |
| uses: ./.github/workflows/_spm.yml | |
| with: | |
| target: FirebaseFirestore | |
| platforms: iOS | |
| buildonly_platforms: iOS | |
| spm-source-cron: | |
| # Don't run on private repo. | |
| if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk' | |
| runs-on: macos-14 | |
| strategy: | |
| matrix: | |
| target: [tvOS, macOS, catalyst] | |
| env: | |
| FIREBASE_SOURCE_FIRESTORE: 1 | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Xcode | |
| run: sudo xcode-select -s /Applications/Xcode_16.2.app/Contents/Developer | |
| - name: Initialize xcodebuild | |
| run: scripts/setup_spm_tests.sh | |
| - name: Build Test - Binary | |
| run: scripts/third_party/travis/retry.sh ./scripts/build.sh FirebaseFirestore ${{ matrix.target }} spmbuildonly | |
| spm-binary-cron: | |
| # Don't run on private repo. | |
| if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk' | |
| runs-on: macos-15 | |
| strategy: | |
| matrix: | |
| target: [tvOS, macOS, catalyst] | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Xcode | |
| run: sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer | |
| - name: Initialize xcodebuild | |
| run: scripts/setup_spm_tests.sh | |
| - name: Build Test - Binary | |
| run: scripts/third_party/travis/retry.sh ./scripts/build.sh FirebaseFirestore ${{ matrix.target }} spmbuildonly | |
| # A job that fails if any required job in the test matrix fails, | |
| # to be used as a required check for merging. | |
| check-required-tests: | |
| runs-on: ubuntu-latest | |
| name: Check all required Firestore tests results | |
| needs: | |
| - cmake | |
| - xcodetest_emulator | |
| - xcodetest_prod | |
| - spm-source | |
| - spm-binary | |
| - sanitizers-mac | |
| - sanitizers-ubuntu | |
| - pod_lib_lint | |
| steps: | |
| - name: Check test matrix | |
| if: contains(needs.*.result, 'failure') | |
| run: exit 1 | |
| # TODO: Disable until FirebaseUI is updated to accept Firebase 9 and | |
| # quickstart is updated to accept Firebase UI 12 | |
| # quickstart: | |
| # uses: ./.github/workflows/_quickstart.yml | |
| # with: | |
| # product: Firestore | |
| # setup_command: scripts/setup_quickstart.sh firestore | |
| # plist_src_path: scripts/gha-encrypted/qs-firestore.plist.gpg | |
| # plist_dst_path: quickstart-ios/firestore/GoogleService-Info.plist | |
| # run_tests: false | |
| # secrets: | |
| # plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }} |