log.Logger api changes

cmd/dep/ensure.go

@@ -10,7 +10,6 @@ import (
 	"flag"
 	"fmt"
 	"go/build"
-	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -288,9 +287,9 @@ func (cmd *ensureCommand) runDefault(ctx *dep.Ctx, args []string, p *dep.Project
 			return sw.PrintPreparedActions(ctx.Out, ctx.Verbose)
 		}
 
-		logger := ctx.Err
-		if !ctx.Verbose {
-			logger = log.New(ioutil.Discard, "", 0)
+		var logger *log.Logger
+		if ctx.Verbose {
+			logger = ctx.Err
 		}
 		return errors.WithMessage(sw.Write(p.AbsRoot, sm, true, logger), "grouped write of manifest, lock and vendor")
 	}
@@ -312,9 +311,9 @@ func (cmd *ensureCommand) runDefault(ctx *dep.Ctx, args []string, p *dep.Project
 		return sw.PrintPreparedActions(ctx.Out, ctx.Verbose)
 	}
 
-	logger := ctx.Err
-	if !ctx.Verbose {
-		logger = log.New(ioutil.Discard, "", 0)
+	var logger *log.Logger
+	if ctx.Verbose {
+		logger = ctx.Err
 	}
 	return errors.Wrap(sw.Write(p.AbsRoot, sm, false, logger), "grouped write of manifest, lock and vendor")
 }
@@ -338,9 +337,9 @@ func (cmd *ensureCommand) runVendorOnly(ctx *dep.Ctx, args []string, p *dep.Proj
 		return sw.PrintPreparedActions(ctx.Out, ctx.Verbose)
 	}
 
-	logger := ctx.Err
-	if !ctx.Verbose {
-		logger = log.New(ioutil.Discard, "", 0)
+	var logger *log.Logger
+	if ctx.Verbose {
+		logger = ctx.Err
 	}
 	return errors.WithMessage(sw.Write(p.AbsRoot, sm, true, logger), "grouped write of manifest, lock and vendor")
 }
@@ -402,9 +401,9 @@ func (cmd *ensureCommand) runUpdate(ctx *dep.Ctx, args []string, p *dep.Project,
 		return sw.PrintPreparedActions(ctx.Out, ctx.Verbose)
 	}
 
-	logger := ctx.Err
-	if !ctx.Verbose {
-		logger = log.New(ioutil.Discard, "", 0)
+	var logger *log.Logger
+	if ctx.Verbose {
+		logger = ctx.Err
 	}
 	return errors.Wrap(sw.Write(p.AbsRoot, sm, false, logger), "grouped write of manifest, lock and vendor")
 }
@@ -702,9 +701,9 @@ func (cmd *ensureCommand) runAdd(ctx *dep.Ctx, args []string, p *dep.Project, sm
 		return sw.PrintPreparedActions(ctx.Out, ctx.Verbose)
 	}
 
-	logger := ctx.Err
-	if !ctx.Verbose {
-		logger = log.New(ioutil.Discard, "", 0)
+	var logger *log.Logger
+	if ctx.Verbose {
+		logger = ctx.Err
 	}
 	if err := errors.Wrap(sw.Write(p.AbsRoot, sm, true, logger), "grouped write of manifest, lock and vendor"); err != nil {
 		return err

cmd/dep/init.go

@@ -7,7 +7,6 @@ package main
 import (
 	"context"
 	"flag"
-	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -185,9 +184,9 @@ func (cmd *initCommand) Run(ctx *dep.Ctx, args []string) error {
 		return errors.Wrap(err, "init failed: unable to create a SafeWriter")
 	}
 
-	logger := ctx.Err
-	if !ctx.Verbose {
-		logger = log.New(ioutil.Discard, "", 0)
+	var logger *log.Logger
+	if ctx.Verbose {
+		logger = ctx.Err
 	}
 	if err := sw.Write(root, sm, !cmd.noExamples, logger); err != nil {
 		return errors.Wrap(err, "init failed: unable to write the manifest, lock and vendor directory to disk")

cmd/dep/prune.go

@@ -103,7 +103,10 @@ func pruneProject(p *dep.Project, sm gps.SourceManager, logger *log.Logger) erro
 	}
 	defer os.RemoveAll(td)
 
-	if err := gps.WriteDepTree(td, p.Lock, sm, gps.CascadingPruneOptions{DefaultOptions: gps.PruneNestedVendorDirs}, logger); err != nil {
+	onWrite := func(progress gps.WriteProgress) {
+		logger.Println(progress)
+	}
+	if err := gps.WriteDepTree(td, p.Lock, sm, gps.CascadingPruneOptions{DefaultOptions: gps.PruneNestedVendorDirs}, onWrite); err != nil {
 		return err
 	}
 

gps/example.go

@@ -54,7 +54,10 @@ func main() {
 		// If no failure, blow away the vendor dir and write a new one out,
 		// stripping nested vendor directories as we go.
 		os.RemoveAll(filepath.Join(root, "vendor"))
-		gps.WriteDepTree(filepath.Join(root, "vendor"), solution, sourcemgr, true)
+		pruneOpts := gps.CascadingPruneOptions{
+			DefaultOptions: gps.PruneNestedVendorDirs | gps.PruneUnusedPackages | gps.PruneGoTestFiles,
+		}
+		gps.WriteDepTree(filepath.Join(root, "vendor"), solution, sourcemgr, pruneOpts, nil)
 	}
 }
 

gps/prune.go

@@ -5,7 +5,6 @@
 package gps
 
 import (
-	"log"
 	"os"
 	"path/filepath"
 	"sort"
@@ -138,7 +137,7 @@ var (
 
 // PruneProject remove excess files according to the options passed, from
 // the lp directory in baseDir.
-func PruneProject(baseDir string, lp LockedProject, options PruneOptions, logger *log.Logger) error {
+func PruneProject(baseDir string, lp LockedProject, options PruneOptions) error {
 	fsState, err := deriveFilesystemState(baseDir)
 
 	if err != nil {

gps/prune_test.go

@@ -6,7 +6,6 @@ package gps
 
 import (
 	"io/ioutil"
-	"log"
 	"os"
 	"testing"
 
@@ -120,9 +119,8 @@ func TestPruneProject(t *testing.T) {
 	}
 
 	options := PruneNestedVendorDirs | PruneNonGoFiles | PruneGoTestFiles | PruneUnusedPackages
-	logger := log.New(ioutil.Discard, "", 0)
 
-	err := PruneProject(baseDir, lp, options, logger)
+	err := PruneProject(baseDir, lp, options)
 	if err != nil {
 		t.Fatal(err)
 	}

gps/solution.go

@@ -7,7 +7,6 @@ package gps
 import (
 	"context"
 	"fmt"
-	"log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -48,6 +47,22 @@ type solution struct {
 	solv Solver
 }
 
+// WriteProgress informs about the progress of WriteDepTree.
+type WriteProgress struct {
+	Count   int
+	Total   int
+	LP      LockedProject
+	Failure bool
+}
+
+func (p WriteProgress) String() string {
+	msg := "Wrote"
+	if p.Failure {
+		msg = "Failed to write"
+	}
+	return fmt.Sprintf("(%d/%d) %s %s@%s", p.Count, p.Total, msg, p.LP.Ident(), p.LP.Version())
+}
+
 const concurrentWriters = 16
 
 // WriteDepTree takes a basedir, a Lock and a RootPruneOptions and exports all
@@ -58,7 +73,9 @@ const concurrentWriters = 16
 //
 // It requires a SourceManager to do the work. Prune options are read from the
 // passed manifest.
-func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOptions, logger *log.Logger) error {
+//
+// If onWrite is not nil, it will be called after each project write. Calls are ordered and atomic.
+func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOptions, onWrite func(WriteProgress)) error {
 	if l == nil {
 		return fmt.Errorf("must provide non-nil Lock to WriteDepTree")
 	}
@@ -95,7 +112,7 @@ func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOpt
 					return errors.Wrapf(err, "failed to export %s", projectRoot)
 				}
 
-				err := PruneProject(to, p, co.PruneOptionsFor(ident.ProjectRoot), logger)
+				err := PruneProject(to, p, co.PruneOptionsFor(ident.ProjectRoot))
 				if err != nil {
 					return errors.Wrapf(err, "failed to prune %s", projectRoot)
 				}
@@ -105,18 +122,20 @@ func WriteDepTree(basedir string, l Lock, sm SourceManager, co CascadingPruneOpt
 
 			switch err {
 			case context.Canceled, context.DeadlineExceeded:
-				// Don't log "secondary" errors.
+				// Don't report "secondary" errors.
 			default:
-				msg := "Wrote"
-				if err != nil {
-					msg = "Failed to write"
+				if onWrite != nil {
+					// Increment and call atomically to prevent re-ordering.
+					cnt.Lock()
+					cnt.i++
+					onWrite(WriteProgress{
+						Count:   cnt.i,
+						Total:   len(lps),
+						LP:      p,
+						Failure: err != nil,
+					})
+					cnt.Unlock()
 				}
-
-				// Log and increment atomically to prevent re-ordering.
-				cnt.Lock()
-				cnt.i++
-				logger.Printf("(%d/%d) %s %s@%s\n", cnt.i, len(lps), msg, p.Ident(), p.Version())
-				cnt.Unlock()
 			}
 
 			return err

gps/solution_test.go

@@ -16,10 +16,6 @@ import (
 	"github.com/golang/dep/internal/test"
 )
 
-func discardLogger() *log.Logger {
-	return log.New(ioutil.Discard, "", 0)
-}
-
 var basicResult solution
 
 func pi(n string) ProjectIdentifier {
@@ -109,12 +105,12 @@ func testWriteDepTree(t *testing.T) {
 	}
 
 	// nil lock/result should err immediately
-	err = WriteDepTree(tmp, nil, sm, defaultCascadingPruneOptions(), discardLogger())
+	err = WriteDepTree(tmp, nil, sm, defaultCascadingPruneOptions(), nil)
 	if err == nil {
 		t.Errorf("Should error if nil lock is passed to WriteDepTree")
 	}
 
-	err = WriteDepTree(tmp, r, sm, defaultCascadingPruneOptions(), discardLogger())
+	err = WriteDepTree(tmp, r, sm, defaultCascadingPruneOptions(), nil)
 	if err != nil {
 		t.Errorf("Unexpected error while creating vendor tree: %s", err)
 	}
@@ -157,7 +153,6 @@ func BenchmarkCreateVendorTree(b *testing.B) {
 	}
 
 	if clean {
-		logger := discardLogger()
 		b.ResetTimer()
 		b.StopTimer()
 		exp := path.Join(tmp, "export")
@@ -166,7 +161,7 @@ func BenchmarkCreateVendorTree(b *testing.B) {
 			// ease manual inspection
 			os.RemoveAll(exp)
 			b.StartTimer()
-			err = WriteDepTree(exp, r, sm, defaultCascadingPruneOptions(), logger)
+			err = WriteDepTree(exp, r, sm, defaultCascadingPruneOptions(), nil)
 			b.StopTimer()
 			if err != nil {
 				b.Errorf("unexpected error after %v iterations: %s", i, err)

txn_writer.go

@@ -267,6 +267,8 @@ func (sw SafeWriter) validate(root string, sm gps.SourceManager) error {
 // 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 {
 	err := sw.validate(root, sm)
 	if err != nil {
@@ -319,7 +321,13 @@ func (sw *SafeWriter) Write(root string, sm gps.SourceManager, examples bool, lo
 	}
 
 	if sw.writeVendor {
-		err = gps.WriteDepTree(filepath.Join(td, "vendor"), sw.lock, sm, sw.pruneOptions, logger)
+		var onWrite func(gps.WriteProgress)
+		if logger != nil {
+			onWrite = func(progress gps.WriteProgress) {
+				logger.Println(progress)
+			}
+		}
+		err = gps.WriteDepTree(filepath.Join(td, "vendor"), sw.lock, sm, sw.pruneOptions, onWrite)
 		if err != nil {
 			return errors.Wrap(err, "error while writing out vendor tree")
 		}