Environment file with Newman in Postman - Test Execution Trace

Test Overview

This test runs a Postman collection using Newman with a specified environment file. It verifies that the API request uses environment variables correctly and the response status is 200 OK.

Test Code - Newman

Postman

const newman = require('newman');

newman.run({
    collection: require('./collection.json'),
    environment: require('./environment.json'),
    reporters: 'cli'
}, function (err, summary) {
    if (err) { throw err; }
    const run = summary.run;
    const failures = run.failures;
    if (failures.length > 0) {
        console.error('Test failed with failures:', failures);
        process.exit(1);
    } else {
        console.log('All tests passed!');
    }
});

Execution Trace - 4 Steps

Step	Action	System State	Assertion	Result
1	Newman starts running the Postman collection with the specified environment file	Newman CLI initializes and loads collection.json and environment.json	—	PASS
2	Newman sends API requests using variables from environment.json	API requests are constructed with environment variable values	—	PASS
3	Newman receives responses and runs tests defined in the collection	Responses received, tests executed for each request	Check that response status code is 200	PASS
4	Newman summarizes test results and reports via CLI	Test summary shows zero failures	Verify no test failures in summary.run.failures	PASS

Failure Scenario

Failing Condition: Environment file is missing or variables are undefined causing request failures

Execution Trace Quiz - 3 Questions

What does Newman use the environment file for during test execution?

A To store test assertions

B To provide variable values for API requests

C To define the collection structure

D To configure Newman CLI options

Key Result

Always verify that the environment file path is correct and contains all necessary variables before running Newman tests to avoid failures due to missing or undefined variables.

Practice

1. What is the main purpose of an environment file in Postman when running tests with Newman?

easy

A. To store variables that customize test runs

B. To write test scripts

C. To save the test results

D. To create new API endpoints

Solution

1. Step 1: Understand environment file role

   Environment files hold variables like URLs or tokens to change test behavior without editing tests.

2. Step 2: Connect to Newman usage

   Newman uses these files to run the same tests with different settings easily.

3. Final Answer:

   To store variables that customize test runs -> Option A

4. Quick Check:

   Environment file = variables for tests [OK]

Hint: Environment files hold variables for flexible test runs [OK]

Common Mistakes:

• Confusing environment files with test scripts
• Thinking environment files save test results
• Assuming environment files create API endpoints

2. Which Newman command option is used to specify an environment file when running a collection?

easy

A. -c

B. -e

C. -d

D. -r

Solution

1. Step 1: Recall Newman command options

   Newman uses -e to load environment files, -c for collections, -d for data files, and -r for reporters.

2. Step 2: Identify correct option for environment file

   The correct option to specify environment file is -e.

3. Final Answer:

   -e -> Option B

4. Quick Check:

   Environment file option = -e [OK]

Hint: Use -e option to load environment files in Newman [OK]

Common Mistakes:

• Using -c instead of -e for environment files
• Confusing data file option -d with environment file
• Using -r which is for reporters

3. Given the Newman command:
newman run mycollection.json -e dev_environment.json
What will happen during this test run?

medium

A. Newman runs tests and saves results to dev_environment.json

B. Newman ignores the environment file and runs default variables

C. Newman runs tests but fails due to missing environment file

D. Newman runs tests using variables from dev_environment.json

Solution

1. Step 1: Analyze the command structure

   The command uses -e dev_environment.json which tells Newman to load that environment file.

2. Step 2: Understand effect on test run

   Newman will use variables from the specified environment file during the test run.

3. Final Answer:

   Newman runs tests using variables from dev_environment.json -> Option D

4. Quick Check:

   -e loads environment variables [OK]

Hint: -newman run ... -e loads environment variables [OK]

Common Mistakes:

• Assuming environment file is ignored
• Thinking results are saved to environment file
• Confusing environment file with data file

4. You run Newman with the command:
newman run collection.json -e wrong_env.json
but get an error saying the environment file is not found. What is the most likely cause?

medium

A. Newman does not support environment files

B. The collection file is missing variables

C. The environment file path or name is incorrect

D. The -e option is not valid in Newman

Solution

1. Step 1: Understand the error message

   Error says environment file not found, meaning Newman cannot locate the file.

2. Step 2: Identify common causes

   Most likely the file path or filename is wrong or file is missing.

3. Final Answer:

   The environment file path or name is incorrect -> Option C

4. Quick Check:

   File not found = wrong path/name [OK]

Hint: Check environment file path and name carefully [OK]

Common Mistakes:

• Assuming Newman does not support environment files
• Blaming collection file for environment file errors
• Using invalid Newman options

5. You want to run the same Postman collection with two different environment files: staging.json and production.json. How can you automate this using Newman in a single command or script?

hard

A. Run two separate Newman commands, each with its own -e option

B. Use one Newman command with both environment files listed after -e

C. Merge both environment files into one and use -e once

D. Newman cannot run multiple environments; run manually

Solution

1. Step 1: Understand Newman environment usage

   Newman accepts only one environment file per run with -e.

2. Step 2: Automate multiple runs

   To run with two environments, run Newman twice, each time specifying one environment file.

3. Final Answer:

   Run two separate Newman commands, each with its own -e option -> Option A

4. Quick Check:

   One environment per run; use multiple commands [OK]

Hint: Run Newman twice, each with one environment file [OK]

Common Mistakes:

• Trying to pass multiple environment files in one command
• Merging environment files incorrectly
• Assuming Newman supports multiple environments in one run