github.com/snyk/vervet/v4@v4.27.2/remove_elements_test.go (about) 1 package vervet_test 2 3 import ( 4 "testing" 5 6 qt "github.com/frankban/quicktest" 7 8 "github.com/snyk/vervet/v4" 9 "github.com/snyk/vervet/v4/testdata" 10 ) 11 12 func TestRemoveElementsExact(t *testing.T) { 13 c := qt.New(t) 14 doc, err := vervet.NewDocumentFile(testdata.Path("output/2021-08-20~experimental/spec.yaml")) 15 c.Assert(err, qt.IsNil) 16 17 // Establish that the OpenAPI document has these expected features 18 19 c.Assert(doc.Paths["/examples/hello-world"], qt.Not(qt.IsNil)) 20 c.Assert(doc.Paths["/examples/hello-world/{id}"], qt.Not(qt.IsNil)) 21 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-request-id"], qt.Not(qt.IsNil)) 22 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-version-served"], qt.Not(qt.IsNil)) 23 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters, qt.HasLen, 4) 24 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters[3].Value.Name, qt.Equals, "x-private-matter") 25 26 c.Assert(doc.Paths["/orgs/{orgId}/projects"].ExtensionProps.Extensions["x-snyk-api-resource"], qt.Not(qt.IsNil)) 27 c.Assert(doc.ExtensionProps.Extensions["x-snyk-api-lifecycle"], qt.Not(qt.IsNil)) 28 29 // Remove some of them 30 31 err = vervet.RemoveElements(doc.T, vervet.ExcludePatterns{ 32 ExtensionPatterns: []string{"x-snyk-api-releases", "x-snyk-api-resource"}, 33 HeaderPatterns: []string{"snyk-request-id", "x-private-matter"}, 34 Paths: []string{"/examples/hello-world", "/examples/hello-world/{id}"}, 35 }) 36 c.Assert(err, qt.IsNil) 37 38 // Assert their removal 39 40 c.Assert(doc.Paths["/examples/hello-world"], qt.IsNil) 41 c.Assert(doc.Paths["/examples/hello-world/{id}"], qt.IsNil) 42 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-request-id"], qt.IsNil) // now removed 43 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-version-served"], qt.Not(qt.IsNil)) // still there 44 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters, qt.HasLen, 3) // x-private-matter removed 45 46 c.Assert(doc.Paths["/orgs/{orgId}/projects"].ExtensionProps.Extensions["x-snyk-api-resource"], qt.IsNil) // now removed 47 c.Assert(doc.ExtensionProps.Extensions["x-snyk-api-lifecycle"], qt.Not(qt.IsNil)) // still there 48 } 49 50 func TestRemoveElementsRegex(t *testing.T) { 51 c := qt.New(t) 52 doc, err := vervet.NewDocumentFile(testdata.Path("output/2021-08-20~experimental/spec.yaml")) 53 c.Assert(err, qt.IsNil) 54 55 // Establish that the OpenAPI document has these expected features 56 57 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-request-id"], qt.Not(qt.IsNil)) 58 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-version-served"], qt.Not(qt.IsNil)) 59 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters, qt.HasLen, 4) 60 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters[3].Value.Name, qt.Equals, "x-private-matter") 61 62 c.Assert(doc.Paths["/orgs/{orgId}/projects"].ExtensionProps.Extensions["x-snyk-api-resource"], qt.Not(qt.IsNil)) 63 c.Assert(doc.ExtensionProps.Extensions["x-snyk-api-lifecycle"], qt.Not(qt.IsNil)) 64 65 // Remove some of them 66 67 err = vervet.RemoveElements(doc.T, vervet.ExcludePatterns{ 68 ExtensionPatterns: []string{"x-snyk-api-r.*"}, 69 HeaderPatterns: []string{"snyk-version-.*", "x-private-.*"}, 70 }) 71 c.Assert(err, qt.IsNil) 72 73 // Assert their removal 74 75 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-request-id"], qt.Not(qt.IsNil)) // still there 76 c.Assert(doc.Paths["/orgs/{orgId}/projects"].Get.Responses["200"].Value.Headers["snyk-version-served"], qt.IsNil) // now removed 77 c.Assert(doc.Paths["/orgs/{org_id}/projects/{project_id}"].Delete.Parameters, qt.HasLen, 3) // x-private-matter removed 78 79 c.Assert(doc.Paths["/orgs/{orgId}/projects"].ExtensionProps.Extensions["x-snyk-api-resource"], qt.IsNil) // now removed 80 c.Assert(doc.ExtensionProps.Extensions["x-snyk-api-lifecycle"], qt.Not(qt.IsNil)) // still there 81 }