Bitrise integration
  • 22 Sep 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Bitrise integration

  • Dark
    Light

Autify provides the official Bitrise step to upload a build and run a test plan easily from your Bitrise workflow.

Getting started

This document describes how to use our Bitrise integrations with your Bitrise workflow step-by-step.

Prerequisites

First, we assume you already have Bitrise workflow to build your application. We'll add an Autify test step right after the build step to confirm the newly built application doesn't break the end-to-end experience.

Secondly, you need to create a test plan on Autify for Mobile. Please note the URL of your test plan e.g. https://mobile-app.autify.com/projects/AAA/test_plans/BBB and we'll use it later.

You also need to create a personal access token of Autify for Mobile. Please note the generated token somewhere so that we can store the value on Bitrise Secrets later.

Note: Since the personal access token is associated with a single user, we recommend you to create a machine user in your organization and use its personal access token for CI/CD integration.

Store personal access token on Bitrise Secrets

Store the personal access token you generated above on Secrets by following Bitrise's document. You can use an arbitrary name for the Secrets but that name will be referred by your Bitrise workflow definition later. Assuming you named it AUTIFY_MOBILE_ACCESS_TOKEN here.

Add Bitrise step to upload a build and run Autify for Mobile

Finally, let's add a new step to your existing Bitrise workflow. See the examples below to edit your bitrise.yaml. The autify-test-url value should be the URL you noted above. You can also configure exactly the same steps via Bitrise UI.


Upload a new build file and start a test (no waiting for the finish of the test):

## With Android Build step: https://www.bitrise.io/integrations/steps/android-build
- android-build@1: {}
- autify-test-run@1:
    inputs:
    - access_token: "$AUTIFY_MOBILE_ACCESS_TOKEN"
    - autify_test_url: https://mobile-app.autify.com/projects/AAA/test_plans/BBB
    - build_path: "$BITRISE_APK_PATH"

## With Xcode build for simulator step: https://www.bitrise.io/integrations/steps/xcode-build-for-simulator
- xcode-build-for-simulator@0: {}
- autify-test-run@1:
    inputs:
    - access_token: "$AUTIFY_MOBILE_ACCESS_TOKEN"
    - autify_test_url: https://mobile-app.autify.com/projects/AAA/test_plans/BBB
    - build_path: "$BITRISE_APP_DIR_PATH"

If you want to wait until the test finishes or timed out:

- autify-test-run@1:
    inputs:
    - access_token: "$AUTIFY_MOBILE_ACCESS_TOKEN"
    - autify_test_url: https://mobile-app.autify.com/projects/AAA/test_plans/BBB
    - build_path: /path/to/your-[ios.app|android.apk]
    - wait: 'true'
    - timeout: '3000'

CAVEAT: This will consume your Bitrise credits while waiting. Be careful when extending the timeout value.

Just upload a new build file (workspace_id is the id right after /projects/ in the URL you noted above):

- autify-upload@1:
    inputs:
    - access_token: "$AUTIFY_MOBILE_ACCESS_TOKEN"
    - workspace_id: AAA
    - build_path: /path/to/your-[ios.app|android.apk]

Conclusion

By using Autify's Bitrise step, you can automatically run a test plan after build so that you can detect regressions right away and take an appropriate actions without wasting time.


First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.