111

Author: unknwon

blob.go

@@ -15,8 +15,8 @@ type Blob struct {
 	*TreeEntry
 }
 
-// Bytes reads and returns the content of the blob all at once in bytes. This
-// can be very slow and memory consuming for huge content.
+// Bytes reads and returns the content of the blob all at once in bytes. This can
+// be very slow and memory consuming for huge content.
 func (b *Blob) Bytes(ctx context.Context) ([]byte, error) {
 	stdout := new(bytes.Buffer)
 
@@ -25,14 +25,13 @@ func (b *Blob) Bytes(ctx context.Context) ([]byte, error) {
 		stdout.Grow(int(size))
 	}
 
-	if err := b.Pipeline(ctx, stdout); err != nil {
+	if err := b.Pipe(ctx, stdout); err != nil {
 		return nil, err
 	}
 	return stdout.Bytes(), nil
 }
 
-// Pipeline reads the content of the blob and pipes stdout to the supplied
-// io.Writer.
-func (b *Blob) Pipeline(ctx context.Context, stdout io.Writer) error {
+// Pipe reads the content of the blob and pipes stdout to the supplied io.Writer.
+func (b *Blob) Pipe(ctx context.Context, stdout io.Writer) error {
 	return pipe(ctx, b.parent.repo.path, []string{"show", b.id.String()}, nil, stdout)
 }

blob_test.go

@@ -48,9 +48,9 @@ This demo also includes an image with changes on a branch for examination of ima
 		assert.Equal(t, expOutput, string(p))
 	})
 
-	t.Run("get data with pipeline", func(t *testing.T) {
+	t.Run("get data with pipe", func(t *testing.T) {
 		stdout := new(bytes.Buffer)
-		err := blob.Pipeline(ctx, stdout)
+		err := blob.Pipe(ctx, stdout)
 		assert.Nil(t, err)
 		assert.Equal(t, expOutput, stdout.String())
 	})

command.go

@@ -7,6 +7,7 @@ package git
 import (
 	"bytes"
 	"context"
+	"errors"
 	"io"
 	"os"
 	"strconv"
@@ -26,22 +27,20 @@ type CommandOptions struct {
 // applied when the context does not already have a deadline.
 const DefaultTimeout = time.Minute
 
-// cmd builds a *run.Command for "git" with the given arguments, environment
-// variables and working directory. If the context does not already have a
-// deadline, DefaultTimeout will be applied automatically.
+// cmd builds a *run.Command for git with the given arguments, environment
+// variables and working directory. DefaultTimeout will be applied if the context
+// does not already have a deadline.
 func cmd(ctx context.Context, dir string, args []string, envs []string) (*run.Command, context.CancelFunc) {
 	cancel := func() {}
-
-	// Apply default timeout if the context doesn't already have a deadline.
 	if _, ok := ctx.Deadline(); !ok {
 		var timeoutCancel context.CancelFunc
 		ctx, timeoutCancel = context.WithTimeout(ctx, DefaultTimeout)
 		cancel = timeoutCancel
 	}
 
-	// run.Cmd joins all parts into a single string and then shell-parses it.
-	// We must quote each argument so that special characters (spaces, quotes,
-	// angle brackets, etc.) are preserved correctly.
+	// run.Cmd joins all parts into a single string and then shell-parses it. We must
+	// quote each argument so that special characters (spaces, quotes, angle
+	// brackets, etc.) are preserved correctly.
 	parts := make([]string, 0, 1+len(args))
 	parts = append(parts, "git")
 	for _, arg := range args {
@@ -59,9 +58,9 @@ func cmd(ctx context.Context, dir string, args []string, envs []string) (*run.Co
 }
 
 // exec executes a git command in the given directory and returns stdout as
-// bytes. Stderr is included in the error message on failure. If the command's
-// context does not have a deadline, DefaultTimeout will be applied
-// automatically. It returns an ErrExecTimeout if the execution was timed out.
+// bytes. Stderr is included in the error message on failure. DefaultTimeout will
+// be applied if the context does not already have a deadline. It returns
+// ErrExecTimeout if the execution was timed out.
 func exec(ctx context.Context, dir string, args []string, envs []string) ([]byte, error) {
 	c, cancel := cmd(ctx, dir, args, envs)
 	defer cancel()
@@ -71,7 +70,7 @@ func exec(ctx context.Context, dir string, args []string, envs []string) ([]byte
 		logBuf = new(bytes.Buffer)
 		logBuf.Grow(512)
 		defer func() {
-			logf(dir, args, logBuf.Bytes())
+			log(dir, args, logBuf.Bytes())
 		}()
 	}
 
@@ -81,8 +80,8 @@ func exec(ctx context.Context, dir string, args []string, envs []string) ([]byte
 	stdout := new(bytes.Buffer)
 	err := c.StdOut().Run().Stream(stdout)
 
-	// Capture (partial) stdout for logging even on error, so failed commands
-	// produce a useful log entry rather than an empty one.
+	// Capture (partial) stdout for logging even on error, so failed commands produce
+	// a useful log entry rather than an empty one.
 	if logOutput != nil {
 		data := stdout.Bytes()
 		limit := len(data)
@@ -102,7 +101,7 @@ func exec(ctx context.Context, dir string, args []string, envs []string) ([]byte
 }
 
 // pipe executes a git command in the given directory, streaming stdout to the
-// given writer.
+// given io.Writer.
 func pipe(ctx context.Context, dir string, args []string, envs []string, stdout io.Writer) error {
 	c, cancel := cmd(ctx, dir, args, envs)
 	defer cancel()
@@ -119,7 +118,7 @@ func pipe(ctx context.Context, dir string, args []string, envs []string, stdout
 		}
 
 		defer func() {
-			logf(dir, args, buf.Bytes())
+			log(dir, args, buf.Bytes())
 		}()
 	}
 
@@ -138,8 +137,8 @@ func committerEnvs(committer *Signature) []string {
 	}
 }
 
-// logf logs a git command execution with optional output.
-func logf(dir string, args []string, output []byte) {
+// log logs a git command execution with its output.
+func log(dir string, args []string, output []byte) {
 	cmdStr := "git"
 	if len(args) > 0 {
 		quoted := make([]string, len(args))
@@ -153,9 +152,9 @@ func logf(dir string, args []string, output []byte) {
 		cmdStr = "git " + strings.Join(quoted, " ")
 	}
 	if len(dir) == 0 {
-		log("%s\n%s", cmdStr, output)
+		logf("%s\n%s", cmdStr, output)
 	} else {
-		log("%s: %s\n%s", dir, cmdStr, output)
+		logf("%s: %s\n%s", dir, cmdStr, output)
 	}
 }
 
@@ -194,7 +193,7 @@ func mapContextError(err error, ctx context.Context) error {
 		return err
 	}
 	if ctxErr := ctx.Err(); ctxErr != nil {
-		if ctxErr == context.DeadlineExceeded {
+		if errors.Is(ctxErr, context.DeadlineExceeded) {
 			return ErrExecTimeout
 		}
 		return ctxErr
@@ -205,6 +204,7 @@ func mapContextError(err error, ctx context.Context) error {
 // isExitStatus reports whether err represents a specific process exit status
 // code, using the run.ExitCoder interface provided by sourcegraph/run.
 func isExitStatus(err error, code int) bool {
-	exitCoder, ok := err.(run.ExitCoder)
+	var exitCoder run.ExitCoder
+	ok := errors.As(err, &exitCoder)
 	return ok && exitCoder.ExitCode() == code
 }

commit.go

@@ -154,7 +154,7 @@ func (c *Commit) isImageFile(ctx context.Context, blob *Blob, err error) (bool,
 		N: int64(buf.Cap()),
 	}
 
-	err = blob.Pipeline(ctx, stdout)
+	err = blob.Pipe(ctx, stdout)
 	if err != nil {
 		return false, err
 	}

git.go

@@ -29,7 +29,7 @@ func SetPrefix(prefix string) {
 	logPrefix = prefix
 }
 
-func log(format string, args ...interface{}) {
+func logf(format string, args ...interface{}) {
 	if logOutput == nil {
 		return
 	}

git_test.go

@@ -83,7 +83,7 @@ func Test_log(t *testing.T) {
 			var buf bytes.Buffer
 			SetOutput(&buf)
 
-			log(test.format, test.args...)
+			logf(test.format, test.args...)
 			assert.Equal(t, test.expOutput, buf.String())
 		})
 	}

repo_commit.go

@@ -85,7 +85,7 @@ func (r *Repository) CatFileCommit(ctx context.Context, rev string, opts ...CatF
 
 	cache, ok := r.cachedCommits.Get(rev)
 	if ok {
-		log("Cached commit hit: %s", rev)
+		logf("Cached commit hit: %s", rev)
 		return cache.(*Commit), nil
 	}
 

repo_tag.go

@@ -55,7 +55,7 @@ l:
 func (r *Repository) getTag(ctx context.Context, id *SHA1) (*Tag, error) {
 	t, ok := r.cachedTags.Get(id.String())
 	if ok {
-		log("Cached tag hit: %s", id)
+		logf("Cached tag hit: %s", id)
 		return t.(*Tag), nil
 	}
 

repo_tree.go

@@ -117,7 +117,7 @@ func (r *Repository) LsTree(ctx context.Context, treeID string, opts ...LsTreeOp
 
 	cache, ok := r.cachedTrees.Get(treeID)
 	if ok {
-		log("Cached tree hit: %s", treeID)
+		logf("Cached tree hit: %s", treeID)
 		return cache.(*Tree), nil
 	}