forked from perkeep/perkeep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
envvardoc.go
189 lines (166 loc) · 3.77 KB
/
envvardoc.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Program envvardoc will verify all referenced environment variables in go
// source are properly documented.
package main
import (
"bufio"
"flag"
"fmt"
"io"
"log"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
"text/tabwriter"
)
var (
srcDirs = flag.String("srcDirs", "cmd,dev,pkg,server",
"comma separated source directories")
doc = flag.String("doc", "doc/environment-vars.txt",
"file containing environment variable documentation")
all = flag.Bool("all", false, "show all environment vars found")
prefixes = flag.String("prefixes", "CAM,DEV,AWS",
"comma-separated list of env var prefixes we care about. Empty implies all")
docVar = regexp.MustCompile(`^(\w+) \(.+?\):$`)
literalEnvVar = regexp.MustCompile(`os.Getenv\("(\w+)"\)`)
variableEnvVar = regexp.MustCompile(`os.Getenv\((\w+)\)`)
)
type pos struct {
line int
path string
}
func (p pos) String() string {
return fmt.Sprintf("%s:%d", p.path, p.line)
}
type varMap map[string][]pos
func sortedKeys(m varMap) []string {
keys := make([]string, 0, len(m))
for k, _ := range m {
keys = append(keys, k)
}
sort.Strings(keys)
return keys
}
type envCollector struct {
literals varMap
variables varMap
documented map[string]struct{}
}
func newEncCollector() *envCollector {
return &envCollector{
literals: varMap{},
variables: varMap{},
documented: map[string]struct{}{},
}
}
func (ec *envCollector) findEnvVars(path string, r io.Reader) error {
scanner := bufio.NewScanner(r)
line := 1
for scanner.Scan() {
l := scanner.Text()
m := literalEnvVar.FindStringSubmatch(l)
if len(m) == 2 {
p := pos{line: line, path: path}
ec.literals[m[1]] = append(ec.literals[m[1]], p)
}
m = variableEnvVar.FindStringSubmatch(l)
if len(m) == 2 {
p := pos{line: line, path: path}
ec.variables[m[1]] = append(ec.variables[m[1]], p)
}
line++
}
return scanner.Err()
}
func (ec *envCollector) findDocVars(r io.Reader) error {
scanner := bufio.NewScanner(r)
for scanner.Scan() {
l := scanner.Text()
m := docVar.FindStringSubmatch(l)
if len(m) == 2 {
ec.documented[m[1]] = struct{}{}
}
}
return scanner.Err()
}
func (ec *envCollector) walk(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() || !strings.HasSuffix(path, ".go") {
return nil
}
r, err := os.Open(path)
if err != nil {
return err
}
defer r.Close()
return ec.findEnvVars(path, r)
}
func printMap(header string, m varMap) {
w := new(tabwriter.Writer)
w.Init(os.Stdout, 0, 8, 1, ' ', 0)
fmt.Fprintln(w, header)
for _, k := range sortedKeys(m) {
for _, pos := range m[k] {
fmt.Fprintf(w, "%s\t%s\n", k, pos)
}
}
w.Flush()
}
func (ec *envCollector) printAll() {
fmt.Println("All environment variables")
printMap("Literal\tLocation", ec.literals)
fmt.Println()
printMap("Variable\tLocation", ec.variables)
}
func (ec *envCollector) printUndocumented(prefixes []string) bool {
missing := varMap{}
for k, v := range ec.literals {
if _, ok := ec.documented[k]; !ok {
keep := false
for _, p := range prefixes {
if strings.HasPrefix(k, p) {
keep = true
break
}
}
if keep || len(prefixes) == 0 {
missing[k] = v
}
}
}
if len(missing) != 0 {
printMap("Undocumented\tLocation", missing)
} else {
fmt.Println("All environment variables are documented")
}
return len(missing) != 0
}
func main() {
flag.Parse()
ec := newEncCollector()
r, err := os.Open(*doc)
if err != nil {
log.Fatal(err)
}
defer r.Close()
err = ec.findDocVars(r)
if err != nil {
log.Fatal(err)
}
for _, dn := range strings.Split(*srcDirs, ",") {
err := filepath.Walk(dn, ec.walk)
if err != nil {
log.Fatal(err)
}
}
if *all {
ec.printAll()
} else {
if ec.printUndocumented(strings.Split(*prefixes, ",")) {
os.Exit(1)
}
}
}