move the openapi.json check into a test

Author: hugodutka

.github/workflows/check-openapi.yml

@@ -0,0 +1,71 @@
+package httpapi_test
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"log/slog"
+	"os"
+	"sort"
+	"testing"
+
+	"github.com/coder/agentapi/lib/httpapi"
+	"github.com/coder/agentapi/lib/logctx"
+	"github.com/coder/agentapi/lib/msgfmt"
+	"github.com/stretchr/testify/require"
+)
+
+func normalizeSchema(t *testing.T, schema any) any {
+	t.Helper()
+	switch val := (schema).(type) {
+	case []any:
+		for i := range val {
+			normalizeSchema(t, &val[i])
+		}
+		sort.SliceStable(val, func(i, j int) bool {
+			return fmt.Sprintf("%v", val[i]) < fmt.Sprintf("%v", val[j])
+		})
+	case map[string]any:
+		for k := range val {
+			valUnderKey := val[k]
+			normalizeSchema(t, &valUnderKey)
+			val[k] = valUnderKey
+		}
+	}
+	return schema
+}
+
+// Ensure the OpenAPI schema on disk is up to date.
+// To update the schema, run `go run main.go server --print-openapi dummy > openapi.json`.
+func TestOpenAPISchema(t *testing.T) {
+	t.Parallel()
+
+	ctx := logctx.WithLogger(context.Background(), slog.New(slog.NewTextHandler(os.Stdout, nil)))
+	srv := httpapi.NewServer(ctx, msgfmt.AgentTypeClaude, nil, 0)
+	currentSchemaStr := srv.GetOpenAPI()
+	var currentSchema any
+	if err := json.Unmarshal([]byte(currentSchemaStr), &currentSchema); err != nil {
+		t.Fatalf("failed to unmarshal current schema: %s", err)
+	}
+
+	diskSchemaFile, err := os.OpenFile("../../openapi.json", os.O_RDONLY, 0)
+	if err != nil {
+		t.Fatalf("failed to open disk schema: %s", err)
+	}
+	defer diskSchemaFile.Close()
+
+	diskSchemaBytes, err := io.ReadAll(diskSchemaFile)
+	if err != nil {
+		t.Fatalf("failed to read disk schema: %s", err)
+	}
+	var diskSchema any
+	if err := json.Unmarshal(diskSchemaBytes, &diskSchema); err != nil {
+		t.Fatalf("failed to unmarshal disk schema: %s", err)
+	}
+
+	normalizeSchema(t, &currentSchema)
+	normalizeSchema(t, &diskSchema)
+
+	require.Equal(t, currentSchema, diskSchema)
+}