feat(go): Manifest strategies

Author: elldritch

analyzers/golang/analyze.go

@@ -2,7 +2,13 @@ package golang
 
 import (
 	"github.com/fossas/fossa-cli/analyzers/golang/resolver"
+	"github.com/fossas/fossa-cli/buildtools/dep"
+	"github.com/fossas/fossa-cli/buildtools/gdm"
+	"github.com/fossas/fossa-cli/buildtools/glide"
 	"github.com/fossas/fossa-cli/buildtools/gocmd"
+	"github.com/fossas/fossa-cli/buildtools/godep"
+	"github.com/fossas/fossa-cli/buildtools/govendor"
+	"github.com/fossas/fossa-cli/buildtools/vndr"
 	"github.com/fossas/fossa-cli/errutil"
 	"github.com/fossas/fossa-cli/log"
 	"github.com/fossas/fossa-cli/module"
@@ -25,20 +31,54 @@ func (a *Analyzer) Analyze(m module.Module) (module.Module, error) {
 	// Read lockfiles to get revisions.
 	var r resolver.Resolver
 	switch a.Options.Strategy {
-	// Read revisions from a tool manifest at a specified location.
-	// TODO: implement these strategies.
 	case "manifest:dep":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = dep.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 	case "manifest:gdm":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = gdm.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 	case "manifest:glide":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = glide.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 	case "manifest:godep":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = godep.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 	case "manifest:govendor":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = govendor.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 	case "manifest:vndr":
-		return m, errutil.ErrNotImplemented
+		if a.Options.LockfilePath == "" {
+			return m, errors.New("manifest strategy specified without lockfile path")
+		}
+		r, err = vndr.FromFile(a.Options.LockfilePath)
+		if err != nil {
+			return m, err
+		}
 
 	// Resolve revisions by traversing the local $GOPATH and calling the package's
 	// VCS.

buildtools/dep/dep.go

@@ -49,7 +49,7 @@ func New(dirname string) (Lockfile, error) {
 	if !ok {
 		return Lockfile{}, errors.New("directory does not use dep")
 	}
-	lockfile, err := ReadRaw(filepath.Join(dirname, "Gopkg.lock"))
+	lockfile, err := FromFile(filepath.Join(dirname, "Gopkg.lock"))
 	if err != nil {
 		return Lockfile{}, err
 	}
@@ -98,23 +98,8 @@ func UsedIn(dirname string) (bool, error) {
 	return false, nil
 }
 
-// Read returns the contents of a dep project.
-func Read(dirname string) ([]Project, error) {
-	return ReadFile(filepath.Join(dirname, "Gopkg.lock"))
-}
-
-// ReadFile returns the contents of a dep lockfile.
-func ReadFile(filename string) ([]Project, error) {
-	var lockfile Lockfile
-	err := files.ReadTOML(&lockfile, filename)
-	if err != nil {
-		return nil, err
-	}
-	return lockfile.Projects, nil
-}
-
-// ReadRaw reads a raw Lockfile from a Gopkg.lock file.
-func ReadRaw(filename string) (Lockfile, error) {
+// FromFile reads a raw Lockfile from a Gopkg.lock file.
+func FromFile(filename string) (Lockfile, error) {
 	var lockfile Lockfile
 	err := files.ReadTOML(&lockfile, filename)
 	if err != nil {

buildtools/gdm/gdm.go

@@ -1,3 +1,4 @@
+// Package gdm implements a Go package resolver for the gdm tool.
 package gdm
 
 import (
@@ -7,7 +8,7 @@ import (
 	"github.com/fossas/fossa-cli/files"
 )
 
-// New constructs a gdm lockfile.
+// New constructs a gdm lockfile from a project directory.
 func New(dirname string) (gpm.Lockfile, error) {
 	ok, err := UsedIn(dirname)
 	if err != nil {
@@ -17,15 +18,20 @@ func New(dirname string) (gpm.Lockfile, error) {
 		return nil, errors.New("directory does not use gdm")
 	}
 
-	lockfile, err := gpm.New(dirname, "Godeps")
+	lockfile, err := FromFile(dirname, "Godeps")
 	if err != nil {
 		return nil, err
 	}
 
 	return lockfile, nil
 }
 
-// UsedIn checks whether gdm is used correctly within a project folder.
+// UsedIn checks whether gdm is used correctly within a project directory.
 func UsedIn(dirname string) (bool, error) {
 	return files.Exists(dirname, "Godeps")
 }
+
+// FromFile constructs a gdm lockfile from a specific file.
+func FromFile(pathElems ...string) (gpm.Lockfile, error) {
+	return gpm.FromFile(pathElems...)
+}

buildtools/glide/glide.go

@@ -52,7 +52,7 @@ func New(dirname string) (Lockfile, error) {
 	if !ok {
 		return Lockfile{}, errors.New("directory does not use glide")
 	}
-	lockfile, err := ReadRaw(filepath.Join(dirname, "glide.lock"))
+	lockfile, err := FromFile(filepath.Join(dirname, "glide.lock"))
 	if err != nil {
 		return Lockfile{}, err
 	}
@@ -112,23 +112,8 @@ func UsedIn(dirname string) (bool, error) {
 	return false, nil
 }
 
-// Read returns the contents of a glide project.
-func Read(dirname string) ([]Import, error) {
-	return ReadFile(filepath.Join(dirname, "glide.lock"))
-}
-
-// ReadFile returns the contents of a glide lockfile.
-func ReadFile(filename string) ([]Import, error) {
-	var lockfile Lockfile
-	err := files.ReadYAML(&lockfile, filename)
-	if err != nil {
-		return nil, err
-	}
-	return lockfile.Imports, nil
-}
-
-// ReadRaw reads a raw Lockfile from a glide.lock file.
-func ReadRaw(filename string) (Lockfile, error) {
+// FromFile reads a raw Lockfile from a glide.lock file.
+func FromFile(filename string) (Lockfile, error) {
 	var lockfile Lockfile
 	err := files.ReadYAML(&lockfile, filename)
 	if err != nil {

buildtools/godep/godep.go

@@ -45,7 +45,7 @@ func New(dirname string) (Lockfile, error) {
 	if !ok {
 		return Lockfile{}, errors.New("directory does not use godep")
 	}
-	lockfile, err := ReadRaw(filepath.Join(dirname, "Godeps", "Godeps.json"))
+	lockfile, err := FromFile(filepath.Join(dirname, "Godeps", "Godeps.json"))
 	if err != nil {
 		return Lockfile{}, err
 	}
@@ -71,23 +71,8 @@ func UsedIn(dirname string) (bool, error) {
 	return files.Exists(dirname, "Godeps", "Godeps.json")
 }
 
-// Read returns the contents of a godep project.
-func Read(dirname string) ([]Package, error) {
-	return ReadFile(filepath.Join(dirname, "Godeps", "Godeps.json"))
-}
-
-// ReadFile returns the contents of a godep lockfile.
-func ReadFile(filename string) ([]Package, error) {
-	var lockfile Lockfile
-	err := files.ReadJSON(&lockfile, filename)
-	if err != nil {
-		return nil, err
-	}
-	return lockfile.Deps, nil
-}
-
-// ReadRaw reads a raw Lockfile from a Godeps/Godeps.json file.
-func ReadRaw(filename string) (Lockfile, error) {
+// FromFile reads a raw Lockfile from a Godeps/Godeps.json file.
+func FromFile(filename string) (Lockfile, error) {
 	var lockfile Lockfile
 	err := files.ReadJSON(&lockfile, filename)
 	if err != nil {

buildtools/govendor/govendor.go

@@ -53,7 +53,7 @@ func New(dirname string) (Lockfile, error) {
 	if !ok {
 		return Lockfile{}, errors.New("directory does not use govendor")
 	}
-	lockfile, err := ReadRaw(filepath.Join(dirname, "vendor", "vendor.json"))
+	lockfile, err := FromFile(filepath.Join(dirname, "vendor", "vendor.json"))
 	if err != nil {
 		return Lockfile{}, err
 	}
@@ -79,23 +79,8 @@ func UsedIn(dirname string) (bool, error) {
 	return files.Exists(dirname, "vendor", "vendor.json")
 }
 
-// Read returns the contents of a govendor project.
-func Read(dirname string) ([]Package, error) {
-	return ReadFile(filepath.Join(dirname, "vendor", "vendor.json"))
-}
-
-// ReadFile returns the contents of a govendor lockfile.
-func ReadFile(filename string) ([]Package, error) {
-	var lockfile Lockfile
-	err := files.ReadJSON(&lockfile, filename)
-	if err != nil {
-		return nil, err
-	}
-	return lockfile.Package, nil
-}
-
-// ReadRaw reads a raw Lockfile from a vendor/vendor.json file.
-func ReadRaw(filename string) (Lockfile, error) {
+// FromFile reads a raw Lockfile from a vendor/vendor.json file.
+func FromFile(filename string) (Lockfile, error) {
 	var lockfile Lockfile
 	err := files.ReadJSON(&lockfile, filename)
 	if err != nil {

buildtools/gpm/gpm.go

@@ -37,10 +37,10 @@ func (l Lockfile) ResolveStrict(importpath string) (pkg.Import, error) {
 	return rev, nil
 }
 
-// New reads and parses a GPM-format lockfile.
-func New(pathElems ...string) (Lockfile, error) {
+// FromFile reads and parses a GPM-format lockfile.
+func FromFile(filename ...string) (Lockfile, error) {
 	// Read lockfile.
-	data, err := files.ReadFile(pathElems...)
+	data, err := files.ReadFile(filename...)
 	if err != nil {
 		return nil, err
 	}

buildtools/vndr/vndr.go

@@ -17,7 +17,7 @@ func New(dirname string) (gpm.Lockfile, error) {
 		return nil, errors.New("directory does not use vndr")
 	}
 
-	lockfile, err := gpm.New(dirname, "vendor.conf")
+	lockfile, err := gpm.FromFile(dirname, "vendor.conf")
 	if err != nil {
 		return nil, err
 	}
@@ -29,3 +29,7 @@ func New(dirname string) (gpm.Lockfile, error) {
 func UsedIn(dirname string) (bool, error) {
 	return files.Exists(dirname, "vendor.conf")
 }
+
+func FromFile(filename string) (gpm.Lockfile, error) {
+	return gpm.FromFile(filename)
+}

files/files.go

@@ -1,3 +1,4 @@
+// Package files implements utility routines for finding and reading files.
 package files
 
 import (

files/unmarshal.go

@@ -2,36 +2,44 @@ package files
 
 import (
 	"encoding/json"
+	"path/filepath"
 
 	"github.com/BurntSushi/toml"
 	yaml "gopkg.in/yaml.v2"
 
 	"github.com/fossas/fossa-cli/log"
 )
 
-func ReadJSON(v interface{}, path string) error {
-	return ReadUnmarshal(v, path, json.Unmarshal)
+// ReadJSON reads and unmarshals a file as if it contained JSON.
+func ReadJSON(v interface{}, pathElems ...string) error {
+	return ReadUnmarshal(json.Unmarshal, v, pathElems...)
 }
 
-func ReadTOML(v interface{}, path string) error {
-	return ReadUnmarshal(v, path, toml.Unmarshal)
+// ReadTOML reads and unmarshals a file as if it contained TOML.
+func ReadTOML(v interface{}, pathElems ...string) error {
+	return ReadUnmarshal(toml.Unmarshal, v, pathElems...)
 }
 
-func ReadYAML(v interface{}, path string) error {
-	return ReadUnmarshal(v, path, yaml.Unmarshal)
+// ReadYAML reads and unmarshals a file as if it contained YAML.
+func ReadYAML(v interface{}, pathElems ...string) error {
+	return ReadUnmarshal(yaml.Unmarshal, v, pathElems...)
 }
 
+// An UnmarshalFunc is a function for unmarshalling bytes into values.
 type UnmarshalFunc func(data []byte, v interface{}) error
 
-func ReadUnmarshal(v interface{}, path string, unmarshal UnmarshalFunc) error {
-	log.Logger.Debugf("Parsing file `%s`", path)
-	contents, err := ReadFile(path)
+// ReadUnmarshal reads a file and then unmarshals its contents using an
+// UnmarshalFunc.
+func ReadUnmarshal(unmarshal UnmarshalFunc, v interface{}, pathElems ...string) error {
+	filename := filepath.Join(pathElems...)
+	log.Logger.Debugf("Parsing file `%s`", filename)
+	contents, err := ReadFile(pathElems...)
 	if err != nil {
 		return err
 	}
 	err = unmarshal(contents, v)
 	if err != nil {
-		log.Logger.Debugf("Could not parse file `%s`: %s", path, err.Error())
+		log.Logger.Debugf("Could not parse file `%s`: %s", filename, err.Error())
 	}
 	return err
 }