> ### ⚠ ️ This project is no longer maintained in this repository.
>
> Development and maintenance have been stopped in this repository.
>
> A fork of this project is active and maintained at apideck-libraries/postman-to-k6.

Postman-to-k6

Converts a Postman collection to a k6 script.

Content

- Features
- Installation
- Local Installation (recommended)
- Global Installation
- Docker
- Usage
- Options
- Iterations
- Environment Variables
- Global Variables
- CSV Data File
- JSON Data File
- Separate
- Docker Usage
- Examples
- Unsupported Features
- Other similar tools
- Credits

Features

- Prerequest scripts.
- Test scripts.
- Variables (at all scopes + dynamic).
- Data files.
- Authentication methods (except Hawk).
- File uploads.
- postman.* interface (exceptions below).
- pm.* interface (exceptions below).
- Global variables exposed by Postman: globals environment data
iteration.
- xml2Json conversion.
- All Postman Schema versions.

Installation

$3

While possible to install globally, we recommend that you, if possible, add the converter to the node_modules of your test project using:

``shell
$ npm install -D postman-to-k6

or using yarn...

$ yarn add postman-to-k6
`

Note that this will require you to run the converter with npx postman-to-k6 your-postman-file or, if you are using an older versions of npm, ./node_modules/.bin/postman-to-k6 your-postman-file.

$3

`shell
$ npm install -g postman-to-k6
`

$3

The tool is also available for usage in Docker. To download an image with the tool from DockerHub:

`shell
$ docker pull loadimpact/postman-to-k6

`

Usage

To convert an exported collection to a k6 script:

`shell
$ postman-to-k6 collection.json -o k6-script.js
`

Then run the script in k6, as usual, using:

`shell
$ k6 run k6-script.js
`

Options

$3

Configures how many times the script will be executed before completion.

| Flag | Verbose | Default |
| ---- | -------------- | ------: |
| -i | --iterations | 1 |

Example:

`shell
$ postman-to-k6 collection.json --iterations 25 -o k6-script.js
`

$3

Provide environment variables from a JSON file.

| Flag | Verbose | Default |
| ---- | --------------- | ------- |
| -e | --environment | N/A |

Example:

`shell
$ postman-to-k6 collection.json --environment environment.json -o k6-script.js
`

$3

Provide global variables from a JSON file.

| Flag | Verbose | Default |
| ---- | ---------- | ------- |
| -g | --global | N/A |

`shell
$ postman-to-k6 collection.json --global globals.json -o k6-script.js
`

$3

Provide a data file in the CSV format.

| Flag | Verbose | Default |
| ---- | ------- | ------- |
| -c | --csv | N/A |

`shell
$ postman-to-k6 collection.json --csv data.csv -o k6-script.js
`

$3

Pass in a data file in the JSON format.

| Flag | Verbose | Default |
| ---- | -------- | ------- |
| -j | --json | N/A |

`shell
$ postman-to-k6 collection.json --json data.json -o k6-script.js
`

$3

Pass K6 parameter options as a file in JSON format.

| Flag | Verbose | Default |
| ---- | ------------- | ------- |
| | --k6-params | N/A |

`shell
$ postman-to-k6 collection.json --k6-params k6-params.json -o k6-script.js
`

$3

Split requests into separate files, for easier rearrangement of the logic.

| Flag | Verbose | Default |
| ---- | ------------ | ------- |
| -s | --separate | false |

`shell
$ postman-to-k6 collection.json --separate -o k6-script.js
`

`shell
postman-to-k6 collection.json -s -o k6-script.js
`

$3

Skips any pre-request scripts during conversion

| Flag | Verbose | Default |
| ---- | ------------ | ------- |
| | --skip-pre | false |

`shell
$ postman-to-k6 collection.json --skip-pre -o k6-script.js
`

$3

Skips any post-request scripts during conversion

| Flag | Verbose | Default |
| ---- | ------------- | ------- |
| | --skip-post | false |

`shell
$ postman-to-k6 collection.json --skip-pre -o k6-script.js
`

Docker Usage

Using the Docker image, you execute the tool as follows:

`shell
$ docker run -it \
-v "/path/to/postman/collection/:/postman/" \
loadimpact/postman-to-k6 \
/postman/my-collection.json \
-o /postman/test.js
`

and then execute the k6 test using:

`shell
$ k6 run /path/to/postman/collection/test.js
`

Examples

A collection of Postman examples are located under example.
To run one of the examples, just run it as you would any other command:

`shell
$ postman-to-k6 example/v2/echo.json -o k6-script.js
`

Unsupported Features

- Sending requests from scripts using pm.sendRequest.
- Controlling request execution order using postman.setNextRequest.
- Cookie properties, like hostOnly, session, and storeId.
- Textual response messages:
- responseCode.name
- responseCode.detail
- pm.response.reason
- pm.response.to.have.status(reason)
- pm.response.to.not.have.status(reason)
- Properties returning Postman classes:
- pm.request.url pm.request.headers
- pm.response.headers
- The Hawk authentication method.
- Deprecated xmlToJson` method.
- Request IDs are changed. Postman doesn't provide them in the export so we
have to generate new ones.

Other similar tools

- jmeter-to-k6: Convert
JMeter JMX files to k6 JS.

Credits

Thanks to bookmoons for creating this tool. Also, thanks to borjacampina for creating the original incarnation of the tool.