Function VerifySwaggerDefinitions

coderd/coderdtest/swaggerparser.go:171–228

(t *testing.T, router chi.Router, swaggerComments []SwaggerComment, opts ...SwaggerOption)

}

func VerifySwaggerDefinitions(t *testing.T, router chi.Router, swaggerComments []SwaggerComment, opts ...SwaggerOption) {
	cfg := swaggerOptions{}
	for _, opt := range opts {
		opt(&cfg)
	}

	assertUniqueRoutes(t, swaggerComments)
	assertSingleAnnotations(t, swaggerComments)

	err := chi.Walk(router, func(method, route string, _ http.Handler, _ ...func(http.Handler) http.Handler) error {
		method = strings.ToLower(method)
		if route != "/" && strings.HasSuffix(route, "/") {
			route = route[:len(route)-1]
		}

		// chi.Walk yields routes relative to the router that
		// VerifySwaggerDefinitions was called with. Prepend the configured
		// mount prefix so routes match the absolute paths used in @Router
		// annotations.
		if cfg.routePrefix != "" {
			if route == "/" {
				route = cfg.routePrefix + "/"
			} else {
				route = cfg.routePrefix + route
			}
		}

		t.Run(method+" "+route, func(t *testing.T) {
			t.Parallel()

			// Wildcard routes break the swaggo parser, so we do not document
			// them.
			if strings.HasSuffix(route, "/*") {
				return
			}
			if isExperimentalEndpoint(route) {
				return
			}

			c := findSwaggerCommentByMethodAndRoute(swaggerComments, method, route)
			assert.NotNil(t, c, "Missing @Router annotation")
			if c == nil {
				return // do not fail next assertion for this route
			}

			assertConsistencyBetweenRouteIDAndSummary(t, *c)
			assertSuccessOrFailureDefined(t, *c)
			assertRequiredAnnotations(t, *c)
			assertGoCommentFirst(t, *c)
			assertPathParametersDefined(t, *c)
			assertSecurityDefined(t, *c)
			assertAccept(t, *c)
			assertProduce(t, *c)
		})
		return nil
	})
	require.NoError(t, err, "chi.Walk should not fail")
}