feat(mock): Add helper methods for setting query params with OpenAPI validation

Author: olisaagbafor

documentation/docs/guides/testing.md

@@ -12,7 +12,12 @@ func TestMyController(t *testing.T) {
     ctx := fuego.NewMockContext[MyRequestType](MyRequestType{
         Name: "John",
         Age:  30,
-    }
+    })
+
+    // Add query parameters with OpenAPI validation
+    ctx.WithQueryParamInt("page", 1,
+        fuego.ParamDescription("Page number"),
+        fuego.ParamDefault(1))
 
     // Call your controller
     response, err := MyController(ctx)
@@ -60,7 +65,7 @@ func TestSearchUsersController(t *testing.T) {
     tests := []struct {
         name          string
         body          UserSearchRequest
-        queryParams   url.Values
+        setupContext  func(*fuego.MockContext[UserSearchRequest])
         expectedError string
         expected      UserSearchResponse
     }{
@@ -71,31 +76,30 @@ func TestSearchUsersController(t *testing.T) {
                 MaxAge:    35,
                 NameQuery: "John",
             },
-            queryParams: url.Values{
-                "page": {"1"},
+            setupContext: func(ctx *fuego.MockContext[UserSearchRequest]) {
+                // Add query parameters with OpenAPI validation
+                ctx.WithQueryParamInt("page", 1,
+                    fuego.ParamDescription("Page number"),
+                    fuego.ParamDefault(1))
+                ctx.WithQueryParamInt("perPage", 20,
+                    fuego.ParamDescription("Items per page"),
+                    fuego.ParamDefault(20))
             },
             expected: UserSearchResponse{
                 // ... expected response
             },
         },
-        {
-            name: "invalid age range",
-            body: UserSearchRequest{
-                MinAge:    40,
-                MaxAge:    20,
-                NameQuery: "John",
-            },
-            expectedError: "minAge cannot be greater than maxAge",
-        },
     }
 
     for _, tt := range tests {
         t.Run(tt.name, func(t *testing.T) {
             // Create mock context with the test body
             ctx := fuego.NewMockContext[UserSearchRequest](tt.body)
 
-            // Set query parameters directly
-            ctx.UrlValues = tt.queryParams
+            // Set up context with query parameters
+            if tt.setupContext != nil {
+                tt.setupContext(ctx)
+            }
 
             // Call the controller
             response, err := SearchUsersController(ctx)
@@ -114,15 +118,29 @@ func TestSearchUsersController(t *testing.T) {
 }
 ```
 
-## Available Fields
+## Available Fields and Methods
+
+The `MockContext` type provides the following:
 
-The `MockContext` type provides the following public fields for testing:
+Public Fields:
 
 - `RequestBody` - The request body of type B
 - `Headers` - HTTP headers
 - `PathParams` - URL path parameters
 - `Cookies` - HTTP cookies
-- `UrlValues` - Query parameters
+
+Helper Methods for Query Parameters:
+
+- `WithQueryParam(name, value string, options ...func(*OpenAPIParam))` - Add a string query parameter
+- `WithQueryParamInt(name string, value int, options ...func(*OpenAPIParam))` - Add an integer query parameter
+- `WithQueryParamBool(name string, value bool, options ...func(*OpenAPIParam))` - Add a boolean query parameter
+
+Each helper method accepts OpenAPI parameter options like:
+
+- `ParamDescription(description string)` - Add parameter description
+- `ParamDefault(value any)` - Set default value
+- `ParamRequired()` - Mark parameter as required
+- `ParamExample(name string, value any)` - Add example value
 
 ## Best Practices
 

mock_context.go

@@ -2,6 +2,7 @@ package fuego
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 	"net/url"
 	"strings"
@@ -136,3 +137,48 @@ func (m *MockContext[B]) Redirect(code int, url string) (any, error) {
 func (m *MockContext[B]) Render(templateToExecute string, data any, templateGlobsToOverride ...string) (CtxRenderer, error) {
 	panic("not implemented")
 }
+
+// WithQueryParam adds a query parameter to the mock context with OpenAPI validation
+func (m *MockContext[B]) WithQueryParam(name string, value string, options ...func(*OpenAPIParam)) *MockContext[B] {
+	param := OpenAPIParam{
+		Name:   name,
+		GoType: "string",
+		Type:   "query",
+	}
+	for _, option := range options {
+		option(&param)
+	}
+	m.CommonContext.OpenAPIParams[name] = param
+	m.CommonContext.UrlValues.Set(name, value)
+	return m
+}
+
+// WithQueryParamInt adds an integer query parameter to the mock context with OpenAPI validation
+func (m *MockContext[B]) WithQueryParamInt(name string, value int, options ...func(*OpenAPIParam)) *MockContext[B] {
+	param := OpenAPIParam{
+		Name:   name,
+		GoType: "integer",
+		Type:   "query",
+	}
+	for _, option := range options {
+		option(&param)
+	}
+	m.CommonContext.OpenAPIParams[name] = param
+	m.CommonContext.UrlValues.Set(name, fmt.Sprintf("%d", value))
+	return m
+}
+
+// WithQueryParamBool adds a boolean query parameter to the mock context with OpenAPI validation
+func (m *MockContext[B]) WithQueryParamBool(name string, value bool, options ...func(*OpenAPIParam)) *MockContext[B] {
+	param := OpenAPIParam{
+		Name:   name,
+		GoType: "boolean",
+		Type:   "query",
+	}
+	for _, option := range options {
+		option(&param)
+	}
+	m.CommonContext.OpenAPIParams[name] = param
+	m.CommonContext.UrlValues.Set(name, fmt.Sprintf("%t", value))
+	return m
+}

mock_context_test.go

@@ -2,7 +2,6 @@ package fuego_test
 
 import (
 	"errors"
-	"net/url"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -81,7 +80,7 @@ func TestSearchUsersController(t *testing.T) {
 	tests := []struct {
 		name          string
 		body          UserSearchRequest
-		queryParams   url.Values
+		setupContext  func(*fuego.MockContext[UserSearchRequest])
 		expectedError string
 		expected      UserSearchResponse
 	}{
@@ -92,9 +91,9 @@ func TestSearchUsersController(t *testing.T) {
 				MaxAge:    35,
 				NameQuery: "John",
 			},
-			queryParams: url.Values{
-				"page":    {"1"},
-				"perPage": {"20"},
+			setupContext: func(ctx *fuego.MockContext[UserSearchRequest]) {
+				ctx.WithQueryParamInt("page", 1, fuego.ParamDescription("Page number"), fuego.ParamDefault(1))
+				ctx.WithQueryParamInt("perPage", 20, fuego.ParamDescription("Items per page"), fuego.ParamDefault(20))
 			},
 			expected: UserSearchResponse{
 				Users: []UserProfile{
@@ -137,8 +136,10 @@ func TestSearchUsersController(t *testing.T) {
 			// Create mock context with the test body
 			ctx := fuego.NewMockContext(tt.body)
 
-			// Set query parameters directly
-			ctx.UrlValues = tt.queryParams
+			// Set up context with query parameters if provided
+			if tt.setupContext != nil {
+				tt.setupContext(ctx)
+			}
 
 			// Call the controller
 			response, err := SearchUsersController(ctx)