mabl Integration

Integrate your mabl tests directly into your build and release pipelines inside Azure DevOps.

mabl

Only mabl offers scriptless cross-browser, API, and mobile testing with auto-healing tests, visual testing, and diagnostics in one simple service. Mabl helps you improve the speed and quality of your release pipeline by allowing you to test every release, at scale, on a single platform, with no infrastructure to manage. Learn more at mabl.com.

Integration Features

• Launch mabl test runs as a build or release pipeline task
• Fail the build or release based on the status of the mabl tests
  • Optionally continue on failure
• View the mabl test statuses from the Tests tab in your Azure DevOps Pipeline output
• Provide additional configuration options to the task
  • Specify list of browsers to run against
  • Override starting URL
  • Specify one or more plan labels to trigger
  • Specify the test branch to use
  • Rebaseline visual change models
  • Set run as fixed baseline image for visual change models

Requirements

• mabl API key
  • See integration docs for details

Adding a Build/Pipeline Task

1. After installing the mabl Integration from the Azure Marketplace you'll find it listed in the tasks option when creating/editing a build or release pipeline

2. Simply type mabl into the search bar under tasks to see the integration listed and click to select it

3. You will then see various configuration options presented. The only required field is the mabl API key which you can find in the mabl app by going to the Settings page and then navigating to the APIs tab. Here you'll find your API key(s). Use the dropdown menu to select the Deployments API builder tool and then pick either an environment and/or an application. Note that you will need a CI/CD Integration key to use with this task. See the Deployments API docs for more info.

4. Copy your API key and paste it into the config form for the mabl Integration. Then find the environment and/or the application ID from the JSON under the Deployments API builder and enter them in the config form as well.

   You must specify at least one environment or one application in the config. You can specify both as well.

Advanced Configuration

There are other configuration options available when setting up your mabl integration. Parenthesis names are the task properties for use with YAML based pipeline.

1. From mabl app go to the Settings page.
2. Select the Deployments API from the API Documentation section at the bottom and fill out any of the optional fields you'd like to trigger during your pipeline build.
3. From the CURL command builder output, copy the IDs or values for each optional config and place them in their corresponding fields in the mabl integration config form.

• Application ID (applicationId): only trigger runs against this application
• Environment ID (environmentId): only trigger runs against this environment
• Browser Override List (browserTypes): comma-separated list (no spaces) of browsers to override the plan settings with i.e. chrome, edge, safari, firefox
• Starting URL Override (uri): (optional, DEPRECATED - use app_url) force the runs to use a specific URL instead of the plan configured URL
• Plan Labels (labels): only trigger plans that match any of the labels provided as a comma-separated list
• App Url (app-url): {string} (optional) the base url to run Web Browser tests against. If provided, this will override the default web browser url associated with the environment in mabl (note, this replaces uri, and will supersede the value in uri if both are provided)
• API URL (api-url): {string} (optional) the base url to run API tests against. If provided, this will override the default API url associated with the environment in mabl
• Await Completion: true/false - wait until the mabl cloud tests runs complete and pass or fail the test accordingly, defaults to true
• Test Branch (mablBranch): only trigger plans that exist in the specified branch
• Rebaseline visual change models (rebaselineImages) - true/false - check if you want to rebaseline the visual change models on task completion, defaults to false
• Set as fixed baseline for visual change models (setStaticBaseline): true/false - check if you want to set the output images as the fixed baseline for visual changes, defaults to false

Example Pipeline Configuration

The following example azure-pipelines.yml shows how to add the mabl task to a YAML based pipeline. Note: it is best practice to use secret variables to store secrets like API keys.

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: mabl-azure-devops-extension@1
  displayName: 'Run tests in the mabl cloud'
  inputs:
    apiKey: '<YOUR-API-KEY>'
    applicationId: '<YOUR-APPLICATION-ID-KEY>'
    environmentId: '<YOUR-ENVIRONMENT-ID-KEY>'
    awaitCompletion: true