Merge pull request #8 from thim81/pr-openapi-to-postman-examples

PR openapi to postman examples

.gitignore

@@ -13,3 +13,5 @@ postman-testsuite.json
 .idea
 /examples/testsuite-default-checks/tmp/
 /examples/testsuite-content-checks/tmp/
+/examples/testsuite-overwrites/tmp/
+/examples/testsuite-assign-variables/tmp/

CHANEGLOG.md

@@ -1,8 +1,16 @@
+## v0.0.x - (2021-xx-xx)
+
+### OpenApi-to-postman
+Bumped openapi-to-postman to the latest version, which includes extended assignPmVariables test capabilities
+Added examples for the test suite assignPmVariables function
+Added examples for the test suite overwriteRequests function
+
 ## v0.0.4 - (2021-05-18)
 
 ### OpenApi-to-postman
 Bumped openapi-to-postman to version 2.7.0, which includes ContentCheck test capabilities
 Added examples for the test suite generation
+Added examples for the test suite contentChecks function
 Made the "orderOfOperations" property optional
 
 ### CLI options

examples/testsuite-assign-variables/portman-cli-options.json

@@ -0,0 +1,11 @@
+{
+  "local": "./examples/testsuite-assign-variables/crm.openapi.yml",
+  "baseUrl": "http://localhost:3050",
+  "output": "./examples/testsuite-assign-variables/crm.postman.json",
+  "portmanConfigFile": "./examples/testsuite-assign-variables/portman-config.crm.json",
+  "postmanConfigFile": "./examples/testsuite-assign-variables/postman-config.crm.json",
+  "includeTests": true,
+  "testSuiteConfigFile": "./examples/testsuite-assign-variables/postman-testsuite.crm.json",
+  "syncPostman": true,
+  "runNewman": false
+}

examples/testsuite-assign-variables/portman-config.crm.json

@@ -0,0 +1,12 @@
+{
+  "preRequestScripts": [],
+  "variableOverwrites": {
+    "application_id": "{{applicationId}}"
+  },
+  "globalReplacements": [
+    {
+      "searchFor": "\"maxItems\":2,",
+      "replaceWith": ""
+    }
+  ]
+}

examples/testsuite-assign-variables/postman-config.crm.json

@@ -0,0 +1,5 @@
+{
+  "folderStrategy": "Tags",
+  "requestParametersResolution": "Example",
+  "exampleParametersResolution": "Example"
+}

examples/testsuite-assign-variables/postman-testsuite.crm.json

@@ -0,0 +1,101 @@
+{
+  "version": 1.0,
+  "generateTests": {
+    "responseChecks": {
+      "StatusSuccess": {
+        "enabled": true
+      },
+      "responseTime": {
+        "enabled": true,
+        "maxMs": 300
+      },
+      "contentType": {
+        "enabled": true
+      },
+      "jsonBody": {
+        "enabled": true
+      },
+      "schemaValidation": {
+        "enabled": true
+      },
+      "headersPresent": {
+        "enabled": true
+      }
+    }
+  },
+  "assignPmVariables": [
+    {
+      "openApiOperationId": "GET::/crm/leads/{id}",
+      "environmentVariables": [
+        {
+          "responseBodyProp": "data.company_name"
+        }
+      ]
+    },
+    {
+      "openApiOperationId": "leadsAdd",
+      "environmentVariables": [
+        {
+          "requestBodyProp": "company_name",
+          "name": "leadsAdd.company_name"
+        },
+        {
+          "responseBodyProp": "data.id",
+          "name": "leadsAdd.id"
+        }
+      ]
+    }
+  ],
+  "contentChecks": [
+    {
+      "openApiOperationId": "leadsOne",
+      "checkRequestBody": [
+        {
+          "key": "data.company_name",
+          "value": "{{leadsAdd.company_name}}"
+        }
+      ]
+    }
+  ],
+  "overwriteRequests": [
+    {
+      "openApiOperationId": "leadsAdd",
+      "overwriteRequestBody": [
+        {
+          "key": "name",
+          "value": "{{leadsAdd.name}}"
+        }
+      ]
+    },
+    {
+      "openApiOperation": "GET::/crm/leads/{id}",
+      "overwriteRequestPathVariables": [
+        {
+          "key": "id",
+          "value": "{{leadsAdd.id}}",
+          "overwrite": true
+        }
+      ]
+    },
+    {
+      "openApiOperation": "PATCH::/crm/leads/{id}",
+      "overwriteRequestPathVariables": [
+        {
+          "key": "id",
+          "value": "{{leadsAdd.id}}",
+          "overwrite": true
+        }
+      ]
+    },
+    {
+      "openApiOperation": "DELETE::/crm/leads/{id}",
+      "overwriteRequestPathVariables": [
+        {
+          "key": "id",
+          "value": "{{leadsAdd.id}}",
+          "overwrite": true
+        }
+      ]
+    }
+  ]
+}