Run API tests in your CI/CD pipeline using Postman

The goal of continuous integration and continuous delivery (CI/CD) is to deliver frequent software updates that provide value for users. At the same time, it's important to maintain software quality. Running API tests automatically during the build process helps to ensure that every code change is ready for production.

The Postman CLI enables you to run your test collections as part of your CI/CD pipeline. Using the Postman CLI, you can execute your tests every time there's a push to your code repository. After the pipeline runs, you can view a detailed test report in Postman.

Configure Postman CLI test runs

To run tests as part of the CI/CD pipeline, first create a Postman Collection with the tests you want to run. Then use Postman to generate a code snippet you can include in your CI/CD pipeline configuration. The Postman CLI will execute your test collection each time your pipeline runs.

To configure your CI/CD pipeline to run a test collection, do the following:

  1. Select Collections in the sidebar and select the collection or folder you want to run in your CI/CD pipeline.
  2. Select Runner icon Run.
  3. On the Functional tab, select Automate runs via CLI.
  4. Under Run on CI/CD, select Configure command.
  5. Select the collections you want to run and an optional environment. Also select your CI/CD provider and operating system.
  6. Select Copy Postman CLI Command to copy a code snippet you can add to your CI/CD pipeline configuration.

Learn more at Running a collection in CI/CD.

View Postman CLI test results

After configuration, Postman runs your tests as part of your CI/CD pipeline. Test results display on the command line and show which tests passed and failed. You can also view the results of CLI runs in Postman.

To view the results of a Postman CLI test run, do the following:

  1. Select Collections in the sidebar and select the collection or folder you want to view results for.
  2. Select the Runs tab, and then select the Functional tab. CLI runs are labeled Postman CLI in the Source column.
  3. Hover over a CLI run and select the view report icon View report icon to view the complete test results.

Learn more at View past runs.

Last modified: 2024/05/01