Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itv/pmpact
A command line tool to convert Pact files to Postman collections.
https://github.com/itv/pmpact
cli pact postman postman-collection
Last synced: 24 days ago
JSON representation
A command line tool to convert Pact files to Postman collections.
- Host: GitHub
- URL: https://github.com/itv/pmpact
- Owner: ITV
- License: other
- Created: 2018-08-28T11:14:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T11:34:49.000Z (3 months ago)
- Last Synced: 2024-12-22T07:49:17.555Z (29 days ago)
- Topics: cli, pact, postman, postman-collection
- Language: JavaScript
- Homepage:
- Size: 282 KB
- Stars: 16
- Watchers: 69
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pmpact
A command line tool to convert [_Pact_](https://docs.pact.io/) files to [_Postman_](https://www.getpostman.com/) collections.
## Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Installation from the repo](#installation-from-the-repo)
- [Command line usage](#command-line-usage)
- [From a url](#from-a-url)
- [From a file](#from-a-file)
- [Save to a file](#save-to-a-file)
- [From a url that requires headers](#from-a-url-that-requires-headers)
- [Postman usage](#postman-usage)
- [Import the collection in _Postman_](#import-the-collection-in-postman)
- [Create a _Postman_ environment](#create-a-postman-environment)
- [Run tests](#run-tests)
- [Run all tests](#run-all-tests)
- [Run unit tests only](#run-unit-tests-only)
- [Run integration tests only](#run-integration-tests-only)
- [License](#license)
## Requirements
Requires [_NodeJS_](https://nodejs.org/en/) version `v20.11` or higher.
## Installation
```
npm install -g pmpact
```
### Installation from the repo
Clone the repo and from the root execute:
```
npm install
npm link
```
**Note**: Don't forget to run `npm unlink` if needed!
## Command line usage
### From a url
```
pmpact http://pact-broker/provider/a-provider/consumer/a-consumer/latest
```
### From a file
```
pmpact pact-file.json
```
### Save to a file
```
pmpact http://pact-broker/provider/a-provider/consumer/a-consumer/latest -o postman-collection.json
```
### From a url that requires headers
```
pmpact http://pact-broker/provider/a-provider/consumer/a-consumer/latest -H '{"Authorization":"Basic ZFhmbHR5Rk1n..."}'
```
## _Postman_ usage
### Import the collection in _Postman_
Once you have a generated [_Postman_ collection](https://www.getpostman.com/docs/v6/postman/collections/intro_to_collections), select "import" in _Postman_. The generated collection format is `2.1`.
A collection should appear, starting with the name "Pact".
### Create a _Postman_ environment
A url variable is used for all the requests. The next step is to create an [_Postman_ environment](https://www.getpostman.com/docs/v6/postman/environments_and_globals/intro_to_environments_and_globals) with a url variable, for example: `url: http://my-service.com`.
1. 
2. 
3. 
4. 
You're good to go - so make the requests!
## Run tests
### Run all tests
```
npm test
```
### Run unit tests only
```
npm run test-unit
```
### Run integration tests only
```
npm run test-integration
```
### Watch tests
```
npm install -g nodemon
nodemon tests/unit -x "npm run test-unit"
nodemon tests/integration -x "npm run test-integration"
```
## Release process
When contributing, the process we adhere to for releases is found in [RELEASE.md](./RELEASE.md).
## License
[See License file](https://github.com/ITV/pmpact/blob/master/LICENSE.md)