Newman in CI/CD pipelines in Postman - Test Execution Trace

Test Overview

This test runs a Postman collection using Newman in a CI/CD pipeline. It verifies that the API responses meet expected status codes and data values.

Test Code - PyTest

Postman

import subprocess
import json
import unittest

class TestNewmanInCICD(unittest.TestCase):
    def test_postman_collection(self):
        # Run Newman command to execute Postman collection
        result = subprocess.run([
            'newman', 'run', 'https://api.getpostman.com/collections/your-collection-id',
            '--environment', 'https://api.getpostman.com/environments/your-environment-id',
            '--reporters', 'json'
        ], capture_output=True, text=True)

        # Parse Newman JSON report from stdout
        report = json.loads(result.stdout)

        # Check that all requests passed
        failures = report['run']['failures']
        self.assertEqual(len(failures), 0, f"Failures found: {failures}")

        # Check a specific request response code
        for execution in report['run']['executions']:
            if execution['item']['name'] == 'Get User':
                self.assertEqual(execution['response']['code'], 200)

if __name__ == '__main__':
    unittest.main()

Execution Trace - 6 Steps

Step	Action	System State	Assertion	Result
1	Test starts	Test runner initializes the test environment	—	PASS
2	Runs Newman command to execute Postman collection with JSON reporter	Newman runs the collection and outputs JSON report to stdout	—	PASS
3	Parses Newman JSON report from command output	Report JSON is loaded into memory for analysis	—	PASS
4	Checks that there are zero failures in the Newman report	Failures list is empty	assertEqual(len(failures), 0)	PASS
5	Verifies that the 'Get User' request returned HTTP status code 200	'Get User' request response code is 200	assertEqual(response_code, 200)	PASS
6	Test ends successfully	All assertions passed, test completes	—	PASS

Failure Scenario

Failing Condition: Newman reports one or more failed requests in the collection run

Execution Trace Quiz - 3 Questions

What does the test verify after running Newman?

A That there are no failed requests in the Postman collection run

B That Newman installed correctly

C That the CI/CD pipeline triggered the test

D That the Postman app is open

Key Result

Always parse and assert Newman JSON reports in CI/CD to catch API failures early and keep tests automated and reliable.

Practice

1. What is the main purpose of using Newman in a CI/CD pipeline?

easy

A. To write new API tests inside Postman

B. To run Postman API tests automatically from the command line

C. To deploy applications to production servers

D. To monitor server performance in real-time

Solution

1. Step 1: Understand Newman's role

   Newman is a command-line tool designed to run Postman API tests outside the Postman app.

2. Step 2: Connect to CI/CD pipeline use

   In CI/CD pipelines, Newman automates running these tests to check API health during builds or deployments.

3. Final Answer:

   To run Postman API tests automatically from the command line -> Option B

4. Quick Check:

   Newman runs tests in CI/CD = C [OK]

Hint: Newman runs Postman tests from command line in pipelines [OK]

Common Mistakes:

• Confusing Newman with deployment tools
• Thinking Newman writes tests instead of running them
• Assuming Newman monitors servers

2. Which of the following is the correct basic syntax to run a Postman collection using Newman?

easy

A. newman run collection.json

B. newman execute collection.json

C. newman start collection.json

D. newman test collection.json

Solution

1. Step 1: Recall Newman command structure

   The correct command to run a collection is 'newman run' followed by the collection file.

2. Step 2: Verify options

   Options like 'execute', 'start', or 'test' are not valid Newman commands.

3. Final Answer:

   newman run collection.json -> Option A

4. Quick Check:

   Correct Newman run syntax = D [OK]

Hint: Use 'newman run' to execute collections [OK]

Common Mistakes:

• Using 'execute' or 'start' instead of 'run'
• Omitting the 'run' keyword
• Confusing Newman commands with other tools

3. What will be the output when running this command in a CI pipeline?

newman run mycollection.json --reporters cli,json --reporter-json-export result.json

medium

A. Runs tests and outputs results only in CLI, no file created

B. Runs tests and saves results only in XML format

C. Runs tests but fails due to invalid reporter options

D. Runs tests, shows CLI output, and saves JSON report to result.json

Solution

1. Step 1: Analyze reporter options

   The command uses '--reporters cli,json' to show results in CLI and JSON format.

2. Step 2: Check JSON export flag

   '--reporter-json-export result.json' saves the JSON report to the file 'result.json'.

3. Final Answer:

   Runs tests, shows CLI output, and saves JSON report to result.json -> Option D

4. Quick Check:

   CLI + JSON report saved = B [OK]

Hint: Multiple reporters show CLI and save JSON report [OK]

Common Mistakes:

• Assuming no file is created
• Thinking JSON export is invalid syntax
• Confusing JSON with XML report format

4. You added this command in your CI pipeline:

newman run collection.json --reporters cli --reporter-json-export report.json

But the JSON report file is not created. What is the likely problem?

medium

A. The CLI reporter disables file exports

B. The collection.json file is missing

C. Missing 'json' in the --reporters option

D. Newman does not support JSON reports

Solution

1. Step 1: Check reporter options consistency

   The command uses '--reporters cli' but tries to export JSON report, which requires 'json' reporter enabled.

2. Step 2: Understand reporter behavior

   Without 'json' in '--reporters', the JSON export flag is ignored, so no file is created.

3. Final Answer:

   Missing 'json' in the --reporters option -> Option C

4. Quick Check:

   JSON export needs 'json' reporter = A [OK]

Hint: Include 'json' in --reporters to export JSON files [OK]

Common Mistakes:

• Assuming collection file missing causes no report
• Thinking CLI reporter blocks file exports
• Believing Newman can't export JSON reports

5. In a CI/CD pipeline, you want to fail the build if any Postman test fails using Newman. Which command option helps achieve this?

hard

A. --bail

B. --fail-fast

C. --exit-on-error

D. --stop-on-failure

Solution

1. Step 1: Identify Newman option for failure control

   The '--bail' option stops the run and returns a failure exit code if any test fails.

2. Step 2: Confirm other options

   Options like '--fail-fast', '--exit-on-error', and '--stop-on-failure' are not valid Newman flags.

3. Final Answer:

   --bail -> Option A

4. Quick Check:

   Fail build on test failure = --bail [OK]

Hint: Use '--bail' to stop and fail on test errors [OK]

Common Mistakes:

• Using non-existent flags like --fail-fast
• Not using any fail option, so build passes despite failures
• Confusing '--bail' with report generation options