smoke-checks.yml

name: Smoke Checks

on:
  pull_request:
    branches:
      - '**'
    paths-ignore:
      - 'docusaurus/**'
      - 'README.md'
      - 'CHANGELOG.md'

  workflow_dispatch:
    inputs:
      swiftui_snapshots:
        description: 'Should SwiftUI Snapshots be recorded on CI?'
        type: boolean
        required: false
        default: false
      uikit_snapshots:
        description: 'Should UIKit Snapshots be recorded on CI?'
        type: boolean
        required: false
        default: false

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  HOMEBREW_NO_INSTALL_CLEANUP: 1 # Disable cleanup for homebrew, we don't need it on CI
  IOS_SIMULATOR_DEVICE: "iPhone 15 Pro (17.4)"
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  GITHUB_PR_NUM: ${{ github.event.pull_request.number }}

jobs:
  test-llc-debug:
    name: Test LLC (Debug)
    runs-on: macos-14
    if: ${{ github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    env:
      STREAM_VIDEO_SECRET: ${{ secrets.STREAM_VIDEO_SECRET }}
    steps:
    - uses: actions/checkout@v4.1.1
    - uses: ./.github/actions/bootstrap
      env:
        INSTALL_YEETD: true
        SKIP_MINT_BOOTSTRAP: true
    - name: Run LLC Tests (Debug)
      run: bundle exec fastlane test_unified device:"${{ env.IOS_SIMULATOR_DEVICE }}"
      timeout-minutes: 40
      env:
        XCODE_VERSION: "15.2" # the most stable pair of Xcode
        IOS_SIMULATOR_DEVICE: "iPhone 15 Pro (17.2)" # and iOS
    - name: Run Sonar analysis
      run: bundle exec fastlane sonar_upload
      env:
        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
    - uses: actions/upload-artifact@v4
      if: failure()
      with:
        name: LLC Test Data
        path: |
          ~/Library/Logs/scan
    - uses: 8398a7/action-slack@v3
      with:
        status: ${{ job.status }}
        text: "You shall not pass!"
        job_name: "Test LLC (Debug)"
        fields: message,commit,author,action,workflow,job,took
      env:
        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
        MATRIX_CONTEXT: ${{ toJson(matrix) }}
      if: ${{ github.event_name == 'push' && failure() }}
    - name: Parse xcresult
      if: failure()
      run: |
        brew install chargepoint/xcparse/xcparse
        xcparse logs fastlane/test_output/StreamVideo.xcresult fastlane/test_output/logs/
    - uses: actions/upload-artifact@v4
      if: failure()
      with:
        name: Test Data LLC
        path: |
          fastlane/test_output/logs/*/Diagnostics/**/*.txt
          fastlane/test_output/logs/*/Diagnostics/simctl_diagnostics/DiagnosticReports/*

  # test-swiftui-debug:
  #   name: Test SwiftUI (Debug)
  #   runs-on: macos-14
  #   needs: test-llc-debug
  #   if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'false' }}
  #   env:
  #     GITHUB_TOKEN: ${{ secrets.CI_BOT_GITHUB_TOKEN }} # to open a PR
  #   steps:
  #   - uses: actions/checkout@v4.1.1
  #   - uses: ./.github/actions/bootstrap
  #     env:
  #       INSTALL_YEETD: true
  #       SKIP_MINT_BOOTSTRAP: true
  #       SKIP_BREW_BOOTSTRAP: true
  #   - name: Run UI Tests (Debug)
  #     run: bundle exec fastlane test_swiftui device:"${{ env.IOS_SIMULATOR_DEVICE }}" record:${{ github.event.inputs.swiftui_snapshots }}
  #     timeout-minutes: 40
  #     env:
  #       XCODE_VERSION: "15.2" # the most stable pair of Xcode
  #       IOS_SIMULATOR_DEVICE: "iPhone 15 Pro (17.2)" # and iOS
  #   - name: Parse xcresult
  #     if: failure()
  #     run: |
  #       brew install chargepoint/xcparse/xcparse
  #       xcparse screenshots fastlane/test_output/StreamVideoSwiftUI.xcresult fastlane/test_output/snapshots --test
  #   - uses: actions/upload-artifact@v4
  #     if: failure()
  #     with:
  #       name: SwiftUI Test Data
  #       path: |
  #         ~/Library/Logs/scan
  #         fastlane/test_output/snapshots

  # test-uikit-debug:
  #   name: Test UIKit (Debug)
  #   runs-on: macos-14
  #   needs: test-swiftui-debug
  #   if: ${{ github.event_name != 'push' && github.event.inputs.uikit_snapshots != 'false' }}
  #   env:
  #     GITHUB_TOKEN: ${{ secrets.CI_BOT_GITHUB_TOKEN }} # to open a PR
  #   steps:
  #   - uses: actions/checkout@v4.1.1
  #   - uses: ./.github/actions/bootstrap
  #     env:
  #       INSTALL_YEETD: true
  #       SKIP_MINT_BOOTSTRAP: true
  #       SKIP_BREW_BOOTSTRAP: true
  #   - name: Run UI Tests (Debug)
  #     run: bundle exec fastlane test_uikit device:"${{ env.IOS_SIMULATOR_DEVICE }}" record:${{ github.event.inputs.uikit_snapshots }}
  #     timeout-minutes: 40
  #     env:
  #       XCODE_VERSION: "15.2" # the most stable pair of Xcode
  #       IOS_SIMULATOR_DEVICE: "iPhone 15 Pro (17.2)" # and iOS
  #   - name: Parse xcresult
  #     if: failure()
  #     run: |
  #       brew install chargepoint/xcparse/xcparse
  #       xcparse screenshots fastlane/test_output/StreamVideoUIKit.xcresult fastlane/test_output/snapshots --test
  #   - uses: actions/upload-artifact@v4
  #     if: failure()
  #     with:
  #       name: UIKit Test Data
  #       path: |
  #         ~/Library/Logs/scan
  #         fastlane/test_output/snapshots

  automated-code-review:
    name: Automated Code Review
    runs-on: macos-13
    env:
      XCODE_VERSION: "15.0.1"
    if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    steps:
    - uses: actions/checkout@v4.1.1
      with:
        fetch-depth: 100
    - uses: ./.github/actions/bootstrap
    - name: Run Danger
      run: bundle exec danger
    - name: Run Fastlane Linting
      run: bundle exec fastlane rubocop
    - name: Run SwiftFormat Linting
      run: bundle exec fastlane run_swift_format lint:true
    - name: Run Podspec Linting
      if: startsWith(github.event.pull_request.head.ref, 'release/')
      run: bundle exec fastlane pod_lint

  build-xcode15:
    name: Build SDKs (Xcode 15.0)
    runs-on: macos-13
    if: ${{ github.event_name != 'push' && github.event.inputs.snapshots != 'true' }}
    env:
      XCODE_VERSION: "15.0.1"
    steps:
    - name: Connect Bot
      uses: webfactory/ssh-agent@v0.7.0
      with:
        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
    - uses: actions/checkout@v3.1.0
    - name: Cache Xcode Derived Data
      uses: irgaly/xcode-cache@v1
      with:
        key: xcode-15-cache-deriveddata-${{ github.workflow }}-${{ github.sha }}
        deriveddata-directory: derived_data
        sourcepackages-directory: spm_cache
    - uses: ./.github/actions/ruby-cache
    - name: List Xcode versions
      run: mdfind "kMDItemCFBundleIdentifier = 'com.apple.dt.Xcode'"
    - name: Build SDKs
      run: bundle exec fastlane test_unified device:"iPhone 15" build_for_testing:true

  build-xcode15-xcframework-stream-video:
    name: Build StreamVideo XCframework (Xcode 15.0)
    needs: build-xcode15
    runs-on: macos-13
    if: ${{ github.event_name != 'push' && github.event.inputs.snapshots != 'true' }}
    env:
      XCODE_VERSION: "15.0.1"
    steps:
    - name: Connect Bot
      uses: webfactory/ssh-agent@v0.7.0
      with:
        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
    - uses: actions/checkout@v3.1.0
    - name: Cache Xcode Derived Data
      uses: irgaly/xcode-cache@v1
      with:
        key: xcode-15-cache-deriveddata-${{ github.workflow }}-${{ github.sha }}
        deriveddata-directory: derived_data
        sourcepackages-directory: spm_cache
    - uses: ./.github/actions/ruby-cache
    - name: Build StreamVideo XCFramework
      run: bundle exec fastlane build_xcframeworks_concurrent scheme:"StreamVideo"
      env:
        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
        APPSTORE_API_KEY: ${{ secrets.APPSTORE_API_KEY }}

  build-xcode15-xcframework-stream-video-swiftui:
    name: Build StreamVideoSwiftUI XCframework (Xcode 15.0)
    needs: build-xcode15
    runs-on: macos-13
    if: ${{ github.event_name != 'push' && github.event.inputs.snapshots != 'true' }}
    env:
      XCODE_VERSION: "15.0.1"
    steps:
    - name: Connect Bot
      uses: webfactory/ssh-agent@v0.7.0
      with:
        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
    - uses: actions/checkout@v3.1.0
    - name: Cache Xcode Derived Data
      uses: irgaly/xcode-cache@v1
      with:
        key: xcode-15-cache-deriveddata-${{ github.workflow }}-${{ github.sha }}
        deriveddata-directory: derived_data
        sourcepackages-directory: spm_cache
    - uses: ./.github/actions/ruby-cache
    - name: Build StreamVideo XCFramework
      run: bundle exec fastlane build_xcframeworks_concurrent scheme:"StreamVideoSwiftUI"
      env:
        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
        APPSTORE_API_KEY: ${{ secrets.APPSTORE_API_KEY }}

  build-xcode15-xcframework-stream-video-uikit:
    name: Build StreamVideoUIKit XCframework (Xcode 15.0)
    needs: build-xcode15
    runs-on: macos-13
    if: ${{ github.event_name != 'push' && github.event.inputs.snapshots != 'true' }}
    env:
      XCODE_VERSION: "15.0.1"
    steps:
    - name: Connect Bot
      uses: webfactory/ssh-agent@v0.7.0
      with:
        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
    - uses: actions/checkout@v3.1.0
    - name: Cache Xcode Derived Data
      uses: irgaly/xcode-cache@v1
      with:
        key: xcode-15-cache-deriveddata-${{ github.workflow }}-${{ github.sha }}
        deriveddata-directory: derived_data
        sourcepackages-directory: spm_cache
    - uses: ./.github/actions/ruby-cache
    - name: Build StreamVideo XCFramework
      run: bundle exec fastlane build_xcframeworks_concurrent scheme:"StreamVideoUIKit"
      env:
        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
        APPSTORE_API_KEY: ${{ secrets.APPSTORE_API_KEY }}

  build-test-app-and-frameworks:
    name: Build Test App and Frameworks
    runs-on: macos-14
    needs: test-llc-debug
    if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    steps:
    - uses: actions/checkout@v4.1.1
    - uses: ./.github/actions/bootstrap
      env:
        INSTALL_YEETD: true
        SKIP_MINT_BOOTSTRAP: true
        SKIP_BREW_BOOTSTRAP: true
    - name: Build
      run: bundle exec fastlane build_test_app_and_frameworks
      timeout-minutes: 60

  build-apps:
    name: Build Demo Apps
    runs-on: macos-14
    needs: build-test-app-and-frameworks
    if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    steps:
    - uses: actions/checkout@v4.1.1
    - uses: ./.github/actions/bootstrap
      env:
        INSTALL_YEETD: true
        SKIP_MINT_BOOTSTRAP: true
        SKIP_BREW_BOOTSTRAP: true
    - name: Build UIKit Demo App
      run: bundle exec fastlane build_uikit_demo
    - name: Build Docs Test Project
      run: bundle exec fastlane build_docs_test

  cache-update:
    name: Update cache
    runs-on: macos-14
    needs: build-test-app-and-frameworks
    steps:
      - uses: irgaly/xcode-cache@v1
        with:
          key: xcode-cache-deriveddata-${{ github.workflow }}-${{ github.event.number }}
          restore-keys: 
            xcode-cache-deriveddata-${{ github.workflow }}-${{ github.sha }}
            xcode-cache-deriveddata-${{ github.workflow }}-${{ github.event.number }}
          deriveddata-directory: derived_data
          sourcepackages-directory: spm_cache

  allure_testops_launch:
    name: Launch Allure TestOps
    runs-on: macos-13
    needs: build-test-app-and-frameworks
    if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    outputs:
      launch_id: ${{ steps.get_launch_id.outputs.launch_id }}
    steps:
    - uses: actions/checkout@v4.1.1
    - uses: ./.github/actions/ruby-cache
    - name: Launch Allure TestOps
      run: bundle exec fastlane allure_launch
      env:
        ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
        GITHUB_EVENT: ${{ toJson(github.event) }}
    - id: get_launch_id
      run: echo "launch_id=${{env.LAUNCH_ID}}" >> $GITHUB_OUTPUT
      if: env.LAUNCH_ID != ''

  test-e2e-debug:
    name: Test E2E UI (Debug)
    needs: allure_testops_launch
    runs-on: macos-14
    if: ${{ github.event_name != 'push' && github.event.inputs.swiftui_snapshots != 'true' && github.event.inputs.uikit_snapshots != 'true' }}
    env:
      LAUNCH_ID: ${{ needs.allure_testops_launch.outputs.launch_id }}
      ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
    # strategy:
    #   matrix:
    #     batch: [0, 1]
    #   fail-fast: false
    steps:
    - uses: actions/checkout@v4.1.1
    - uses: ./.github/actions/bootstrap
      env:
        INSTALL_ALLURE: true
        INSTALL_VIDEO_BUDDY: true
        INSTALL_YEETD: true
        SKIP_MINT_BOOTSTRAP: true
        SKIP_BREW_BOOTSTRAP: true
    - name: Run UI Tests (Debug)
      run: bundle exec fastlane test_e2e device:"${{ env.IOS_SIMULATOR_DEVICE }}" batch:'${{ matrix.batch }}' test_without_building:false
      timeout-minutes: 60
      env:
        XCODE_VERSION: "15.2" # the most stable pair of Xcode
        IOS_SIMULATOR_DEVICE: "iPhone 15 Pro (17.2)" # and iOS
        MATRIX_SIZE: ${{ strategy.job-total }}
        STREAM_SDK_TEST_APP: ${{ secrets.STREAM_SDK_TEST_APP }}
        STREAM_SDK_TEST_ACCOUNT_EMAIL: ${{ secrets.STREAM_SDK_TEST_ACCOUNT_EMAIL }}
        STREAM_SDK_TEST_ACCOUNT_PASSWORD: ${{ secrets.STREAM_SDK_TEST_ACCOUNT_PASSWORD }}
        STREAM_SDK_TEST_ACCOUNT_OTP_SECRET: ${{ secrets.STREAM_SDK_TEST_ACCOUNT_OTP_SECRET }}
        STREAM_VIDEO_SECRET: ${{ secrets.STREAM_VIDEO_SECRET }}
    - name: Allure TestOps Upload
      if: env.LAUNCH_ID != '' && (success() || failure())
      run: bundle exec fastlane allure_upload launch_id:$LAUNCH_ID
    - name: Allure TestOps Launch Removal
      if: env.LAUNCH_ID != '' && cancelled()
      run: bundle exec fastlane allure_launch_removal launch_id:$LAUNCH_ID
    - name: Parse xcresult
      if: failure()
      run: |
        brew install chargepoint/xcparse/xcparse
        xcparse logs fastlane/test_output/DemoApp.xcresult fastlane/test_output/logs/
    - uses: actions/upload-artifact@v4
      if: failure()
      with:
        name: E2E Test Data ${{ matrix.batch }}
        path: |
          ~/Library/Logs/scan
          fastlane/recordings
          fastlane/*.log
          fastlane/test_output/report.junit
          fastlane/test_output/logs/*/Diagnostics/**/*.txt
          fastlane/test_output/logs/*/Diagnostics/simctl_diagnostics/DiagnosticReports/*