Added support for paths with fragments.

pb33f/wiretap#78
Signed-off-by: Dave Shanley <[email protected]>

Author: daveshanley

go.mod

@@ -3,7 +3,7 @@ module github.com/pb33f/libopenapi-validator
 go 1.21
 
 require (
-	github.com/pb33f/libopenapi v0.15.0
+	github.com/pb33f/libopenapi v0.15.2
 	github.com/santhosh-tekuri/jsonschema/v5 v5.3.1
 	github.com/stretchr/testify v1.8.4
 	github.com/vmware-labs/yaml-jsonpath v0.3.2

go.sum

@@ -54,8 +54,8 @@ github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1y
 github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY=
 github.com/onsi/gomega v1.19.0 h1:4ieX6qQjPP/BfC3mpsAtIGGlxTWPeA3Inl/7DtXw1tw=
 github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro=
-github.com/pb33f/libopenapi v0.15.0 h1:AoBYIY3HXqDDF8O9kcudlqWaRFZZJmgtueE649oHzIw=
-github.com/pb33f/libopenapi v0.15.0/go.mod h1:m+4Pwri31UvcnZjuP8M7TlbR906DXJmMvYsbis234xg=
+github.com/pb33f/libopenapi v0.15.2 h1:Jit99QiDVgrYgTbEeBmzlUnrR/oewH6K24OTVPRbYaU=
+github.com/pb33f/libopenapi v0.15.2/go.mod h1:m+4Pwri31UvcnZjuP8M7TlbR906DXJmMvYsbis234xg=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 h1:lZUw3E0/J3roVtGQ+SCrUrg3ON6NgVqpn3+iol9aGu4=

paths/paths.go

@@ -36,6 +36,9 @@ func FindPath(request *http.Request, document *v3.Document) (*v3.PathItem, []*er
 
 	// strip any base path
 	stripped := stripBaseFromPath(request.URL.Path, basePaths)
+	if request.URL.Fragment != "" {
+		stripped = fmt.Sprintf("%s#%s", stripped, request.URL.Fragment)
+	}
 
 	reqPathSegments := strings.Split(stripped, "/")
 	if reqPathSegments[0] == "" {
@@ -48,6 +51,15 @@ pathFound:
 	for pair := orderedmap.First(document.Paths.PathItems); pair != nil; pair = pair.Next() {
 		path := pair.Key()
 		pathItem := pair.Value()
+
+		// if the stripped path has a fragment, then use that as part of the lookup
+		// if not, then strip off any fragments from the pathItem
+		if !strings.Contains(stripped, "#") {
+			if strings.Contains(path, "#") {
+				path = strings.Split(path, "#")[0]
+			}
+		}
+
 		segs := strings.Split(path, "/")
 		if segs[0] == "" {
 			segs = segs[1:]
@@ -256,11 +268,8 @@ func comparePaths(mapped, requested []string,
 	var imploded []string
 	for i, seg := range mapped {
 		s := seg
-		// sOrig := seg
-		// check for braces
 		if strings.Contains(seg, "{") {
 			s = requested[i]
-			// sOrig = s
 		}
 		// check param against type, check if it's a number or not, and if it validates.
 		for p := range params {

paths/paths_test.go

@@ -601,3 +601,33 @@ paths:
 
 	assert.Len(t, errs, 1)
 }
+
+func TestNewValidator_FindPathWithFragment(t *testing.T) {
+
+	spec := `openapi: 3.1.0
+paths:
+  /hashy#one:
+    post:
+      operationId: one
+  /hashy#two:
+    post:
+      operationId: two
+`
+
+	doc, _ := libopenapi.NewDocument([]byte(spec))
+	m, _ := doc.BuildV3Model()
+
+	request, _ := http.NewRequest(http.MethodPost, "https://things.com/hashy#one", nil)
+
+	pathItem, errs, _ := FindPath(request, &m.Model)
+	assert.Len(t, errs, 0)
+	assert.NotNil(t, pathItem)
+	assert.Equal(t, "one", pathItem.Post.OperationId)
+
+	request, _ = http.NewRequest(http.MethodPost, "https://things.com/hashy#two", nil)
+	pathItem, errs, _ = FindPath(request, &m.Model)
+	assert.Len(t, errs, 0)
+	assert.NotNil(t, pathItem)
+	assert.Equal(t, "two", pathItem.Post.OperationId)
+
+}

requests/validate_request.go

@@ -23,7 +23,7 @@ import (
 
 var instanceLocationRegex = regexp.MustCompile(`^/(\d+)`)
 
-// ValidateRequestSchema will validate an http.Request pointer against a schema.
+// ValidateRequestSchema will validate a http.Request pointer against a schema.
 // If validation fails, it will return a list of validation errors as the second return value.
 func ValidateRequestSchema(
 	request *http.Request,