godep: Import additional packages as required (#1640)

* godep: Import additional packages as required

In a godep manifest, entries in Packages are commonly used to specify extra
dependencies of a project, like tools (code generators for example).
Adding those same packages to dep's "required" entry achieves the same.

* importertest: Add ability to validate required entries

This mirrors what is done for ignored, as both fields are similar.

* godep: Add tests to validate godep conversion of Packages.

We expect to map non-local Packages in godep manifest to required entries in
dep.

Author: sigma

internal/importers/godep/importer.go

@@ -10,6 +10,7 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/golang/dep"
 	"github.com/golang/dep/gps"
@@ -31,7 +32,8 @@ func NewImporter(logger *log.Logger, verbose bool, sm gps.SourceManager) *Import
 }
 
 type godepJSON struct {
-	Imports []godepPackage `json:"Deps"`
+	Required []string       `json:"Packages"`
+	Imports  []godepPackage `json:"Deps"`
 }
 
 type godepPackage struct {
@@ -113,5 +115,14 @@ func (g *Importer) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock) {
 	}
 
 	g.ImportPackages(packages, true)
+	required := make([]string, 0, len(g.json.Required))
+	for _, req := range g.json.Required {
+		if !strings.HasPrefix(req, ".") { // ignore project packages
+			required = append(required, req)
+		}
+	}
+	if len(required) > 0 {
+		g.Manifest.Required = required
+	}
 	return g.Manifest, g.Lock
 }

internal/importers/godep/importer_test.go

@@ -77,6 +77,22 @@ func TestGodepConfig_Convert(t *testing.T) {
 				},
 			},
 		},
+		"package with requirements": {
+			importertest.TestCase{
+				WantRequired: []string{importertest.Project},
+			},
+			godepJSON{
+				Required: []string{importertest.Project},
+			},
+		},
+		"package with local requirements": {
+			importertest.TestCase{
+				WantRequired: nil,
+			},
+			godepJSON{
+				Required: []string{"./..."},
+			},
+		},
 	}
 
 	for name, testCase := range testCases {

internal/importers/importertest/testcase.go

@@ -27,6 +27,7 @@ type TestCase struct {
 	WantRevision              gps.Revision
 	WantVersion               string
 	WantIgnored               []string
+	WantRequired              []string
 	WantWarning               string
 }
 
@@ -71,6 +72,11 @@ func (tc TestCase) validate(manifest *dep.Manifest, lock *dep.Lock, output *byte
 			manifest.Ignored, tc.WantIgnored)
 	}
 
+	if !equalSlice(manifest.Required, tc.WantRequired) {
+		return errors.Errorf("unexpected set of required projects: \n\t(GOT) %#v \n\t(WNT) %#v",
+			manifest.Required, tc.WantRequired)
+	}
+
 	wantConstraintCount := 0
 	if tc.WantConstraint != "" {
 		wantConstraintCount = 1