-
Notifications
You must be signed in to change notification settings - Fork 131
/
licensegen.go
168 lines (139 loc) · 4.1 KB
/
licensegen.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package main
import (
"bufio"
"flag"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"strings"
)
type (
// task that adds license header to source
// files, if they don't already exist
addLicenseHeaderTask struct {
license string // license header string to add
config *config // root directory of the project source
}
// command line config params
config struct {
rootDir string
verifyOnly bool
}
)
// licenseFileName is the name of the license file
const licenseFileName = "LICENSE"
// unique indicator that identifies a license header
const licenseHeaderIndicator = "Copyright (c)"
var (
// directories to be excluded
dirExcludeList = []string{"vendor/"}
// default perms for the newly created files
defaultFilePerms = os.FileMode(0644)
)
// command line utility that adds license header
// to the source files. Usage as follows:
//
// ./cmd/tools/copyright/licensegen.go
func main() {
var cfg config
flag.StringVar(&cfg.rootDir, "rootDir", ".", "project root directory")
flag.BoolVar(&cfg.verifyOnly, "verifyOnly", false,
"don't automatically add headers, just verify all files")
flag.Parse()
task := newAddLicenseHeaderTask(&cfg)
if err := task.run(); err != nil {
fmt.Println(err)
os.Exit(-1)
}
}
func newAddLicenseHeaderTask(cfg *config) *addLicenseHeaderTask {
return &addLicenseHeaderTask{
config: cfg,
}
}
func (task *addLicenseHeaderTask) run() error {
data, err := ioutil.ReadFile(task.config.rootDir + "/" + licenseFileName)
if err != nil {
return fmt.Errorf("error reading license file, errr=%v", err.Error())
}
task.license = string(data)
err = filepath.Walk(task.config.rootDir, task.handleFile)
if err != nil {
return fmt.Errorf("copyright header check failed, err=%v", err.Error())
}
return nil
}
func (task *addLicenseHeaderTask) handleFile(path string, fileInfo os.FileInfo, err error) error {
if err != nil {
return err
}
if fileInfo.IsDir() {
return nil
}
if !mustProcessPath(path) {
return nil
}
if !strings.HasSuffix(fileInfo.Name(), ".go") {
return nil
}
f, err := os.Open(path)
if err != nil {
return err
}
reader := bufio.NewReader(f)
firstLine, err := reader.ReadString('\n')
f.Close()
if err != nil && !isEOF(err) {
return err
}
if strings.Contains(firstLine, licenseHeaderIndicator) {
return nil // file already has the copyright header
}
// at this point, src file is missing the header
if task.config.verifyOnly {
if !isFileAutogenerated(path) {
return fmt.Errorf("%v missing license header", path)
}
}
data, err := ioutil.ReadFile(path)
if err != nil {
return err
}
return ioutil.WriteFile(path, []byte(task.license+string(data)), defaultFilePerms)
}
func isFileAutogenerated(path string) bool {
return strings.HasPrefix(path, ".gen")
}
func mustProcessPath(path string) bool {
for _, d := range dirExcludeList {
if strings.HasPrefix(path, d) {
return false
}
}
return true
}
// returns true if the error type is an EOF
func isEOF(err error) bool {
return err == io.EOF || err == io.ErrUnexpectedEOF
}