Newman in CI/CD pipelines in Postman - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

Newman run output in CI pipeline

You run the following Newman command in a CI pipeline:

newman run collection.json -e environment.json --reporters cli,json --reporter-json-export result.json

What will be the content of result.json after the run?

Postman

newman run collection.json -e environment.json --reporters cli,json --reporter-json-export result.json

A An empty file because the JSON reporter does not export results automatically.

B A plain text file with only the summary of test results like total tests and failures.

C A JSON file containing detailed test run results including request, response, assertions, and environment variables.

D A CSV file listing all test names and their pass/fail status.

💡 Hint

Think about what the JSON reporter exports when used with --reporter-json-export.

The JSON reporter exports a detailed JSON file with all test run data including requests, responses, and assertion results. It is not a summary or CSV.

🔀 Workflow

intermediate

Integrating Newman in a Jenkins pipeline

You want to add a Newman test run to your Jenkins pipeline script. Which snippet correctly runs a Postman collection and fails the build if any test fails?

A sh 'newman run collection.json --bail'

B sh 'newman run collection.json || true'

C sh 'newman run collection.json --ignore-errors'

D sh 'newman run collection.json --silent'

💡 Hint

Which option stops the pipeline on test failures?

The --bail option stops the run on first failure and causes the command to exit with a non-zero code, failing the Jenkins build.

❓ Troubleshoot

advanced

Newman fails in CI with 'command not found'

Your CI pipeline fails with the error:

sh: newman: command not found

What is the most likely cause?

A Newman is not installed or not in the PATH on the CI agent.

B The CI pipeline script has a syntax error.

C The environment file has invalid JSON syntax.

D The collection file is missing or corrupted.

💡 Hint

The error says the command itself is missing.

The error means the shell cannot find the newman executable, usually because it is not installed or PATH is not set correctly.

✅ Best Practice

advanced

Best practice for storing Postman collections in CI

Which is the best practice for managing Postman collections in a CI/CD pipeline?

A Manually upload collections to the CI server before each run.

B Store collections and environments as JSON files in the source code repository.

C Keep collections only in the Postman cloud and export manually when needed.

D Use a separate private server to host collections and download them during CI runs.

💡 Hint

Think about version control and automation.

Storing collections as JSON files in the repo allows version control, easy updates, and automated CI runs.

🧠 Conceptual

expert

Understanding Newman exit codes in CI

What exit code does Newman return when all tests pass successfully in a CI pipeline?

A 255

B 1

C 2

D 0

💡 Hint

Standard Unix convention for success.

Newman returns exit code 0 when all tests pass, indicating success to the CI system.

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