forked from prometheus/promu
/
check.go
169 lines (136 loc) · 4.02 KB
/
check.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
// Copyright © 2017 Prometheus Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"bufio"
"fmt"
"os"
"path/filepath"
"strings"
"github.com/pkg/errors"
"github.com/prometheus/promu/pkg/changelog"
)
var (
// validHeaderStrings is a slice of strings that must exist in a header.
validHeaderStrings = []string{"copyright", "generated"}
checkcmd = app.Command("check", "Check the resources for validity")
checkLicensescmd = checkcmd.Command("licenses", "Inspect source files for each file in a given directory")
sourceExtensions = checkLicensescmd.Flag("extensions", "Comma separated list of valid source code extensions (default is .go)").
Default(".go").Strings()
headerLength = checkLicensescmd.Flag("length", "The number of lines to read from the head of the file").
Short('n').Default("10").Int()
checkLicLocation = checkLicensescmd.Arg("location", "Directory path to check licenses").
Default(".").Strings()
checkChangelogcmd = checkcmd.Command("changelog", "Check that CHANGELOG.md follows the guidelines")
checkChangelogPath = checkChangelogcmd.Flag("location", "Path to CHANGELOG.md").
Default("CHANGELOG.md").String()
checkChangelogVersion = checkChangelogcmd.Flag("version", "Version to check (defaults to the current version)").
Default("").String()
)
func runCheckLicenses(path string, n int, extensions []string) {
path = fmt.Sprintf("%s%c", filepath.Clean(path), filepath.Separator)
filesMissingHeaders, err := checkLicenses(path, n, extensions)
if err != nil {
fatal(errors.Wrap(err, "Failed to check files for license header"))
}
for _, file := range filesMissingHeaders {
fmt.Println(file)
}
}
func checkLicenses(path string, n int, extensions []string) ([]string, error) {
var missingHeaders []string
walkFunc := func(filepath string, f os.FileInfo, err error) error {
if err != nil {
return err
}
if f.IsDir() {
return nil
}
if strings.HasPrefix(filepath, "vendor/") {
return nil
}
if !suffixInSlice(f.Name(), extensions) {
return nil
}
file, err := os.Open(filepath)
if err != nil {
return err
}
defer file.Close()
pass := false
scanner := bufio.NewScanner(file)
for i := 0; i < n; i++ {
scanner.Scan()
if err = scanner.Err(); err != nil {
return err
}
if stringContainedInSlice(strings.ToLower(scanner.Text()), validHeaderStrings) {
pass = true
}
}
if !pass {
missingHeaders = append(missingHeaders, filepath)
}
return nil
}
err := filepath.Walk(path, walkFunc)
if err != nil {
return nil, err
}
return missingHeaders, nil
}
func stringContainedInSlice(needle string, haystack []string) bool {
exists := false
for _, h := range haystack {
if strings.Contains(needle, h) {
exists = true
break
}
}
return exists
}
func suffixInSlice(needle string, haystack []string) bool {
exists := false
for _, h := range haystack {
if strings.HasSuffix(needle, h) {
exists = true
break
}
}
return exists
}
func runCheckChangelog(path string, version string) error {
if version == "" {
_, err := projInfo.ToSemver()
if err != nil {
return errors.Wrap(err, "invalid semver version")
}
version = projInfo.Version
}
f, err := os.Open(path)
if err != nil {
return err
}
defer f.Close()
entry, err := changelog.ReadEntry(f, version)
if err != nil {
return errors.Wrapf(err, "%s:", path)
}
// Check that the changes are ordered correctly.
err = entry.Changes.Sorted()
if err != nil {
return errors.Wrap(err, "invalid changelog entry")
}
return nil
}