test.yml

name: test
on:
  workflow_dispatch:
    inputs:
      flutter_version:
        description: 'Flutter Version'
        required: false
        default: 'any'
        type: choice
        options:
          - 'any'
          - '3.24.x'
          - '3.22.x'
      flutter_channel:
        description: 'Flutter Channel'
        required: false
        default: 'stable'
        type: choice
        options:
          - 'stable'
          - 'beta'
          - 'dev'
          - 'master'
      fatal_warnings:
        description: 'Treat warnings as fatal'
        required: false
        default: true
        type: boolean
      enable_android:
        description: 'Test Android'
        required: false
        default: true
        type: boolean
      enable_web:
        description: 'Test Web'
        required: false
        default: true
        type: boolean
      enable_ios:
        description: 'Test IOS'
        required: false
        default: true
        type: boolean
      enable_windows:
        description: 'Test Windows'
        required: false
        default: true
        type: boolean
      enable_linux:
        description: 'Test Linux'
        required: false
        default: true
        type: boolean
      enable_macos:
        description: 'Test MacOS'
        required: false
        default: true
        type: boolean
  workflow_call:
    inputs:
      flutter_version:
        required: false
        default: '3.24.5'
        type: string
      flutter_channel:
        required: false
        default: 'stable'
        type: string
      fatal_warnings:
        required: false
        default: true
        type: boolean
      enable_android:
        required: false
        default: true
        type: boolean
      enable_web:
        required: false
        default: true
        type: boolean
      enable_ios:
        required: false
        default: true
        type: boolean
      enable_windows:
        required: false
        default: true
        type: boolean
      enable_linux:
        required: false
        default: true
        type: boolean
      enable_macos:
        required: false
        default: true
        type: boolean

jobs:
  test:
    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - uses: actions/checkout@v4
        with:
          # Full git history needed for `super-linter`
          fetch-depth: 0
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3

      - run: melos format --set-exit-if-changed
      - run: melos analyze ${{ inputs.fatal_warnings && '--fatal-infos' || '--no-fatal-warnings' }}
      - run: melos run test

      - name: Lint Code Base
        uses: super-linter/super-linter/slim@v5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          VALIDATE_ALL_CODEBASE: false
          DEFAULT_BRANCH: main
          VALIDATE_KOTLIN_ANDROID: true
          VALIDATE_CLANG_FORMAT: true
      - name: Lint Swift
        # TODO: check if swift-format can be integrated in super-linter, as soon as Alpine is supported
        # https://github.com/apple/swift-docker/issues/231
        # https://github.com/super-linter/super-linter/pull/4568
        run: |
          docker run --rm --workdir=/work --volume=$PWD:/work mtgto/swift-format:5.8 \
           lint --parallel --strict --recursive packages/audioplayers_darwin

  web:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    if: inputs.enable_web
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3
      - uses: nanasess/setup-chromedriver@v2

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        run: |
          export DISPLAY=:99
          sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
          
          chromedriver --port=4444 &
          
          ( cd server; dart run bin/server.dart ) &
          flutter drive \
           --driver=test_driver/integration_test.dart \
           --target=integration_test/platform_test.dart \
           -d web-server \
           --web-browser-flag="--autoplay-policy=no-user-gesture-required" \
           --web-browser-flag="--disable-web-security" \
           --dart-define USE_LOCAL_SERVER=true
          
          flutter drive \
           --driver=test_driver/integration_test.dart \
           --target=integration_test/lib_test.dart \
           -d web-server \
           --web-browser-flag="--autoplay-policy=no-user-gesture-required" \
           --web-browser-flag="--disable-web-security" \
           --dart-define USE_LOCAL_SERVER=true
          
          flutter drive \
           --driver=test_driver/integration_test.dart \
           --target=integration_test/app_test.dart \
           -d web-server \
           --web-browser-flag="--autoplay-policy=no-user-gesture-required" \
           --web-browser-flag="--disable-web-security" \
           --dart-define USE_LOCAL_SERVER=true

  android:
    runs-on: ubuntu-latest
    timeout-minutes: 90
    if: inputs.enable_android
    steps:
      - uses: actions/checkout@v4
      - name: Enable KVM group perms
        # see: https://github.com/actions/runner-images/discussions/7191
        run: |
          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
          sudo udevadm control --reload-rules
          sudo udevadm trigger --name-match=kvm
      - uses: actions/setup-java@v4
        with:
          # AGP8 needs JDK 17
          distribution: 'temurin'
          java-version: '17'
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3

      - name: Download Android emulator image
        run: |
          export ANDROID_TOOLS="$ANDROID_HOME/cmdline-tools/latest/bin"
          echo "y" | $ANDROID_TOOLS/sdkmanager --install "system-images;android-30;aosp_atd;x86"
          echo "no" | $ANDROID_TOOLS/avdmanager create avd --force --name emu --device "Nexus 5X" -k 'system-images;android-30;aosp_atd;x86'
          $ANDROID_HOME/emulator/emulator -list-avds
      - name: Start Android emulator
        timeout-minutes: 10
        run: |
          export ANDROID_TOOLS="$ANDROID_HOME/cmdline-tools/latest/bin"
          echo "Starting emulator"
          $ANDROID_TOOLS/sdkmanager "platform-tools" "platforms;android-30"
          nohup $ANDROID_HOME/emulator/emulator -avd emu -no-audio -no-snapshot -no-window &
          $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done; input keyevent 82'
          $ANDROID_HOME/platform-tools/adb devices
          echo "Emulator started"
      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        run: |
          ( cd server; dart run bin/server.dart ) &
          flutter test integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true

      - name: Run Android unit tests
        working-directory: ./packages/audioplayers/example/android
        run: ./gradlew test

  ios-16:
    # Run lib tests only to ensure compatibility with iOS 16.
    runs-on: macos-13
    timeout-minutes: 60
    if: inputs.enable_ios
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        run: |
          sudo xcode-select -switch /Applications/Xcode_14.3.1.app/Contents/Developer
          UDID=$(xcrun simctl create test-se-16-4 com.apple.CoreSimulator.SimDeviceType.iPhone-SE-3rd-generation com.apple.CoreSimulator.SimRuntime.iOS-16-4)
          xcrun simctl list devices
          echo "Using simulator $UDID"
          xcrun simctl boot "${UDID:?No Simulator with this name iPhone found}"
          sudo xcode-select -switch /Applications/Xcode_15.2.app/Contents/Developer
          ( cd server; dart run bin/server.dart ) &
          flutter test -d $UDID integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true

  ios-17:
    runs-on: macos-14
    timeout-minutes: 60
    if: inputs.enable_ios
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@main

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        run: |
          UDID=$(xcrun simctl create test-se-17-2 com.apple.CoreSimulator.SimDeviceType.iPhone-SE-3rd-generation com.apple.CoreSimulator.SimRuntime.iOS-17-2)
          xcrun simctl list devices
          echo "Using simulator $UDID"
          xcrun simctl boot "${UDID:?No Simulator with this name iPhone found}"
          ( cd server; dart run bin/server.dart ) &
          flutter test -d $UDID integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d $UDID integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d $UDID integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true

  macos-13:
    # TODO: Run lib tests only to ensure compatibility with macOS 13, once tests for macOS 14 succeed.
    runs-on: macos-13
    timeout-minutes: 30
    if: inputs.enable_macos
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@main

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        run: |
          ( cd server; dart run bin/server.dart ) &
          flutter test -d macos integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d macos integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
        # TODO: Integration tests on macOS 13 currently time out.
        #  flutter test -d macos integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true

  macos-14:
    runs-on: macos-14
    timeout-minutes: 30
    if: false # TODO: Tests on macOS 14 currently fail.
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        run: |
          ( cd server; dart run bin/server.dart ) &
          flutter test -d macos integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d macos integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d macos integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true

  windows:
    runs-on: windows-latest
    timeout-minutes: 30
    if: inputs.enable_windows
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3
      - name: Start audio server
        run: net start audiosrv
      - name: Download virtual audio device
        # Download has to be done before setting the system date time.
        timeout-minutes: 1
        run: |
          Invoke-WebRequest https://github.com/duncanthrax/scream/releases/download/4.0/Scream4.0.zip -OutFile Scream.zip
          Expand-Archive -Path Scream.zip -DestinationPath Scream
      - name: Disable time sync with Hyper-V & setting system date time (#1573)
        # TODO(gustl22): Remove workaround of setting the time when virtual audio device certificate is valid again (#1573)
        run: |
          Set-Service -Name vmictimesync -Status stopped -StartupType disabled
          Set-ItemProperty HKLM:\SYSTEM\CurrentControlSet\services\W32Time\Parameters -Name 'Type' -Value 'NoSync'
          net stop w32time; Set-Date (Get-Date "2023-07-04 12:00:00")
      - name: Install virtual audio device
        timeout-minutes: 1
        run: |
          Import-Certificate -FilePath Scream\Install\driver\x64\Scream.cat -CertStoreLocation Cert:\LocalMachine\TrustedPublisher
          Scream\Install\helpers\devcon-x64.exe install Scream\Install\driver\x64\Scream.inf *Scream
      - name: Resetting system date time (#1573)
        run: |
          Set-Service -Name vmictimesync -Status running -StartupType automatic
          Set-ItemProperty HKLM:\SYSTEM\CurrentControlSet\services\W32Time\Parameters -Name 'Type' -Value 'NTP'
          net start w32time; w32tm /resync /force; $currentDate = Get-Date; Write-Host "Current System Date: $currentDate";
      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        shell: bash # Needed in order to fail fast, see: https://github.com/actions/runner-images/issues/6668
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        run: |
          ( cd server; dart run bin/server.dart ) &
          flutter test -d windows integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d windows integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d windows integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true

  linux:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    if: inputs.enable_linux
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: ${{ inputs.flutter_version }}
          channel: ${{ inputs.flutter_channel }}
      - uses: bluefireteam/melos-action@v3
      - name: Install Flutter requirements for Linux
        run: |
          sudo apt-get update
          sudo apt-get install -y clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
      - name: Install GStreamer
        # Install libunwind-dev, see https://github.com/actions/runner-images/issues/6399#issuecomment-1285011525
        run: |
          sudo apt install -y libunwind-dev
          sudo apt-get install -y libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-good gstreamer1.0-plugins-bad

      - name: Run Flutter integration tests
        working-directory: ./packages/audioplayers/example
        # Need to execute lib and app tests one by one, see: https://github.com/flutter/flutter/issues/101031
        # TODO(gustl22): Linux tests are flaky with LIVE_MODE=false
        run: |
          export DISPLAY=:99
          sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
          ( cd server; LIVE_MODE=true dart run bin/server.dart ) &
          flutter test -d linux integration_test/platform_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d linux integration_test/lib_test.dart --dart-define USE_LOCAL_SERVER=true
          flutter test -d linux integration_test/app_test.dart --dart-define USE_LOCAL_SERVER=true