New Feature - Generate tests from OpenAPI / Swagger - automated contract testing #56

CHANGELOG.md

@@ -54,7 +54,7 @@
 * Added support for internal $ref resolution in validation flows.
 * Fixed issue where parameter resolution was "schema" when "example" was specified.
 * Add supported formats for schema resolution (deref).
-* Fix for [#7643](https://github.com/postmanlabs/postman-app-support/issues/7643), [#7914](https://github.com/postmanlabs/postman-app-support/issues/7914), [#9004](https://github.com/postmanlabs/postman-app-support/issues/9004) - Added support for Auth params in response/example. 
+* Fix for [#7643](https://github.com/postmanlabs/postman-app-support/issues/7643), [#7914](https://github.com/postmanlabs/postman-app-support/issues/7914), [#9004](https://github.com/postmanlabs/postman-app-support/issues/9004) - Added support for Auth params in response/example.
 * Bumped up multiple dependecies and dev-dependencies versions to keep them up-to-date.
 * Updated code coverage tool from deprecated istanbul to nyc.
 
@@ -127,7 +127,7 @@
 
 #### v1.1.13 (April 21, 2020)
 * Added support for detailed validation body mismatches with option detailedBlobValidation.
-* Fix for [#8098](https://github.com/postmanlabs/postman-app-support/issues/8098) - Unable to validate schema with type array. 
+* Fix for [#8098](https://github.com/postmanlabs/postman-app-support/issues/8098) - Unable to validate schema with type array.
 * Fixed URIError for invalid URI in transaction.
 * Fix for [#152](https://github.com/postmanlabs/openapi-to-postman/issues/152) - Path references not resolved due to improver handling of special characters.
 * Fix for [#160](https://github.com/postmanlabs/openapi-to-postman/issues/160) - Added handling for variables in local servers not a part of a URL segment. All path servers to be added as collection variables.

README.md

@@ -1,14 +1,17 @@
 
-![postman icon](https://raw.githubusercontent.com/postmanlabs/postmanlabs.github.io/develop/global-artefacts/postman-logo%2Btext-320x132.png) 
+# THIS BRANCH IS DEPRECATED, IN FAVOR OF A STANDALONE PACKAGE [Portman](https://github.com/apideck-libraries/portman) 
+ ---
 
-*Supercharge your API workflow.*  
+![postman icon](https://raw.githubusercontent.com/postmanlabs/postmanlabs.github.io/develop/global-artefacts/postman-logo%2Btext-320x132.png)
+
+*Supercharge your API workflow.*
 *Modern software is built on APIs. Postman helps you develop APIs faster.*
 
 # OpenAPI 3.0 to Postman Collection v2.1.0 Converter
 
 [![Build Status](https://travis-ci.org/postmanlabs/openapi-to-postman.svg?branch=master)](https://travis-ci.org/postmanlabs/openapi-to-postman)
 
-#### Contents 
+#### Contents
 
 1. [Getting Started](#getting-started)
 2. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module)
@@ -21,6 +24,7 @@
     1. [Options](#options)
     2. [Usage](#usage)
 4. [Conversion Schema](#conversion-schema)
+5. [Postman test suite generation options](/TESTGENERATION.md)
 
 ---
 
@@ -99,7 +103,7 @@ Check out complete list of options and their usage at [OPTIONS.md](/OPTIONS.md)
 
 ### ConversionResult
 
-- `result` - Flag responsible for providing a status whether the conversion was successful or not 
+- `result` - Flag responsible for providing a status whether the conversion was successful or not
 
 - `reason` - Provides the reason for an unsuccessful conversion, defined only if result: false
 
@@ -158,28 +162,31 @@ The converter can be used as a CLI tool as well. The following [command line opt
 `openapi2postmanv2 [options]`
 
 ### Options
-- `-v`, `--version`  
+- `-v`, `--version`
   Specifies the version of the converter
 
-- `-s <source>`, `--spec <source>`  
+- `-s <source>`, `--spec <source>`
   Used to specify the OpenAPI specification (file path) which is to be converted
 
-- `-o <destination>`, `--output <destination>`  
+- `-o <destination>`, `--output <destination>`
   Used to specify the destination file in which the collection is to be written
 
-- `-t`, `--test`  
+- `-t`, `--test`
   Used to test the collection with an in-built sample specification
 
-- `-p`, `--pretty`  
+- `-p`, `--pretty`
   Used to pretty print the collection object while writing to a file
 
 - `-O`, `--options`
   Used to supply options to the converter, for complete options details see [here](/OPTIONS.md)
 
-- `-c`, `--options-config`  
+- `-c`, `--options-config`
   Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
 
-- `-h`, `--help`  
+- `-g <generate>`, `--generate <generate>`
+  Used to generate postman tests given the JSON file with test options, for complete options details see [here](/TESTGENERATION.md)
+
+- `-h`, `--help`
   Specifies all the options along with a few usage examples on the terminal
 
 
@@ -203,6 +210,11 @@ $ openapi2postmanv2 -s spec.yaml -o collection.json -p  -c ./examples/cli-option
 $ openapi2postmanv2 --test
 ```
 
+- Generating additional postman tests for the OpenAPi specification
+```terminal
+$ openapi2postmanv2 -s spec.yaml -o collection.json -p -g postman-testsuite.json
+```
+
 ## Conversion Schema
 
 | *postman* | *openapi* | *options* | *examples* |