functional-test.yml

name: Functional Tests

on:
  # Run by manual at this time
  workflow_dispatch:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  ios_test:
    strategy:
      fail-fast: false
      matrix:
        test_targets:
          - target: test/functional/ios/search_context/find_by_*.py test/functional/ios/remote_fs_tests.py test/functional/ios/safari_tests.py test/functional/ios/execute_driver_tests.py
            name: func_test_ios1
          - target: test/functional/ios/applications_tests.py test/functional/ios/hw_actions_tests.py test/functional/ios/keyboard_tests.py
            name: func_test_ios2
          - target: test/functional/ios/screen_record_tests.py test/functional/ios/webdriver_tests.py
            name: func_test_ios3

    runs-on: macos-14

    # Please make sure the available Xcode versions and iOS versions
    # on the runner images. https://github.com/actions/runner-images
    env:
      XCODE_VERSION: 15.3
      IOS_VERSION: 17.4
      IPHONE_MODEL: iPhone 15 Plus

    steps:
    - uses: actions/checkout@v3

    - name: Install Node.js
      uses: actions/setup-node@v3
      with:
        node-version: 'lts/*'

    - name: Select Xcode
      uses: maxim-lobanov/setup-xcode@v1
      with:
        xcode-version: ${{ env.XCODE_VERSION }}
    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false

    - uses: futureware-tech/simulator-action@v3
      with:
        # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
        model: ${{ env.IPHONE_MODEL }}
        os_version: ${{ env.IOS_VERSION }}

    # needed?
    - run: brew install ffmpeg

    # Start Appium
    - run: npm install -g appium
    - run: |
        appium driver install xcuitest
        appium plugin install images
        appium plugin install execute-driver
        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &

    - name: Set up Python 3.12
      uses: actions/setup-python@v3
      with:
        python-version: 3.12

    - run: |
        # Separate 'run' creates differnet pipenv env. Does them in one run for now.
        pip install --upgrade pip
        pip install --upgrade pipenv
        pipenv lock --clear
        pipenv install -d --system
        pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

    - name: Save server output
      if: ${{ always() }}
      uses: actions/upload-artifact@master
      with:
        name: appium-ios-${{matrix.test_targets.name}}.log
        path: appium.log


  android_test:
    strategy:
      fail-fast: false
      matrix:
        test_targets:
          - target: test/functional/android/device_time_tests.py test/functional/android/search_context/find_by_*.py
            name: func_test_android1
          - target: test/functional/android/keyboard_tests.py test/functional/android/location_tests.py
            name: func_test_android2
          - target: test/functional/android/appium_service_tests.py
            name: func_test_android3
          - target: test/functional/android/finger_print_tests.py test/functional/android/screen_record_tests.py test/functional/android/settings_tests.py test/functional/android/chrome_tests.py
            name: func_test_android4
          - target: test/functional/android/context_switching_tests.py test/functional/android/remote_fs_tests.py
            name: func_test_android5
          - target: test/functional/android/common_tests.py test/functional/android/webelement_tests.py
            name: func_test_android6
          - target: test/functional/android/applications_tests.py
            name: func_test_android7
          - target: test/functional/android/network_connection_tests.py test/functional/android/log_event_tests.py test/functional/android/activities_tests.py test/functional/android/hw_actions_tests.py
            name: func_test_android8

    runs-on: ubuntu-latest

    env:
      API_LEVEL: 29
      ARCH: x86

    steps:
    - uses: actions/checkout@v3

    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'

    - name: Install Node.js
      uses: actions/setup-node@v3
      with:
        node-version: 'lts/*'

    # Start Appium
    - run: npm install -g appium
    - run: |
        appium driver install uiautomator2
        appium driver install espresso
        appium plugin install images
        appium plugin install execute-driver
        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &

    - name: Enable KVM group perms
      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

    - name: AVD cache
      uses: actions/cache@v3
      id: avd-cache
      with:
        path: |
          ~/.android/avd/*
          ~/.android/adb*
        key: avd-${{ env.API_LEVEL }}
    - name: create AVD and generate snapshot for caching
      if: steps.avd-cache.outputs.cache-hit != 'true'
      uses: reactivecircus/android-emulator-runner@v2
      with:
        api-level: ${{ env.API_LEVEL }}
        arch: ${{ env.ARCH }}
        target: google_apis
        force-avd-creation: false
        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
        disable-animations: false
        script: echo "Generated AVD snapshot for caching."

    - name: Set up Python 3.12
      uses: actions/setup-python@v3
      with:
        python-version: 3.12

    - name: run tests
      uses: reactivecircus/android-emulator-runner@v2
      with:
        api-level: ${{ env.API_LEVEL }}
        arch: ${{ env.ARCH }}
        script: |
          # Separate 'run' creates differnet pipenv env. Does them in one run for now.
          pip install --upgrade pip
          pip install --upgrade pipenv
          pipenv lock --clear
          pipenv install -d --system
          pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
        target: google_apis
        profile: Nexus 5X
        disable-spellchecker: true
        disable-animations: true

      env:
        ANDROID_SDK_VERSION: ${{ env.API_LEVEL }}
        APPIUM_DRIVER: ${{matrix.test_targets.automation_name}}
        IGNORE_VERSION_SKIP: true
        CI: true

    - name: Save server output
      if: ${{ always() }}
      uses: actions/upload-artifact@master
      with:
        name: appium-android-${{matrix.test_targets.name}}.log
        path: appium.log

  flutter_e2e_test:
    strategy:
      fail-fast: false
      matrix:
        include:
          - platform: macos-14
            e2e-tests: flutter-ios
          - platform: ubuntu-latest
            e2e-tests: flutter-android

    runs-on: ${{ matrix.platform }}

    env:
      API_LEVEL: 28
      ARCH: x86
      CI: true
      XCODE_VERSION: 15.4
      IOS_VERSION: 17.5
      IPHONE_MODEL: iPhone 15
      FLUTTER_ANDROID_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/app-debug.apk"
      FLUTTER_IOS_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/ios.zip"

    steps:

    - uses: actions/checkout@v4

    - uses: actions/setup-java@v4
      if: matrix.e2e-tests == 'flutter-android'
      with:
        distribution: 'zulu'
        java-version: '17'

    - name: Enable KVM group perms
      if: matrix.e2e-tests == 'flutter-android'
      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
  
    # - name: AVD cache
    #   if: matrix.e2e-tests == 'flutter-android'
    #   uses: actions/cache@v3
    #   id: avd-cache
    #   with:
    #     path: |
    #       ~/.android/avd/*
    #       ~/.android/adb*
    #     key: avd-${{ env.API_LEVEL }}

    # - name: Create AVD and generate snapshot for caching
    #   if: matrix.e2e-tests == 'flutter-android'
    #   uses: reactivecircus/android-emulator-runner@v2
    #   with:
    #     api-level: ${{ env.API_LEVEL }}
    #     arch: ${{ env.ARCH }}
    #     target: google_apis
    #     force-avd-creation: false
    #     emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
    #     disable-animations: false
    #     script: echo "Generated AVD snapshot for caching."

    - name: Set up Python 3.12
      uses: actions/setup-python@v3
      with:
        python-version: 3.12

    - name: Install Node.js
      uses: actions/setup-node@v4
      with:
        node-version: 'lts/*'

    - name: Install Appium
      run: npm install --location=global appium
    
    - name: Install Android drivers and Run Appium
      if: matrix.e2e-tests == 'flutter-android'
      run: |
        appium driver install uiautomator2
        appium driver install appium-flutter-integration-driver --source npm
        nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_flutter_android.log &

    - name: Run Android tests
      if: matrix.e2e-tests == 'flutter-android'
      uses: reactivecircus/android-emulator-runner@v2
      with:
        api-level: ${{ env.API_LEVEL }}
        script: |
          pip install --upgrade pip
          pip install --upgrade pipenv
          pipenv lock --clear
          pipenv install -d --system
          export PLATFORM=android
          pytest test/functional/flutter_integration/*_test.py -k test_camera_mocking --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
        target: default
        disable-spellchecker: true
        disable-animations: true

    - name: Save server output
      if: always() && matrix.e2e-tests == 'flutter-android'
      uses: actions/upload-artifact@master
      with:
        name: appium-flutter-android.log
        path: appium_flutter_android.log

    - name: Select Xcode
      if: matrix.e2e-tests == 'flutter-ios'
      uses: maxim-lobanov/setup-xcode@v1
      with:
        xcode-version: ${{ env.XCODE_VERSION }}
    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false

    - uses: futureware-tech/simulator-action@v3
      with:
        # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
        model: ${{ env.IPHONE_MODEL }}
        os_version: ${{ env.IOS_VERSION }}

    - name: install dependencies
      if: matrix.e2e-tests == 'flutter-ios'
      run: brew install ffmpeg

    - name: Install IOS drivers and Run Appium
      if: matrix.e2e-tests == 'flutter-ios'
      run: |
        appium driver install xcuitest
        appium driver install appium-flutter-integration-driver --source npm
        appium driver run xcuitest build-wda
        nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_ios.log &

    - name: Run IOS tests
      if: matrix.e2e-tests == 'flutter-ios'
      run: |
        # Separate 'run' creates differnet pipenv env. Does them in one run for now.
        pip install --upgrade pip
        pip install --upgrade pipenv
        pipenv lock --clear
        pipenv install -d --system
        export PLATFORM=ios
        pytest test/functional/flutter_integration/*_test.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html