mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
MM-17888 Check plugin Helpers minimum server version comments (#12663)
This commit is contained in:
committed by
Ben Schumacher
parent
7cc1f19453
commit
7d0d7c304e
50
plugin/checker/check_api.go
Normal file
50
plugin/checker/check_api.go
Normal file
@@ -0,0 +1,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/plugin/checker/internal/asthelpers"
|
||||
"github.com/mattermost/mattermost-server/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
|
||||
}
|
||||
Reference in New Issue
Block a user