Data file with Newman in Postman - Framework Patterns

Framework Mode - Data file with Newman

Folder Structure

newman-postman-project/
├── collections/
│   └── my-api-collection.json       # Postman collection exported JSON
├── data/
│   └── test-data.json                # Data file with variables for Newman
├── reports/
│   └── newman-report.html            # Generated test reports
├── scripts/
│   └── run-newman.js                 # Script to run Newman with data file
├── package.json                      # Node.js project config with Newman dependency
└── README.md                        # Project overview and instructions

Test Framework Layers

• Collections: Postman exported JSON files defining API requests and tests.
• Data Files: JSON or CSV files providing variable data sets for data-driven testing with Newman.
• Scripts: Node.js scripts to execute Newman CLI commands programmatically, specifying collections and data files.
• Reports: Output folders where Newman saves test run reports in HTML, JSON, or other formats.
• Config: package.json manages dependencies like Newman and scripts for running tests.

Configuration Patterns

• Environment Variables: Use Postman environment files or pass environment JSON files to Newman for environment-specific values.
• Data Files: Use JSON or CSV files to provide multiple data sets for the same collection to run data-driven tests.
• Newman CLI Options: Configure timeout, iteration count, reporters, and data files via CLI or scripts.
• Credentials: Store sensitive data in environment files or external vaults, avoid hardcoding in collections or data files.
• package.json Scripts: Define npm scripts to run Newman commands with specific collections and data files for easy execution.

Test Reporting and CI/CD Integration

• Newman Reporters: Use built-in reporters like HTML, JSON, or CLI summary for test results.
• Custom Reports: Generate detailed HTML reports saved in the reports/ folder for easy review.
• CI/CD Integration: Integrate Newman runs in pipelines (GitHub Actions, Jenkins, GitLab CI) using npm scripts or direct CLI commands.
• Fail Fast: Configure Newman to fail the build on test failures to ensure quality gates.
• Artifacts: Save reports as build artifacts for traceability and sharing with the team.

Best Practices

• Separate Data from Tests: Keep test data in external JSON or CSV files to enable easy data-driven testing without changing collections.
• Use Environment Files: Manage different environments (dev, staging, prod) with Postman environment files passed to Newman.
• Automate with Scripts: Use Node.js scripts to run Newman with parameters, improving repeatability and integration.
• Version Control: Store collections, data files, and scripts in version control to track changes and collaborate.
• Clear Reporting: Generate readable reports and integrate with CI/CD to quickly identify failures.

Self Check

Where in this folder structure would you add a new data file to test a different set of user credentials?

Key Result

Use external JSON or CSV data files with Newman to run data-driven API tests efficiently.