summaryrefslogtreecommitdiffstats
path: root/tests/integration/swagger_test.go
blob: 584601f7f9cd86cedfe514fef3364fb8a4b0925c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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")
}