Integrate Testsigma with Azure DevOps

Integrate Testsigma with Azure DevOps to trigger Test Plan executions from your CI/CD pipeline. Azure DevOps runs a shell script that calls the Testsigma API to start a Test Plan and fetch its results.

Prerequisites

Before you begin, ensure that you have referred to:

1. Documentation on generic Shell script to get the script file.
2. Documentation on generating API keys.
3. Documentation on getting test plan ID.

Prepare the Shell Script

1. Copy the Unix shell script from the documentation on generic Shell script.

2. Generate an API key from Configurations > API Keys. The link is mentioned in the prerequisites.
3. Get the Test Plan ID from the CI/CD Integrations tab on the Test Plan details page. The link is mentioned in the prerequisites.
4. Replace TESTSIGMA_API_KEY and TESTSIGMA_TEST_PLAN_ID in the script with the values from steps 2 and 3.
5. Save the script in the code repository that you'll use for the Azure DevOps pipeline. Name it cicd-api.sh.

Create the Azure DevOps Pipeline

1. Sign in to your Azure DevOps account.
2. Create a Project.
3. Navigate to Pipelines and click New Pipeline.
4. Select the version control system (VCS) where your code repository, including cicd-api.sh, is stored.

5. Select the repository that contains your configuration YAML file.

6. On the Configure your pipeline page, select Existing Azure Pipelines YAML file if your repository already has one, or select Starter pipeline to create a sample file.

   (If using an existing file): Enter the branch and path of the YAML file in your repository.

7. Review the CI configuration, then click Continue.
8. In the YAML file, enter the path to cicd-api.sh in the filePath field:

# Azure Pipelines YAML file
trigger: master

pool:
  vmImage: 'ubuntu-latest'

steps:
- script: echo Hello, world!
  displayName: Run a one-line script

- task: Bash@3
  displayName: Run Shell Script (./cicd-api.sh)
  inputs:
    filePath: ./cicd-api.sh

- task: PublishTestResults@2
  displayName: publish test-results
  inputs:
    testResultFormat: JUnit
    testResultsFiles: '**/*junit-report.xml'

Run the Pipeline and View Results

1. Click Run to start the pipeline job.
2. Track the run on the pipeline results page.
3. Once the job completes, the job status shows Success.
4. Navigate to Test Plans > Runs to view the reports.
5. Select Runs, then select the Test Plan whose report you want to view. Download the JUnit report in XML format from this page.