Skip to content

Slight clarification in strict dependencies error message #1424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jayconrod merged 2 commits into from
Apr 2, 2018
Merged

Slight clarification in strict dependencies error message #1424

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e30a73
Slight clarification in strict dependencies error message
Apr 2, 2018
25e9e0f
Print known dependencies, too.
Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions go/tools/builders/compile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package main

import (
"bytes"
"flag"
"fmt"
"go/build"
Expand Down Expand Up @@ -128,6 +129,8 @@ func run(args []string) error {
}

func main() {
log.SetFlags(0) // no timestamp
log.SetPrefix("GoCompile: ")
if err := run(os.Args[1:]); err != nil {
log.Fatal(err)
}
Expand All @@ -151,7 +154,7 @@ func checkDirectDeps(bctx build.Context, files []*goMetadata, deps []string, pac
depSet[d] = true
}

var errs depsError
derr := depsError{known: deps}
for _, f := range files {
for _, path := range f.imports {
if path == "C" || stdlib[path] || isRelative(path) {
Expand All @@ -161,26 +164,43 @@ func checkDirectDeps(bctx build.Context, files []*goMetadata, deps []string, pac
continue
}
if !depSet[path] {
errs = append(errs, fmt.Errorf("%s: import of %s, which is not a direct dependency", f.filename, path))
derr.missing = append(derr.missing, missingDep{f.filename, path})
}
}
}
if len(errs) > 0 {
return errs
if len(derr.missing) > 0 {
return derr
}
return nil
}

type depsError []error
type depsError struct {
missing []missingDep
known []string
}

type missingDep struct {
filename, imp string
}

var _ error = depsError(nil)
var _ error = depsError{}

func (e depsError) Error() string {
errorStrings := make([]string, len(e))
for i, err := range e {
errorStrings[i] = err.Error()
buf := bytes.NewBuffer(nil)
fmt.Fprintf(buf, "missing strict dependencies:\n")
for _, dep := range e.missing {
fmt.Fprintf(buf, "\t%s: import of %q\n", dep.filename, dep.imp)
}
if len(e.known) == 0 {
fmt.Fprintln(buf, "No dependencies were provided.")
} else {
fmt.Fprintln(buf, "Known dependencies are:")
for _, imp := range e.known {
fmt.Fprintf(buf, "\t%s\n", imp)
}
}
return "missing strict dependencies:\n\t" + strings.Join(errorStrings, "\n\t")
fmt.Fprint(buf, "Check that imports in Go sources match importpath attributes in deps.")
return buf.String()
}

func isRelative(path string) bool {
Expand Down