Newman in CI/CD pipelines in Postman

Introduction

Newman helps run Postman API tests automatically in your software build process. It makes sure your APIs work well every time you update your code.

You want to check your APIs automatically after every code change.

You need to run API tests on a server without Postman app installed.

You want to include API tests as part of your software delivery process.

You want to get test results in your build logs or reports.

You want to stop a deployment if API tests fail.

Syntax

Postman

newman run <collection-file.json> [options]

Replace with your exported Postman collection file.

Options can include environment files, reporters, and more.

Examples

Runs the Postman collection named mycollection.json with default settings.

Postman

newman run mycollection.json

Runs the collection using environment variables from myenv.json.

Postman

newman run mycollection.json -e myenv.json

Runs the collection and outputs test results in JUnit XML format for CI tools.

Postman

newman run mycollection.json -r cli,junit --reporter-junit-export results.xml

Sample Program

This command runs the Postman collection sample_collection.json using environment variables from sample_environment.json. It shows results in the command line and saves a JSON report file newman_report.json.

Postman

newman run sample_collection.json -e sample_environment.json -r cli,json --reporter-json-export newman_report.json

Important Notes

Make sure Node.js and Newman are installed on your CI server.

Use environment files to test different API setups easily.

Integrate Newman commands into your CI scripts like Jenkins, GitHub Actions, or GitLab CI.

Summary

Newman runs Postman API tests from the command line.

It fits well into CI/CD pipelines to automate API testing.

Use options to customize test runs and generate reports.