Browserstack Flutter Action

This action fulfils the following objectives in your runner environment:

• Uploading the app/testsuite paths provided to browserstack
• Starting the testrun on browserstack
• Waiting until the tests are done and checking the result

Prerequisites

• The actions/checkout@v4 action should be invoked prior to invoking this action as we will be using config files committed to the repo
• App and Tests have to be build before this step see:
  • iOS: https://www.browserstack.com/docs/app-automate/flutter-ios/getting-started
  • Android: https://www.browserstack.com/docs/app-automate/flutter/getting-started

Inputs

• browserstackUsername:
  • Browserstack Username
• browserstackAccessKey:
  • Browserstack Access Key
• testPackagePath:
  • Path to the iOS testPackage that will be uploaded
• appFilePath:
  • Path to the android app that will be uploaded
• testFilePath:
  • Path to the android test apk that will be uploaded
• devices:
  • Devices to test on see https://www.browserstack.com/list-of-browsers-and-platforms/app_automate'
• project:
  • Optional projectname that will be shown on browserstack
• buildTag:
  • Optional buildTag for the testrun that will be shown on browserstack
• customId:
  • Optional customId for the uploaded packages that will be shown on browserstack

Outputs

• app_url:
  • The app url for the Android APK on Browserstack
• test_suite_url:
  • The test file url for the Android APK on Browserstack
• test_package_url:
  • The test package url for the iOS App on Browserstack
• build_id:
  • The build id for the triggered testrun
• test_result:
  • The test result from browserstack (json)

Usage

Use the code snippet below in your workflow to upload run a flutter android test:

  name: Upload and Run Tests on Browserstack
  uses: Grodien/[email protected]
  with:
    browserstackUsername: ${{ secrets.BROWSERSTACK_USERNAME }}
    browserstackAccessKey: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
    project: example
    customId: example_android
    buildTag: example_android
    appFilePath: ${{ github.workspace }}/build/app/outputs/flutter-apk/app-dev-debug.apk
    testFilePath: ${{ github.workspace }}/build/app/outputs/apk/androidTest/dev/debug/app-dev-debug-androidTest.apk
    devices: Samsung Galaxy Tab S9-13.0,Samsung Galaxy Tab S8-12.0

Use the code snippet below in your workflow to upload run a flutter ios test:

- name: Upload and Run on Browserstack
  uses: Grodien/[email protected]
  with:
    browserstackUsername: ${{ secrets.BROWSERSTACK_USERNAME }}
    browserstackAccessKey: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
    project: example
    customId: example_ios
    buildTag: example_ios
    testPackagePath: ${{ github.workspace }}/build/ios_integration/Build/Products/app-integrationtest-release.zip
    devices: iPad 9th-15