newman - npm Package Compare versions

Comparing version 5.3.2 to 6.0.0

bin/newman.js

@@ -140,8 +140,2 @@ #!/usr/bin/env node
 
-// This hack has been added from https://github.com/nodejs/node/issues/6456#issue-151760275
-// @todo: remove when https://github.com/nodejs/node/issues/6456 has been fixed
-(Number(process.version[1]) >= 6) && [process.stdout, process.stderr].forEach((s) => {
-    s && s.isTTY && s._handle && s._handle.setBlocking && s._handle.setBlocking(true);
-});
-
 // Run this script if this is a direct stdin.
@@ -148,0 +142,0 @@ !module.parent && run(process.argv);

docker/images/alpine/README.md

 # newman:alpine
 
-This image runs newman on node v10 on Alpine
+This image runs newman on node v16 on Alpine
 
@@ -5,0 +5,0 @@ Build the image:

docker/images/ubuntu/README.md

 # newman:ubuntu
 
-This image runs newman on node v10 on Ubuntu 18.04
+This image runs newman on node v16 on Ubuntu 22.04
 
@@ -5,0 +5,0 @@ Build the image,

docker/README.md

@@ -18,3 +18,3 @@ <img src="https://s3.amazonaws.com/web-artefacts/cartoon-whale-8.gif+(400%C3%97225).png">
 
-## There are four available Docker images for Newman
+## There are two available Docker images for Newman
 ### postman/newman:alpine (lightweight):
@@ -28,13 +28,2 @@ * <a href="https://hub.docker.com/r/postman/newman/">DockerHub</a>
 
-### postman/newman_alpine33 (lightweight, deprecated):
-   * <a href="https://hub.docker.com/r/postman/newman_alpine33/">DockerHub</a>
-   * <a href="https://github.com/postmanlabs/newman/tree/develop/docker/images/alpine33">Documentation</a>
-
-### postman/newman_ubuntu1404 (deprecated):
-   * <a href="https://hub.docker.com/r/postman/newman_ubuntu1404/">DockerHub</a>
-   * <a href="https://github.com/postmanlabs/newman/tree/develop/docker/images/ubuntu1404">Documentation</a>
-
-### Note:
-The Docker images postman/newman_alpine33 and postman/newman_ubuntu1404 for Newman are deprecated. It is advised to use [postman/newman](https://hub.docker.com/r/postman/newman/) instead.
-
 ## Using the docker image
@@ -41,0 +30,0 @@

lib/run/export-file.js

 var fs = require('fs'),
-    nodePath = require('path'),
+    {
+        join: joinPath,
+        parse: parsePath,
+        resolve: resolvePath
+    } = require('path'),
 
     _ = require('lodash'),
     async = require('async'),
-    mkdirp = require('mkdirp'),
+    { mkdirp } = require('mkdirp'),
 
-    // @todo: ES6: Change the sequence below to use object destructuring when Node v4 support is dropped
-    joinPath = nodePath.join,
-    parsePath = nodePath.parse,
-    resolvePath = nodePath.resolve,
-
     /**
@@ -14,0 +13,0 @@ * The root path specifier

lib/run/index.js

 var _ = require('lodash'),
+    EventEmitter = require('events'),
     asyncEach = require('async/each'),
@@ -6,3 +7,2 @@ sdk = require('postman-collection'),
     request = require('postman-request'),
-    EventEmitter = require('eventemitter3'),
     SecureFS = require('./secure-fs'),
@@ -9,0 +9,0 @@ RunSummary = require('./summary'),

lib/run/options.js

@@ -6,3 +6,3 @@ var _ = require('lodash'),
     VariableScope = require('postman-collection').VariableScope,
-    CookieJar = require('tough-cookie').CookieJar,
+    CookieJar = require('@postman/tough-cookie').CookieJar,
     transformer = require('postman-collection-transformer'),
@@ -90,3 +90,3 @@ liquidJSON = require('liquid-json'),
      *
-     * @todo Drop support for the v1 collection format in Newman v5.
+     * @todo Drop support for the v1 collection format in Newman v7?
      * Reference: https://github.com/postmanlabs/newman/pull/1660
@@ -93,0 +93,0 @@ *

lib/run/summary.js

@@ -329,3 +329,3 @@ var _ = require('lodash'),
                     previousAverage = summary.run.timings[`${value}Average`],
-                    previousVariance = Math.pow(summary.run.timings[`${value}Sd`], 2),
+                    previousVariance = summary.run.timings[`${value}Sd`] ** 2,
                     delta1 = currentValue - previousAverage,
@@ -332,0 +332,0 @@ delta2,

lib/util.js

@@ -6,4 +6,4 @@ var fs = require('fs'),
     chardet = require('chardet'),
-    filesize = require('filesize'),
     prettyms = require('pretty-ms'),
+    { filesize } = require('filesize'),
     liquidJSON = require('liquid-json'),
@@ -10,0 +10,0 @@ request = require('postman-request'),

MIGRATION.md

@@ -6,5 +6,6 @@ # Newman
 1. [Updating to the latest version](#updating-to-the-latest-version)
-2. [Migrating from V4 to V5](#migrating-from-v4-to-v5)
-3. [Migrating from V3 to V4](#migrating-from-v3-to-v4)
-4. [Migrating from V2 to V3](#migrating-from-v2-to-v3)
+2. [Migrating from V5 to V6](#migrating-from-v5-to-v6)
+3. [Migrating from V4 to V5](#migrating-from-v4-to-v5)
+4. [Migrating from V3 to V4](#migrating-from-v3-to-v4)
+5. [Migrating from V2 to V3](#migrating-from-v2-to-v3)
 
@@ -28,2 +29,24 @@ ## Updating to the latest version
 
+## Migrating from V5 to V6
+
+Newman v6.0 requires Node.js v16 or higher. Also, the runtime dependencies are upgraded to their latest versions.
+
+### Upgrading Node.js
+Newman v6 requires Node.js >= v16. [Install Node.js via package manager](https://nodejs.org/en/download/package-manager/).
+
+### Latest Postman Runtime
+Newman v6 uses the latest version of the Postman Runtime dependencies. This brings in several improvements and bug fixes.
+Here are some of the notable additions:
+* JWT authentication
+* NTLMv2 authentication
+* Promise execution in scripts
+* Stripping JSON comments in the raw mode body
+
+### Docker Images
+Newman v6 drops support for deprecated `postman/newman_alpine33` and `postman/newman_ubuntu1404` Docker images.
+
+The two available Docker images, `postman/newman:alpine` and `postman/newman:ubuntu` are upgraded to Node.js v16.
+
+---
+
 ## Migrating from V4 to V5
@@ -30,0 +53,0 @@

package.json

 {
   "name": "newman",
-  "version": "5.3.2",
+  "version": "6.0.0",
   "description": "Command-line companion utility for Postman",
+  "author": "Postman Labs <[e-mail]> (=)",
+  "license": "Apache-2.0",
   "homepage": "https://github.com/postmanlabs/newman",
@@ -26,66 +28,60 @@ "bugs": "https://github.com/postmanlabs/newman/issues",
   "scripts": {
+    "docker-publish": "./npm/docker-publish.sh",
+    "release": "node npm/create-release.js",
     "test": "npm run test-lint && npm run test-system && npm run test-unit && npm run test-integration && npm run test-cli && npm run test-library",
-    "test-system": "node npm/test-system.js",
-    "test-lint": "node npm/test-lint.js",
-    "test-unit": "nyc --nycrc-path=.nycrc.js node npm/test-unit.js",
+    "test-cli": "nyc --nycrc-path=.nycrc.js node npm/test-cli.js",
     "test-integration": "nyc --nycrc-path=.nycrc.js node npm/test-integration.js",
-    "test-cli": "nyc --nycrc-path=.nycrc.js node npm/test-cli.js",
     "test-library": "nyc --nycrc-path=.nycrc.js node npm/test-library.js",
-    "build-docs": "node npm/build-docs.js",
-    "build-wiki": "node npm/build-wiki.js",
-    "publish-docs": "node npm/publish-docs.js",
-    "publish-wiki": "node npm/publish-wiki.js"
+    "test-lint": "node npm/test-lint.js",
+    "test-system": "node npm/test-system.js",
+    "test-unit": "nyc --nycrc-path=.nycrc.js node npm/test-unit.js"
   },
-  "author": "Postman Labs <[e-mail]> (=)",
-  "license": "Apache-2.0",
   "dependencies": {
-    "async": "3.2.3",
-    "chardet": "1.4.0",
-    "cli-progress": "3.10.0",
-    "cli-table3": "0.6.1",
+    "@postman/tough-cookie": "4.1.3-postman.1",
+    "async": "3.2.4",
+    "chardet": "1.6.0",
+    "cli-progress": "3.12.0",
+    "cli-table3": "0.6.3",
     "colors": "1.4.0",
-    "commander": "7.2.0",
+    "commander": "11.0.0",
     "csv-parse": "4.16.3",
-    "eventemitter3": "4.0.7",
-    "filesize": "8.0.7",
+    "filesize": "10.0.12",
+    "liquid-json": "0.3.1",
     "lodash": "4.17.21",
-    "mkdirp": "1.0.4",
-    "postman-collection": "4.1.1",
-    "postman-collection-transformer": "4.1.6",
-    "postman-request": "2.88.1-postman.31",
-    "postman-runtime": "7.29.0",
+    "mkdirp": "3.0.1",
+    "postman-collection": "4.2.1",
+    "postman-collection-transformer": "4.1.7",
+    "postman-request": "2.88.1-postman.33",
+    "postman-runtime": "7.33.0",
     "pretty-ms": "7.0.1",
-    "semver": "7.3.5",
+    "semver": "7.5.4",
     "serialised-error": "1.1.3",
-    "tough-cookie": "3.0.1",
-    "word-wrap": "1.2.3",
+    "word-wrap": "1.2.5",
     "xmlbuilder": "15.1.1"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
+    "@postman/shipit": "^0.4.0",
+    "chai": "^4.3.8",
+    "dependency-check": "^4.1.0",
     "dockerfile_lint": "^0.3.4",
-    "editorconfig": "^0.15.3",
-    "eslint": "^7.32.0",
-    "eslint-plugin-jsdoc": "^36.1.0",
+    "editorconfig": "^2.0.0",
+    "eslint": "^8.49.0",
+    "eslint-plugin-jsdoc": "^46.6.0",
     "eslint-plugin-lodash": "^7.4.0",
-    "eslint-plugin-mocha": "^10.0.3",
-    "eslint-plugin-security": "^1.4.0",
+    "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-security": "^1.7.1",
     "js-yaml": "^4.1.0",
-    "jsdoc": "^3.6.10",
-    "jsdoc-to-markdown": "^7.1.1",
-    "mocha": "^9.2.1",
-    "nock": "^13.2.4",
+    "mocha": "^10.2.0",
+    "nock": "^13.3.3",
     "nyc": "^15.1.0",
-    "packity": "^0.3.4",
-    "parse-gitignore": "^1.0.1",
-    "postman-jsdoc-theme": "^0.0.3",
-    "recursive-readdir": "^2.2.2",
+    "parse-gitignore": "^2.0.0",
+    "recursive-readdir": "^2.2.3",
     "server-destroy": "^1.0.1",
     "shelljs": "^0.8.5",
-    "sinon": "^13.0.1",
-    "xml2js": "^0.4.23"
+    "sinon": "^16.0.0",
+    "xml2js": "^0.6.2"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16"
   }
 }

README.md

@@ -1,7 +0,5 @@
-### Newman v5 has been released. Check the [migration guide](MIGRATION.md#migrating-from-v4-to-v5) and [changelog](https://github.com/postmanlabs/newman/blob/v5.0.0/CHANGELOG.yaml#L1) for more details.
-
 <a href="https://www.postman.com/"><img src="https://assets.getpostman.com/common-share/postman-logo-horizontal-320x132.png" /></a><br />
 _Manage all of your organization's APIs in Postman, with the industry's most complete API development environment._
 
-# newman <sub>_the cli companion for postman_</sub> [![Build Status](https://travis-ci.org/postmanlabs/newman.svg?branch=develop)](https://travis-ci.com/postmanlabs/newman) [![codecov](https://codecov.io/gh/postmanlabs/newman/branch/develop/graph/badge.svg)](https://codecov.io/gh/postmanlabs/newman)
+# newman <sub>_the cli companion for postman_</sub> [![Build Status](https://github.com/postmanlabs/newman/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/postmanlabs/newman/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/postmanlabs/newman/branch/develop/graph/badge.svg)](https://codecov.io/gh/postmanlabs/newman)
 
@@ -49,3 +47,3 @@ Newman is a command-line collection runner for Postman. It allows you to effortlessly run and test a Postman collection directly from the command-line. It is built with extensibility in mind so that you can easily integrate it with your continuous integration servers and build systems.
 
-To run Newman, ensure that you have Node.js >= v10. [Install Node.js via package manager](https://nodejs.org/en/download/package-manager/).
+To run Newman, ensure that you have Node.js >= v16. [Install Node.js via package manager](https://nodejs.org/en/download/package-manager/).
 
@@ -129,3 +127,3 @@ ### Installation
 - `-v`, `--version`<br />
-  Displays the current Newman version, taken from [package.json](https://github.com/postmanlabs/newman/blob/master/package.json)
+  Displays the current Newman version, taken from [package.json](https://github.com/postmanlabs/newman/blob/main/package.json)
 
@@ -352,3 +350,3 @@
     },
-    globalVar: [ 
+    globalVar: [
         { "key":"glboalSecret", "value":"globalSecretValue" },
@@ -373,3 +371,3 @@ { "key":"globalAnotherSecret", "value":`${process.env.GLOBAL_ANOTHER_SECRET}`}
     },
-    envVar: [ 
+    envVar: [
         { "key":"secret", "value":"secretValue" },
@@ -390,4 +388,4 @@ { "key":"anotherSecret", "value":`${process.env.ANOTHER_SECRET}`}
 
-All events receive two arguments (1) `error` and (2) `args`. **The list below describes the properties of the second
-argument object.**
+All events receive two arguments (1) `error` and (2) `args`. The list below describes the properties of the second
+argument object. [Learn more](https://github.com/postmanlabs/newman/wiki/Newman-Run-Events)
 
@@ -415,4 +413,2 @@ | Event     | Description   |
 
-<!-- TODO: write about callback summary -->
-
 [back to top](#table-of-contents)
@@ -455,3 +451,3 @@
 
-| `--reporter-cli-show-timestamps` | This prints the local time for each request made. | 
+| `--reporter-cli-show-timestamps` | This prints the local time for each request made. |
 | `--reporter-cli-no-summary`     | The statistical summary table is not shown. |
@@ -535,2 +531,4 @@ | `--reporter-cli-no-failures`    | This prevents the run failures from being separately printed. |
 
+- [allure](https://github.com/allure-framework/allure-js/tree/master/packages/newman-reporter-allure) -
+This reporter allow to create fully-featured allure reports that can allow you to have easy to understand HTML reports with features like historical data, link tests to the JIRA and all other benefits of using [allure framework](https://qameta.io/allure-report/).
 - [htmlextra](https://github.com/DannyDainton/newman-reporter-htmlextra) -
@@ -658,4 +656,4 @@ This is an updated version of the standard HTML reporter containing a more in-depth data output and a few helpful extras
 
-- [Newman v4 to v5 Migration Guide](MIGRATION.md)
-- [Newman v4.x Documentation](https://github.com/postmanlabs/newman/blob/release/4.x/README.md)
+- [Newman v5 to v6 Migration Guide](MIGRATION.md)
+- [Newman v5.x Documentation](https://github.com/postmanlabs/newman/blob/release/5.x/README.md)
 
@@ -672,2 +670,3 @@
 |       v5.x        |  >= v10.x  |
+|       v6.x        |  >= v16.x  |
 
@@ -674,0 +673,0 @@ The current Node version compatibility can also be seen from the `engines.node` property in [package.json](https://github.com/postmanlabs/newman/blob/develop/package.json)

No alert changes

Improved metrics

Dev dependency count

20

decreased by-9.09%

Worsened metrics

Total package byte prevSize

242485

decreased by-3.05%

Number of package files

33

decreased by-10.81%

Lines of code

3109

decreased by-0.16%

Number of lines in readme file

690

decreased by-0.14%

Dependency changes

• + Added@postman/tough-cookie@4.1.3-postman.1

• + Addedliquid-json@0.3.1

• + Added@colors/colors@1.5.0(transitive)

• + Added@faker-js/faker@5.5.3(transitive)

• + Added@postman/tough-cookie@4.1.3-postman.1(transitive)

• + Addedasync@3.2.4(transitive)

• + Addedaws4@1.12.0(transitive)

• + Addedchardet@1.6.0(transitive)

• + Addedcli-progress@3.12.0(transitive)

• + Addedcli-table3@0.6.3(transitive)

• + Addedcommander@11.0.0(transitive)

• + Addeddes.js@1.1.0(transitive)

• + Addedfilesize@10.0.12(transitive)

• + Addedflatted@3.2.6(transitive)

• + Addedhandlebars@4.7.8(transitive)

• + Addedhttpntlm@1.8.13(transitive)

• + Addedjose@4.14.4(transitive)

• + Addedjs-md4@0.3.2(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedminimalistic-assert@1.0.1(transitive)

• + Addedmkdirp@3.0.1(transitive)

• + Addedpostman-collection@4.2.04.2.1(transitive)

• + Addedpostman-collection-transformer@4.1.7(transitive)

• + Addedpostman-request@2.88.1-postman.33(transitive)

• + Addedpostman-runtime@7.33.0(transitive)

• + Addedpostman-sandbox@4.2.7(transitive)

• + Addedquerystringify@2.2.0(transitive)

• + Addedrequires-port@1.0.0(transitive)

• + Addedsemver@7.5.4(transitive)

• + Addeduniversalify@0.2.0(transitive)

• + Addedurl-parse@1.5.10(transitive)

• + Addeduvm@2.1.1(transitive)

• + Addedword-wrap@1.2.5(transitive)

• - Removedeventemitter3@4.0.7

• - Removedtough-cookie@3.0.1

• - Removedasync@3.2.3(transitive)

• - Removedaws4@1.11.0(transitive)

• - Removedchardet@1.4.0(transitive)

• - Removedcli-progress@3.10.0(transitive)

• - Removedcli-table3@0.6.1(transitive)

• - Removedcommander@7.2.0(transitive)

• - Removedeventemitter3@4.0.7(transitive)

• - Removedfaker@5.5.3(transitive)

• - Removedfilesize@8.0.7(transitive)

• - Removedflatted@3.1.1(transitive)

• - Removedhandlebars@4.7.7(transitive)

• - Removedhttpntlm@1.7.7(transitive)

• - Removedip-regex@2.1.0(transitive)

• - Removedmime-db@1.51.0(transitive)

• - Removedmime-types@2.1.34(transitive)

• - Removedmkdirp@1.0.4(transitive)

• - Removedpostman-collection@4.1.1(transitive)

• - Removedpostman-collection-transformer@4.1.6(transitive)

• - Removedpostman-request@2.88.1-postman.31(transitive)

• - Removedpostman-runtime@7.29.0(transitive)

• - Removedpostman-sandbox@4.0.6(transitive)

• - Removedsemver@7.3.5(transitive)

• - Removedtough-cookie@2.5.03.0.1(transitive)

• - Removeduvm@2.0.2(transitive)

• - Removedword-wrap@1.2.3(transitive)

• Updatedasync@3.2.4

• Updatedchardet@1.6.0

• Updatedcli-progress@3.12.0

• Updatedcli-table3@0.6.3

• Updatedcommander@11.0.0

• Updatedfilesize@10.0.12

• Updatedmkdirp@3.0.1

• Updatedpostman-collection@4.2.1

• Updatedpostman-collection-transformer@4.1.7

• Updatedpostman-request@2.88.1-postman.33

• Updatedpostman-runtime@7.33.0

• Updatedsemver@7.5.4

• Updatedword-wrap@1.2.5