HTTP Tests

HTTP tests verify request handling at the controller, route group, or generated server boundary.

Use the smallest boundary that proves the behavior.

Controller Tests

Test a controller handler directly when route registration is not the focus:

package users

import (
	"net/http"
	"net/http/httptest"
	"strings"
	"testing"

	"github.com/goforj/web/webtest"
)

func TestControllerShow(t *testing.T) {
	controller := NewController(NewService())

	req := httptest.NewRequest(http.MethodGet, "/users/42", nil)
	rec := httptest.NewRecorder()
	ctx := webtest.NewContext(req, rec, "/users/:id", webtest.PathParams{"id": "42"})

	if err := controller.Show(ctx); err != nil {
		t.Fatalf("show user: %v", err)
	}
	if ctx.StatusCode() != http.StatusOK {
		t.Fatalf("status = %d", ctx.StatusCode())
	}
	if !strings.Contains(rec.Body.String(), `"id":"42"`) {
		t.Fatalf("body = %s", rec.Body.String())
	}
}

This matches the controller from JSON API Route. Use Web for package-level testing helpers.

The snippet is a focused test fragment. For the runnable GoForj App HTTP path, complete the scenario and run:

forj build
go test ./...
forj api

Then request the route from another terminal:

curl http://localhost:3000/api/v1/users/42

Expected response:

{"id":"42","name":"Ada Lovelace","email":"ada@example.test"}

Route Tests

Use route or server-level tests when you need to verify:

• route grouping
• middleware
• path parameters
• framework routes
• route visibility
• readiness behavior
• metrics or inspect integration

Generated Health Tests

GoForj Apps include generated HTTP tests for framework routes when HTTP is enabled.

Common routes:

• GET /-/health
• GET /-/ready
• GET /swagger
• GET /swagger/doc.json
• GET /metrics when metrics are enabled

Readiness

Test readiness failures deliberately. Public readiness should be safe. Authorized readiness can expose structured details when called with APP_DIAG_TOKEN.

Next Steps

• Controllers explains controller boundaries.
• Middleware explains route policy.
• Integration Tests covers full boundary tests.