Skip to content

Commit 4b4d5a7

Browse files
elldritchelldritch
committed
refactor(log): Improve logging diagnostics, fix Go project names
1 parent cc9586b commit 4b4d5a7

26 files changed

+293
-328
lines changed

‎builders/archive.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,24 @@ func (builder *VendoredArchiveBuilder) Analyze(m module.Module, allowUnresolved
4949
// extractedArchivePaths := []string{}
5050
var rawDependencies []nodeManifest
5151

52-
log.Debugf("Looking for tar files...")
52+
log.Logger.Debugf("Looking for tar files...")
5353
tarFiles, err := doublestar.Glob(filepath.Join(m.Dir, "**", "*.{tar.gz,tgz}"))
5454
if err != nil {
5555
return nil, err
5656
}
57-
log.Debugf("Found %#v tar files.", len(tarFiles))
57+
log.Logger.Debugf("Found %#v tar files.", len(tarFiles))
5858

5959
for i := 0; i < len(tarFiles); i++ {
6060
// Open the tar archive for reading.
6161
f, err := os.Open(tarFiles[i])
6262
if err != nil {
63-
log.Warningf("Unable to open tarfile: %#v", tarFiles[i])
63+
log.Logger.Warningf("Unable to open tarfile: %#v", tarFiles[i])
6464
}
6565
defer f.Close()
6666

6767
gzf, err := gzip.NewReader(f)
6868
if err != nil {
69-
log.Warningf("Gzip error: %#v", err)
69+
log.Logger.Warningf("Gzip error: %#v", err)
7070
break
7171
}
7272

@@ -80,25 +80,25 @@ func (builder *VendoredArchiveBuilder) Analyze(m module.Module, allowUnresolved
8080
}
8181

8282
if err != nil {
83-
log.Warningf("Tar error: %#v", err)
83+
log.Logger.Warningf("Tar error: %#v", err)
8484
return nil, err
8585
}
8686

8787
if strings.HasSuffix(hdr.Name, "package.json") {
88-
log.Debugf("Found node module: %#v", hdr.Name)
88+
log.Logger.Debugf("Found node module: %#v", hdr.Name)
8989
nodeManifestBuffer := make([]byte, hdr.Size)
9090

9191
_, err := io.ReadFull(tr, nodeManifestBuffer)
9292
if err != nil {
93-
log.Warningf("Error reading node module: %#v", hdr.Name)
93+
log.Logger.Warningf("Error reading node module: %#v", hdr.Name)
9494
break
9595
}
9696
var nodeModule nodeManifest
9797
if err := json.Unmarshal(nodeManifestBuffer, &nodeModule); err != nil {
98-
log.Warningf("Error parsing node module: %#v", hdr.Name)
98+
log.Logger.Warningf("Error parsing node module: %#v", hdr.Name)
9999
break
100100
}
101-
log.Debugf("Found node module: %#v", nodeModule)
101+
log.Logger.Debugf("Found node module: %#v", nodeModule)
102102
rawDependencies = append(rawDependencies, nodeModule)
103103
break
104104
}

‎builders/bower.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ type BowerBuilder struct {
2929

3030
// Initialize collects metadata on Node and Bower binaries
3131
func (builder *BowerBuilder) Initialize() error {
32-
log.Debug("Initializing Bower builder...")
32+
log.Logger.Debug("Initializing Bower builder...")
3333

3434
// Set Node context variables
3535
nodeCmd, nodeVersion, err := which("-v", os.Getenv("NODE_BINARY"), "node", "nodejs")
3636
if err != nil {
37-
log.Warningf("Could not find Node binary (try setting $NODE_BINARY): %s", err.Error())
37+
log.Logger.Warningf("Could not find Node binary (try setting $NODE_BINARY): %s", err.Error())
3838
}
3939
builder.NodeCmd = nodeCmd
4040
builder.NodeVersion = nodeVersion
@@ -47,13 +47,13 @@ func (builder *BowerBuilder) Initialize() error {
4747
builder.BowerCmd = bowerCmd
4848
builder.BowerVersion = bowerVersion
4949

50-
log.Debugf("Done initializing Bower builder: %#v", builder)
50+
log.Logger.Debugf("Done initializing Bower builder: %#v", builder)
5151
return nil
5252
}
5353

5454
// Build runs `bower install --production` and cleans with `rm -rf bower_components`
5555
func (builder *BowerBuilder) Build(m module.Module, force bool) error {
56-
log.Debugf("Running Bower build: %#v", m, force)
56+
log.Logger.Debugf("Running Bower build: %#v", m, force)
5757

5858
if force {
5959
_, _, err := runLogged(m.Dir, "rm", "-rf", "bower_components")
@@ -67,7 +67,7 @@ func (builder *BowerBuilder) Build(m module.Module, force bool) error {
6767
return fmt.Errorf("could not run Bower build: %s", err.Error())
6868
}
6969

70-
log.Debug("Done running Bower build.")
70+
log.Logger.Debug("Done running Bower build.")
7171
return nil
7272
}
7373

@@ -112,7 +112,7 @@ func normalizeBowerComponents(parent module.ImportPath, c bowerListManifest) []I
112112
// Analyze reads the output of `bower ls --json`
113113
// TODO: fall back to old method of reading `bower_components/*/.bower.json`s?
114114
func (builder *BowerBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error) {
115-
log.Debugf("Running Bower analysis: %#v %#v", m, allowUnresolved)
115+
log.Logger.Debugf("Running Bower analysis: %#v %#v", m, allowUnresolved)
116116

117117
stdout, _, err := runLogged(m.Dir, "bower", "ls", "--json")
118118
if err != nil {
@@ -143,7 +143,7 @@ func (builder *BowerBuilder) Analyze(m module.Module, allowUnresolved bool) ([]m
143143
}
144144
deps := computeImportPaths(depList)
145145

146-
log.Debugf("Done running Bower analysis: %#v", deps)
146+
log.Logger.Debugf("Done running Bower analysis: %#v", deps)
147147
return deps, nil
148148
}
149149

@@ -166,7 +166,7 @@ func resolveBowerComponentsDirectory(dir string) string {
166166

167167
// IsBuilt checks for the existence of `$PROJECT/bower_components`
168168
func (builder *BowerBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error) {
169-
log.Debug("Checking Bower build: %#v %#v", m, allowUnresolved)
169+
log.Logger.Debug("Checking Bower build: %#v %#v", m, allowUnresolved)
170170

171171
// TODO: Check if the installed modules are consistent with what's in the
172172
// actual manifest.
@@ -175,7 +175,7 @@ func (builder *BowerBuilder) IsBuilt(m module.Module, allowUnresolved bool) (boo
175175
return false, fmt.Errorf("could not find Bower dependencies folder: %s", err.Error())
176176
}
177177

178-
log.Debugf("Done checking Bower build: %#v", isBuilt)
178+
log.Logger.Debugf("Done checking Bower build: %#v", isBuilt)
179179
return isBuilt, nil
180180
}
181181

@@ -189,12 +189,12 @@ func (builder *BowerBuilder) DiscoverModules(dir string) ([]module.Config, error
189189
var moduleConfigs []module.Config
190190
err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
191191
if err != nil {
192-
log.Debugf("Failed to access path %s: %s", path, err.Error())
192+
log.Logger.Debugf("Failed to access path %s: %s", path, err.Error())
193193
return err
194194
}
195195
// Skip **/node_modules and **/bower_components directories
196196
if info.IsDir() && (info.Name() == "node_modules" || info.Name() == "bower_components") {
197-
log.Debugf("Skipping directory: %s", info.Name())
197+
log.Logger.Debugf("Skipping directory: %s", info.Name())
198198
return filepath.SkipDir
199199
}
200200

@@ -207,7 +207,7 @@ func (builder *BowerBuilder) DiscoverModules(dir string) ([]module.Config, error
207207
moduleName = manifest.Name
208208
}
209209

210-
log.Debugf("Found Bower package: %s (%s)", path, moduleName)
210+
log.Logger.Debugf("Found Bower package: %s (%s)", path, moduleName)
211211
moduleConfigs = append(moduleConfigs, module.Config{
212212
Name: moduleName,
213213
Path: path,

‎builders/cocoapods.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -91,36 +91,36 @@ func extractPodName(fullDepStr string) string {
9191

9292
// Initialize collects metadata on Cocoapods
9393
func (builder *CocoapodsBuilder) Initialize() error {
94-
log.Debug("Initializing Cocoapods builder...")
94+
log.Logger.Debug("Initializing Cocoapods builder...")
9595

9696
// Set Ruby context variables
9797
cocoapodsCmd, cocoapodsVersion, err := which("--version", os.Getenv("COCOAPODS_BINARY"), "pod")
9898
if err != nil {
99-
log.Warningf("Could not find Pod binary (try setting $COCOAPODS_BINARY): %s", err.Error())
99+
log.Logger.Warningf("Could not find Pod binary (try setting $COCOAPODS_BINARY): %s", err.Error())
100100
}
101101
builder.CocoapodsCmd = cocoapodsCmd
102102
builder.CocoapodsVersion = strings.TrimRight(cocoapodsVersion, "\n")
103103

104-
log.Debugf("Initialized Cocoapods builder: %#v", builder)
104+
log.Logger.Debugf("Initialized Cocoapods builder: %#v", builder)
105105
return nil
106106
}
107107

108108
// Build runs `pod install`
109109
func (builder *CocoapodsBuilder) Build(m module.Module, force bool) error {
110-
log.Debugf("Running Cocoapods build: %#v %#v", m, force)
110+
log.Logger.Debugf("Running Cocoapods build: %#v %#v", m, force)
111111

112112
_, _, err := runLogged(m.Dir, builder.CocoapodsCmd, "install")
113113
if err != nil {
114114
return fmt.Errorf("could not run Cocoapods build: %s", err.Error())
115115
}
116116

117-
log.Debug("Done running Cocoapods build.")
117+
log.Logger.Debug("Done running Cocoapods build.")
118118
return nil
119119
}
120120

121121
// Analyze parses the `podfile.lock` YAML file and analyzes
122122
func (builder *CocoapodsBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error) {
123-
log.Debugf("Running Cocoapods analysis: %#v %#v", m, allowUnresolved)
123+
log.Logger.Debugf("Running Cocoapods analysis: %#v %#v", m, allowUnresolved)
124124
var podLockfile PodFileLock
125125

126126
currentLockfile := filepath.Join(m.Dir, "Podfile.lock")
@@ -237,20 +237,20 @@ func (builder *CocoapodsBuilder) Analyze(m module.Module, allowUnresolved bool)
237237

238238
deps := computeImportPaths(imports)
239239

240-
log.Debugf("Done running Pod analysis: %#v", deps)
240+
log.Logger.Debugf("Done running Pod analysis: %#v", deps)
241241
return deps, nil
242242
}
243243

244244
// IsBuilt checks whether `Podfile.lock` exists
245245
func (builder *CocoapodsBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error) {
246-
log.Debugf("Checking Cocoapods build: %#v %#v", m, allowUnresolved)
246+
log.Logger.Debugf("Checking Cocoapods build: %#v %#v", m, allowUnresolved)
247247

248248
isBuilt, err := hasFile(m.Dir, "Podfile.lock")
249249
if err != nil {
250250
return false, fmt.Errorf("could not find Podfile.lock file: %s", err.Error())
251251
}
252252

253-
log.Debugf("Done checking Cocoapods build: %#v", isBuilt)
253+
log.Logger.Debugf("Done checking Cocoapods build: %#v", isBuilt)
254254
return isBuilt, nil
255255
}
256256

@@ -269,7 +269,7 @@ func (builder *CocoapodsBuilder) DiscoverModules(dir string) ([]module.Config, e
269269
for _, path := range cococapodsFilePaths {
270270
podName := filepath.Base(filepath.Dir(path))
271271

272-
log.Debugf("Found Cocoapods package: %s (%s)", path, podName)
272+
log.Logger.Debugf("Found Cocoapods package: %s (%s)", path, podName)
273273
path, _ = filepath.Rel(dir, path)
274274
moduleConfigs = append(moduleConfigs, module.Config{
275275
Name: podName,

‎builders/common.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ func runInDir(dir string, name string, arg ...string) (string, string, error) {
107107
// Utilities for debug logging
108108
func runLogged(dir string, name string, arg ...string) (string, string, error) {
109109
cmd := strings.Join(append([]string{name}, arg...), " ")
110-
log.Debugf("Running `%s` in dir `%s`...", cmd, dir)
110+
log.Logger.Debugf("Running `%s` in dir `%s`...", cmd, dir)
111111
stdout, stderr, err := runInDir(dir, name, arg...)
112112
if err != nil {
113-
log.Debugf("Running `%s` failed: %#v %#v", cmd, err, stderr)
113+
log.Logger.Debugf("Running `%s` failed: %#v %#v", cmd, err, stderr)
114114
return stdout, stderr, fmt.Errorf("running `%s` failed: %#v %#v", cmd, err, stderr)
115115
}
116-
log.Debugf("Done running `%s`: %#v %#v", stdout, stderr)
116+
log.Logger.Debugf("Done running `%s`: %#v %#v", stdout, stderr)
117117
return stdout, stderr, nil
118118
}
119119

@@ -124,20 +124,20 @@ func parseLogged(file string, v interface{}) error {
124124
type unmarshaller func(data []byte, v interface{}) error
125125

126126
func parseLoggedWithUnmarshaller(file string, v interface{}, unmarshal unmarshaller) error {
127-
log.Debugf("Parsing %s...", file)
127+
log.Logger.Debugf("Parsing %s...", file)
128128

129129
contents, err := ioutil.ReadFile(file)
130130
if err != nil {
131-
log.Debugf("Error reading %s: %s", file, err.Error())
131+
log.Logger.Debugf("Error reading %s: %s", file, err.Error())
132132
return err
133133
}
134134
err = unmarshal(contents, v)
135135
if err != nil {
136-
log.Debugf("Error parsing %s: %#v %#v", file, err, contents)
136+
log.Logger.Debugf("Error parsing %s: %#v %#v", file, err, contents)
137137
return err
138138
}
139139

140-
log.Debugf("Done parsing %s.", file)
140+
log.Logger.Debugf("Done parsing %s.", file)
141141
return nil
142142
}
143143

@@ -150,7 +150,7 @@ func whichWithResolver(cmds []string, getVersion versionResolver) (string, strin
150150
if err == nil {
151151
return cmd, version, nil
152152
}
153-
log.Debugf("Tried resolving `%s` but did not work: %#v %#v", cmd, err, version)
153+
log.Logger.Debugf("Tried resolving `%s` but did not work: %#v %#v", cmd, err, version)
154154
}
155155
return "", "", errors.New("could not resolve version")
156156
}

‎builders/composer.go

+13-13
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ type ComposerBuilder struct {
2424

2525
// Initialize collects metadata on PHP and Composer binaries
2626
func (builder *ComposerBuilder) Initialize() error {
27-
log.Debug("Initializing Composer builder...")
27+
log.Logger.Debug("Initializing Composer builder...")
2828

2929
// Set PHP context variables
3030
phpCmd, phpVersion, err := which("-v", os.Getenv("PHP_BINARY"), "php")
3131
if err != nil {
32-
log.Warningf("Could not find PHP binary (try setting $PHP_BINARY): %s", err.Error())
32+
log.Logger.Warningf("Could not find PHP binary (try setting $PHP_BINARY): %s", err.Error())
3333
}
3434
builder.PHPCmd = phpCmd
3535
builder.PHPVersion = phpVersion
@@ -42,13 +42,13 @@ func (builder *ComposerBuilder) Initialize() error {
4242
builder.ComposerCmd = composerCmd
4343
builder.ComposerVersion = composerVersion
4444

45-
log.Debugf("Done initializing Composer builder: %#v", builder)
45+
log.Logger.Debugf("Done initializing Composer builder: %#v", builder)
4646
return nil
4747
}
4848

4949
// Build runs `composer install --prefer-dist --no-dev` and cleans with `rm -rf vendor`
5050
func (builder *ComposerBuilder) Build(m module.Module, force bool) error {
51-
log.Debug("Running Composer build: %#v %#v", m, force)
51+
log.Logger.Debug("Running Composer build: %#v %#v", m, force)
5252

5353
if force {
5454
_, _, err := runLogged(m.Dir, "rm", "-rf", "vendor")
@@ -62,7 +62,7 @@ func (builder *ComposerBuilder) Build(m module.Module, force bool) error {
6262
return fmt.Errorf("could not run Composer build: %s", err.Error())
6363
}
6464

65-
log.Debug("Done running Composer build.")
65+
log.Logger.Debug("Done running Composer build.")
6666
return nil
6767
}
6868

@@ -73,7 +73,7 @@ type composerManifest struct {
7373

7474
// Analyze parses the output of `composer show -f json --no-ansi`
7575
func (builder *ComposerBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error) {
76-
log.Debug("Running Composer analysis: %#v %#v", m, allowUnresolved)
76+
log.Logger.Debug("Running Composer analysis: %#v %#v", m, allowUnresolved)
7777

7878
// Run `composer show --format=json --no-ansi` to get resolved versions
7979
showOutput, _, err := runLogged(m.Dir, builder.ComposerCmd, "show", "--format=json", "--no-ansi")
@@ -135,7 +135,7 @@ func (builder *ComposerBuilder) Analyze(m module.Module, allowUnresolved bool) (
135135
depth = len(matches[1])
136136
if depth%3 != 0 {
137137
// Sanity check
138-
log.Panicf("Bad depth: %#v %s %#v", depth, line, matches)
138+
log.Logger.Panicf("Bad depth: %#v %s %#v", depth, line, matches)
139139
}
140140
}
141141
if depth > lastDepth {
@@ -161,13 +161,13 @@ func (builder *ComposerBuilder) Analyze(m module.Module, allowUnresolved bool) (
161161
}
162162
}
163163

164-
log.Debugf("Done running Composer analysis: %#v", deps)
164+
log.Logger.Debugf("Done running Composer analysis: %#v", deps)
165165
return deps, nil
166166
}
167167

168168
// IsBuilt checks whether `composer show --no-ansi` produces output
169169
func (builder *ComposerBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error) {
170-
log.Debugf("Checking Composer build: %#v %#v", m, allowUnresolved)
170+
log.Logger.Debugf("Checking Composer build: %#v %#v", m, allowUnresolved)
171171

172172
// Run `composer show --no-ansi`
173173
output, _, err := runLogged(m.Dir, builder.ComposerCmd, "show", "--no-ansi")
@@ -178,7 +178,7 @@ func (builder *ComposerBuilder) IsBuilt(m module.Module, allowUnresolved bool) (
178178
// Check that the output is non-empty
179179
isBuilt := len(strings.TrimSpace(string(output))) > 0
180180

181-
log.Debugf("Done checking Composer build: %#v", isBuilt)
181+
log.Logger.Debugf("Done checking Composer build: %#v", isBuilt)
182182
return isBuilt, nil
183183
}
184184

@@ -192,13 +192,13 @@ func (builder *ComposerBuilder) DiscoverModules(dir string) ([]module.Config, er
192192
var moduleConfigs []module.Config
193193
err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
194194
if err != nil {
195-
log.Debugf("failed to access path %s: %s\n", path, err.Error())
195+
log.Logger.Debugf("failed to access path %s: %s\n", path, err.Error())
196196
return err
197197
}
198198

199199
// Skip the /vendor/ folder
200200
if info.IsDir() && info.Name() == "vendor" {
201-
log.Debugf("skipping `vendor` directory: %s", info.Name())
201+
log.Logger.Debugf("skipping `vendor` directory: %s", info.Name())
202202
return filepath.SkipDir
203203
}
204204

@@ -211,7 +211,7 @@ func (builder *ComposerBuilder) DiscoverModules(dir string) ([]module.Config, er
211211
moduleName = composerPackage.Name
212212
}
213213

214-
log.Debugf("found Composer package: %s (%s)", path, moduleName)
214+
log.Logger.Debugf("found Composer package: %s (%s)", path, moduleName)
215215
moduleConfigs = append(moduleConfigs, module.Config{
216216
Name: moduleName,
217217
Path: path,

0 commit comments

Comments
 (0)