Use the "Run mabl tests" community step template to automatically trigger mabl plans in an Octopus Deploy release.
By adding the "Run mabl tests" step to a deployment process, you can:
- Create an Octopus Deploy release that executes mabl tests as a deployment event
- View the status of mabl test results in the task log
Before you start
Before adding a "Run mabl tests" step to your deployment process, gather the necessary information in mabl:
- The application ID and/or environment ID of the plans you want to trigger. See the article on mabl resource IDs for more information on how to obtain these IDs.
- Plan labels - if you plan to run a subset of plans with specific labels.
- A "CI/CD integration" type API key. API key access and usage is limited to workspace owners.
Only active mabl plans that match your defined filters and have a "Run on deployment" trigger will execute. If a plan is disabled or lacks a deployment trigger, it does not run as part of a deployment event.
Setup
Installation
In Octopus Deploy, go to the Deployment Process editor and add the "Run mabl tests" step template:
- Search for "mabl"
- Hover over the "Run mabl tests" step
- Select install
- Add it to your deployment process
Install and add the "Run mabl tests" step template
Configuration
On the step configuration screen, configure "Run mabl tests" step to trigger a deployment event in mabl:
- mabl Integration Key: Use a "CI/CD integration" API key. API key access and usage is limited to workspace owners.
- Environment ID: Add the environment ID for the plans you want to run.
- Application ID: Add the application ID for the plans you want to run.
- Plan Labels: If you intend to run a subset of plans with specific labels, provide a comma-separated list of plan labels
- Test Branch: When the branch field is left empty, mabl runs the tests from the master branch
- Await Completion: By default, the deployment process waits for all triggered tests to complete. If you don't want your Octopus deployment to wait for or fail on mabl test results, turn off the Await Completion flag.
Click Save to apply the changes.
Configuring the "Run mabl tests" step
Results
After you create and deploy a release, the detailed task log shows:
- The progress of mabl tests triggered in the deployment process
- A link to the deployment output in the mabl app
