From 834e8e6c51f3698240cbf78045100df9552bef8b Mon Sep 17 00:00:00 2001 From: Carolyn Van Slyck Date: Wed, 30 Aug 2017 18:03:36 -0500 Subject: [PATCH] Address code climate warnings --- cmd/dep/base_importer.go | 15 +++------------ cmd/dep/glide_importer.go | 20 ++++++++++---------- cmd/dep/glide_importer_test.go | 10 +++++----- cmd/dep/godep_importer.go | 8 ++++---- cmd/dep/govend_importer.go | 6 +++--- cmd/dep/vndr_importer.go | 6 +++--- 6 files changed, 28 insertions(+), 37 deletions(-) diff --git a/cmd/dep/base_importer.go b/cmd/dep/base_importer.go index 6b175a1311..9d8c787c90 100644 --- a/cmd/dep/base_importer.go +++ b/cmd/dep/base_importer.go @@ -13,6 +13,8 @@ import ( "github.com/pkg/errors" ) +// baseImporter provides a common implementation for importing from other +// dependency managers. type baseImporter struct { logger *log.Logger verbose bool @@ -21,6 +23,7 @@ type baseImporter struct { lock *dep.Lock } +// newBaseImporter creates a new baseImporter for embedding in an importer. func newBaseImporter(logger *log.Logger, verbose bool, sm gps.SourceManager) *baseImporter { return &baseImporter{ logger: logger, @@ -90,18 +93,6 @@ func (i *baseImporter) lookupVersionForLockedProject(pi gps.ProjectIdentifier, c return rev, nil } -// projectExistsInLock checks if the given project already exists in -// a lockfile. -func projectExistsInLock(l *dep.Lock, pr gps.ProjectRoot) bool { - for _, lp := range l.P { - if pr == lp.Ident().ProjectRoot { - return true - } - } - - return false -} - // importedPackage is a common intermediate representation of a package imported // from an external tool's configuration. type importedPackage struct { diff --git a/cmd/dep/glide_importer.go b/cmd/dep/glide_importer.go index 084a8cc897..90d4e9e05f 100644 --- a/cmd/dep/glide_importer.go +++ b/cmd/dep/glide_importer.go @@ -49,7 +49,7 @@ type glideLock struct { type glidePackage struct { Name string `yaml:"package"` - Reference string `yaml:"version"` + Reference string `yaml:"version"` // could contain a semver, tag or branch Repository string `yaml:"repo"` // Unsupported fields that we will warn if used @@ -60,7 +60,7 @@ type glidePackage struct { type glideLockedPackage struct { Name string `yaml:"name"` - Reference string `yaml:"version"` // TODO(carolynvs) Rename to Revision + Revision string `yaml:"version"` Repository string `yaml:"repo"` } @@ -96,11 +96,11 @@ func (g *glideImporter) load(projectDir string) error { } yb, err := ioutil.ReadFile(y) if err != nil { - return errors.Wrapf(err, "Unable to read %s", y) + return errors.Wrapf(err, "unable to read %s", y) } err = yaml.Unmarshal(yb, &g.glideConfig) if err != nil { - return errors.Wrapf(err, "Unable to parse %s", y) + return errors.Wrapf(err, "unable to parse %s", y) } l := filepath.Join(projectDir, glideLockName) @@ -111,12 +111,12 @@ func (g *glideImporter) load(projectDir string) error { g.lockFound = true lb, err := ioutil.ReadFile(l) if err != nil { - return errors.Wrapf(err, "Unable to read %s", l) + return errors.Wrapf(err, "unable to read %s", l) } lock := glideLock{} err = yaml.Unmarshal(lb, &lock) if err != nil { - return errors.Wrapf(err, "Unable to parse %s", l) + return errors.Wrapf(err, "unable to parse %s", l) } g.glideLock = lock } @@ -142,7 +142,7 @@ func (g *glideImporter) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, e for _, pkg := range append(g.glideConfig.Imports, g.glideConfig.TestImports...) { // Validate if pkg.Name == "" { - return nil, nil, errors.New("Invalid glide configuration: Name is required.") + return nil, nil, errors.New("invalid glide configuration: Name is required.") } // Warn @@ -167,20 +167,20 @@ func (g *glideImporter) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, e for _, pkg := range append(g.glideLock.Imports, g.glideLock.TestImports...) { // Validate if pkg.Name == "" { - return nil, nil, errors.New("Invalid glide lock: Name is required.") + return nil, nil, errors.New("invalid glide lock: Name is required.") } ip := importedPackage{ Name: pkg.Name, Source: pkg.Repository, - LockHint: pkg.Reference, + LockHint: pkg.Revision, } packages = append(packages, ip) } err := g.importPackages(packages, false) if err != nil { - return nil, nil, errors.Wrap(err, "Invalid glide configuration") + return nil, nil, errors.Wrap(err, "invalid glide configuration") } // Ignores diff --git a/cmd/dep/glide_importer_test.go b/cmd/dep/glide_importer_test.go index a74645740c..d60e61acda 100644 --- a/cmd/dep/glide_importer_test.go +++ b/cmd/dep/glide_importer_test.go @@ -52,7 +52,7 @@ func TestGlideConfig_Convert(t *testing.T) { { Name: "github.com/sdboyer/deptest", Repository: "https://github.com/sdboyer/deptest.git", - Reference: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", + Revision: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", }, }, }, @@ -76,8 +76,8 @@ func TestGlideConfig_Convert(t *testing.T) { glideLock{ TestImports: []glideLockedPackage{ { - Name: "github.com/sdboyer/deptest", - Reference: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", + Name: "github.com/sdboyer/deptest", + Revision: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", }, }, }, @@ -99,8 +99,8 @@ func TestGlideConfig_Convert(t *testing.T) { glideLock{ Imports: []glideLockedPackage{ { - Name: "github.com/sdboyer/deptest", - Reference: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", + Name: "github.com/sdboyer/deptest", + Revision: "ff2948a2ac8f538c4ecd55962e919d1e13e74baf", }, }, }, diff --git a/cmd/dep/godep_importer.go b/cmd/dep/godep_importer.go index 0b3f67f903..9d84e3e56d 100644 --- a/cmd/dep/godep_importer.go +++ b/cmd/dep/godep_importer.go @@ -67,11 +67,11 @@ func (g *godepImporter) load(projectDir string) error { } jb, err := ioutil.ReadFile(j) if err != nil { - return errors.Wrapf(err, "Unable to read %s", j) + return errors.Wrapf(err, "unable to read %s", j) } err = json.Unmarshal(jb, &g.json) if err != nil { - return errors.Wrapf(err, "Unable to parse %s", j) + return errors.Wrapf(err, "unable to parse %s", j) } return nil @@ -84,12 +84,12 @@ func (g *godepImporter) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, e for _, pkg := range g.json.Imports { // Validate if pkg.ImportPath == "" { - err := errors.New("Invalid godep configuration, ImportPath is required") + err := errors.New("invalid godep configuration, ImportPath is required") return nil, nil, err } if pkg.Rev == "" { - err := errors.New("Invalid godep configuration, Rev is required") + err := errors.New("invalid godep configuration, Rev is required") return nil, nil, err } diff --git a/cmd/dep/govend_importer.go b/cmd/dep/govend_importer.go index 8b3e68aad9..3dc0799c65 100644 --- a/cmd/dep/govend_importer.go +++ b/cmd/dep/govend_importer.go @@ -70,11 +70,11 @@ func (g *govendImporter) load(projectDir string) error { } yb, err := ioutil.ReadFile(y) if err != nil { - return errors.Wrapf(err, "Unable to read %s", y) + return errors.Wrapf(err, "unable to read %s", y) } err = yaml.Unmarshal(yb, &g.yaml) if err != nil { - return errors.Wrapf(err, "Unable to parse %s", y) + return errors.Wrapf(err, "unable to parse %s", y) } return nil } @@ -87,7 +87,7 @@ func (g *govendImporter) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, for _, pkg := range g.yaml.Imports { // Path must not be empty if pkg.Path == "" || pkg.Revision == "" { - return nil, nil, errors.New("Invalid govend configuration, path and rev are required") + return nil, nil, errors.New("invalid govend configuration, path and rev are required") } ip := importedPackage{ diff --git a/cmd/dep/vndr_importer.go b/cmd/dep/vndr_importer.go index 202808ecc3..911700a260 100644 --- a/cmd/dep/vndr_importer.go +++ b/cmd/dep/vndr_importer.go @@ -52,7 +52,7 @@ func (v *vndrImporter) loadVndrFile(dir string) error { f, err := os.Open(vndrFile(dir)) if err != nil { - return errors.Wrapf(err, "Unable to open %s", vndrFile(dir)) + return errors.Wrapf(err, "unable to open %s", vndrFile(dir)) } defer f.Close() @@ -81,12 +81,12 @@ func (v *vndrImporter) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, er for _, pkg := range v.packages { // Validate if pkg.importPath == "" { - err := errors.New("Invalid vndr configuration, import path is required") + err := errors.New("invalid vndr configuration: import path is required") return nil, nil, err } if pkg.reference == "" { - err := errors.New("Invalid vndr configuration, revision is required") + err := errors.New("invalid vndr configuration: revision is required") return nil, nil, err }