forked from hmarr/codeowners
-
Notifications
You must be signed in to change notification settings - Fork 0
/
parse.go
195 lines (167 loc) · 4.83 KB
/
parse.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
190
191
192
193
194
195
package codeowners
import (
"bufio"
"bytes"
"fmt"
"io"
"regexp"
"strings"
)
var (
emailRegexp = regexp.MustCompile(`\A[A-Z0-9a-z\._%\+\-]+@[A-Za-z0-9\.\-]+\.[A-Za-z]{2,6}\z`)
teamRegexp = regexp.MustCompile(`\A@([a-zA-Z0-9\-]+\/[a-zA-Z0-9_\-]+)\z`)
usernameRegexp = regexp.MustCompile(`\A@([a-zA-Z0-9\-]+)\z`)
usernameRegexpGitlab = regexp.MustCompile(`\A@([a-zA-Z0-9\-]+\.[a-zA-Z0-9\-])\z`)
)
const (
statePattern = iota + 1
stateOwners
)
// ParseFile parses a CODEOWNERS file, returning a set of rules.
func ParseFile(f io.Reader) (Ruleset, error) {
rules := Ruleset{}
scanner := bufio.NewScanner(f)
lineNo := 0
for scanner.Scan() {
lineNo++
line := scanner.Text()
// Ignore blank lines and comments
if len(line) == 0 || line[0] == '#' {
continue
}
rule, err := parseRule(line)
if err != nil {
return nil, fmt.Errorf("line %d: %w", lineNo, err)
}
rule.LineNumber = lineNo
rules = append(rules, rule)
}
return rules, nil
}
// parseRule parses a single line of a CODEOWNERS file, returning a Rule struct
func parseRule(ruleStr string) (Rule, error) {
r := Rule{}
state := statePattern
escaped := false
buf := bytes.Buffer{}
for i, ch := range strings.TrimSpace(ruleStr) {
// Comments consume the rest of the line and stop further parsing
if ch == '#' {
r.Comment = strings.TrimSpace(ruleStr[i+1:])
break
}
switch state {
case statePattern:
switch {
case ch == '\\':
// Escape the next character (important for whitespace while parsing), but
// don't lose the backslash as it's part of the pattern
escaped = true
buf.WriteRune(ch)
continue
case isWhitespace(ch) && !escaped:
// Unescaped whitespace means this is the end of the pattern
pattern, err := newPattern(buf.String())
if err != nil {
return r, err
}
r.pattern = pattern
buf.Reset()
state = stateOwners
case isPatternChar(ch) || (isWhitespace(ch) && escaped):
// Keep any valid pattern characters and escaped whitespace
buf.WriteRune(ch)
default:
return r, fmt.Errorf("unexpected character '%c' at position %d", ch, i+1)
}
// Escaping only applies to one character
escaped = false
case stateOwners:
switch {
case isWhitespace(ch):
// Whitespace means we've reached the end of the owner or we're just chomping
// through whitespace before or after owner declarations
if buf.Len() > 0 {
ownerStr := buf.String()
owner, err := newOwner(ownerStr)
if err != nil {
return r, fmt.Errorf("%s at position %d", err.Error(), i+1-len(ownerStr))
}
r.Owners = append(r.Owners, owner)
buf.Reset()
}
case isOwnersChar(ch):
// Write valid owner characters to the buffer
buf.WriteRune(ch)
default:
return r, fmt.Errorf("unexpected character '%c' at position %d", ch, i+1)
}
}
}
// We've finished consuming the line, but we might still have content in the buffer
// if the line didn't end with a separator (whitespace)
switch state {
case statePattern:
if buf.Len() == 0 { // We should have non-empty pattern
return r, fmt.Errorf("unexpected end of rule")
}
pattern, err := newPattern(buf.String())
if err != nil {
return r, err
}
r.pattern = pattern
case stateOwners:
// If there's an owner left in the buffer, don't leave it behind
if buf.Len() > 0 {
ownerStr := buf.String()
owner, err := newOwner(ownerStr)
if err != nil {
return r, fmt.Errorf("%s at position %d", err.Error(), len(ruleStr)+1-len(ownerStr))
}
r.Owners = append(r.Owners, owner)
}
}
return r, nil
}
// newOwner figures out which kind of owner this is and returns an Owner struct
func newOwner(s string) (Owner, error) {
match := emailRegexp.FindStringSubmatch(s)
if match != nil {
return Owner{Value: match[0], Type: EmailOwner}, nil
}
match = teamRegexp.FindStringSubmatch(s)
if match != nil {
return Owner{Value: match[1], Type: TeamOwner}, nil
}
match = usernameRegexp.FindStringSubmatch(s)
if match != nil {
return Owner{Value: match[1], Type: UsernameOwner}, nil
}
match = usernameRegexpGitlab.FindStringSubmatch(s)
if match != nil {
return Owner{Value: match[1], Type: UsernameOwner}, nil
}
return Owner{}, fmt.Errorf("invalid owner format '%s'", s)
}
func isWhitespace(ch rune) bool {
return ch == ' ' || ch == '\t' || ch == '\n'
}
func isAlphanumeric(ch rune) bool {
return (ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') || (ch >= '0' && ch <= '9')
}
// isPatternChar matches characters that are allowed in patterns
func isPatternChar(ch rune) bool {
switch ch {
case '*', '?', '.', '/', '@', '_', '+', '-', '\\':
return true
}
return isAlphanumeric(ch)
}
// isOwnersChar matches characters that are allowed in owner definitions
func isOwnersChar(ch rune) bool {
switch ch {
case '.', '@', '/', '_', '%', '+', '-':
return true
}
return isAlphanumeric(ch)
}