Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions codegen/internal/runtime/params/bind.go
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ func BindQueryParameter(paramName string, queryParams url.Values, dest any, opts
var fieldsPresent bool
fieldsPresent, err = bindParamsToExplodedObject(paramName, queryParams, output)
if !fieldsPresent {
if opts.Required {
return &MissingRequiredParameterError{ParamName: paramName}
}
return nil
}
default:
Expand Down Expand Up @@ -339,6 +342,9 @@ func BindRawQueryParameter(paramName string, rawQuery string, dest any, opts Par
var fieldsPresent bool
fieldsPresent, err = bindParamsToExplodedObject(paramName, queryParams, output)
if !fieldsPresent {
if opts.Required {
return &MissingRequiredParameterError{ParamName: paramName}
}
return nil
}
default:
Expand Down
122 changes: 111 additions & 11 deletions codegen/internal/runtime/params/bind_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"errors"
"net/url"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -252,22 +253,60 @@ func TestBindQueryParameter_Form_Roundtrip(t *testing.T) {
}

func TestBindQueryParameter_OptionalMissing(t *testing.T) {
vals := url.Values{}
t.Run("explode_primitive", func(t *testing.T) {
vals := url.Values{}

var result *string
err := BindQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: true})
require.NoError(t, err)
assert.Nil(t, result)
var result *string
err := BindQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: true})
require.NoError(t, err)
assert.Nil(t, result)
})
t.Run("explode_string_slice", func(t *testing.T) {
vals := url.Values{}

var result *[]string
err := BindQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: true})
require.NoError(t, err)
assert.Nil(t, result)
})
t.Run("explode_struct", func(t *testing.T) {
vals := url.Values{}

var result *time.Time
err := BindQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: true})
require.NoError(t, err)
assert.Nil(t, result)
})
}

func TestBindQueryParameter_RequiredMissing(t *testing.T) {
vals := url.Values{}
t.Run("explode_primitive", func(t *testing.T) {
vals := url.Values{}

var result string
err := BindQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: true, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
var result string
err := BindQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: true, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
t.Run("explode_string_slice", func(t *testing.T) {
vals := url.Values{}

var result []string
err := BindQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: true, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
t.Run("explode_struct", func(t *testing.T) {
vals := url.Values{}

var result time.Time
err := BindQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: true, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
}

func TestBindQueryParameter_DeepObject_Roundtrip(t *testing.T) {
Expand Down Expand Up @@ -325,3 +364,64 @@ func TestBindQueryParameter_DeepObject_Roundtrip(t *testing.T) {
assert.Equal(t, original, result)
})
}

// ---------------------------------------------------------------------------
// BindRawQueryParameter (query - string)
// ---------------------------------------------------------------------------

func TestBindRawQueryParameter_OptionalMissing(t *testing.T) {
t.Run("primitive", func(t *testing.T) {
vals := ""

var result *string
err := BindRawQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: false})
require.NoError(t, err)
assert.Nil(t, result)
})
t.Run("string_slice", func(t *testing.T) {
vals := ""

var result *[]string
err := BindRawQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: false})
require.NoError(t, err)
assert.Nil(t, result)
})
t.Run("struct", func(t *testing.T) {
vals := ""

var result *time.Time
err := BindRawQueryParameter("missing", vals, &result, ParameterOptions{Style: "form", Explode: false})
require.NoError(t, err)
assert.Nil(t, result)
})
}

func TestBindRawQueryParameter_RequiredMissing(t *testing.T) {
t.Run("primitive", func(t *testing.T) {
vals := ""

var result string
err := BindRawQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: false, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
t.Run("string_slice", func(t *testing.T) {
vals := ""

var result []string
err := BindRawQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: false, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
t.Run("struct", func(t *testing.T) {
vals := ""

var result time.Time
err := BindRawQueryParameter("required", vals, &result, ParameterOptions{Style: "form", Explode: false, Required: true})
require.Error(t, err)
var reqErr *MissingRequiredParameterError
assert.True(t, errors.As(err, &reqErr))
})
}
3 changes: 3 additions & 0 deletions examples/petstore-expanded/chi/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/echo-v4/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/echo/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/fiber/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/gin/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/gorilla/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/iris/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/petstore-expanded/stdhttp/server/server.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions runtime/params/params.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.