Eggplant DAI Runner
Introduction
The Eggplant DAI Runner is an Eggplant DAI integration tool that build as Azure DevOps extension.
It enables the functionality to launch DAI tests from within a Azure DevOps workflow pipeline.
You can use it to continuously test your application's model-based approach to testing.
For more information about Eggplant, visit https://www.eggplantsoftware.com.
The core integration of the Eggplant DAI Runner are with DAI Test Configuration.
Eggplant DAI Runner basically will communicate with the API services provided by Eggplant DAI to perform test configuration execution.
Using Eggplant DAI Runner in your workflow
Step 1: Search for Eggplant Runner in Visual Studio Marketplace and click on it
Step 2: Click on Get it free to navigate to the download page
Step 3: Select the organization that you want to install the extension and click on Install.
Step 4: Click on Proceed to organization
Step 5: Create pipeline .yml in the project and Click on Edit at the pipeline
Step 6: At the task search list, enter Eggplant Runner and click on it
Step 7: Fill in Eggplant Runner inputs value -> Click Add
Step 8: View the added information in azure-pipelines.yml file
Step 9 (Optional) : Access client secret from a variable
Navigate to Library and create a property group
Add the Client Secret as a variable
Click on Pipeline permission and select the pipeline
Update azure-pipelines.yml file as below
serverURL
Required The URL of the Eggplant DAI server, http(s)://dai_server_hostname:portnumber.
testConfigID
Required The ID of the Eggplant DAI test configuration that you want to run, e.g. 09c48b7d-fc5b-481d-af80-fcffad5d9587.
Test configuration ID can be obtain by go to test config > look for a particular test config > test config id can be obtain from url.
clientSecret
Required The client secret to use to authenticate with the Eggplant DAI server.
Alternatively, you could set a repo secret in Repo Settings > Secrets > Actions and refer to it like below:
clientSecret: "${{ secrets.DAI_CLIENT_SECRET }}".
The DAI Client Secret can be obtain by go to http(s):/dai_server_hostname:portnumber/ > System > API Access > "Add New" (for new API access creation)
clientID
Required The client ID to use to authenticate with the Eggplant DAI server.
Default: client:dai:agent:integration
requestTimeout
Optional The timeout in seconds for each HTTP request to the Eggplant DAI server
Default: 30
requestRetries
Optional The number of times to attempt each HTTP request to the Eggplant DAI server
Default: 5
backoffFactor
Optional The exponential backoff factor between each HTTP request
Default: 0.5
pollInterval
Optional The number of seconds to wait between each call to the Eggplant DAI server
Default: 5
testEnvironmentTimeout
Optional The timeout in seconds for checking test environment readiness
Default: 15
logLevel
Optional The logging level
Default: INFO
CACertPath
Optional The path to an alternative Certificate Authority pem file
testResultPath
Optional Path to a file where the test results will be stored in junit xml format
Example C:\results\result.xml
eggplantRunnerPath
Optional The path to eggplant runner CLI executable
Output
Pipeline triggered
Based on the pipeline .yml configuration, when there is commits or pull request action performed. The pipeline will be triggered and Eggplant DAI Runner will be executed.
Console Output
Release Notes
Notes
- Eggplant DAI Runner supports 3 type of operating system:
