forked from kardianos/govendor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
context.go
406 lines (351 loc) · 10.5 KB
/
context.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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
// Copyright 2015 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package context gathers the status of packages and stores it in Context.
// A new Context needs to be pointed to the root of the project and any
// project owned vendor file.
package context
import (
"fmt"
"io"
"os/exec"
"path/filepath"
"strconv"
"strings"
"github.com/kardianos/govendor/internal/pathos"
os "github.com/kardianos/govendor/internal/vos"
"github.com/kardianos/govendor/vendorfile"
)
const (
debug = false
looplimit = 10000
vendorFilename = "vendor.json"
)
func dprintf(f string, v ...interface{}) {
if debug {
fmt.Printf(f, v...)
}
}
// Context represents the current project context.
type Context struct {
Logger io.Writer // Write to the verbose log.
Insecure bool // Allow insecure network operations
GopathList []string // List of GOPATHs in environment. Includes "src" dir.
Goroot string // The path to the standard library.
RootDir string // Full path to the project root.
RootGopath string // The GOPATH the project is in.
RootImportPath string // The import path to the project.
VendorFile *vendorfile.File
VendorFilePath string // File path to vendor file.
VendorFolder string // Store vendor packages in this folder.
VendorFileToFolder string // The relative path from the vendor file to the vendor folder.
RootToVendorFile string // The relative path from the project root to the vendor file directory.
VendorDiscoverFolder string // Normally auto-set to "vendor"
// Package is a map where the import path is the key.
// Populated with LoadPackage.
Package map[string]*Package
// Change to unkown structure (rename). Maybe...
// MoveRule provides the translation from origional import path to new import path.
RewriteRule map[string]string // map[from]to
Operation []*Operation
loaded, dirty bool
rewriteImports bool
ignoreTag []string // list of tags to ignore
}
// Package maintains information pertaining to a package.
type Package struct {
OriginDir string // Origin directory
Dir string // Physical directory path of the package.
Status Status // Status and location of the package.
Origin string // Origin path for remote
Path string // Import path for a package.
Local string // Current location of a package relative to $GOPATH/src.
IncludeTree bool // Package is a tree of folder.
Gopath string // Inlcudes trailing "src".
Files []*File
inVendor bool // Different then Status.Location, this is in *any* vendor tree.
inTree bool
ignoreFile []string
// used in resolveUnknown function. Not persisted.
referenced map[string]*Package
}
// File holds a reference to the imports in a file and the file locaiton.
type File struct {
Package *Package
Path string
Imports []string
ImportComment string
}
type RootType byte
const (
RootVendor RootType = iota
RootWD
RootVendorOrWD
)
func (pkg *Package) String() string {
return pkg.Local
}
type packageList []*Package
func (li packageList) Len() int { return len(li) }
func (li packageList) Swap(i, j int) { li[i], li[j] = li[j], li[i] }
func (li packageList) Less(i, j int) bool {
if li[i].Path != li[j].Path {
return li[i].Path < li[j].Path
}
return li[i].Local < li[j].Local
}
// NewContextWD creates a new context. It looks for a root folder by finding
// a vendor file.
func NewContextWD(rt RootType) (*Context, error) {
wd, err := os.Getwd()
if err != nil {
return nil, err
}
pathToVendorFile := filepath.Join("vendor", vendorFilename)
rootIndicator := "vendor"
vendorFolder := "vendor"
root := wd
if rt == RootVendor || rt == RootVendorOrWD {
tryRoot, err := findRoot(wd, rootIndicator)
switch rt {
case RootVendor:
if err != nil {
return nil, err
}
root = tryRoot
case RootVendorOrWD:
if err == nil {
root = tryRoot
}
}
}
// Check for old vendor file location.
oldLocation := filepath.Join(root, vendorFilename)
if _, err := os.Stat(oldLocation); err == nil {
return nil, ErrOldVersion{`Use the "migrate" command to update.`}
}
return NewContext(root, pathToVendorFile, vendorFolder, false)
}
// NewContext creates new context from a given root folder and vendor file path.
// The vendorFolder is where vendor packages should be placed.
func NewContext(root, vendorFilePathRel, vendorFolder string, rewriteImports bool) (*Context, error) {
dprintf("CTX: %s\n", root)
vendorFilePath := filepath.Join(root, vendorFilePathRel)
vf, err := readVendorFile(vendorFilePath)
if err != nil {
if !os.IsNotExist(err) {
return nil, err
}
vf = &vendorfile.File{}
}
// Get GOROOT. First check ENV, then run "go env" and find the GOROOT line.
goroot := os.Getenv("GOROOT")
if len(goroot) == 0 {
// If GOROOT is not set, get from go cmd.
cmd := exec.Command("go", "env")
var goEnv []byte
goEnv, err = cmd.CombinedOutput()
if err != nil {
return nil, err
}
const gorootLookFor = `GOROOT=`
for _, line := range strings.Split(string(goEnv), "\n") {
if strings.HasPrefix(line, gorootLookFor) == false {
continue
}
goroot = strings.TrimPrefix(line, gorootLookFor)
goroot, err = strconv.Unquote(goroot)
if err != nil {
return nil, fmt.Errorf("Failed to unquote GOROOT: %v", err)
}
break
}
}
if goroot == "" {
return nil, ErrMissingGOROOT
}
goroot = filepath.Join(goroot, "src")
// Get the GOPATHs. Prepend the GOROOT to the list.
all := os.Getenv("GOPATH")
if len(all) == 0 {
return nil, ErrMissingGOPATH
}
gopathList := filepath.SplitList(all)
gopathGoroot := make([]string, 0, len(gopathList)+1)
gopathGoroot = append(gopathGoroot, goroot)
for _, gopath := range gopathList {
gopathGoroot = append(gopathGoroot, filepath.Join(gopath, "src")+string(filepath.Separator))
}
rootToVendorFile, _ := filepath.Split(vendorFilePathRel)
vendorFileDir, _ := filepath.Split(vendorFilePath)
vendorFolderRel, err := filepath.Rel(vendorFileDir, filepath.Join(root, vendorFolder))
if err != nil {
return nil, err
}
vendorFileToFolder := pathos.SlashToImportPath(vendorFolderRel)
ctx := &Context{
RootDir: root,
GopathList: gopathGoroot,
Goroot: goroot,
VendorFile: vf,
VendorFilePath: vendorFilePath,
VendorFolder: vendorFolder,
VendorFileToFolder: vendorFileToFolder,
RootToVendorFile: pathos.SlashToImportPath(rootToVendorFile),
VendorDiscoverFolder: "vendor",
Package: make(map[string]*Package),
RewriteRule: make(map[string]string, 3),
rewriteImports: rewriteImports,
}
ctx.RootImportPath, ctx.RootGopath, err = ctx.findImportPath(root)
if err != nil {
return nil, err
}
ctx.IgnoreBuild(vf.Ignore)
return ctx, nil
}
// IgnoreBuild takes a space separated list of tags to ignore.
// "a b c" will ignore "a" OR "b" OR "c".
func (ctx *Context) IgnoreBuild(ignore string) {
ors := strings.Fields(ignore)
ctx.ignoreTag = make([]string, 0, len(ors))
for _, or := range ors {
if len(or) == 0 {
continue
}
ctx.ignoreTag = append(ctx.ignoreTag, or)
}
}
// Write to the set io.Writer for logging.
func (ctx *Context) Write(s []byte) (int, error) {
if ctx.Logger != nil {
return ctx.Logger.Write(s)
}
return len(s), nil
}
// VendorFilePackageCanonical finds a given vendor file package give the import path.
func (ctx *Context) VendorFilePackagePath(path string) *vendorfile.Package {
for _, pkg := range ctx.VendorFile.Package {
if pkg.Remove {
continue
}
if pkg.Path == path {
return pkg
}
}
return nil
}
func (ctx *Context) packagePath(path string) []*Package {
var list []*Package
for _, pkg := range ctx.Package {
if pkg.Path == path {
list = append(list, pkg)
}
}
return list
}
// findPackageChild finds any package under the current package.
// Used for finding tree overlaps.
func (ctx *Context) findPackageChild(ck *Package) []*Package {
out := make([]*Package, 0, 3)
for _, pkg := range ctx.Package {
if pkg == ck {
continue
}
if pkg.inVendor == false {
continue
}
if pkg.Status.Presence == PresenceTree {
continue
}
if strings.HasPrefix(pkg.Path, ck.Path) {
out = append(out, pkg)
}
}
return out
}
// findPackageParentTree finds any parent tree package that would
// include the given canonical path.
func (ctx *Context) findPackageParentTree(ck *Package) []string {
out := make([]string, 0, 1)
for _, pkg := range ctx.Package {
if pkg.inVendor == false {
continue
}
if pkg.IncludeTree == false || pkg == ck {
continue
}
// pkg.Path = github.com/usera/pkg, tree = true
// ck.Path = github.com/usera/pkg/dance
if strings.HasPrefix(ck.Path, pkg.Path) {
out = append(out, pkg.Local)
}
}
return out
}
// updatePackageReferences populates the referenced field in each Package.
func (ctx *Context) updatePackageReferences() {
pathUnderDirLookup := make(map[string]map[string]*Package)
findCanonicalUnderDir := func(dir, path string) *Package {
if importMap, found := pathUnderDirLookup[dir]; found {
if pkg, found2 := importMap[path]; found2 {
return pkg
}
} else {
pathUnderDirLookup[dir] = make(map[string]*Package)
}
for _, pkg := range ctx.Package {
if !pkg.inVendor {
continue
}
removeFromEnd := len(pkg.Path) + len(ctx.VendorDiscoverFolder) + 2
nextLen := len(pkg.Dir) - removeFromEnd
if nextLen < 0 {
continue
}
checkDir := pkg.Dir[:nextLen]
if !pathos.FileHasPrefix(dir, checkDir) {
continue
}
if pkg.Path != path {
continue
}
pathUnderDirLookup[dir][path] = pkg
return pkg
}
pathUnderDirLookup[dir][path] = nil
return nil
}
for _, pkg := range ctx.Package {
pkg.referenced = make(map[string]*Package, len(pkg.referenced))
}
for _, pkg := range ctx.Package {
for _, f := range pkg.Files {
for _, imp := range f.Imports {
if vpkg := findCanonicalUnderDir(pkg.Dir, imp); vpkg != nil {
vpkg.referenced[pkg.Local] = pkg
continue
}
if other, found := ctx.Package[imp]; found {
other.referenced[pkg.Local] = pkg
continue
}
}
}
}
// Transfer all references from the child to the top parent.
for _, pkg := range ctx.Package {
if parentTrees := ctx.findPackageParentTree(pkg); len(parentTrees) > 0 {
if parentPkg := ctx.Package[parentTrees[0]]; parentPkg != nil {
for opath, opkg := range pkg.referenced {
// Do not transfer internal references.
if strings.HasPrefix(opkg.Path, parentPkg.Path+"/") {
continue
}
parentPkg.referenced[opath] = opkg
}
pkg.referenced = make(map[string]*Package, 0)
}
}
}
}