|
1 | 1 | package coderdtest
|
2 | 2 |
|
3 | 3 | import (
|
| 4 | + "go/ast" |
| 5 | + "go/parser" |
| 6 | + "go/token" |
4 | 7 | "net/http"
|
| 8 | + "strings" |
5 | 9 | "testing"
|
6 | 10 |
|
7 | 11 | "github.com/go-chi/chi/v5"
|
8 | 12 | "github.com/stretchr/testify/require"
|
| 13 | + "golang.org/x/xerrors" |
9 | 14 | )
|
10 | 15 |
|
| 16 | +type swaggerComment struct { |
| 17 | + method string |
| 18 | + router string |
| 19 | +} |
| 20 | + |
11 | 21 | func TestAllEndpointsDocumented(t *testing.T) {
|
12 |
| - _, _, api := NewWithAPI(t, nil) |
| 22 | + t.Parallel() |
| 23 | + |
| 24 | + swaggerCommentss, err := parseSwaggerComments("..") // TODO enterprise |
| 25 | + require.NoError(t, err, "can't parse swagger comments") |
13 | 26 |
|
14 |
| - err := chi.Walk(api.APIHandler, func(method, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error { |
| 27 | + for _, c := range swaggerCommentss { |
| 28 | + t.Log(c.method, c.router) |
| 29 | + } |
| 30 | + |
| 31 | + _, _, api := NewWithAPI(t, nil) |
| 32 | + err = chi.Walk(api.APIHandler, func(method, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error { |
15 | 33 | return nil
|
16 | 34 | })
|
17 |
| - require.NoError(t, err) |
| 35 | + require.Error(t, err) |
| 36 | +} |
| 37 | + |
| 38 | +func parseSwaggerComments(dir string) ([]swaggerComment, error) { |
| 39 | + fileSet := token.NewFileSet() |
| 40 | + commentNodes, err := parser.ParseDir(fileSet, dir, nil, parser.ParseComments) |
| 41 | + if err != nil { |
| 42 | + return nil, xerrors.Errorf(`can't parse directory "%s": %w`, dir) |
| 43 | + } |
| 44 | + |
| 45 | + var swaggerComments []swaggerComment |
| 46 | + for _, commentNode := range commentNodes { |
| 47 | + ast.Inspect(commentNode, func(n ast.Node) bool { |
| 48 | + commentGroup, ok := n.(*ast.CommentGroup) |
| 49 | + if !ok { |
| 50 | + return true |
| 51 | + } |
| 52 | + |
| 53 | + var isSwaggerComment bool |
| 54 | + for _, line := range commentGroup.List { |
| 55 | + text := strings.TrimSpace(line.Text) |
| 56 | + if strings.HasPrefix(text, "//") && strings.Contains(text, "@Router") { |
| 57 | + isSwaggerComment = true |
| 58 | + break |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + if isSwaggerComment { |
| 63 | + swaggerComments = append(swaggerComments, parseSwaggerComment(commentGroup)) |
| 64 | + } |
| 65 | + return true |
| 66 | + }) |
| 67 | + } |
| 68 | + return swaggerComments, nil |
| 69 | +} |
| 70 | + |
| 71 | +func parseSwaggerComment(commentGroup *ast.CommentGroup) swaggerComment { |
| 72 | + var c swaggerComment |
| 73 | + for _, line := range commentGroup.List { |
| 74 | + text := strings.TrimSpace(line.Text) |
| 75 | + if strings.Contains(text, "@Router ") { |
| 76 | + c.router = strings.SplitN(text, " ", 3)[2] |
| 77 | + } |
| 78 | + } |
| 79 | + return c |
18 | 80 | }
|
0 commit comments