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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
package codeowners
import (
"bufio"
"fmt"
"io"
"os"
"path"
"path/filepath"
"regexp"
"strings"
"github.com/spf13/afero"
)
// Codeowners - patterns/owners mappings for the given repo
type Codeowners struct {
repoRoot string
Patterns []Codeowner
}
// Codeowner - owners for a given pattern
type Codeowner struct {
Pattern string
re *regexp.Regexp
Owners []string
}
func (c Codeowner) String() string {
return fmt.Sprintf("%s\t%v", c.Pattern, strings.Join(c.Owners, ", "))
}
var fs = afero.NewOsFs()
// findCodeownersFile - find a CODEOWNERS file somewhere within or below
// the working directory (wd), and open it.
func findCodeownersFile(wd string) (io.Reader, string, error) {
dir := wd
for {
for _, p := range []string{".", "docs", ".github", ".gitlab"} {
pth := path.Join(dir, p)
exists, err := afero.DirExists(fs, pth)
if err != nil {
return nil, "", err
}
if exists {
f := path.Join(pth, "CODEOWNERS")
_, err := fs.Stat(f)
if err != nil {
if os.IsNotExist(err) {
continue
}
return nil, "", err
}
r, err := fs.Open(f)
return r, dir, err
}
}
odir := dir
dir = path.Dir(odir)
// if we can't go up any further...
if odir == dir {
break
}
// if we're heading above the volume name (relevant on Windows)...
if len(dir) < len(filepath.VolumeName(odir)) {
break
}
}
return nil, "", nil
}
// Deprecated: Use FromFile(path) instead.
func NewCodeowners(path string) (*Codeowners, error) {
return FromFile(path)
}
// FromFile creates a Codeowners from the path to a local file.
func FromFile(path string) (*Codeowners, error) {
r, root, err := findCodeownersFile(path)
if err != nil {
return nil, err
}
if r == nil {
return nil, fmt.Errorf("No CODEOWNERS found in %s", path)
}
return FromReader(r, root)
}
// FromReader creates a Codeowners from a given Reader instance and root path.
func FromReader(r io.Reader, repoRoot string) (*Codeowners, error) {
co := &Codeowners{
repoRoot: repoRoot,
}
co.Patterns = parseCodeowners(r)
return co, nil
}
// parseCodeowners parses a list of Codeowners from a Reader
func parseCodeowners(r io.Reader) []Codeowner {
co := []Codeowner{}
s := bufio.NewScanner(r)
for s.Scan() {
fields := strings.Fields(s.Text())
if len(fields) > 0 && strings.HasPrefix(fields[0], "#") {
continue
}
if len(fields) > 1 {
fields = combineEscapedSpaces(fields)
c, _ := NewCodeowner(fields[0], fields[1:])
co = append(co, c)
}
}
return co
}
// if any of the elements ends with a \, it was an escaped space
// put it back together properly so it's not treated as separate fields
func combineEscapedSpaces(fields []string) []string {
outFields := make([]string, 0)
escape := `\`
for i := 0; i < len(fields); i++ {
outField := fields[i]
for strings.HasSuffix(fields[i], escape) && i+1 < len(fields) {
outField = strings.Join([]string{strings.TrimRight(outField, escape), fields[i+1]}, " ")
i++
}
outFields = append(outFields, outField)
}
return outFields
}
// NewCodeowner -
func NewCodeowner(pattern string, owners []string) (Codeowner, error) {
re := getPattern(pattern)
c := Codeowner{
Pattern: pattern,
re: re,
Owners: owners,
}
return c, nil
}
// Owners - return the list of code owners for the given path
// (within the repo root)
func (c *Codeowners) Owners(path string) []string {
if strings.HasPrefix(path, c.repoRoot) {
path = strings.Replace(path, c.repoRoot, "", 1)
}
// Order is important; the last matching pattern takes the most precedence.
for i := len(c.Patterns) - 1; i >= 0; i-- {
p := c.Patterns[i]
if p.re.MatchString(path) {
return p.Owners
}
}
return nil
}
// based on github.com/sabhiram/go-gitignore
// but modified so that 'dir/*' only matches files in 'dir/'
func getPattern(line string) *regexp.Regexp {
// when # or ! is escaped with a \
if regexp.MustCompile(`^(\\#|\\!)`).MatchString(line) {
line = line[1:]
}
// If we encounter a foo/*.blah in a folder, prepend the / char
if regexp.MustCompile(`([^\/+])/.*\*\.`).MatchString(line) && line[0] != '/' {
line = "/" + line
}
// Handle escaping the "." char
line = regexp.MustCompile(`\.`).ReplaceAllString(line, `\.`)
magicStar := "#$~"
// Handle "/**/" usage
if strings.HasPrefix(line, "/**/") {
line = line[1:]
}
line = regexp.MustCompile(`/\*\*/`).ReplaceAllString(line, `(/|/.+/)`)
line = regexp.MustCompile(`\*\*/`).ReplaceAllString(line, `(|.`+magicStar+`/)`)
line = regexp.MustCompile(`/\*\*`).ReplaceAllString(line, `(|/.`+magicStar+`)`)
// Handle escaping the "*" char
line = regexp.MustCompile(`\\\*`).ReplaceAllString(line, `\`+magicStar)
line = regexp.MustCompile(`\*`).ReplaceAllString(line, `([^/]*)`)
// Handle escaping the "?" char
line = strings.Replace(line, "?", `\?`, -1)
line = strings.Replace(line, magicStar, "*", -1)
// Temporary regex
var expr = ""
if strings.HasSuffix(line, "/") {
expr = line + "(|.*)$"
} else {
expr = line + "$"
}
if strings.HasPrefix(expr, "/") {
expr = "^(|/)" + expr[1:]
} else {
expr = "^(|.*/)" + expr
}
pattern, _ := regexp.Compile(expr)
return pattern
}
|