postmanlabs/newman
Newman
Newman is a headless API client and command line tool for executing Postman collections. It serves as an API test automation tool and execution engine that allows users to run predefined sets of API requests without a graphical interface.
The project differentiates itself as a data-driven testing engine, capable of iterating through request sequences using external JSON or CSV files to validate multiple sets of input values. It also functions as an API execution reporter, utilizing a plugin-based interface to output results in formats such as JSON and JUnit.
The tool covers broad capability areas including API regression testing and the integration of automated quality gates within continuous integration pipelines. It provides a variable-injection engine to manage environment and global variables, as well as a configurable network agent to handle SSL settings and proxy routing.
This is a Node.js based execution engine.
Features
- API Request Collections - Executes predefined sets of API requests defined in collection files via a command line interface.
- Test Execution Automation - Provides a command line interface for running predefined sets of API requests to verify system behavior.
- API Collection Runners - Provides a headless command line tool to execute predefined sets of API requests defined in Postman collection files.
- API Testing - Runs automated test suites and regression checks through command line interfaces or CI pipelines.
- Session Variable Stores - Maintains a mutable key-value store of cookies and environment variables that persists across the execution lifecycle.
- API Request Executors - Sends requests across multiple protocols with custom authentication and variable data to inspect server responses.
- Data-Driven Testing - Provides a data-driven testing engine that iterates through API requests using external JSON or CSV files.
- CI/CD Pipeline Integrations - Integrates automated API tests into commit pipelines to act as quality gates against regressions and schema drift.
- Environment Variable Management - Loads specific variable sets from files or URLs to customize request data at runtime.
- Environment Variable Configurations - Injects runtime settings and configuration parameters into requests via environment and global variable stores.
- Quality Gates - Integrates automated testing and protocol verification into commit pipelines to block builds containing regressions.
- Automated Testing Tools - Serves as a comprehensive tool for running automated regression checks and quality gates in CI pipelines.
- Data-Driven Testing - Repeats request sequences by mapping rows from CSV or JSON files to request variables for each iteration.
- External Result Reporters - Utilizes a plugin-based interface to output execution results to various internal and external report formats.
- Test Result Reporters - Outputs API test results into multiple structured formats such as JSON and JUnit.
- API Request Clients - Provides a headless Node.js execution engine for sending network requests and verifying responses without a GUI.
- Regression Testing Suites - Executes saved request collections across different environments to verify that new changes do not break existing functionality.
- Request Sequence Definitions - Executes network calls by iterating through a structured JSON schema that defines the order and parameters of requests.
- Test Execution Reports - Generates test results in multiple formats including CLI, JSON, and JUnit for detailed analysis.
- Variable Injection - Replaces placeholders in request templates with values from environment or global stores during runtime.
- Execution State Exporters - Saves the final state of environment variables, global variables, and cookie jars to files after a run completes.
- Event Listeners - Provides hooks to trigger custom logic at specific lifecycle stages, such as before a request or after a run.
- Headless Execution Environments - Executes API tests in a headless mode within containers to ensure isolated and consistent runtimes.
- Request Execution Settings - Sets timeouts, delays, and SSL verification toggles to manage request behavior during test runs.
- Execution Flow Controls - Manages the run process by selecting folders, setting timeouts, or stopping execution upon the first failure.
- Automated Testing Containers - Provides the ability to run API test suites within isolated containers to ensure environment consistency.
- Network Agent Configuration - Provides customization of low-level networking behavior, including SSL settings and proxy routing, via a configurable network agent.
- Network Proxy Configurations - Supports routing traffic through HTTP, HTTPS, or SOCKS proxies via environment variables or custom agents.
- Certificate Handling - Manages SSL certificates and allows disabling verification for self-signed certificates in restricted environments.
- API Workflow Automation - Automates sequential API interactions where the output of one call serves as the input for another.
- Reporting Plugins - Outputs execution results into formats like JSON or JUnit through an extensible reporting plugin interface.
- Execution Lifecycle Hooks - Triggers custom callbacks at specific stages of the execution lifecycle, such as before a request.
- API Testing Tools - A command-line collection runner for API testing.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
