Reporter options (CLI, HTML, JUnit) in Postman

Introduction

Reporters show test results in different ways. They help you understand what passed or failed easily.

You want to see test results quickly in the command line after running tests.

You need a detailed, easy-to-read report to share with your team.

You want to integrate test results with other tools that use JUnit format.

You want to save test results as a file for later review.

You want to automate test reporting in your build or deployment process.

Syntax

Postman

newman run collection.json --reporters cli,html,junit --reporter-html-export report.html --reporter-junit-export report.xml

Use --reporters to specify one or more reporters separated by commas.

Use --reporter--export to save the report to a file.

Examples

Shows test results in the command line interface (CLI) only.

Postman

newman run mycollection.json --reporters cli

Generates an HTML report and saves it as results.html.

Postman

newman run mycollection.json --reporters html --reporter-html-export results.html

Generates a JUnit XML report for integration with CI tools.

Postman

newman run mycollection.json --reporters junit --reporter-junit-export results.xml

Runs tests and outputs results in CLI, HTML file, and JUnit XML file.

Postman

newman run mycollection.json --reporters cli,html,junit --reporter-html-export report.html --reporter-junit-export report.xml

Sample Program

This command runs a Postman collection from a URL using Newman. It shows results in the terminal, creates an HTML report saved as test-report.html, and creates a JUnit XML report saved as test-report.xml.

Postman

newman run https://api.getpostman.com/collections/12345678-1234-1234-1234-123456789abc?apikey=your_api_key --reporters cli,html,junit --reporter-html-export test-report.html --reporter-junit-export test-report.xml

Important Notes

CLI reporter is the default and shows results in your terminal.

HTML reporter creates a colorful, easy-to-read report you can open in a browser.

JUnit reporter creates XML files useful for CI/CD tools like Jenkins or GitLab.

Summary

Reporter options let you choose how to see your test results.

Use CLI for quick terminal output, HTML for detailed reports, and JUnit for tool integration.

You can use multiple reporters at once to get different views of your test results.

Practice

1. Which reporter option in Postman is best for quickly viewing test results directly in the terminal?

easy

A. JSON reporter

B. HTML reporter

C. CLI reporter

D. JUnit reporter

Solution

1. Step 1: Understand reporter types

   CLI reporter shows results in the terminal quickly, HTML creates detailed reports, and JUnit is for integration.

2. Step 2: Match reporter to quick terminal output

   CLI reporter is designed for quick terminal output, so it fits the requirement.

3. Final Answer:

   CLI reporter -> Option C

4. Quick Check:

   Quick terminal output = CLI reporter [OK]

Hint: CLI means command line, perfect for terminal output [OK]

Common Mistakes:

• Confusing HTML reporter as quick terminal output
• Choosing JUnit reporter for terminal display
• Thinking JSON reporter is default quick output

2. Which of the following is the correct syntax to run a Postman collection with an HTML reporter using the CLI?

easy

A. newman run collection.json --reporter html

B. newman run collection.json --reporter-html

C. newman run collection.json -r html

D. newman run collection.json --reporters=html

Solution

1. Step 1: Recall Postman CLI reporter syntax

   The correct syntax uses '--reporter' followed by the reporter name without extra symbols.

2. Step 2: Check each option

   newman run collection.json --reporter html uses '--reporter html' which is correct. newman run collection.json --reporter-html and D have incorrect flags, and C uses shorthand '-r' which is invalid.

3. Final Answer:

   newman run collection.json --reporter html -> Option A

4. Quick Check:

   Correct flag is '--reporter html' [OK]

Hint: Use '--reporter html' exactly for HTML reports in CLI [OK]

Common Mistakes:

• Using '--reporter-html' instead of '--reporter html'
• Using shorthand '-r' which is not supported
• Adding '=' sign in '--reporters=html'

3. What will be the output when running this command?

newman run test_collection.json --reporter junit

Choose the best description.

medium

A. Displays test results in the terminal in JUnit style

B. Generates a JUnit XML report file for integration with CI tools

C. Creates an HTML report and opens it in the browser

D. Runs tests silently without any output

Solution

1. Step 1: Understand JUnit reporter purpose

   JUnit reporter generates XML files compatible with CI/CD tools for test result integration.

2. Step 2: Match command output

   The command uses '--reporter junit' which creates the XML report file, not terminal display or HTML report.

3. Final Answer:

   Generates a JUnit XML report file for integration with CI tools -> Option B

4. Quick Check:

   JUnit reporter = XML report file [OK]

Hint: JUnit reporter creates XML files for CI tools, not terminal output [OK]

Common Mistakes:

• Thinking JUnit reporter shows output in terminal
• Confusing JUnit with HTML reporter
• Assuming no output is generated

4. You run this command but get an error: newman run collection.json --reporter html junit. What is the likely cause?

medium

A. Missing comma between reporter names

B. Collection file name is invalid

C. HTML reporter is not supported in Newman

D. Incorrect flag usage for multiple reporters

Solution

1. Step 1: Check syntax for multiple reporters

   Newman requires multiple reporters to be specified with the '--reporters' flag and comma-separated list.

2. Step 2: Analyze given command

   The command uses '--reporter' once and lists reporters without commas, which is invalid syntax.

3. Final Answer:

   Incorrect flag usage for multiple reporters -> Option D

4. Quick Check:

   Use '--reporters html,junit' for multiple reporters [OK]

Hint: Use '--reporters html,junit' for multiple reporters [OK]

Common Mistakes:

• Using '--reporter' instead of '--reporters' for multiple
• Not separating reporter names with commas
• Assuming HTML reporter is unsupported

5. You want to run a Postman collection and generate both a detailed HTML report and a JUnit XML report for CI integration. Which command correctly achieves this?

hard

A. newman run collection.json --reporters html,junit

B. newman run collection.json --reporter html --reporter junit

C. newman run collection.json --reporters html;junit

D. newman run collection.json --reporters html junit

Solution

1. Step 1: Understand multiple reporter syntax

   Newman uses '--reporters' flag with comma-separated reporter names to run multiple reporters.

2. Step 2: Evaluate each option

   newman run collection.json --reporters html,junit uses correct syntax with '--reporters html,junit'. newman run collection.json --reporter html --reporter junit uses '--reporter' twice which is invalid. Options A and D use incorrect separators.

3. Final Answer:

   newman run collection.json --reporters html,junit -> Option A

4. Quick Check:

   Multiple reporters = '--reporters html,junit' [OK]

Hint: Use '--reporters' with comma-separated names for multiple reports [OK]

Common Mistakes:

• Using multiple '--reporter' flags instead of one '--reporters'
• Separating reporters with semicolon or space instead of comma
• Assuming only one reporter can be used