quick_godoc_test.go

// Package quick provides a high-performance, minimalistic web framework for Go.
//
// This file contains **unit tests** for various functionalities of the Quick framework,
// including route handling, middleware, static file serving, and request handling.
//
// These tests ensure that the core features of Quick work as expected.
//
// 📌 To run all unit tests, use:
//
//	$ go test -v ./...
//	$ go test -v
package quick

import (
	"net/http"
	"reflect"
	"runtime"
	"testing"
	"time"

	"github.com/jeffotoni/quick/middleware/cors"
)

// TestExamplePath tests whether a PATCH route returns the expected response.
// Simulates a partial feature update.
//
// Expected result: status 200 and body "Feature partially updated!".
//
// Use:
//
//	go test -v -run TestExamplePath
func TestExamplePath(t *testing.T) {
	q := New()

	// Sets a PATCH route to partially update a feature
	q.Patch("/update-partial", func(c *Ctx) error {
		c.Set("Content-Type", "text/plain")
		return c.Status(200).String("Feature partially updated!")
	})

	// Simulates a PATCH request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodPatch,
		URI:    "/update-partial",
	})
	if err != nil {
		t.Errorf("Error during Qtest: %v", err)
		return
	}

	// Checks if the returned HTTP status code is correct
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200 but got %d", data.StatusCode())
	}

	// Check if the response body contains the expected message
	expectedBody := "Feature partially updated!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s' but got '%s'", expectedBody, data.BodyStr())
	}
}

// TestExampleOptions tests if the OPTIONS path returns the allowed methods correctly.
// Simulates the definition of Allow headers with supported HTTP methods.
//
// Expected result: status 204 with Allow header.
//
// Use:
//
//	go test -v -run TestExampleOptions
func TestExampleOptions(t *testing.T) {
	q := New()

	// default
	allowedMethods := "GET, POST, PUT, DELETE, PATCH, OPTIONS"

	// Define a GET route
	q.Get("/v1/user", func(c *Ctx) error {
		c.Set("Content-Type", "application/json")
		c.Set("Allow", allowedMethods)
		return c.Status(200).String("GET is working!")
	})

	opts := QuickTestOptions{
		Method: "GET",
		URI:    "/v1/user",
		Headers: map[string]string{
			"Content-Type": "application/json",
			"Accept":       "application/json",
			"Allow":        allowedMethods,
		},
		LogDetails: true,
	}

	// Simulate an OPTIONS request
	resp, err := q.Qtest(opts)
	if err != nil {
		t.Errorf("Error executing QuickTest: %v", err)
		return
	}

	// Verify that the HTTP status code is 200
	err = resp.AssertStatus(200)
	if err != nil {
		t.Errorf("StatusCode assertion failed: %v", err)
	}

	err = resp.AssertHeader("Allow", allowedMethods)
	if err != nil {
		t.Errorf("Header assertion failed: %v", err)
	}

	err = resp.AssertHeader("Content-Type", "application/json")
	if err != nil {
		t.Errorf("Header assertion failed: %v", err)
	}

	// Register OPTIONS for the /options route
	q.Options("/options", func(c *Ctx) error {
		// Define the methods allowed for this
		// resource in the Allow header
		c.Set("Allow", allowedMethods)
		//c.Response.Header().Set("Allow", allowedMethods)
		return c.Status(204).Send(nil)
	})

	opts = QuickTestOptions{
		Method: "OPTIONS",
		URI:    "/options",
		Headers: map[string]string{
			"Content-Type": "application/json",
			"Accept":       "application/json",
			"Allow":        allowedMethods,
		},
		LogDetails: true,
	}

	// Simulate an OPTIONS request
	resp, err = q.Qtest(opts)
	if err != nil {
		t.Errorf("Error executing QuickTest: %v", err)
		return
	}

	// Verify that the HTTP status code is 200
	err = resp.AssertStatus(204)
	if err != nil {
		t.Errorf("StatusCode assertion failed: %v", err)
	}
}

// TestExampleGetDefaultConfig verifies that GetDefaultConfig returns the correct default values.
// Compares the returned values with the expected default setting.
//
// Use:
//
//	go test -v -run TestExampleGetDefaultConfig
func TestExampleGetDefaultConfig(t *testing.T) {
	// Expected default configuration values
	expected := Config{
		BodyLimit:      2 * 1024 * 1024, // 2MB
		MaxBodySize:    2 * 1024 * 1024, // 2MB
		MaxHeaderBytes: 1 * 1024 * 1024, // 1MB

		GOMAXPROCS:      runtime.NumCPU(),
		GCHeapThreshold: 1 << 30, // 1GB
		BufferPoolSize:  32768,

		RouteCapacity: 1000,  // Initial capacity of 1000 routes.
		MoreRequests:  290,   // default GC value equilibrium value
		NoBanner:      false, // Display Quick banner by default.
	}

	// Get actual configuration
	result := GetDefaultConfig()

	// Verify if the configuration matches the expected values
	if !reflect.DeepEqual(expected, result) {
		t.Errorf("GetDefaultConfig() did not return expected configuration. Expected %+v, got %+v", expected, result)
	}
}

// TestExampleNew tests whether a simple GET route returns the expected response.
// Expect status 200 and the message "Quick in action ❤️!".
//
// Usage:
//
// go test -v -run TestExampleNew
func TestExampleNew(t *testing.T) {
	q := New()

	// Define a simple GET route
	q.Get("/", func(c *Ctx) error {
		// Set response content type
		c.Set("Content-Type", "text/plain")
		// Return a success message
		return c.Status(200).String("Quick in action ❤️!")
	})

	// Simulate a GET request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodGet,
		URI:    "/",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Validate HTTP status code
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200, but got %d", data.StatusCode())
	}

	// Validate response body
	expectedBody := "Quick in action ❤️!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but got '%s'", expectedBody, data.BodyStr())
	}
}

// TestExampleUse checks if middleware (e.g. CORS) is applied correctly to the route.
// Expect status 200 and the body "Quick in action with middleware ❤️!".
//
// Use:
//
// go test -v -run ^TestExampleUse
func TestExampleUse(t *testing.T) {
	q := New()

	// Apply CORS middleware
	q.Use(cors.New())

	// Define a GET route that uses middleware
	q.Get("/use", func(c *Ctx) error {
		// Set response content type
		c.Set("Content-Type", "text/plain")
		// Return success message
		return c.Status(200).String("Quick in action com middleware ❤️!")
	})

	// Simulate a GET request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodGet,
		URI:    "/use",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Validate HTTP status code
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200, but got %d", data.StatusCode())
	}

	// Validate response body
	expectedBody := "Quick in action com middleware ❤️!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but got '%s'", expectedBody, data.BodyStr())
	}
}

// TestExampleGet tests a simple GET request.
// Status 200 and "Hello world" body are expected.
//
// Use:
//
//	go test -v -run TestExampleGet
func TestExampleGet(t *testing.T) {
	q := New()

	// Define a GET route
	q.Get("/hello", func(c *Ctx) error {
		// Set response content type
		c.Set("Content-Type", "text/plain")
		// Return success message
		return c.Status(200).String("Olá, mundo!")
	})

	// Simulate a GET request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodGet,
		URI:    "/hello",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Validate HTTP status code
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200, but got %d", data.StatusCode())
	}

	// Validate response body
	expectedBody := "Olá, mundo!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but got '%s'", expectedBody, data.BodyStr())
	}
}

// TestExamplePost tests a POST route that returns a success response.
// Expected status 201 and body "Resource created!".
//
// Use:
//
//	go test -v -run TestExamplePost
func TestExamplePost(t *testing.T) {
	q := New()

	// Define a POST route
	q.Post("/create", func(c *Ctx) error {
		// Set response content type
		c.Set("Content-Type", "text/plain")
		// Return success message
		return c.Status(201).String("Recurso criado!")
	})

	// Simulate a POST request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodPost,
		URI:    "/create",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Validate HTTP status code
	if data.StatusCode() != 201 {
		t.Errorf("Expected status 201, but got %d", data.StatusCode())
	}

	// Validate response body
	expectedBody := "Recurso criado!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but got '%s'", expectedBody, data.BodyStr())
	}
}

// TestExamplePut tests a PUT route that updates a resource.
// Expected status 200 and body "Resource updated!".
//
// Use:
//
//	go test -v -run TestExamplePut
func TestExamplePut(t *testing.T) {
	q := New()

	// Define a PUT route for updating a resource
	q.Put("/update", func(c *Ctx) error {
		c.Set("Content-Type", "text/plain")
		return c.Status(200).String("Recurso atualizado!")
	})

	// Simulate a PUT request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodPut,
		URI:    "/update",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Check if the status code is correct
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200, but received %d", data.StatusCode())
	}

	// Check if the response body is correct
	expectedBody := "Recurso atualizado!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but received '%s'", expectedBody, data.BodyStr())
	}
}

// TestExampleDelete tests a DELETE route that deletes a resource.
// Expected status 200 and body "Feature deleted!".
//
// Use:
//
//	go test -v -run TestExampleDelete
func TestExampleDelete(t *testing.T) {
	q := New()

	// Define a DELETE route for deleting a resource
	q.Delete("/delete", func(c *Ctx) error {
		c.Set("Content-Type", "text/plain")
		return c.Status(200).String("Recurso deletado!")
	})

	// Simulate a DELETE request
	data, err := q.Qtest(QuickTestOptions{
		Method: MethodDelete,
		URI:    "/delete",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Check if the status code is correct
	if data.StatusCode() != 200 {
		t.Errorf("Expected status 200, but received %d", data.StatusCode())
	}

	// Check if the response body is correct
	expectedBody := "Recurso deletado!"
	if data.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but received '%s'", expectedBody, data.BodyStr())
	}
}

// TestServeHTTP tests if dynamic parameters are extracted correctly in the route.
// Response is expected with the ID provided in the URL.
//
// Use:
//
//	go test -v -run TestServeHTTP
func TestServeHTTP(t *testing.T) {
	q := New()

	// Define a GET route with a dynamic parameter
	q.Get("/users/:id", func(c *Ctx) error {
		return c.Status(200).String("User Id: " + c.Params["id"])
	})

	// Simulate a GET request with a user ID
	res, err := q.Qtest(QuickTestOptions{
		Method: MethodGet,
		URI:    "/users/42",
	})
	if err != nil {
		t.Errorf("Error when running QuickTest: %v", err)
		return
	}

	// Check if the status code is correct
	expectedStatus := 200
	if res.StatusCode() != expectedStatus {
		t.Errorf("Expected status %d, but got %d", expectedStatus, res.StatusCode())
	}

	// Check if the response body is correct
	expectedBody := "User Id: 42"
	if res.BodyStr() != expectedBody {
		t.Errorf("Expected body '%s', but got '%s'", expectedBody, res.BodyStr())
	}
}

// TestGetRoute tests whether the recorded routes are correctly returned by GetRoute().
// Checks if the routes and methods are correct.
//
// Use:
//
//	go test -v -run TestGetRoute
func TestGetRoute(t *testing.T) {
	q := New()

	// Define multiple routes
	q.Get("/users/:id", func(c *Ctx) error {
		return c.Status(200).String("User ID: " + c.Params["id"])
	})
	q.Post("/users", func(c *Ctx) error {
		return c.Status(201).String("User created")
	})

	// Retrieve the registered routes
	routes := q.GetRoute()

	// Check if the expected number of routes exists
	expectedNumRoutes := 2
	if len(routes) != expectedNumRoutes {
		t.Errorf("Expected %d routes, but got %d", expectedNumRoutes, len(routes))
	}

	// Define expected routes
	expectedRoutes := map[string]string{
		"GET":  "/users/:id",
		"POST": "/users",
	}

	// Check if the routes match the expected values
	for _, route := range routes {
		pattern := route.Pattern
		if pattern == "" {
			pattern = route.Path
		}

		expectedPattern, exists := expectedRoutes[route.Method]
		if !exists {
			t.Errorf("Unexpected HTTP method: %s", route.Method)
		} else if pattern != expectedPattern {
			t.Errorf("Expected pattern for %s: %s, but got %s", route.Method, expectedPattern, route.Pattern)
		}
	}
}

// TestQuick_ExampleListen tests if the Quick server starts and responds correctly.
// Uses ListenWithShutdown on dynamic port and performs GET request.
//
// Use:
//
//	go test -v -run TestQuick_ExampleListen
func TestQuick_ExampleListen(t *testing.T) {

	// start Quick
	q := New()

	// Define a simple GET route
	q.Get("/", func(c *Ctx) error {
		return c.Status(200).String("Hello, Quick!")
	})

	// Start the server using ListenWithShutdown on a dynamic port
	server, shutdown, err := q.ListenWithShutdown(":0")
	if err != nil {
		t.Fatalf("Failed to start server: %v", err)
	}
	defer shutdown()

	// Wait for the server to start correctly
	time.Sleep(500 * time.Millisecond)

	// Make an HTTP request using the returned dynamic port
	resp, err := http.Get("http://" + server.Addr + "/")
	if err != nil {
		t.Fatalf("Failed to connect to server: %v", err)
	}
	defer resp.Body.Close()

	// Checks if the returned status is correct
	if resp.StatusCode != http.StatusOK {
		t.Errorf("Expected status 200, but got %d", resp.StatusCode)
	}
}