summaryrefslogtreecommitdiffstats
path: root/tests/integration/swagger_test.go
diff options
context:
space:
mode:
Diffstat (limited to 'tests/integration/swagger_test.go')
-rw-r--r--tests/integration/swagger_test.go100
1 files changed, 100 insertions, 0 deletions
diff --git a/tests/integration/swagger_test.go b/tests/integration/swagger_test.go
new file mode 100644
index 0000000..584601f
--- /dev/null
+++ b/tests/integration/swagger_test.go
@@ -0,0 +1,100 @@
+// Copyright 2024 The Forgejo Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package integration
+
+import (
+ "net/http"
+ "strings"
+ "testing"
+
+ "code.gitea.io/gitea/modules/json"
+ "code.gitea.io/gitea/tests"
+
+ swagger_spec "github.com/go-openapi/spec"
+ "github.com/stretchr/testify/require"
+)
+
+func getSwagger(t *testing.T) *swagger_spec.Swagger {
+ t.Helper()
+
+ resp := MakeRequest(t, NewRequest(t, "GET", "/swagger.v1.json"), http.StatusOK)
+
+ swagger := new(swagger_spec.Swagger)
+
+ decoder := json.NewDecoder(resp.Body)
+ require.NoError(t, decoder.Decode(swagger))
+
+ return swagger
+}
+
+func checkSwaggerMethodResponse(t *testing.T, path string, method *swagger_spec.Operation, name string, statusCode int, responseType string) {
+ t.Helper()
+
+ if method == nil {
+ return
+ }
+
+ val, ok := method.Responses.StatusCodeResponses[statusCode]
+ if !ok {
+ t.Errorf("%s %s is missing response status code %d in swagger", name, path, statusCode)
+ return
+ }
+
+ if responseType != val.Ref.String() {
+ t.Errorf("%s %s has %s response type for %d in swagger (expected %s)", name, path, val.Ref.String(), statusCode, responseType)
+ }
+}
+
+func checkSwaggerPathResponse(t *testing.T, paths map[string]swagger_spec.PathItem, pathMatch string, statusCode int, responseType string) {
+ t.Helper()
+
+ for pathName, pathData := range paths {
+ if pathName != pathMatch {
+ continue
+ }
+
+ checkSwaggerMethodResponse(t, pathName, pathData.Get, "GET", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Put, "PUT", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Post, "POST", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Patch, "PATCH", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Delete, "DELETE", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Options, "OPTIONS", statusCode, responseType)
+
+ return
+ }
+}
+
+func checkSwaggerRouteResponse(t *testing.T, paths map[string]swagger_spec.PathItem, prefix string, statusCode int, responseType string) {
+ t.Helper()
+
+ for pathName, pathData := range paths {
+ if !strings.HasPrefix(pathName, prefix) {
+ continue
+ }
+
+ checkSwaggerMethodResponse(t, pathName, pathData.Get, "GET", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Put, "PUT", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Post, "POST", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Patch, "PATCH", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Delete, "DELETE", statusCode, responseType)
+ checkSwaggerMethodResponse(t, pathName, pathData.Options, "OPTIONS", statusCode, responseType)
+ }
+}
+
+func TestSwaggerUserRoute(t *testing.T) {
+ defer tests.PrepareTestEnv(t)()
+
+ swagger := getSwagger(t)
+
+ checkSwaggerPathResponse(t, swagger.Paths.Paths, "/user", http.StatusUnauthorized, "#/responses/unauthorized")
+ checkSwaggerRouteResponse(t, swagger.Paths.Paths, "/user/", http.StatusUnauthorized, "#/responses/unauthorized")
+}
+
+func TestSwaggerUsersRoute(t *testing.T) {
+ defer tests.PrepareTestEnv(t)()
+
+ swagger := getSwagger(t)
+
+ checkSwaggerRouteResponse(t, swagger.Paths.Paths, "/users/{username}", http.StatusNotFound, "#/responses/notFound")
+}