-
Notifications
You must be signed in to change notification settings - Fork 508
/
typelinter.go
111 lines (98 loc) · 2.57 KB
/
typelinter.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
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
101
102
103
104
105
106
107
108
109
110
111
package main
import (
"flag"
"fmt"
"go/types"
"os"
"regexp"
"golang.org/x/tools/go/packages"
)
type stringListVar map[string]struct{}
func (sl stringListVar) String() string {
var keys []string
for k := range sl {
keys = append(keys, k)
}
return fmt.Sprintf("%v", keys)
}
func (sl *stringListVar) Set(value string) error {
if *sl == nil {
*sl = map[string]struct{}{}
}
(*sl)[value] = struct{}{}
return nil
}
var (
excludedFields stringListVar
typesWhitelist string
typesWhitelistRegexp *regexp.Regexp
)
// validStruct checks whether the structure s uses only the whitelisted types.
// structName is the name of s in format `example.com/package.TypeName`.
func validStruct(structName string, s *types.Struct) bool {
valid := true
for i := 0; i < s.NumFields(); i++ {
field := s.Field(i)
fieldName := fmt.Sprintf("%s:%s", structName, field.Name())
if _, ok := excludedFields[fieldName]; ok {
continue
}
typ := field.Type().String()
if !typesWhitelistRegexp.MatchString(typ) {
fmt.Fprintf(os.Stderr, "%s: type %s is not allowed to be used\n", fieldName, typ)
valid = false
}
}
return valid
}
// validPackage checks whether pkg's exported structures use only the
// whitelisted types.
func validPackage(pkg *packages.Package) bool {
valid := true
scope := pkg.Types.Scope()
for _, name := range scope.Names() {
obj := scope.Lookup(name)
if !obj.Exported() {
continue
}
if typeName, ok := obj.(*types.TypeName); ok {
typ := typeName.Type().Underlying()
if s, ok := typ.(*types.Struct); ok {
structName := fmt.Sprintf("%s.%s", pkg.PkgPath, typeName.Name())
if !validStruct(structName, s) {
valid = false
}
}
}
}
return valid
}
func main() {
flag.Var(&excludedFields, "excluded", "exclude the field from being checked (e.g. -excluded=github.com/openshift/api/image/dockerpre012.ImagePre012:Created), can be used multiple times")
flag.StringVar(&typesWhitelist, "whitelist", "", "regular expression that specifies allowed types")
flag.Parse()
var err error
typesWhitelistRegexp, err = regexp.Compile(typesWhitelist)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to compile whitelist regexp: %v\n", err)
os.Exit(1)
}
cfg := &packages.Config{Mode: packages.NeedName | packages.NeedImports | packages.NeedTypes}
pkgs, err := packages.Load(cfg, flag.Args()...)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to load packages: %v\n", err)
os.Exit(1)
}
if packages.PrintErrors(pkgs) > 0 {
os.Exit(1)
}
ok := true
for _, pkg := range pkgs {
if !validPackage(pkg) {
ok = false
}
}
if !ok {
os.Exit(1)
}
}