Fix: Default parameter addition check (#384)

Tufin · Sep 19, 2023 · bdb2a75 · bdb2a75
1 parent 34d3dbf
commit bdb2a75
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 23 deletions.
diff --git a/checker/check-new-request-non-path-default-parameter.go b/checker/check-new-request-non-path-default-parameter.go
@@ -14,13 +14,15 @@ func NewRequestNonPathDefaultParameterCheck(diffReport *diff.Diff, operationsSou
 			continue
 		}
 
-		for paramLoc := range pathItem.ParametersDiff.Added {
+		for paramLoc, paramNameList := range pathItem.ParametersDiff.Added {
 			if paramLoc == "path" {
 				continue
 			}
 
 			for _, param := range pathItem.Revision.Parameters {
-
+				if !paramNameList.Contains(param.Value.Name) {
+					continue
+				}
 				id := "new-required-request-default-parameter-to-existing-path"
 				level := ERR
 				if !param.Value.Required {

diff --git a/checker/check-new-request-non-path-default-parameter_test.go b/checker/check-new-request-non-path-default-parameter_test.go
@@ -21,7 +21,7 @@ func TestNewRequestNonPathParameter_DetectsNewRequiredPathsAndNewOperations(t *t
 
 	errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.NewRequestNonPathDefaultParameterCheck), d, osm, checker.INFO)
 	require.NotEmpty(t, errs)
-	require.Len(t, errs, 9)
+	require.Len(t, errs, 7)
 
 	require.ElementsMatch(t, []checker.ApiChange{
 		{
@@ -44,16 +44,6 @@ func TestNewRequestNonPathParameter_DetectsNewRequiredPathsAndNewOperations(t *t
 			Path:        "/api/test1",
 			Source:      "../data/request_params/required-request-params.yaml",
 		},
-		{
-			Id:          "new-required-request-default-parameter-to-existing-path",
-			Text:        "added the new required 'header' request parameter 'id' to all path's operations",
-			Comment:     "",
-			Level:       3,
-			Operation:   "GET",
-			OperationId: "getTest",
-			Path:        "/api/test2",
-			Source:      "../data/request_params/required-request-params.yaml",
-		},
 		{
 			Id:          "new-required-request-default-parameter-to-existing-path",
 			Text:        "added the new required 'query' request parameter 'id' to all path's operations",
@@ -103,15 +93,5 @@ func TestNewRequestNonPathParameter_DetectsNewRequiredPathsAndNewOperations(t *t
 			OperationId: "getTest",
 			Path:        "/api/test2",
 			Source:      "../data/request_params/required-request-params.yaml",
-		},
-		{
-			Id:          "new-optional-request-default-parameter-to-existing-path",
-			Text:        "added the new optional 'query' request parameter 'optionalHeaderParam' to all path's operations",
-			Comment:     "",
-			Level:       1,
-			Operation:   "GET",
-			OperationId: "getTest",
-			Path:        "/api/test2",
-			Source:      "../data/request_params/required-request-params.yaml",
 		}}, errs)
 }
diff --git a/data/request_params/base.yaml b/data/request_params/base.yaml
@@ -4,6 +4,12 @@ info:
 openapi: 3.0.3
 paths:
   /api/test1:
+    parameters:
+      - in: query
+        name: baseQueryParam
+        required: true
+        schema:
+          type: string
     get:
       operationId: getTest
       responses:
@@ -15,6 +21,12 @@ paths:
           description: OK
 
   /api/test2:
+    parameters:
+      - in: query
+        name: baseNotRequiredQueryParam
+        required: false
+        schema:
+          type: string
     get:
       operationId: getTest
       responses:

diff --git a/data/request_params/required-request-params.yaml b/data/request_params/required-request-params.yaml
@@ -5,6 +5,11 @@ openapi: 3.0.3
 paths:
   /api/test1:
     parameters:
+      - in: query
+        name: baseQueryParam
+        required: true
+        schema:
+          type: string
       - in: query
         name: version
         required: true
@@ -33,6 +38,11 @@ paths:
 
   /api/test2:
     parameters:
+      - in: query
+        name: baseNotRequiredQueryParam
+        required: false
+        schema:
+          type: string
       - in: query
         name: id
         required: true