-
Notifications
You must be signed in to change notification settings - Fork 7.2k
/
check_api.go
50 lines (41 loc) · 1.31 KB
/
check_api.go
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
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package main
import (
"fmt"
"go/ast"
"go/token"
"github.com/mattermost/mattermost-server/v5/plugin/checker/internal/asthelpers"
"github.com/mattermost/mattermost-server/v5/plugin/checker/internal/version"
)
func checkAPIVersionComments(pkgPath string) (result, error) {
pkg, err := asthelpers.GetPackage(pkgPath)
if err != nil {
return result{}, err
}
apiInterface, err := asthelpers.FindInterface("API", pkg.Syntax)
if err != nil {
return result{}, err
}
invalidMethods := findInvalidMethods(apiInterface.Methods.List)
return result{Errors: renderErrors(pkg.Fset, invalidMethods)}, nil
}
func findInvalidMethods(methods []*ast.Field) []*ast.Field {
var invalid []*ast.Field
for _, m := range methods {
if !hasValidMinimumVersionComment(m.Doc.Text()) {
invalid = append(invalid, m)
}
}
return invalid
}
func hasValidMinimumVersionComment(s string) bool {
return version.ExtractMinimumVersionFromComment(s) != ""
}
func renderErrors(fset *token.FileSet, methods []*ast.Field) []string {
var out []string
for _, m := range methods {
out = append(out, renderWithFilePosition(fset, m.Pos(), fmt.Sprintf("missing a minimum server version comment on method %s", m.Names[0].Name)))
}
return out
}