Remove InputsDigest, add InputImports

First steps towards a better in-sync checking system that does not rely
on a merge-conflict-prone explicit hash digest.

Author: sdboyer

gps/selection.go

@@ -119,7 +119,7 @@ func (s *selection) getRequiredPackagesIn(id ProjectIdentifier) map[string]int {
 	return uniq
 }
 
-// Suppress unused warning.
+// Suppress unused linting warning.
 var _ = (*selection)(nil).getSelectedPackagesIn
 
 // Compute a list of the unique packages within the given ProjectIdentifier that
@@ -141,6 +141,29 @@ func (s *selection) getSelectedPackagesIn(id ProjectIdentifier) map[string]int {
 	return uniq
 }
 
+// getProjectImportMap extracts the set of package imports from the used
+// packages in each selected project.
+func (s *selection) getProjectImportMap() map[ProjectRoot]map[string]struct{} {
+	importMap := make(map[ProjectRoot]map[string]struct{})
+	for _, edges := range s.deps {
+		for _, edge := range edges {
+			var curmap map[string]struct{}
+			if imap, has := importMap[edge.depender.id.ProjectRoot]; !has {
+				curmap = make(map[string]struct{})
+			} else {
+				curmap = imap
+			}
+
+			for _, pl := range edge.dep.pl {
+				curmap[pl] = struct{}{}
+			}
+			importMap[edge.depender.id.ProjectRoot] = curmap
+		}
+	}
+
+	return importMap
+}
+
 func (s *selection) getConstraint(id ProjectIdentifier) Constraint {
 	deps, exists := s.deps[id.ProjectRoot]
 	if !exists || len(deps) == 0 {

gps/solution_test.go

@@ -39,15 +39,6 @@ func init() {
 		},
 	}
 	basicResult.analyzerInfo = (naiveAnalyzer{}).Info()
-
-	// Just in case something needs punishing, kubernetes offers a complex,
-	// real-world set of dependencies, and this revision is known to work.
-	/*
-		_ = atom{
-			id: pi("github.com/kubernetes/kubernetes"),
-			v:  NewVersion("1.0.0").Pair(Revision("528f879e7d3790ea4287687ef0ab3f2a01cc2718")),
-		}
-	*/
 }
 
 func testWriteDepTree(t *testing.T) {

gps/solver.go

@@ -1363,18 +1363,16 @@ func pa2lp(pa atom, pkgs map[string]struct{}) LockedProject {
 		panic("unreachable")
 	}
 
-	lp.pkgs = make([]string, len(pkgs))
-	k := 0
+	lp.pkgs = make([]string, 0, len(pkgs))
 
 	pr := string(pa.id.ProjectRoot)
 	trim := pr + "/"
 	for pkg := range pkgs {
 		if pkg == string(pa.id.ProjectRoot) {
-			lp.pkgs[k] = "."
+			lp.pkgs = append(lp.pkgs, ".")
 		} else {
-			lp.pkgs[k] = strings.TrimPrefix(pkg, trim)
+			lp.pkgs = append(lp.pkgs, strings.TrimPrefix(pkg, trim))
 		}
-		k++
 	}
 	sort.Strings(lp.pkgs)
 

lock.go

@@ -6,7 +6,6 @@ package dep
 
 import (
 	"bytes"
-	"encoding/hex"
 	"io"
 	"sort"
 
@@ -26,7 +25,6 @@ type Lock struct {
 
 // SolveMeta holds solver meta data.
 type SolveMeta struct {
-	InputsDigest    []byte
 	AnalyzerName    string
 	AnalyzerVersion int
 	SolverName      string
@@ -39,11 +37,11 @@ type rawLock struct {
 }
 
 type solveMeta struct {
-	InputsDigest    string `toml:"inputs-digest"`
-	AnalyzerName    string `toml:"analyzer-name"`
-	AnalyzerVersion int    `toml:"analyzer-version"`
-	SolverName      string `toml:"solver-name"`
-	SolverVersion   int    `toml:"solver-version"`
+	AnalyzerName    string   `toml:"analyzer-name"`
+	AnalyzerVersion int      `toml:"analyzer-version"`
+	SolverName      string   `toml:"solver-name"`
+	SolverVersion   int      `toml:"solver-version"`
+	InputImports    []string `toml:"input-imports"`
 }
 
 type rawLockedProject struct {
@@ -77,15 +75,11 @@ func fromRawLock(raw rawLock) (*Lock, error) {
 		P: make([]gps.LockedProject, len(raw.Projects)),
 	}
 
-	l.SolveMeta.InputsDigest, err = hex.DecodeString(raw.SolveMeta.InputsDigest)
-	if err != nil {
-		return nil, errors.Errorf("invalid hash digest in lock's memo field")
-	}
-
 	l.SolveMeta.AnalyzerName = raw.SolveMeta.AnalyzerName
 	l.SolveMeta.AnalyzerVersion = raw.SolveMeta.AnalyzerVersion
 	l.SolveMeta.SolverName = raw.SolveMeta.SolverName
 	l.SolveMeta.SolverVersion = raw.SolveMeta.SolverVersion
+	l.SolveMeta.InputImports = raw.SolveMeta.InputImports
 
 	for i, ld := range raw.Projects {
 		r := gps.Revision(ld.Revision)
@@ -106,15 +100,17 @@ func fromRawLock(raw rawLock) (*Lock, error) {
 			ProjectRoot: gps.ProjectRoot(ld.Name),
 			Source:      ld.Source,
 		}
-		l.P[i] = gps.NewLockedProject(id, v, ld.Packages)
+		l.P[i] = gps.NewLockedProject(id, v, ld.Packages, ld.Imports)
 	}
 
 	return l, nil
 }
 
 // InputsDigest returns the hash of inputs which produced this lock data.
+//
+// TODO(sdboyer) remove, this is now deprecated
 func (l *Lock) InputsDigest() []byte {
-	return l.SolveMeta.InputsDigest
+	return nil
 }
 
 // Projects returns the list of LockedProjects contained in the lock data.
@@ -140,7 +136,6 @@ func (l *Lock) HasProjectWithRoot(root gps.ProjectRoot) bool {
 func (l *Lock) toRaw() rawLock {
 	raw := rawLock{
 		SolveMeta: solveMeta{
-			InputsDigest:    hex.EncodeToString(l.SolveMeta.InputsDigest),
 			AnalyzerName:    l.SolveMeta.AnalyzerName,
 			AnalyzerVersion: l.SolveMeta.AnalyzerVersion,
 			SolverName:      l.SolveMeta.SolverName,
@@ -182,13 +177,12 @@ func (l *Lock) MarshalTOML() ([]byte, error) {
 // LockFromSolution converts a gps.Solution to dep's representation of a lock.
 //
 // Data is defensively copied wherever necessary to ensure the resulting *lock
-// shares no memory with the original lock.
+// shares no memory with the input solution.
 func LockFromSolution(in gps.Solution) *Lock {
-	h, p := in.InputsDigest(), in.Projects()
+	p := in.Projects()
 
 	l := &Lock{
 		SolveMeta: SolveMeta{
-			InputsDigest:    make([]byte, len(h)),
 			AnalyzerName:    in.AnalyzerName(),
 			AnalyzerVersion: in.AnalyzerVersion(),
 			SolverName:      in.SolverName(),
@@ -197,7 +191,6 @@ func LockFromSolution(in gps.Solution) *Lock {
 		P: make([]gps.LockedProject, len(p)),
 	}
 
-	copy(l.SolveMeta.InputsDigest, h)
 	copy(l.P, p)
 	return l
 }

lock_test.go

@@ -28,9 +28,6 @@ func TestReadLock(t *testing.T) {
 
 	b, _ := hex.DecodeString("2252a285ab27944a4d7adcba8dbd03980f59ba652f12db39fa93b927c345593e")
 	want := &Lock{
-		SolveMeta: SolveMeta{
-			InputsDigest: b,
-		},
 		P: []gps.LockedProject{
 			gps.NewLockedProject(
 				gps.ProjectIdentifier{ProjectRoot: gps.ProjectRoot("github.com/golang/dep")},
@@ -54,9 +51,6 @@ func TestReadLock(t *testing.T) {
 
 	b, _ = hex.DecodeString("2252a285ab27944a4d7adcba8dbd03980f59ba652f12db39fa93b927c345593e")
 	want = &Lock{
-		SolveMeta: SolveMeta{
-			InputsDigest: b,
-		},
 		P: []gps.LockedProject{
 			gps.NewLockedProject(
 				gps.ProjectIdentifier{ProjectRoot: gps.ProjectRoot("github.com/golang/dep")},
@@ -79,9 +73,6 @@ func TestWriteLock(t *testing.T) {
 	want := h.GetTestFileString(golden)
 	memo, _ := hex.DecodeString("2252a285ab27944a4d7adcba8dbd03980f59ba652f12db39fa93b927c345593e")
 	l := &Lock{
-		SolveMeta: SolveMeta{
-			InputsDigest: memo,
-		},
 		P: []gps.LockedProject{
 			gps.NewLockedProject(
 				gps.ProjectIdentifier{ProjectRoot: gps.ProjectRoot("github.com/golang/dep")},
@@ -110,9 +101,6 @@ func TestWriteLock(t *testing.T) {
 	want = h.GetTestFileString(golden)
 	memo, _ = hex.DecodeString("2252a285ab27944a4d7adcba8dbd03980f59ba652f12db39fa93b927c345593e")
 	l = &Lock{
-		SolveMeta: SolveMeta{
-			InputsDigest: memo,
-		},
 		P: []gps.LockedProject{
 			gps.NewLockedProject(
 				gps.ProjectIdentifier{ProjectRoot: gps.ProjectRoot("github.com/golang/dep")},

txn_writer.go

@@ -233,7 +233,9 @@ func formatLockDiff(diff gps.LockDiff) (string, error) {
 type VendorBehavior int
 
 const (
-	// VendorOnChanged indicates that the vendor directory should be written when the lock is new or changed.
+	// VendorOnChanged indicates that the vendor directory should be written
+	// when the lock is new or changed, or a project in vendor differs from its
+	// intended state.
 	VendorOnChanged VendorBehavior = iota
 	// VendorAlways forces the vendor directory to always be written.
 	VendorAlways
@@ -259,14 +261,14 @@ func (sw SafeWriter) validate(root string, sm gps.SourceManager) error {
 	return nil
 }
 
-// Write saves some combination of config yaml, lock, and a vendor tree.
-// root is the absolute path of root dir in which to write.
-// sm is only required if vendor is being written.
+// Write saves some combination of manifest, lock, and a vendor tree. root is
+// the absolute path of root dir in which to write. sm is only required if
+// vendor is being written.
 //
-// It first writes to a temp dir, then moves them in place if and only if all the write
-// operations succeeded. It also does its best to roll back if any moves fail.
-// This mostly guarantees that dep cannot exit with a partial write that would
-// leave an undefined state on disk.
+// It first writes to a temp dir, then moves them in place if and only if all
+// the write operations succeeded. It also does its best to roll back if any
+// moves fail. This mostly guarantees that dep cannot exit with a partial write
+// that would leave an undefined state on disk.
 //
 // If logger is not nil, progress will be logged after each project write.
 func (sw *SafeWriter) Write(root string, sm gps.SourceManager, examples bool, logger *log.Logger) error {