Name: newman
Owner: Postman
Description: Newman is a command-line collection runner for Postman
Created: 2014-03-05 17:52:17.0
Updated: 2018-01-18 18:31:42.0
Pushed: 2018-01-18 18:54:03.0
Homepage: http://www.getpostman.com
Size: 2242
Language: HTML
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Supercharge your API workflow
Modern software is built on APIs. Postman helps you develop APIs faster.
Using Newman, one can effortlessly run and test a Postman Collections directly from the command-line. It is built with extensibility in mind so that you can easily integrate it into your continuous integration servers and build systems.
For details on changes across v2 to v3, see the Newman v2 to v3 Migration Guide
For Newman v2.x release documentation, see the Newman v2.x README.
To run Newman, ensure that you have NodeJS >= v4. A copy of the NodeJS installable can be downloaded from https://nodejs.org/en/download/package-manager.
The easiest way to install Newman is using NPM. If you have NodeJS installed, it is most likely that you have NPM installed as well.
m install newman --global;
The newman run command allows you to specify a collection to be run. You can easily export your Postman
Collection as a json file from the Postman App and run it using Newman.
wman run examples/sample-collection.json;
If your collection file is available as an URL (such as from our Cloud API service), Newman can fetch your file and run it as well.
wman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv;
For the complete list of options, refer the Commandline Options section below.
Newman can be easily used within your JavaScript projects as a NodeJS module. The entire set of Newman CLI functionality is available for programmatic use as well. The following example runs a collection by reading a JSON collection file stored on disk.
newman = require('newman'); // require newman in your project
all newman.run to pass `options` object and wait for callback
an.run({
collection: require('./sample-collection.json'),
reporters: 'cli'
unction (err) {
if (err) { throw err; }
console.log('collection run complete!');
Note: The newman v2.x .execute function has been discontinued.
newman run <collection-file-source> [options]-e <source>, --environment <source>
Specify an environment file path or URL. Environments provide a set of variables that one can use within collections.
Read More
-g <source>, --globals <source>
Specify file path or URL for global variables. Global variables are similar to environment variables but has a lower
precedence and can be overridden by environment variables having same name.
-d <source>, --iteration-data <source>
Specify a data source file (CSV) to be used for iteration as a path to a file or as a URL.
Read More
-n <number>, --iteration-count <number>
Specifies the number of times the collection has to be run when used in conjunction with iteration data file.
--folder <name>
Run requests within a particular folder in a collection.
--export-environment <path>
The path to the file where Newman will output the final environment variables file before completing a run.
--export-globals <path>
The path to the file where Newman will output the final global variables file before completing a run.
--export-collection <path>
The path to the file where Newman will output the final collection file before completing a run.
--timeout <ms>
Specify the time (in milliseconds) to wait for the entire collection run to complete execution.
--timeout-request <ms>
Specify the time (in milliseconds) to wait for requests to return a response.
--timeout-script <ms>
Specify the time (in milliseconds) to wait for scripts to complete execution.
-k, --insecure
Disables SSL verification checks and allows self-signed SSL certificates.
--ignore-redirects
Prevents newman from automatically following 3XX redirect responses.
--delay-request
Specify the extent of delay between requests (milliseconds).
--bail [optional modifiers]
Specify whether or not to stop a collection run on encountering the first error.
Can optionally accept modifiers, currently include folder and failure.
folder allows you to skip the entire collection run in case an invalid folder
was specified using the --folder option or an error was encountered in general.
failure would gracefully stop a collection run on the first test failure.
-x, --suppress-exit-code
Specify whether or not to override the default exit code for the current run.
--color
Use this option to force colored CLI output (for use in CLI for CI / non TTY environments).
--no-color
Newman attempts to automatically turn off color output to terminals when it detects the lack of color support. With
this property, one can forcibly turn off the usage of color in terminal output for reporters and other parts of Newman
that output to console.
--disable-unicode
Specify whether or not to force the unicode disable option. When supplied, all symbols in the output will be replaced
by their plain text equivalents.
--global-var "<global-variable-name>=<global-variable-value>"
Allows the specification of global variables via the command line, in a key=value format. Multiple CLI global variables
can be added by using --global-var multiple times, like so: --global-var "foo=bar" --global-var "alpha=beta".
Reporters provide information about the current collection run in a format that is easy to both: disseminate and assimilate.
-r <reporter-name>, --reporters <reporter-name>
Specify one reporter name as string or provide more than one reporter name as a comma separated list of reporter names. Available reporters are: cli, json, html and junit.
Spaces should not be used between reporter names / commas whilst specifying a comma separted list of reporters. For instance:
:white_check_mark: -r html,cli,json,junit
:x: -r html, cli , json,junit
--reporter-{{reporter-name}}-{{reporter-option}}
When multiple reporters are provided, if one needs to specifically override or provide an option to one reporter, this
is achieved by prefixing the option with --reporter-{{reporter-name}}-.
For example, ... --reporters cli,html --reporter-cli-silent would silence the CLI reporter only.
--reporter-{{reporter-options}}
If more than one reporter accepts the same option name, they can be provided using the common reporter option syntax.
For example, ... --reporters cli,html --reporter-silent passes the silent: true option to both HTML and CLI
reporter.
Note: Sample collection reports have been provided in examples/reports.
These options are supported by the CLI reporter, use them with appropriate argument switch prefix. For example, the
option no-summary can be passed as --reporter-no-summary or --reporter-cli-no-summary.
CLI reporter is enabled by default, you do not need to specifically provide the same as part of --reporters option.
However, enabling one or more of the other reporters will result in no CLI output. Explicitly enable the CLI option in
such a scenario.
| CLI Option | Description |
|————-|——————-|
| --reporter-cli-silent | The CLI reporter is internally disabled and you see no output to terminal. |
| --reporter-cli-no-summary | The statistical summary table is not shown. |
| --reporter-cli-no-failures | This prevents the run failures from being separately printed. |
| --reporter-cli-no-assertions | This turns off the output for request-wise assertions as they happen. |
| --reporter-cli-no-console | This turns off the output of console.log (and other console calls) from collection's scripts. |
The built-in JSON reporter is useful in producing a comprehensive output of the run summary. It takes the path to the
file where to write the file. The content of this file is exactly same as the summary parameter sent to the callback
when Newman is used as a library.
To enable JSON reporter, provide --reporters json as a CLI option.
| CLI Option | Description |
|————-|——————-|
| --reporter-json-export <path> | Specify a path where the output JSON file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. |
The built-in HTML reporter produces and HTML output file outlining the summary and report of the Newman run. To enable the
HTML reporter, provide --reporters html as a CLI option.
| CLI Option | Description |
|————-|——————-|
| --reporter-html-export <path> | Specify a path where the output HTML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. |
| --reporter-html-template <path> | Specify a path to the custom template which will be used to render the HTML report. This option depends on --reporter html and --reporter-html-export being present in the run command. If this option is not specified, the default template is used |
Custom templates (currently handlebars only) can be passed to the HTML reporter via --reporter-html-template <path> with --reporters html and --reporter-html-export.
The default template is used in all other cases.
Newman can output a summary of the collection run to a JUnit compatible XML file. To enable the JUNIT reporter, provide
--reporters junit as a CLI option.
| CLI Option | Description |
|————-|——————-|
| --reporter-junit-export <path> | Specify a path where the output XML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. |
Older command line options are supported, but are deprecated in favour of the newer v3 options and will soon be discontinued. For documentation on the older command options, refer to README.md for Newman v2.X.
Newman also supports custom reporters, provided that the reporter works with Newman's event sequence. Working examples on how Newman reporters work can be found in lib/reporters. For instance, to use the Newman teamcity reporter:
Install the reporter package. Note that the name of the package is of the form newman-reporter-<name>. The installation should be global if newman is installed globally, local otherwise. (Replace -g from the command below with -S for a local installation.
install -g newman-reporter-teamcity
Use the installed reporter, either via the CLI, or programmatic usage. Here, the newman-reporter prefix is not required while specifying the reporter name in the options.
an run /path/to/collection.json -r cli,teamcity
newman = require('newman');
newman.run({
collection: '/path/to/collection.json',
reporters: ['cli', 'teamcity']
}, process.exit);
SSL client certificates
nt certificates are an alternative to traditional authentication mechanisms. These allow their users to make authenticated requests to a server, using a public certificate, and an optional private key that verifies certificate ownership. In some cases, the private key may also be protected by a secret passphrase, providing an additional layer of authentication security.
an supports SSL client certificates, via the following CLI options (available with Newman `v3` style `run` only):
-ssl-client-cert`<br/>
path to the public client certificate file.
-ssl-client-key`<br/>
path to the private client key (optional).
-ssl-client-passphrase`<br/>
secret passphrase used to protect the private client key (optional).
`newman [options]`
h`, `--help`<br />
ow commandline help, including a list of options, and sample use cases.
v`, `--version`<br />
splays the current Newman version, taken from [package.json](https://github.com/postmanlabs/newman/blob/master/package.json)
Proxy
an can also be configured to work with proxy settings via the following environment variables:
HTTP_PROXY` / `http_proxy`
HTTPS_PROXY` / `https_proxy`
NO_PROXY` / `no_proxy`
more details on using these variables, please see https://github.com/postmanlabs/postman-request/blob/master/README.md#controlling-proxy-behaviour-using-environment-variables
PI Reference
newman.run(options: _object_ , callback: _function_) => run: EventEmitter
`run` function executes a collection and returns the run result to a callback function provided as parameter. The
rn of the `newman.run` function is a run instance, which emits run events that can be listened to.
rameter | Description |
--------|---------------|
tions | This is a required argument and it contains all information pertaining to running a collection.<br /><br />_Required_<br />Type: `object` |
tions.collection | The collection is a required property of the `options` argument. It accepts an object representation of a Postman Collection which should resemble the schema mentioned at [https://schema.getpostman.com/](https://schema.getpostman.com/). The value of this property could also be an instance of Collection Object from the [Postman Collection SDK](https://github.com/postmanlabs/postman-collection).<br /><br />As `string`, one can provide a URL where the Collection JSON can be found (e.g. [Postman Cloud API](https://api.getpostman.com/) service) or path to a local JSON file.<br /><br />_Required_<br />Type: `object\|string` [PostmanCollection](https://github.com/postmanlabs/postman-collection/wiki#Collection) |
tions.environment | One can optionally pass an environment file path or URL as `string` to this property and that will be used to read Postman Environment Variables from. This property also accepts environment variables as an `object`. Environment files exported from Postman App can be directly used here.<br /><br />_Optional_<br />Type: `object\|string` |
tions.globals | Postman Global Variables can be optionally passed on to a collection run in form of path to a file or URL. It also accepts variables as an `object`.<br /><br />_Optional_<br />Type: `object\|string` |
tions.iterationCount | Specify the number of iterations to run on the collection. This is usually accompanied by providing a data file reference as `options.iterationData`.<br /><br />_Optional_<br />Type: `number`, Default value: `1` |
tions.iterationData | Path to the JSON or CSV file or URL to be used as data source when running multiple iterations on a collection.<br /><br />_Optional_<br />Type: `string` |
tions.folder | The name or ID of the folder (ItemGroup) in the collection which would be run instead of the entire collection.<br /><br />_Optional_<br />Type: `string` |
tions.timeout | Specify the time (in milliseconds) to wait for the entire collection run to complete execution.<br /><br />_Optional_<br />Type: `number`, Default value: `Infinity` |
tions.timeoutRequest | Specify the time (in milliseconds) to wait for requests to return a response.<br /><br />_Optional_<br />Type: `number`, Default value: `Infinity` |
tions.timeoutScript | Specify the time (in milliseconds) to wait for scripts to return a response.<br /><br />_Optional_<br />Type: `number`, Default value: `Infinity` |
tions.delayRequest | Specify the time (in milliseconds) to wait for between subsequent requests.<br /><br />_Optional_<br />Type: `number`, Default value: `0` |
tions.ignoreRedirects | This specifies whether newman would automatically follow 3xx responses from servers.<br /><br />_Optional_<br />Type: `boolean`, Default value: `false` |
tions.insecure | Disables SSL verification checks and allows self-signed SSL certificates.<br /><br />_Optional_<br />Type: `boolean`, Default value: `false` |
tions.bail | A switch to specify whether or not to gracefully stop a collection run on encountering the first error. Takes additional modifiers as arguments to specify whether to end the run with an error for invalid name or path.<br /><br/>Available modifiers: `folder` and `failure`.<br />eg. `bail : ['folder']`<br /><br />_Optional_<br />Type: `boolean\|object`, Default value: `false` |
tions.suppressExitCode | If present, allows overriding the default exit code from the current collection run, useful for bypassing collection result failures. Takes no arguments.<br /><br />_Optional_<br />Type: `boolean`, Default value: `false` |
tions.reporters | Specify one reporter name as `string` or provide more than one reporter name as an `array`.<br /><br />Available reporters: `cli`, `json`, `html` and `junit`.<br /><br />_Optional_<br />Type: `string|array` |
tions.reporter | Specify options for the reporter(s) declared in `options.reporters`. <br /> e.g. `reporter : { junit : { export : './xmlResults.xml' } }` <br /> e.g. `reporter : { html : { export : './htmlResults.html', template: './customTemplate.hbs' } }` <br /><br />_Optional_<br />Type: `object` |
tions.color | Forces colored CLI output (for use in CI / non TTY environments).<br /><br />_Optional_<br />Type: `boolean` |
tions.noColor | Newman attempts to automatically turn off color output to terminals when it detects the lack of color support. With this property, one can forcibly turn off the usage of color in terminal output for reporters and other parts of Newman that output to console.<br /><br />_Optional_<br />Type: `boolean` |
tions.sslClientCert | The path to the public client certificate file.<br /><br />_Optional_<br />Type: `string` |
tions.sslClientKey | The path to the private client key file.<br /><br />_Optional_<br />Type: `string` |
tions.sslClientPassphrase | The secret client key passphrase.<br /><br />_Optional_<br />Type: `string` |
llback | Upon completion of the run, this callback is executed with the `error`, `summary` argument.<br /><br />_Required_<br />Type: `function` |
newman.run~callback(error: _object_ , summary: _object_)
`callback` parameter of the `newman.run` function receives two arguments: (1) `error` and (2) `summary`
gument | Description |
--------|---------------|
ror | In case newman faces an error during the run, the error is passed on to this argument of callback. By default, only fatal errors, such as the ones caused by any fault inside Newman is passed on to this argument. However, setting `abortOnError:true` or `abortOnFailure:true` as part of run options will cause newman to treat collection script syntax errors and test failures as fatal errors and be passed down here while stopping the run abruptly at that point.<br /><br />Type: `object` |
mmary | The run summary will contain information pertaining to the run.<br /><br />Type: `object` |
mmary.error | An error object which if exists, contains an error message describing the message <br /><br />Type: `object` |
mmary.collection | This object contains information about the collection being run, it's requests, and their associated pre-request scripts and tests.<br /><br />Type: `object` |
mmary.environment | An object with environment variables used for the current run, and the usage status for each of those variables.<br /><br />Type: `object` |
mmary.globals | This object holds details about the globals used within the collection run namespace.<br /><br />Type: `object` |
mmary.run | A cumulative run summary object that provides information on .<br /><br />Type: `object` |
mmary.run.stats | An object which provides details about the total, failed, and pending counts for pre request scripts, tests, assertions, requests, and more.<br /><br />Type: `object` |
mmary.run.failures | An array of failure objects, with each element holding details, including the assertion that failed, and the request.<br /><br />Type: `array.<object>` |
mmary.run.executions | This object contains information about each request, along with it's associated activities within the scope of the current collection run.<br /><br />Type: `array.<object>` |
newman.run~events
an triggers a whole bunch of events during the run.
newman.run({
collection: require('./sample-collection.json'),
iterationData: [{ "var": "data", "var_beta": "other_val" }],
globals: {
"id": "5bfde907-2a1e-8c5a-2246-4aff74b74236",
"name": "test-env",
"values": [
{
"key": "alpha",
"value": "beta",
"type": "text",
"enabled": true
}
],
"timestamp": 1404119927461,
"_postman_variable_scope": "globals",
"_postman_exported_at": "2016-10-17T14:31:26.200Z",
"_postman_exported_using": "Postman/4.8.0"
},
environment: {
"id": "4454509f-00c3-fd32-d56c-ac1537f31415",
"name": "test-env",
"values": [
{
"key": "foo",
"value": "bar",
"type": "text",
"enabled": true
}
],
"timestamp": 1404119927461,
"_postman_variable_scope": "environment",
"_postman_exported_at": "2016-10-17T14:26:34.940Z",
"_postman_exported_using": "Postman/4.8.0"
}
}).on('start', function (err, args) { // on start of run, log to console
console.log('running a collection...');
}).on('done', function (err, summary) {
if (err || summary.error) {
console.error('collection run encountered an error.');
}
else {
console.log('collection run completed.');
}
});
events receive two arguments (1) `error` and (2) `args`. **The list below describes the properties of the second
ment object.**
ent | Description |
--------|---------------|
art | The start of a collection run |
foreIteration | Before an iteration commences |
foreItem | Before an item execution begins (the set of prerequest->request->test) |
forePrerequest | Before `prerequest` script is execution starts |
erequest | After `prerequest` script execution completes |
foreRequest | Before an HTTP request is sent |
quest | After response of the request is received |
foreTest | Before `test` script is execution starts |
st | After `test` script execution completes |
foreScript | Before any script (of type `test` or `prerequest`) is executed |
ript | After any script (of type `test` or `prerequest`) is executed |
em | When an item (the whole set of prerequest->request->test) completes |
eration | After an iteration completes |
sertion | This event is triggered for every test assertion done within `test` scripts |
nsole | Every time a `console` function is called from within any script, this event is propagated |
ception | When any asynchronous error happen in `scripts` this event is triggered |
foreDone | An event that is triggered prior to the completion of the run |
ne | This event is emitted when a collection run has completed, with or without errors |
TODO: write about callback summary -->
ile uploads
an also supports file uploads for request form data. The files must be present in the
ent working directory. Your collection must also contain the filename in
"src" attribute of the request.
his collection, `sample-file.txt` should be present in the current working directory.
{
"info": {
"name": "file-upload"
},
"item": [
{
"request": {
"url": "https://postman-echo.com/post",
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"enabled": true,
"src": "sample-file.txt"
}
]
}
}
}
]
}
$ ls file-upload.postman_collection.json sample-file.txt
$ newman run file-upload.postman_collection.json
sing Newman with the Postman API
enerate an API key](https://app.getpostman.com/dashboard/integrations)<br/>
tch a list of your collections from: `https://api.getpostman.com/collections?apikey=$apiKey`<br/>
t the collection link via it's `uid`: `https://api.getpostman.com/collections/$uid?apikey=$apiKey`<br/>
tain the environment URI from: `https://api.getpostman.com/environments?apikey=$apiKey`<br/>
ing the collection and environment URIs acquired in steps 3 and 4, run the collection as follows:
newman run “https://api.getpostman.com/collections/$uid?apikey=$apiKey” \
--environment "https://api.getpostman.com/environments/$uid?apikey=$apiKey"
ommunity Support
src="https://avatars1.githubusercontent.com/u/3220138?v=3&s=120" align="right" />
ou are interested in talking to the Postman team and fellow Newman users, you can find us on our <a href="https://community.getpostman.com">Postman Community Forum</a>. Feel free to drop by and say hello. You'll find us posting about upcoming features and beta releases, answering technical support questions, and contemplating world peace.
in using your Postman account to participate in the discussions and don't forget to take advantage of the <a href="https://community.getpostman.com/search?q=newman">search bar</a> - the answer to your question might already be waiting for you! Don?t want to log in? Then lurk on the sidelines and absorb all the knowledge.
icense
software is licensed under Apache-2.0. Copyright Postdot Technologies, Inc. See the [LICENSE.md](LICENSE.md) file for more information.
nalytics](https://ga-beacon.appspot.com/UA-43979731-9/newman/readme)](https://www.getpostman.com)