Environment file with Newman in Postman - Framework Patterns

Framework Mode - Environment file with Newman

Folder Structure

postman-project/
├── collections/
│   └── api-collection.json          # Postman collection JSON file
├── environments/
│   ├── dev-environment.json         # Environment file for development
│   └── prod-environment.json        # Environment file for production
├── reports/
│   └── newman-report.html           # Generated test reports
├── scripts/
│   └── run-tests.sh                 # Shell script to run Newman with env files
└── package.json                     # Node.js project config (optional)

Test Framework Layers

• Collections: Store API requests and test scripts exported from Postman.
• Environment Files: JSON files defining variables like base URLs, tokens, and credentials for different environments.
• Test Runner Scripts: Scripts (e.g., shell or Node.js) that execute Newman commands using specific environment files.
• Reports: Output folders where Newman saves test execution reports in HTML or JSON format.
• Configuration: Manage environment-specific variables separately to keep tests flexible and reusable.

Configuration Patterns

• Use separate environment JSON files for each environment (dev, staging, prod) with variables like base_url, auth_token.
• Pass the environment file to Newman using the --environment flag, e.g., newman run collections/api-collection.json --environment environments/dev-environment.json.
• Store sensitive data like passwords or tokens in environment files but keep them secure (e.g., .gitignore these files if needed).
• Use scripts to automate running tests with different environment files for CI/CD pipelines.

Test Reporting and CI/CD Integration

• Generate reports with Newman using reporters like html, json, or junit by adding --reporters html,json flags.
• Save reports in the reports/ folder for easy access and review.
• Integrate Newman commands into CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run API tests automatically on code changes.
• Use environment files in CI/CD to run tests against different deployment stages by passing the correct environment JSON.
• Fail the build if Newman test results contain failures to ensure quality gates.

Best Practices

1. Separate Environment Files: Keep environment variables outside collections to reuse collections across environments easily.
2. Secure Sensitive Data: Avoid committing sensitive environment files to version control; use secure vaults or CI secrets instead.
3. Consistent Naming: Name environment files clearly (e.g., dev-environment.json, prod-environment.json) for clarity.
4. Automate Test Runs: Use scripts or CI jobs to run Newman with environment files to reduce manual errors.
5. Use Version Control: Track collections and environment files in version control to maintain history and collaboration.

Self Check

Where in this folder structure would you add a new environment file for a testing environment?

Key Result

Use separate environment JSON files with Newman to run Postman collections flexibly across multiple environments.