Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theplenkov-npm/newman-collection
Minimalistic Postman/Newman collections generator
https://github.com/theplenkov-npm/newman-collection
http-testing newman postman postman-collection
Last synced: about 1 month ago
JSON representation
Minimalistic Postman/Newman collections generator
- Host: GitHub
- URL: https://github.com/theplenkov-npm/newman-collection
- Owner: theplenkov-npm
- License: mit
- Created: 2020-02-16T21:09:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T18:43:55.000Z (over 2 years ago)
- Last Synced: 2024-04-24T11:46:18.634Z (8 months ago)
- Topics: http-testing, newman, postman, postman-collection
- Language: TypeScript
- Homepage:
- Size: 103 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Newman/Postman collection generator
> This module will bring your postman/newman experience to a next level
[![NPM Version][npm-image]][npm-url]
## Install
```bash
npm i newman-collection
```
## Usage
The only feature this module brings is simplified minimalistic JS-like creation of the collection file.
Newman is a tool developed by a postman team which can run existing collections . Having postman-collection SDK available we can already generate collections on the fly, however working with this library directly developer experience was not that great. Behind the idea of this module I have personal experience of working with Express.js (get/post/head/put/delete and other https methods), fetch Web API-like headers declaration and finally writing scripts as Javascript not like strings
Same code with postman SDK will take more lines:
```js
const { Collection, Item } = require("newman-collection");
const newman = require("newman");
let oCollection = new Collection([
// test GET
new Item("Test GET request")
.get("https://postman-echo.com/get?foo1=bar1&foo2=bar2")
.pm.test("This is test A", () => {
pm.response.to.be.ok;
})
.pm.test("This is test B", () => {
pm.response.to.be.ok;
}),
// test POST
new Item("Test POST request")
.post("https://postman-echo.com/post")
.headers({ "Content-Type": "text/plain" })
.body("test")
.pm.test("body should be same", () => {
pm.response.to.have.jsonBody("data", "test");
}),
// test auth
new Item("Test basic auth")
.get("https://postman-echo.com/basic-auth")
.auth.basic({ username: "postman", password: "password" })
.pm.test("Must be authenticated", () => {
pm.response.to.have.jsonBody("authenticated", true);
})
]);
newman.run({
collection: oCollection.collection,
reporters: ["cli"]
});
```
#### Interface auth
| method | description |
| -------------------------- | -------------------------------------------------------------------------------------------------------- |
| basic({username,password}) | Provides basic authentication. Do not use secret data in your code but use {{secret}} variables instead. |
#### class Collection
| method | description |
|:--------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _constructor_( _collection_?: CollectionDefinition , _items_?: Item ) | To create an instance you can provide collection definition from postman SDK. In addition to this list of items can be provided also |
| _constructor_( items\*?: Item ) | You can omit definition part providing just array of items |
| _set_ items(_items_: Item) { | A setter method is also availabe to set items later |
| auth | Returns auth interface. Please see section above. When using auth on the collection level credentials will be applied to all requests in the collection |
#### class Item
| method | description |
| --------------------------------------------------- | --------------------------------------------------------- |
| get/post/head/options/put/delete/patch (url:string) | these are factory functions for Request of a certain type |
| auth | See auth section |
#### interface Request
| method | description |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| body(body:string\|object) | Sets body, converts to JSON if needed |
| headers(headers: object) | Sets request headers in a similar to fetch API way |
| auth.basic({username,password}) | Provides basic authentication. Do not use secret data in your code but use {{secret}} variables instead. |
| on.prerequest(callback:Function) | This function along with test script also is probably the main purpose of this module creation. It is extremely not convenient to work with a collection file editing script as string data, not a code. |
| on.test(callback:Function) | test script writer, same as prerequest |
| pm.test(description, callback) | Even more simplified way of creating test scripts. This is what it does:
will create JSON like this:
and finally in the console we can have this:
 |
| auth | see auth section |
## Extensibility
You can always use these classes to build your own recipies and then reuse them across your scenarios
```js
const { Collection, Item } = require("newman-collection");
// Odata login: fetching X-CSRF-Token for future reusing it in the collection with embedded test
class OdataLogin extends Item {
request(...args) {
return super
.request(...args)
.headers({ "X-CSRF-Token": "fetch" })
.pm.test("Token must be fetched", () => {
pm.response.to.be.ok;
pm.response.to.have.header("x-csrf-token");
pm.variables.set(
"x-csrf-token",
pm.response.headers.get("x-csrf-token")
);
});
}
}
// Odata call, CSRF token provided + expects json back
class OdataCall extends Item {
request(...args) {
return super.request(...args).headers({
"X-CSRF-Token": "{{x-csrf-token}}",
Accept: "application/json"
});
}
}
```
## Important links:
[Newman API - CLI/Node.js postman collections runner](https://github.com/postmanlabs/newman)
[Postman SDK - Model this extension is built on top of](http://www.postmanlabs.com/postman-collection/index.html)
[Postman Sandbox API Reference (pm.)](https://learning.postman.com/docs/postman/scripts/postman-sandbox-api-reference/)
[Postman Echo Test Service](https://docs.postman-echo.com/)
## License
[MIT](http://vjpr.mit-license.org)
[npm-image]: https://img.shields.io/npm/v/newman-collection.svg
[npm-url]: https://npmjs.org/package/newman-collection
[travis-image]: https://img.shields.io/travis/live-js/newman-collection/master.svg
[coveralls-image]: https://img.shields.io/coveralls/live-js/newman-collection/master.svg
[coveralls-url]: https://coveralls.io/r/live-js/newman-collection?branch=master
[postman-collection]: https://github.com/postmanlabs/postman-collection