(maint) clean up linting issues (#77)

Author: TP Honey

.golangci.yml

@@ -59,7 +59,6 @@ linters:
   disable-all: true
   enable:
     - bodyclose
-    - deadcode
     - depguard
     - dogsled
     - errcheck
@@ -86,13 +85,11 @@ linters:
     - revive
     - rowserrcheck
     - staticcheck
-    - structcheck
     - stylecheck
     - typecheck
     - unconvert
     - unparam
     - unused
-    - varcheck
     - whitespace
 
   # don't enable:

cli/client/http.go

@@ -64,29 +64,29 @@ type HTTPClient struct {
 func (c *HTTPClient) Setup(ctx context.Context, in *api.SetupRequest) (*api.SetupResponse, error) {
 	path := "setup"
 	out := new(api.SetupResponse)
-	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) //nolint:bodyclose
 	return out, err
 }
 
 // Destroy will clean up the resources created
 func (c *HTTPClient) Destroy(ctx context.Context, in *api.DestroyRequest) (*api.DestroyResponse, error) {
 	path := "destroy"
 	out := new(api.DestroyResponse)
-	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) //nolint:bodyclose
 	return out, err
 }
 
 func (c *HTTPClient) StartStep(ctx context.Context, in *api.StartStepRequest) (*api.StartStepResponse, error) {
 	path := "start_step"
 	out := new(api.StartStepResponse)
-	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) //nolint:bodyclose
 	return out, err
 }
 
 func (c *HTTPClient) PollStep(ctx context.Context, in *api.PollStepRequest) (*api.PollStepResponse, error) {
 	path := "poll_step"
 	out := new(api.PollStepResponse)
-	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, http.MethodPost, in, out) //nolint:bodyclose
 	return out, err
 }
 
@@ -107,7 +107,7 @@ func (c *HTTPClient) RetryPollStep(ctx context.Context, in *api.PollStepRequest,
 				Trace("RetryPollStep: step completed")
 			return step, pollError
 		}
-		time.Sleep(time.Millisecond * 10) // nolint:gomnd
+		time.Sleep(time.Millisecond * 10) //nolint:gomnd
 	}
 }
 
@@ -151,7 +151,7 @@ func (c *HTTPClient) GetStepLogOutput(ctx context.Context, in *api.StreamOutputR
 func (c *HTTPClient) Health(ctx context.Context) (*api.HealthResponse, error) {
 	path := "healthz"
 	out := new(api.HealthResponse)
-	_, err := c.do(ctx, c.Endpoint+path, http.MethodGet, nil, out) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, http.MethodGet, nil, out) //nolint:bodyclose
 	return out, err
 }
 
@@ -177,12 +177,12 @@ func (c *HTTPClient) RetryHealth(ctx context.Context, timeout time.Duration) (*a
 				WithField("retry_num", i).WithError(err).Traceln("health check failed. Retrying")
 			lastErr = err
 		}
-		time.Sleep(time.Millisecond * 100) // nolint:gomnd
+		time.Sleep(time.Millisecond * 100) //nolint:gomnd
 	}
 }
 
 // do is a helper function that posts a http request with the input encoded and response decoded from json.
-func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interface{}) (*http.Response, error) { // nolint:unparam
+func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interface{}) (*http.Response, error) { //nolint:unparam
 	var r io.Reader
 
 	if in != nil {
@@ -204,7 +204,7 @@ func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interf
 		defer func() {
 			// drain the response body so we can reuse
 			// this connection.
-			if _, cerr := io.Copy(io.Discard, io.LimitReader(res.Body, 4096)); cerr != nil { // nolint:gomnd
+			if _, cerr := io.Copy(io.Discard, io.LimitReader(res.Body, 4096)); cerr != nil { //nolint:gomnd
 				logrus.WithError(cerr).Errorln("failed to drain response body")
 			}
 			res.Body.Close()
@@ -227,7 +227,7 @@ func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interf
 		return res, err
 	}
 
-	if res.StatusCode > 299 { // nolint:gomnd
+	if res.StatusCode > 299 { //nolint:gomnd
 		// if the response body includes an error message
 		// we should return the error string.
 		if len(body) != 0 {

engine/docker/convert.go

@@ -307,7 +307,7 @@ func isBindMount(volume *spec.Volume) bool {
 
 // returns true if the volume is in-memory.
 func isTempfs(volume *spec.Volume) bool {
-	return volume.EmptyDir != nil && volume.EmptyDir.Medium == "memory" // nolint:goconst
+	return volume.EmptyDir != nil && volume.EmptyDir.Medium == "memory" //nolint:goconst
 }
 
 // returns true if the volume is a data-volume.

engine/docker/docker.go

@@ -208,7 +208,7 @@ func (e *Docker) Run(ctx context.Context, pipelineConfig *spec.PipelineConfig, s
 // emulate docker commands
 //
 
-func (e *Docker) create(ctx context.Context, pipelineConfig *spec.PipelineConfig, step *spec.Step, output io.Writer) error { // nolint:gocyclo
+func (e *Docker) create(ctx context.Context, pipelineConfig *spec.PipelineConfig, step *spec.Step, output io.Writer) error { //nolint:gocyclo
 	// create pull options with encoded authorization credentials.
 	pullopts := types.ImagePullOptions{}
 	if step.Auth != nil {

engine/engine.go

@@ -59,7 +59,7 @@ func (e *Engine) Setup(ctx context.Context, pipelineConfig *spec.PipelineConfig)
 				continue
 			}
 
-			if err := os.MkdirAll(path, 0777); err != nil { // nolint:gomnd
+			if err := os.MkdirAll(path, 0777); err != nil { //nolint:gomnd
 				return errors.Wrap(err,
 					fmt.Sprintf("failed to create directory for host volume path: %s", path))
 			}

internal/docker/errors/errors_test.go

@@ -15,8 +15,8 @@ import (
 
 func TestTrimExtraInfo(t *testing.T) {
 	const (
-		before = `Error response from daemon: container encountered an error during CreateProcess: failure in a Windows system call: The system cannot find the file specified. (0x2) extra info: { "User":"ContainerUser" }` // nolint:lll
-		after  = `Error response from daemon: container encountered an error during CreateProcess: failure in a Windows system call: The system cannot find the file specified.`                                              // nolint:lll
+		before = `Error response from daemon: container encountered an error during CreateProcess: failure in a Windows system call: The system cannot find the file specified. (0x2) extra info: { "User":"ContainerUser" }` //nolint:lll
+		after  = `Error response from daemon: container encountered an error during CreateProcess: failure in a Windows system call: The system cannot find the file specified.`                                              //nolint:lll
 	)
 	errBefore := errors.New(before)
 	errAfter := TrimExtraInfo(errBefore)

internal/docker/jsonmessage/jsonmessage.go

@@ -12,6 +12,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"net/http"
 )
 
 type jsonError struct {
@@ -46,7 +47,7 @@ func Copy(in io.Reader, out io.Writer) error {
 		}
 
 		if jm.Error != nil {
-			if jm.Error.Code == 401 { // nolint:gomnd
+			if jm.Error.Code == http.StatusUnauthorized {
 				return fmt.Errorf("authentication is required")
 			}
 			fmt.Fprintf(out, "%s\n", jm.Error)

internal/docker/stdcopy/stdcopy.go

@@ -106,7 +106,7 @@ func NewStdWriter(w io.Writer, t StdType) io.Writer {
 // In other words: if `err` is non nil, it indicates a real underlying error.
 //
 // `written` will hold the total number of bytes written to `dstout` and `dsterr`.
-func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error) { // nolint:gocyclo
+func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error) { //nolint:gocyclo
 	var (
 		buf       = make([]byte, startingBufLen)
 		bufLen    = len(buf)
@@ -136,7 +136,7 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, err error)
 		// Check the first byte to know where to write
 		switch StdType(buf[stdWriterFdIndex]) {
 		case Stdin:
-			fallthrough // nolint:gocritic
+			fallthrough //nolint:gocritic
 		case Stdout:
 			// Write on stdout
 			out = dstout

livelog/livelog.go

@@ -169,7 +169,7 @@ func (b *Writer) Close() error {
 	if b.stop() {
 		// Flush anything waiting on a new line
 		if len(b.prev) > 0 {
-			b.Write([]byte("\n")) // nolint:errcheck
+			b.Write([]byte("\n")) //nolint:errcheck
 		}
 		b.flush()
 	}
@@ -277,7 +277,7 @@ func (b *Writer) Start() {
 func (b *Writer) checkErrInLogs() {
 	size := len(b.history)
 	// Check last 10 log lines for errors. TODO(Shubham): see if this can be made better
-	for idx := max(0, size-10); idx < size; idx++ { // nolint:gomnd
+	for idx := max(0, size-10); idx < size; idx++ { //nolint:gomnd
 		line := b.history[idx]
 		// Iterate over the nudges and see if we get a match
 		for _, n := range b.nudges {
@@ -295,7 +295,7 @@ func (b *Writer) checkErrInLogs() {
 
 // return back two byte arrays after splitting on last \n.
 // Eg: ABC\nDEF\nGH will return ABC\nDEF\n and GH
-func splitLast(p []byte) ([]byte, []byte) { // nolint:gocritic
+func splitLast(p []byte) ([]byte, []byte) { //nolint:gocritic
 	if !bytes.Contains(p, []byte("\n")) {
 		return p, []byte{} // If no \n is present, return the string itself
 	}

livelog/livelog_test.go

@@ -19,7 +19,7 @@ func TestLineWriterSingle(t *testing.T) {
 	w := New(client, "1", "1", nil)
 	w.SetInterval(time.Duration(0))
 	w.num = 4
-	w.Write([]byte("foo\nbar\n")) // nolint:errcheck
+	_, _ = w.Write([]byte("foo\nbar\n"))
 
 	a := w.pending
 	b := []*logstream.Line{

logstream/remote/http.go

@@ -53,7 +53,7 @@ func NewHTTPClient(endpoint, accountID, token string, indirectUpload, skipverify
 			Transport: &http.Transport{
 				Proxy: http.ProxyFromEnvironment,
 				TLSClientConfig: &tls.Config{
-					InsecureSkipVerify: true, // nolint:gosec
+					InsecureSkipVerify: true, //nolint:gosec
 				},
 			},
 		}
@@ -129,39 +129,39 @@ func (c *HTTPClient) uploadToRemoteStorage(ctx context.Context, key string, r io
 func (c *HTTPClient) uploadLink(ctx context.Context, key string) (*Link, error) {
 	path := fmt.Sprintf(uploadLinkEndpoint, c.AccountID, key)
 	out := new(Link)
-	backoff := createBackoff(60 * time.Second)                                // nolint:gomnd
-	_, err := c.retry(ctx, c.Endpoint+path, "POST", nil, out, false, backoff) // nolint:bodyclose
+	backoff := createBackoff(60 * time.Second)                                //nolint:gomnd
+	_, err := c.retry(ctx, c.Endpoint+path, "POST", nil, out, false, backoff) //nolint:bodyclose
 	return out, err
 }
 
 // uploadUsingLink takes in a reader and a link object and uploads directly to
 // remote storage.
 func (c *HTTPClient) uploadUsingLink(ctx context.Context, link string, r io.Reader) error {
-	backoff := createBackoff(60 * time.Second)                 // nolint:gomnd
-	_, err := c.retry(ctx, link, "PUT", r, nil, true, backoff) // nolint:bodyclose
+	backoff := createBackoff(60 * time.Second)                 //nolint:gomnd
+	_, err := c.retry(ctx, link, "PUT", r, nil, true, backoff) //nolint:bodyclose
 	return err
 }
 
 // Open opens the data stream.
 func (c *HTTPClient) Open(ctx context.Context, key string) error {
 	path := fmt.Sprintf(streamEndpoint, c.AccountID, key)
-	backoff := createBackoff(10 * time.Second)                                // nolint:gomnd
-	_, err := c.retry(ctx, c.Endpoint+path, "POST", nil, nil, false, backoff) // nolint:bodyclose
+	backoff := createBackoff(10 * time.Second)                                //nolint:gomnd
+	_, err := c.retry(ctx, c.Endpoint+path, "POST", nil, nil, false, backoff) //nolint:bodyclose
 	return err
 }
 
 // Close closes the data stream.
 func (c *HTTPClient) Close(ctx context.Context, key string) error {
 	path := fmt.Sprintf(streamEndpoint, c.AccountID, key)
-	_, err := c.do(ctx, c.Endpoint+path, "DELETE", nil, nil) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, "DELETE", nil, nil) //nolint:bodyclose
 	return err
 }
 
 // Write writes logs to the data stream.
 func (c *HTTPClient) Write(ctx context.Context, key string, lines []*logstream.Line) error {
 	path := fmt.Sprintf(streamEndpoint, c.AccountID, key)
 	l := convertLines(lines)
-	_, err := c.do(ctx, c.Endpoint+path, "PUT", &l, nil) // nolint:bodyclose
+	_, err := c.do(ctx, c.Endpoint+path, "PUT", &l, nil) //nolint:bodyclose
 	return err
 }
 
@@ -189,7 +189,7 @@ func (c *HTTPClient) retry(ctx context.Context, method, path string, in, out int
 			// 5xx's are typically not permanent errors and may
 			// relate to outages on the server side.
 
-			if res.StatusCode >= 500 { // nolint:gomnd
+			if res.StatusCode >= 500 { //nolint:gomnd
 				logrus.WithError(err).WithField("path", path).Warnln("http: log-service server error: reconnect and retry")
 				if duration == backoff.Stop {
 					return nil, err
@@ -236,7 +236,7 @@ func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interf
 		defer func() {
 			// drain the response body so we can reuse
 			// this connection.
-			if _, cerr := io.Copy(io.Discard, io.LimitReader(res.Body, 4096)); cerr != nil { // nolint:gomnd
+			if _, cerr := io.Copy(io.Discard, io.LimitReader(res.Body, 4096)); cerr != nil { //nolint:gomnd
 				logrus.WithError(cerr).Errorln("failed to drain response body")
 			}
 			res.Body.Close()
@@ -249,7 +249,7 @@ func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interf
 	// if the response body return no content we exit
 	// immediately. We do not read or unmarshal the response
 	// and we do not return an error.
-	if res.StatusCode == 204 { // nolint:gomnd
+	if res.StatusCode == 204 { //nolint:gomnd
 		return res, nil
 	}
 
@@ -259,7 +259,7 @@ func (c *HTTPClient) do(ctx context.Context, path, method string, in, out interf
 		return res, err
 	}
 
-	if res.StatusCode > 299 { // nolint:gomnd
+	if res.StatusCode > 299 { //nolint:gomnd
 		// if the response body includes an error message
 		// we should return the error string.
 		if len(body) != 0 {

logstream/replacer.go

@@ -29,9 +29,8 @@ func NewReplacer(w Writer, secrets []string) Writer {
 		for _, part := range strings.Split(secret, "\n") {
 			part = strings.TrimSpace(part)
 
-			// avoid masking empty or single character
-			// strings.
-			if len(part) < 2 { // nolint:gomnd
+			// avoid masking empty or single character strings.
+			if len(part) < 2 { //nolint:gomnd
 				continue
 			}
 

logstream/replacer_test.go

@@ -13,7 +13,7 @@ func TestReplace(t *testing.T) {
 
 	sw := &nopWriter{}
 	w := NewReplacer(&nopCloser{sw}, secrets)
-	w.Write([]byte("username octocat password correct-horse-batter-staple")) // nolint:errcheck
+	_, _ = w.Write([]byte("username octocat password correct-horse-batter-staple"))
 	w.Close()
 
 	if got, want := sw.data[0], "username octocat password **************"; got != want {
@@ -40,7 +40,7 @@ r9nicR5wDy2W
 
 	sw := &nopWriter{}
 	w := NewReplacer(&nopCloser{sw}, secrets)
-	w.Write([]byte(line)) // nolint:errcheck
+	_, _ = w.Write([]byte(line))
 	w.Close()
 
 	if got, want := sw.data[0], "> **************"; got != want {
@@ -61,7 +61,7 @@ func TestReplaceMultilineJson(t *testing.T) {
 
 	sw := &nopWriter{}
 	w := NewReplacer(&nopCloser{sw}, secrets)
-	w.Write([]byte(line)) // nolint:errcheck
+	_, _ = w.Write([]byte(line))
 	w.Close()
 
 	if got, want := sw.data[0], "{\n  **************\n}"; got != want {

pipeline/runtime/common.go

@@ -75,7 +75,7 @@ func fetchOutputVariables(outputFile string, out io.Writer) (map[string]string,
 	for s.Scan() {
 		line := s.Text()
 		sa := strings.Split(line, " ")
-		if len(sa) < 2 { // nolint:gomnd
+		if len(sa) < 2 { //nolint:gomnd
 			log.WithField("variable", sa[0]).Warnln("output variable does not exist")
 		} else {
 			outputs[sa[0]] = line[len(sa[0])+1:]
@@ -90,7 +90,6 @@ func fetchOutputVariables(outputFile string, out io.Writer) (map[string]string,
 
 // setTiEnvVariables sets the environment variables required for TI
 func setTiEnvVariables(step *spec.Step) {
-
 	config := pipeline.GetState().GetTIConfig()
 	if config == nil {
 		return

pipeline/runtime/run.go

@@ -44,7 +44,7 @@ func executeRunStep(ctx context.Context, engine *engine.Engine, r *api.StartStep
 
 	if len(r.OutputVars) > 0 {
 		if exited != nil && exited.Exited && exited.ExitCode == 0 {
-			outputs, err := fetchOutputVariables(outputFile, out) // nolint:govet
+			outputs, err := fetchOutputVariables(outputFile, out) //nolint:govet
 			if err != nil {
 				return exited, nil, err
 			}

pipeline/runtime/runtest.go

@@ -56,7 +56,7 @@ func executeRunTestStep(ctx context.Context, engine *engine.Engine, r *api.Start
 
 	if len(r.OutputVars) > 0 {
 		if exited != nil && exited.Exited && exited.ExitCode == 0 {
-			outputs, err := fetchOutputVariables(outputFile, out) // nolint:govet
+			outputs, err := fetchOutputVariables(outputFile, out) //nolint:govet
 			if err != nil {
 				return exited, nil, err
 			}