extend overwrites for handling overwriteRequestSecurity (#124)

* extend overwrites for handling overwriteRequestSecurity * add example and update tests * add "other" for fallback auth definition
apideck-libraries · Aug 2, 2021 · d462a7f · d462a7f
1 parent 7a60d08
commit d462a7f
Show file tree

Hide file tree

Showing 16 changed files with 7,410 additions and 156 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## v1.7.0 - (2021-08-02)
+
+### Enhancement
+
+- Added overwrite `overwriteRequestSecurity` to be able to fine tune auth on a request level. This allows you to (for example) ensure all operations are authenticated via variation tests.
+
 ## v1.6.2 - (2021-08-02)
 
 ### Housekeeping

diff --git a/README.md b/README.md
@@ -431,6 +431,10 @@ To facilitate automation, you might want to modify properties with "randomized"
   - **overwrite (Boolean true/false | Default: true)** : Overwrites the request body value OR attaches the value to the original request body value.
   - **remove (Boolean true/false | Default: false)** : Removes the request body property, including the value.
 
+- **overwriteRequestSecurity (Object)** :
+
+  A Postman RequestAuthDefinition object that will be applied to the request.
+
 For more details, review the [overwrites example](https://github.com/apideck-libraries/portman/tree/main/examples/testsuite-overwrites).
 
 <hr>

diff --git a/__tests__/fixtures/portman-variations.crm.json b/__tests__/fixtures/portman-variations.crm.json
@@ -4,9 +4,7 @@
     "contractTests": [
       {
         "openApiOperation": "*::/crm/*",
-        "excludeForOperations": [
-          "GET::/crm/companies"
-        ],
+        "excludeForOperations": ["GET::/crm/companies"],
         "statusSuccess": {
           "enabled": true
         }
@@ -63,6 +61,31 @@
       }
     ],
     "variationTests": [
+      {
+        "openApiOperationId": "leadsAdd",
+        "variations": [
+          {
+            "openApiResponse": "403",
+            "name": "InvalidAuth",
+            "overwrites": [
+              {
+                "overwriteRequestSecurity": {
+                  "bearer": { "token": "not_a_real_token" }
+                }
+              }
+            ],
+            "tests": {
+              "contractTests": [
+                {
+                  "statusCode": {
+                    "enabled": true
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      },
       {
         "openApiOperationId": "leadsAdd",
         "variations": [

diff --git a/examples/cli-filtering/filtered-crm.leads.yml b/examples/cli-filtering/filtered-crm.leads.yml
diff --git a/examples/testsuite-overwrites/portman-config.crm.json b/examples/testsuite-overwrites/portman-config.crm.json
@@ -68,7 +68,12 @@
           "remove": true
         }
       ]
+    },
+    {
+      "openApiOperationId": "leadsAll",
+      "overwriteRequestSecurity": {
+        "bearer": { "token": "{{managementToken}}" }
+      }
     }
   ]
-
 }
diff --git a/examples/testsuite-variation-tests/portman-config.crm.json b/examples/testsuite-variation-tests/portman-config.crm.json
@@ -49,6 +49,31 @@
       }
     ],
     "variationTests": [
+      {
+        "openApiOperation": "*::/crm/*",
+        "variations": [
+          {
+            "openApiResponse": "401",
+            "name": "Unauthorized",
+            "overwrites": [
+              {
+                "overwriteRequestSecurity": {
+                  "bearer": { "token": "bogus_token" }
+                }
+              }
+            ],
+            "tests": {
+              "contractTests": [
+                {
+                  "statusCode": {
+                    "enabled": true
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      },
       {
         "openApiOperationId": "leadsAdd",
         "variations": [