Skip to content

Fixing issues. #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daveshanley merged 2 commits into from
Mar 15, 2026
Merged

Fixing issues. #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37a6eda
fully address https://github.com/pb33f/wiretap/issues/134
daveshanley Mar 15, 2026
b529f4b
Address #27 fully
daveshanley Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
237 changes: 151 additions & 86 deletions errors/parameter_errors.go
View file
Open in desktop

Large diffs are not rendered by default.

315 changes: 314 additions & 1 deletion errors/parameter_errors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023-2024 Princess Beef Heavy Industries, LLC / Dave Shanley
// Copyright 2023-2026 Princess Beef Heavy Industries, LLC / Dave Shanley
// https://pb33f.io

package errors
Expand Down Expand Up @@ -1242,3 +1242,316 @@ items:
require.Contains(t, err.Reason, "The query parameter (which is an array) 'testQueryParam' contains the following duplicates: 'fish, cake'")
require.Contains(t, err.HowToFix, "Ensure the array values are all unique")
}

// createMinimalParameter creates a parameter with nil GoLow nodes to test nil safety.
func createMinimalParameter() *v3.Parameter {
param := &lowv3.Parameter{
Name: low.NodeReference[string]{Value: "minParam"},
// All node references intentionally left with nil KeyNode/ValueNode
}
return v3.NewParameter(param)
}

func TestParameterErrors_NilGoLowNodes(t *testing.T) {
// Tests that all parameter error constructors handle nil GoLow nodes
// without panicking. This covers the crash scenario from wiretap #134.
param := createMinimalParameter()
qp := &helpers.QueryParam{
Key: "minParam",
Values: []string{"value"},
}
sch := &base.Schema{}

t.Run("IncorrectFormEncoding", func(t *testing.T) {
err := IncorrectFormEncoding(param, qp, 0)
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectSpaceDelimiting", func(t *testing.T) {
err := IncorrectSpaceDelimiting(param, qp)
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPipeDelimiting", func(t *testing.T) {
err := IncorrectPipeDelimiting(param, qp)
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidDeepObject", func(t *testing.T) {
err := InvalidDeepObject(param, qp)
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("QueryParameterMissing", func(t *testing.T) {
err := QueryParameterMissing(param, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("HeaderParameterMissing", func(t *testing.T) {
err := HeaderParameterMissing(param, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("CookieParameterMissing", func(t *testing.T) {
err := CookieParameterMissing(param, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("HeaderParameterCannotBeDecoded", func(t *testing.T) {
err := HeaderParameterCannotBeDecoded(param, "bad", "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectHeaderParamEnum", func(t *testing.T) {
err := IncorrectHeaderParamEnum(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectQueryParamEnum", func(t *testing.T) {
err := IncorrectQueryParamEnum(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectCookieParamEnum", func(t *testing.T) {
err := IncorrectCookieParamEnum(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamEnum", func(t *testing.T) {
err := IncorrectPathParamEnum(param, "bad", sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectQueryParamBool", func(t *testing.T) {
err := IncorrectQueryParamBool(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidQueryParamInteger", func(t *testing.T) {
err := InvalidQueryParamInteger(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidQueryParamNumber", func(t *testing.T) {
err := InvalidQueryParamNumber(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectReservedValues", func(t *testing.T) {
err := IncorrectReservedValues(param, "a:b", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidHeaderParamInteger", func(t *testing.T) {
err := InvalidHeaderParamInteger(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidHeaderParamNumber", func(t *testing.T) {
err := InvalidHeaderParamNumber(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidCookieParamInteger", func(t *testing.T) {
err := InvalidCookieParamInteger(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("InvalidCookieParamNumber", func(t *testing.T) {
err := InvalidCookieParamNumber(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectHeaderParamBool", func(t *testing.T) {
err := IncorrectHeaderParamBool(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectCookieParamBool", func(t *testing.T) {
err := IncorrectCookieParamBool(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamBool", func(t *testing.T) {
err := IncorrectPathParamBool(param, "bad", sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamInteger", func(t *testing.T) {
err := IncorrectPathParamInteger(param, "bad", sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamNumber", func(t *testing.T) {
err := IncorrectPathParamNumber(param, "bad", sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectParamEncodingJSON", func(t *testing.T) {
err := IncorrectParamEncodingJSON(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectQueryParamEnumArray", func(t *testing.T) {
err := IncorrectQueryParamEnumArray(param, "bad", sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("PathParameterMissing", func(t *testing.T) {
err := PathParameterMissing(param, "/test/{id}", "/test/123")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})
}

func TestParameterErrors_NilSchemaItems(t *testing.T) {
// Tests array parameter error constructors with nil Items in schema.
param := createMinimalParameter()
sch := &base.Schema{} // no Items set

t.Run("IncorrectQueryParamArrayBoolean", func(t *testing.T) {
err := IncorrectQueryParamArrayBoolean(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectParamArrayMaxNumItems", func(t *testing.T) {
err := IncorrectParamArrayMaxNumItems(param, sch, 5, 10, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectParamArrayMinNumItems", func(t *testing.T) {
err := IncorrectParamArrayMinNumItems(param, sch, 5, 2, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectParamArrayUniqueItems", func(t *testing.T) {
err := IncorrectParamArrayUniqueItems(param, sch, "dup", "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectCookieParamArrayBoolean", func(t *testing.T) {
err := IncorrectCookieParamArrayBoolean(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectQueryParamArrayInteger", func(t *testing.T) {
err := IncorrectQueryParamArrayInteger(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectQueryParamArrayNumber", func(t *testing.T) {
err := IncorrectQueryParamArrayNumber(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectCookieParamArrayNumber", func(t *testing.T) {
err := IncorrectCookieParamArrayNumber(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectHeaderParamArrayBoolean", func(t *testing.T) {
err := IncorrectHeaderParamArrayBoolean(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectHeaderParamArrayNumber", func(t *testing.T) {
err := IncorrectHeaderParamArrayNumber(param, "bad", sch, sch, "/test", "get", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamArrayNumber", func(t *testing.T) {
err := IncorrectPathParamArrayNumber(param, "bad", sch, sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamArrayInteger", func(t *testing.T) {
err := IncorrectPathParamArrayInteger(param, "bad", sch, sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})

t.Run("IncorrectPathParamArrayBoolean", func(t *testing.T) {
err := IncorrectPathParamArrayBoolean(param, "bad", sch, sch, "/test", "{}")
require.NotNil(t, err)
require.Equal(t, 1, err.SpecLine)
require.Equal(t, 0, err.SpecCol)
})
}
30 changes: 22 additions & 8 deletions errors/request_errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
// Copyright 2023-2026 Princess Beef Heavy Industries, LLC / Dave Shanley
// SPDX-License-Identifier: MIT

package errors
Expand All @@ -18,8 +18,17 @@ import (
func RequestContentTypeNotFound(op *v3.Operation, request *http.Request, specPath string) *ValidationError {
ct := request.Header.Get(helpers.ContentTypeHeader)
var ctypes []string
for pair := orderedmap.First(op.RequestBody.Content); pair != nil; pair = pair.Next() {
ctypes = append(ctypes, pair.Key())
var contentMap *orderedmap.Map[string, *v3.MediaType]
specLine, specCol := 1, 0
if op.RequestBody != nil {
contentMap = op.RequestBody.Content
for pair := orderedmap.First(op.RequestBody.Content); pair != nil; pair = pair.Next() {
ctypes = append(ctypes, pair.Key())
}
if low := op.RequestBody.GoLow(); low != nil && low.Content.KeyNode != nil {
specLine = low.Content.KeyNode.Line
specCol = low.Content.KeyNode.Column
}
}
return &ValidationError{
ValidationType: helpers.RequestBodyValidation,
Expand All @@ -28,25 +37,30 @@ func RequestContentTypeNotFound(op *v3.Operation, request *http.Request, specPat
request.Method, ct),
Reason: fmt.Sprintf("The content type '%s' of the %s request submitted has not "+
"been defined, it's an unknown type", ct, request.Method),
SpecLine: op.RequestBody.GoLow().Content.KeyNode.Line,
SpecCol: op.RequestBody.GoLow().Content.KeyNode.Column,
SpecLine: specLine,
SpecCol: specCol,
Context: op,
HowToFix: fmt.Sprintf(HowToFixInvalidContentType, orderedmap.Len(op.RequestBody.Content), strings.Join(ctypes, ", ")),
HowToFix: fmt.Sprintf(HowToFixInvalidContentType, orderedmap.Len(contentMap), strings.Join(ctypes, ", ")),
RequestPath: request.URL.Path,
RequestMethod: request.Method,
SpecPath: specPath,
}
}

func OperationNotFound(pathItem *v3.PathItem, request *http.Request, method string, specPath string) *ValidationError {
specLine, specCol := 1, 0
if low := pathItem.GoLow(); low != nil && low.KeyNode != nil {
specLine = low.KeyNode.Line
specCol = low.KeyNode.Column
}
return &ValidationError{
ValidationType: helpers.RequestValidation,
ValidationSubType: helpers.ValidationMissingOperation,
Message: fmt.Sprintf("%s operation request content type '%s' does not exist",
request.Method, method),
Reason: fmt.Sprintf("The path was found, but there was no '%s' method found in the spec", request.Method),
SpecLine: pathItem.GoLow().KeyNode.Line,
SpecCol: pathItem.GoLow().KeyNode.Column,
SpecLine: specLine,
SpecCol: specCol,
Context: pathItem,
HowToFix: HowToFixPathMethod,
RequestPath: request.URL.Path,
Expand Down
Loading
Loading