forked from golangci/golangci-lint
/
load.go
347 lines (288 loc) · 8.77 KB
/
load.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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package lint
import (
"fmt"
"go/build"
"go/parser"
"go/types"
"os"
"path/filepath"
"strings"
"time"
"github.com/golangci/golangci-lint/pkg/exitcodes"
"github.com/golangci/golangci-lint/pkg/fsutils"
"github.com/golangci/golangci-lint/pkg/goutils"
"github.com/golangci/golangci-lint/pkg/logutils"
"github.com/golangci/golangci-lint/pkg/config"
"github.com/golangci/golangci-lint/pkg/lint/astcache"
"github.com/golangci/golangci-lint/pkg/lint/linter"
"github.com/golangci/golangci-lint/pkg/packages"
"golang.org/x/tools/go/loader"
"golang.org/x/tools/go/ssa"
"golang.org/x/tools/go/ssa/ssautil"
)
var loadDebugf = logutils.Debug("load")
func isFullImportNeeded(linters []linter.Config, cfg *config.Config) bool {
for _, linter := range linters {
if linter.NeedsProgramLoading() {
if linter.Linter.Name() == "govet" && cfg.LintersSettings.Govet.UseInstalledPackages {
// TODO: remove this hack
continue
}
return true
}
}
return false
}
func isSSAReprNeeded(linters []linter.Config) bool {
for _, linter := range linters {
if linter.NeedsSSARepresentation() {
return true
}
}
return false
}
func normalizePaths(paths []string) ([]string, error) {
ret := make([]string, 0, len(paths))
for _, p := range paths {
relPath, err := fsutils.ShortestRelPath(p, "")
if err != nil {
return nil, fmt.Errorf("can't get relative path for path %s: %s", p, err)
}
p = relPath
ret = append(ret, "./"+p)
}
return ret, nil
}
func getCurrentProjectImportPath() (string, error) {
gopath := os.Getenv("GOPATH")
if gopath == "" {
return "", fmt.Errorf("no GOPATH env variable")
}
wd, err := fsutils.Getwd()
if err != nil {
return "", fmt.Errorf("can't get workind directory: %s", err)
}
if !strings.HasPrefix(wd, gopath) {
return "", fmt.Errorf("currently no in gopath: %q isn't a prefix of %q", gopath, wd)
}
path := strings.TrimPrefix(wd, gopath)
path = strings.TrimPrefix(path, string(os.PathSeparator)) // if GOPATH contains separator at the end
src := "src" + string(os.PathSeparator)
if !strings.HasPrefix(path, src) {
return "", fmt.Errorf("currently no in gopath/src: %q isn't a prefix of %q", src, path)
}
path = strings.TrimPrefix(path, src)
path = strings.Replace(path, string(os.PathSeparator), "/", -1)
return path, nil
}
func isLocalProjectAnalysis(args []string) bool {
for _, arg := range args {
if strings.HasPrefix(arg, "..") || filepath.IsAbs(arg) {
return false
}
}
return true
}
func getTypeCheckFuncBodies(cfg *config.Run, linters []linter.Config,
pkgProg *packages.Program, log logutils.Log) func(string) bool {
if !isLocalProjectAnalysis(cfg.Args) {
loadDebugf("analysis in nonlocal, don't optimize loading by not typechecking func bodies")
return nil
}
if isSSAReprNeeded(linters) {
loadDebugf("ssa repr is needed, don't optimize loading by not typechecking func bodies")
return nil
}
if len(pkgProg.Dirs()) == 0 {
// files run, in this mode packages are fake: can't check their path properly
return nil
}
projPath, err := getCurrentProjectImportPath()
if err != nil {
log.Infof("Can't get cur project path: %s", err)
return nil
}
return func(path string) bool {
if strings.HasPrefix(path, ".") {
loadDebugf("%s: dot import: typecheck func bodies", path)
return true
}
isLocalPath := strings.HasPrefix(path, projPath)
if isLocalPath {
localPath := strings.TrimPrefix(path, projPath)
localPath = strings.TrimPrefix(localPath, "/")
if strings.HasPrefix(localPath, "vendor/") {
loadDebugf("%s: local vendor import: DO NOT typecheck func bodies", path)
return false
}
loadDebugf("%s: local import: typecheck func bodies", path)
return true
}
loadDebugf("%s: not local import: DO NOT typecheck func bodies", path)
return false
}
}
func loadWholeAppIfNeeded(linters []linter.Config, cfg *config.Config,
pkgProg *packages.Program, log logutils.Log) (*loader.Program, *loader.Config, error) {
if !isFullImportNeeded(linters, cfg) {
return nil, nil, nil
}
startedAt := time.Now()
defer func() {
log.Infof("Program loading took %s", time.Since(startedAt))
}()
bctx := pkgProg.BuildContext()
loadcfg := &loader.Config{
Build: bctx,
AllowErrors: true, // Try to analyze partially
ParserMode: parser.ParseComments, // AST will be reused by linters
TypeCheckFuncBodies: getTypeCheckFuncBodies(&cfg.Run, linters, pkgProg, log),
TypeChecker: types.Config{
Sizes: types.SizesFor(build.Default.Compiler, build.Default.GOARCH),
},
}
var loaderArgs []string
dirs := pkgProg.Dirs()
if len(dirs) != 0 {
loaderArgs = dirs // dirs run
} else {
loaderArgs = pkgProg.Files(cfg.Run.AnalyzeTests) // files run
}
nLoaderArgs, err := normalizePaths(loaderArgs)
if err != nil {
return nil, nil, err
}
rest, err := loadcfg.FromArgs(nLoaderArgs, cfg.Run.AnalyzeTests)
if err != nil {
return nil, nil, fmt.Errorf("can't parepare load config with paths: %s", err)
}
if len(rest) > 0 {
return nil, nil, fmt.Errorf("unhandled loading paths: %v", rest)
}
prog, err := loadcfg.Load()
if err != nil {
return nil, nil, fmt.Errorf("can't load program from paths %v: %s", loaderArgs, err)
}
if len(prog.InitialPackages()) == 1 {
pkg := prog.InitialPackages()[0]
var files []string
for _, f := range pkg.Files {
files = append(files, prog.Fset.Position(f.Pos()).Filename)
}
log.Infof("pkg %s files: %s", pkg, files)
}
return prog, loadcfg, nil
}
func buildSSAProgram(lprog *loader.Program, log logutils.Log) *ssa.Program {
startedAt := time.Now()
defer func() {
log.Infof("SSA repr building took %s", time.Since(startedAt))
}()
ssaProg := ssautil.CreateProgram(lprog, ssa.GlobalDebug)
ssaProg.Build()
return ssaProg
}
// separateNotCompilingPackages moves not compiling packages into separate slices:
// a lot of linters crash on such packages. Leave them only for those linters
// which can work with them.
//nolint:gocyclo
func separateNotCompilingPackages(lintCtx *linter.Context) {
prog := lintCtx.Program
notCompilingPackagesSet := map[*loader.PackageInfo]bool{}
if prog.Created != nil {
compilingCreated := make([]*loader.PackageInfo, 0, len(prog.Created))
for _, info := range prog.Created {
if len(info.Errors) != 0 {
lintCtx.NotCompilingPackages = append(lintCtx.NotCompilingPackages, info)
notCompilingPackagesSet[info] = true
} else {
compilingCreated = append(compilingCreated, info)
}
}
prog.Created = compilingCreated
}
if prog.Imported != nil {
for k, info := range prog.Imported {
if len(info.Errors) == 0 {
continue
}
lintCtx.NotCompilingPackages = append(lintCtx.NotCompilingPackages, info)
notCompilingPackagesSet[info] = true
delete(prog.Imported, k)
}
}
if prog.AllPackages != nil {
for k, info := range prog.AllPackages {
if len(info.Errors) == 0 {
continue
}
if !notCompilingPackagesSet[info] {
lintCtx.NotCompilingPackages = append(lintCtx.NotCompilingPackages, info)
notCompilingPackagesSet[info] = true
}
delete(prog.AllPackages, k)
}
}
if len(lintCtx.NotCompilingPackages) != 0 {
lintCtx.Log.Infof("Not compiling packages: %+v", lintCtx.NotCompilingPackages)
}
}
//nolint:gocyclo
func LoadContext(linters []linter.Config, cfg *config.Config, log logutils.Log) (*linter.Context, error) {
// Set GOROOT to have working cross-compilation: cross-compiled binaries
// have invalid GOROOT. XXX: can't use runtime.GOROOT().
goroot, err := goutils.DiscoverGoRoot()
if err != nil {
return nil, fmt.Errorf("can't discover GOROOT: %s", err)
}
os.Setenv("GOROOT", goroot)
build.Default.GOROOT = goroot
args := cfg.Run.Args
if len(args) == 0 {
args = []string{"./..."}
}
skipDirs := append([]string{}, packages.StdExcludeDirRegexps...)
skipDirs = append(skipDirs, cfg.Run.SkipDirs...)
r, err := packages.NewResolver(cfg.Run.BuildTags, skipDirs, log.Child("path_resolver"))
if err != nil {
return nil, err
}
pkgProg, err := r.Resolve(args...)
if err != nil {
return nil, err
}
if len(pkgProg.Packages()) == 0 {
return nil, exitcodes.ErrNoGoFiles
}
prog, loaderConfig, err := loadWholeAppIfNeeded(linters, cfg, pkgProg, log)
if err != nil {
return nil, err
}
var ssaProg *ssa.Program
if prog != nil && isSSAReprNeeded(linters) {
ssaProg = buildSSAProgram(prog, log)
}
astLog := log.Child("astcache")
var astCache *astcache.Cache
if prog != nil {
astCache, err = astcache.LoadFromProgram(prog, astLog)
} else {
astCache, err = astcache.LoadFromFiles(pkgProg.Files(cfg.Run.AnalyzeTests), astLog)
}
if err != nil {
return nil, err
}
ret := &linter.Context{
PkgProgram: pkgProg,
Cfg: cfg,
Program: prog,
SSAProgram: ssaProg,
LoaderConfig: loaderConfig,
ASTCache: astCache,
Log: log,
}
if prog != nil {
separateNotCompilingPackages(ret)
}
return ret, nil
}