Merge pull request #1952 from sdboyer/noverify

dep: Introduce noverify field to Gopkg.toml

Author: sdboyer

cmd/dep/check.go

@@ -33,6 +33,10 @@ can be disabled with -skip-lock and -skip-vendor, respectively.
 
 (See https://golang.github.io/dep/docs/ensure-mechanics.html#staying-in-sync for
 more information on what it means to be "in sync.")
+
+If your workflow necessitates that you modify the contents of vendor, you can
+force check to ignore hash mismatches on a per-project basis by naming
+project roots in Gopkg.toml's "noverify" list.
 `
 
 type checkCommand struct {
@@ -132,23 +136,42 @@ func (cmd *checkCommand) Run(ctx *dep.Ctx, args []string) error {
 			logger.Println()
 		}
 
+		noverify := make(map[string]bool)
+		for _, skip := range p.Manifest.NoVerify {
+			noverify[skip] = true
+		}
+
 		var vendorfail bool
 		// One full pass through, to see if we need to print the header, and to
 		// create an array of names to sort for deterministic output.
 		var ordered []string
 		for path, status := range statuses {
 			ordered = append(ordered, path)
-			if status != verify.NoMismatch {
+
+			switch status {
+			case verify.DigestMismatchInLock, verify.HashVersionMismatch, verify.EmptyDigestInLock:
+				// NoVerify applies only to these three cases.
+				if noverify[path] {
+					continue
+				}
+				fallthrough
+			case verify.NotInTree, verify.NotInLock:
 				fail = true
 				if !vendorfail {
 					vendorfail = true
 					logger.Println("# vendor is out of sync:")
 				}
+
 			}
 		}
 		sort.Strings(ordered)
 
 		for _, pr := range ordered {
+			var nvSuffix string
+			if noverify[pr] {
+				nvSuffix = "  (CHECK IGNORED: marked noverify in Gopkg.toml)"
+			}
+
 			status := statuses[pr]
 			switch status {
 			case verify.NotInTree:
@@ -158,19 +181,20 @@ func (cmd *checkCommand) Run(ctx *dep.Ctx, args []string) error {
 				if err != nil {
 					return errors.Wrap(err, "could not stat file that VerifyVendor claimed existed")
 				}
-
 				if fi.IsDir() {
 					logger.Printf("%s: unused project\n", pr)
 				} else {
 					logger.Printf("%s: orphaned file\n", pr)
 				}
 			case verify.DigestMismatchInLock:
-				logger.Printf("%s: hash of vendored tree didn't match digest in Gopkg.lock\n", pr)
+				logger.Printf("%s: hash of vendored tree not equal to digest in Gopkg.lock%s\n", pr, nvSuffix)
+			case verify.EmptyDigestInLock:
+				logger.Printf("%s: no digest in Gopkg.lock to compare against hash of vendored tree%s\n", pr, nvSuffix)
 			case verify.HashVersionMismatch:
 				// This will double-print if the hash version is zero, but
 				// that's a rare case that really only occurs before the first
 				// run with a version of dep >=0.5.0, so it's fine.
-				logger.Printf("%s: hash algorithm mismatch, want version %v\n", pr, verify.HashVersion)
+				logger.Printf("%s: hash algorithm mismatch, want version %v%s\n", pr, verify.HashVersion, nvSuffix)
 			}
 		}
 	}
@@ -185,12 +209,12 @@ func sprintLockUnsat(lsat verify.LockSatisfaction) string {
 	var buf bytes.Buffer
 	sort.Strings(lsat.MissingImports)
 	for _, missing := range lsat.MissingImports {
-		fmt.Fprintf(&buf, "%s: missing from input-imports\n", missing)
+		fmt.Fprintf(&buf, "%s: imported or required, but missing from Gopkg.lock's input-imports\n", missing)
 	}
 
 	sort.Strings(lsat.ExcessImports)
 	for _, excess := range lsat.ExcessImports {
-		fmt.Fprintf(&buf, "%s: in input-imports, but not imported\n", excess)
+		fmt.Fprintf(&buf, "%s: in Gopkg.lock's input-imports, but neither imported nor required\n", excess)
 	}
 
 	var ordered []string

cmd/dep/ensure.go

@@ -285,11 +285,7 @@ func (cmd *ensureCommand) runDefault(ctx *dep.Ctx, args []string, p *dep.Project
 		lock = dep.LockFromSolution(solution, p.Manifest.PruneOptions)
 	}
 
-	status, err := p.VerifyVendor()
-	if err != nil {
-		return errors.Wrap(err, "error while verifying vendor directory")
-	}
-	dw, err := dep.NewDeltaWriter(p.Lock, lock, status, p.Manifest.PruneOptions, filepath.Join(p.AbsRoot, "vendor"), cmd.vendorBehavior())
+	dw, err := dep.NewDeltaWriter(p, lock, cmd.vendorBehavior())
 	if err != nil {
 		return err
 	}
@@ -365,11 +361,7 @@ func (cmd *ensureCommand) runUpdate(ctx *dep.Ctx, args []string, p *dep.Project,
 		return handleAllTheFailuresOfTheWorld(err)
 	}
 
-	status, err := p.VerifyVendor()
-	if err != nil {
-		return errors.Wrap(err, "error while verifying vendor directory")
-	}
-	dw, err := dep.NewDeltaWriter(p.Lock, dep.LockFromSolution(solution, p.Manifest.PruneOptions), status, p.Manifest.PruneOptions, filepath.Join(p.AbsRoot, "vendor"), cmd.vendorBehavior())
+	dw, err := dep.NewDeltaWriter(p, dep.LockFromSolution(solution, p.Manifest.PruneOptions), cmd.vendorBehavior())
 	if err != nil {
 		return err
 	}
@@ -411,11 +403,6 @@ func (cmd *ensureCommand) runAdd(ctx *dep.Ctx, args []string, p *dep.Project, sm
 		}
 	}
 
-	//exrmap, err := p.GetDirectDependencyNames(sm)
-	//if err != nil {
-	//return err
-	//}
-
 	// Note: these flags are only partially used by the latter parts of the
 	// algorithm; rather, it relies on inference. However, they remain in their
 	// entirety as future needs may make further use of them, being a handy,
@@ -643,11 +630,7 @@ func (cmd *ensureCommand) runAdd(ctx *dep.Ctx, args []string, p *dep.Project, sm
 	}
 	sort.Strings(reqlist)
 
-	status, err := p.VerifyVendor()
-	if err != nil {
-		return errors.Wrap(err, "error while verifying vendor directory")
-	}
-	dw, err := dep.NewDeltaWriter(p.Lock, dep.LockFromSolution(solution, p.Manifest.PruneOptions), status, p.Manifest.PruneOptions, filepath.Join(p.AbsRoot, "vendor"), cmd.vendorBehavior())
+	dw, err := dep.NewDeltaWriter(p, dep.LockFromSolution(solution, p.Manifest.PruneOptions), cmd.vendorBehavior())
 	if err != nil {
 		return err
 	}

cmd/dep/integration_test.go

@@ -195,7 +195,12 @@ func testIntegration(name, relPath, wd string, run integration.RunFunc) func(t *
 			}
 		}
 
+		if err != nil {
+			t.Log(err)
+		}
+
 		// Check error raised in final command
+		testCase.CompareCmdFailure(err != nil)
 		testCase.CompareError(err, testProj.GetStderr())
 
 		if *test.UpdateGolden {

cmd/dep/testdata/harness_tests/check/excess_inputs/stdout.txt

@@ -1,3 +1,3 @@
 # Gopkg.lock is out of sync:
-github.com/sdboyer/deptest: in input-imports, but not imported
+github.com/sdboyer/deptest: in Gopkg.lock's input-imports, but neither imported nor required
 

cmd/dep/testdata/harness_tests/check/excess_inputs/testcase.json

@@ -2,6 +2,6 @@
   "commands": [
     ["check"]
   ],
-  "exit-code": 1,
+  "should-fail": true,
   "vendor-final": []
 }

cmd/dep/testdata/harness_tests/check/hash_mismatch/stdout.txt

@@ -1,2 +1,2 @@
 # vendor is out of sync:
-github.com/sdboyer/deptest: hash of vendored tree didn't match digest in Gopkg.lock
+github.com/sdboyer/deptest: hash of vendored tree not equal to digest in Gopkg.lock

cmd/dep/testdata/harness_tests/check/hash_mismatch/testcase.json

@@ -2,7 +2,7 @@
   "commands": [
     ["check"]
   ],
-  "exit-code": 1,
+  "should-fail": true,
   "vendor-final": [
     "github.com/sdboyer/deptest"
   ]

cmd/dep/testdata/harness_tests/check/hash_version_mismatch/testcase.json

@@ -2,7 +2,7 @@
   "commands": [
     ["check"]
   ],
-  "exit-code": 1,
+  "should-fail": true,
   "vendor-final": [
     "github.com/sdboyer/deptest"
   ]

cmd/dep/testdata/harness_tests/check/missing_and_excess/stdout.txt

@@ -1,4 +1,4 @@
 # Gopkg.lock is out of sync:
-github.com/sdboyer/deptestdos: missing from input-imports
-github.com/sdboyer/deptest: in input-imports, but not imported
+github.com/sdboyer/deptestdos: imported or required, but missing from Gopkg.lock's input-imports
+github.com/sdboyer/deptest: in Gopkg.lock's input-imports, but neither imported nor required
 

cmd/dep/testdata/harness_tests/check/missing_and_excess/testcase.json

@@ -2,6 +2,6 @@
   "commands": [
     ["check"]
   ],
-  "exit-code": 1,
+  "should-fail": true,
   "vendor-final": []
 }

cmd/dep/testdata/harness_tests/check/missing_inputs/stdout.txt

@@ -1,3 +1,3 @@
 # Gopkg.lock is out of sync:
-github.com/sdboyer/deptestdos: missing from input-imports
+github.com/sdboyer/deptestdos: imported or required, but missing from Gopkg.lock's input-imports
 

cmd/dep/testdata/harness_tests/check/missing_inputs/testcase.json

@@ -2,6 +2,6 @@
   "commands": [
     ["check"]
   ],
-  "exit-code": 1,
+  "should-fail": true,
   "vendor-final": []
 }

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/final/Gopkg.lock

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/final/Gopkg.toml

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/initial/Gopkg.lock

@@ -0,0 +1,12 @@
+// Copyright 2017 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	_ "github.com/sdboyer/deptest"
+)
+
+func main() {
+}

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/initial/Gopkg.toml

@@ -0,0 +1 @@
+github.com/sdboyer/deptest: hash of vendored tree not equal to digest in Gopkg.lock  (CHECK IGNORED: marked noverify in Gopkg.toml)

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/initial/main.go

@@ -0,0 +1,8 @@
+{
+  "commands": [
+    ["check"]
+  ],
+  "vendor-final": [
+    "github.com/sdboyer/deptest"
+  ]
+}

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/initial/vendor/github.com/sdboyer/deptest/deptest.go

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/stdout.txt

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_mismatch/testcase.json

@@ -0,0 +1,12 @@
+// Copyright 2017 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	_ "github.com/sdboyer/deptest"
+)
+
+func main() {
+}

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/final/Gopkg.lock

@@ -0,0 +1 @@
+github.com/sdboyer/deptest: hash algorithm mismatch, want version 1  (CHECK IGNORED: marked noverify in Gopkg.toml)

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/final/Gopkg.toml

@@ -0,0 +1,8 @@
+{
+  "commands": [
+    ["check"]
+  ],
+  "vendor-final": [
+    "github.com/sdboyer/deptest"
+  ]
+}

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/initial/Gopkg.lock

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/initial/Gopkg.toml

@@ -0,0 +1 @@
+noverify = ["github.com/sdboyer/deptest"]

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/initial/main.go

@@ -0,0 +1,12 @@
+// Copyright 2017 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	_ "github.com/sdboyer/deptestdos"
+)
+
+func main() {
+}

cmd/dep/testdata/harness_tests/check/noverify/hash_version_mismatch/initial/vendor/github.com/sdboyer/deptest/deptest.go

@@ -0,0 +1,4 @@
+# Gopkg.lock is out of sync:
+github.com/sdboyer/deptestdos: imported or required, but missing from Gopkg.lock's input-imports
+github.com/sdboyer/deptest: in Gopkg.lock's input-imports, but neither imported nor required
+