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

Inputs

daiVersion

[Required] Version of the DAI application, e.g. 7.0.0-3, 25.1.0+3.

serverURL

[Required] The URL of the Eggplant DAI server, http(s)://dai_server_hostname:portnumber.

testConfig

[Optional] Not required for execution, auto-generated input from DAI Test Config dropdown selection using task assistant, preview as below:

testConfigID

[Required if testConfigName is not given] The ID of the Eggplant DAI test configuration that you want to run, e.g. 389fee3e-9d6b-43e6-b31e-f1d379f27cdf.
Test configuration ID can be obtained by go to Test Config > Look for a particular test config > Test config id can be obtain from url.
Alternatively, use testConfigName and remove this input.

testConfigName

[Required if testConfigID is not given] The name of the Eggplant DAI test configuration that you want to run.
Must provide one of the following supporting arguments:

• modelName

DAI model name for the specified test configuration. (Use this argument if only testConfigName is provided)

• suiteName

DAI suite name for the specified test configuration. (Use this argument if only testConfigName is provided)

clientID

[Required] The client ID to use to authenticate with the Eggplant DAI server.

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)

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

logLevel

[Optional] The logging level.
Default: INFO

CACertPath

[Optional] The path to an alternative Certificate Authority pem file.

testResultPath

[Optional] The 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.

parameters

[Optional] The global parameter(s) to override in the format parameter_name=parameter_value.
Example username=Lily
You can override multiple parameters by separating them with a delimiter of two semi-colons (;;).
Example username=Lily;;city=Paris;;hobby=Jogging

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

• October'22 release for Eggplant Runner
  • Upgraded to Eggplant Runner version 2.0.0
  • New parameter supported by Eggplant Runner Task
    • DAI Version
      • DAI Version: DAI version deployed in user environment
      • Default : 6.3.0-3
      • User can specify which DAI version that in used in your environment.
      • DAI Version supported by Eggplant Runner
        • DAI 6.3.0-3
        • DAI 6.2.1-2
        • DAI 6.1.2-1
  • Example new DAI Version supported in Eggplant Runner

Notes

1. Eggplant DAI Runner supports 3 type of operating system:

• Linux
• Windows
• MacOS

2. If the input for your parameters in yml contains the single quote (') special characters, you must replace it with two single quote characters ('').
   This is because single quote characters that are not escaped are used to wrap all the parameter input.
   Example parameters: 'value="one'' quote"'

3. Release version 2.0.16 now allows passes after re-run.