Testify, clean up, upgrade (#22)

Use testify for assertions, clean up go.mod, and upgrade everything.

Author: abhinav

.github/workflows/go.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Setup Go
       uses: actions/setup-go@v1
       with:
-        go-version: 1.16.x
+        go-version: 1.17.x
 
     - name: Checkout code
       uses: actions/checkout@v2
@@ -55,7 +55,7 @@ jobs:
     - name: Setup Go
       uses: actions/setup-go@v1
       with:
-        go-version: 1.16.x
+        go-version: 1.17.x
 
     - name: Checkout code
       uses: actions/checkout@v2

cmd/restack/main_test.go

@@ -2,11 +2,10 @@ package main
 
 import (
 	"bytes"
-	"errors"
-	"strings"
 	"testing"
 
 	"github.com/abhinav/restack/internal/testwriter"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestRun_Version(t *testing.T) {
@@ -15,14 +14,9 @@ func TestRun_Version(t *testing.T) {
 		Stdout: &stdout,
 		Stderr: testwriter.New(t),
 	}
-	err := run(&opts, []string{"-version"})
-	if err != nil {
-		t.Errorf("unexpected error: %v", err)
-	}
-
-	if stdout.Len() == 0 {
-		t.Errorf("stdout should contain version information")
-	}
+	assert.NoError(t, run(&opts, []string{"-version"}))
+	assert.NotEmpty(t, stdout.String(),
+		"stdout should contain version information")
 }
 
 func TestRun_CommandErrors(t *testing.T) {
@@ -50,13 +44,9 @@ func TestRun_CommandErrors(t *testing.T) {
 				Stderr: &stderr,
 			}
 
-			if err := run(opts, tt.give); !errors.Is(err, tt.want) {
-				t.Errorf("unexpected error: got %v, want %v", err, tt.want)
-			}
-
-			if stderr.Len() == 0 {
-				t.Errorf("stderr should contain usage")
-			}
+			assert.ErrorIs(t, run(opts, tt.give), tt.want)
+			assert.NotEmpty(t, stderr.String(),
+				"stderr should contain usage")
 		})
 	}
 }
@@ -85,10 +75,7 @@ func TestNewSetup_Errors(t *testing.T) {
 				Stdout: new(bytes.Buffer),
 				Stderr: new(bytes.Buffer),
 			}, tt.give)
-
-			if !strings.Contains(err.Error(), tt.want) {
-				t.Errorf("unexpected error: got %v, should contain %q", err, tt.want)
-			}
+			assert.Contains(t, err.Error(), tt.want)
 		})
 	}
 }
@@ -100,17 +87,9 @@ func TestNewSetup(t *testing.T) {
 		Stdout: &stdout,
 		Stderr: &stderr,
 	}, nil)
-	if err != nil {
-		t.Errorf("unexpected error: %v", err)
-	}
-
-	if stdout.Len() > 0 {
-		t.Errorf("stdout should be empty, got:\n%s", stdout.String())
-	}
-
-	if stderr.Len() > 0 {
-		t.Errorf("stderr should be empty, got:\n%s", stderr.String())
-	}
+	assert.NoError(t, err)
+	assert.Empty(t, stdout.String(), "stdout should be empty")
+	assert.Empty(t, stderr.String(), "stderr should be empty")
 }
 
 func TestNewEdit_EditorParsing(t *testing.T) {
@@ -178,21 +157,10 @@ func TestNewEdit_EditorParsing(t *testing.T) {
 				Stderr: &stderr,
 				Getenv: func(k string) string { return env[k] },
 			}, args)
-			if err != nil {
-				t.Errorf("unexpected error: %v", err)
-			}
-
-			if got.Editor != tt.want {
-				t.Errorf("unexpected editor %q, want %q", got.Editor, tt.want)
-			}
-
-			if stdout.Len() > 0 {
-				t.Errorf("stdout should be empty, got:\n%s", stdout.String())
-			}
-
-			if stderr.Len() > 0 {
-				t.Errorf("stderr should be empty, got:\n%s", stderr.String())
-			}
+			assert.NoError(t, err)
+			assert.Equal(t, tt.want, got.Editor, "unexpected editor")
+			assert.Empty(t, stdout.String(), "stdout should be empty")
+			assert.Empty(t, stderr.String(), "stderr should be empty")
 		})
 	}
 }
@@ -231,19 +199,12 @@ func TestNewEdit_FileParsing(t *testing.T) {
 			}, tt.args)
 
 			if tt.wantErr != nil {
-				if !errors.Is(err, tt.wantErr) {
-					t.Errorf("unexpected error: %v, want %v", err, tt.wantErr)
-				}
+				assert.ErrorIs(t, err, tt.wantErr)
 				return
 			}
 
-			if err != nil {
-				t.Errorf("unexpected error: %v", err)
-			}
-
-			if tt.want != got.Path {
-				t.Errorf("unexpected path %q, want %q", got.Path, tt.want)
-			}
+			assert.NoError(t, err)
+			assert.Equal(t, tt.want, got.Path, "unexpected path")
 		})
 	}
 }

edit_test.go

@@ -7,13 +7,14 @@ import (
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
-	"strings"
 	"testing"
 
 	"github.com/abhinav/restack/internal/editorfake"
 	"github.com/abhinav/restack/internal/iotest"
+	"github.com/abhinav/restack/internal/test"
 	"github.com/abhinav/restack/internal/testwriter"
-	"github.com/google/go-cmp/cmp"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 var _noop = "noop\n"
@@ -22,9 +23,9 @@ func TestEdit(t *testing.T) {
 	dir := iotest.TempDir(t, "edit")
 	file := filepath.Join(dir, "git-rebase-todo")
 
-	if err := ioutil.WriteFile(file, []byte(_noop), 0600); err != nil {
-		t.Fatalf("write temporary file: %v", err)
-	}
+	require.NoError(t,
+		ioutil.WriteFile(file, []byte(_noop), 0600),
+		"write temporary file")
 
 	restackerOutput := "x echo hello world"
 	restacker := fakeRestacker{
@@ -49,23 +50,17 @@ func TestEdit(t *testing.T) {
 		Stdout:    testwriter.New(t),
 		Stderr:    testwriter.New(t),
 	}).Run(ctx)
-
-	if err != nil {
-		t.Errorf("edit failed: %v", err)
-	}
+	require.NoError(t, err, "edit failed")
 
 	gotOutput, err := ioutil.ReadFile(file)
-	if err != nil {
-		t.Fatalf("read output: %v", err)
-	}
+	require.NoError(t, err, "read output")
 
-	if diff := cmp.Diff(editorOutput, string(gotOutput)); len(diff) > 0 {
-		t.Errorf("output mismatch: (-want, +got):\n%s", diff)
-	}
+	assert.Equal(t, editorOutput, string(gotOutput),
+		"output mismatch")
 }
 
 type fakeRestacker struct {
-	T *testing.T
+	T test.T
 
 	ran        bool
 	WantInput  string
@@ -74,27 +69,22 @@ type fakeRestacker struct {
 }
 
 func (r *fakeRestacker) VerifyRan() {
-	if !r.ran {
-		r.T.Errorf("restack never executed")
-	}
+	assert.True(r.T, r.ran, "restack never executed")
 }
 
 func (r *fakeRestacker) Restack(ctx context.Context, req *Request) error {
 	t := r.T
 	r.ran = true
 
 	gotInput, err := ioutil.ReadAll(req.From)
-	if err != nil {
-		t.Errorf("read input: %v", err)
+	if !assert.NoError(t, err, "read input") {
 		return err
 	}
 
-	if diff := cmp.Diff(r.WantInput, string(gotInput)); len(diff) > 0 {
-		t.Errorf("input mismatch: (-want, +got):\n%s", diff)
-	}
+	assert.Equal(t, r.WantInput, string(gotInput), "input mismatch")
 
-	if _, err := req.To.Write([]byte(r.GiveOutput)); err != nil {
-		t.Errorf("write output: %v", err)
+	_, err = req.To.Write([]byte(r.GiveOutput))
+	if !assert.NoError(t, err, "write output") {
 		return err
 	}
 
@@ -112,20 +102,18 @@ func TestEdit_MissingFile(t *testing.T) {
 		Stdout:    testwriter.New(t),
 		Stderr:    testwriter.New(t),
 	}).Run(ctx)
-	if err == nil {
-		t.Errorf("edit must fail")
-	}
-	errorMustContain(t, err, "no such file")
+	assert.Error(t, err, "edit must fail")
+	assert.Contains(t, err.Error(), "no such file")
 }
 
 // Handle failures in restacking the instructions.
 func TestEdit_RestackFailed(t *testing.T) {
 	dir := iotest.TempDir(t, "edit-restack-fail")
 	file := filepath.Join(dir, "git-rebase-todo")
 
-	if err := ioutil.WriteFile(file, []byte(_noop), 0600); err != nil {
-		t.Fatalf("write temporary file: %v", err)
-	}
+	require.NoError(t,
+		ioutil.WriteFile(file, []byte(_noop), 0600),
+		"write temporary file")
 
 	ctx := context.Background()
 	err := (&Edit{
@@ -140,20 +128,18 @@ func TestEdit_RestackFailed(t *testing.T) {
 		Stdout: testwriter.New(t),
 		Stderr: testwriter.New(t),
 	}).Run(ctx)
-	if err == nil {
-		t.Errorf("edit must fail")
-	}
-	errorMustContain(t, err, "great sadness")
+	assert.Error(t, err, "edit must fail")
+	assert.Contains(t, err.Error(), "great sadness")
 }
 
 // Handle non-zero codes from editors.
 func TestEdit_EditorFailed(t *testing.T) {
 	dir := iotest.TempDir(t, "edit-editor-fail")
 	file := filepath.Join(dir, "git-rebase-todo")
 
-	if err := ioutil.WriteFile(file, []byte{}, 0600); err != nil {
-		t.Fatalf("write temporary file: %v", err)
-	}
+	require.NoError(t,
+		ioutil.WriteFile(file, []byte{}, 0600),
+		"write temporary file")
 
 	restacker := fakeRestacker{T: t}
 	defer restacker.VerifyRan()
@@ -169,11 +155,8 @@ func TestEdit_EditorFailed(t *testing.T) {
 		Stdout:    testwriter.New(t),
 		Stderr:    testwriter.New(t),
 	}).Run(ctx)
-	if err == nil {
-		t.Fatalf("edit must fail")
-	}
-
-	errorMustContain(t, err, "exit status 1")
+	assert.Error(t, err, "edit must fail")
+	assert.Contains(t, err.Error(), "exit status 1")
 }
 
 // Handle failures in renaming if, for example, the file was deleted by the
@@ -182,9 +165,9 @@ func TestEdit_RenameFailed(t *testing.T) {
 	dir := iotest.TempDir(t, "edit-rename-fail")
 	file := filepath.Join(dir, "git-rebase-todo")
 
-	if err := ioutil.WriteFile(file, []byte{}, 0600); err != nil {
-		t.Fatalf("write temporary file: %v", err)
-	}
+	require.NoError(t,
+		ioutil.WriteFile(file, []byte{}, 0600),
+		"write temporary file")
 
 	restacker := fakeRestacker{T: t}
 	defer restacker.VerifyRan()
@@ -200,18 +183,7 @@ func TestEdit_RenameFailed(t *testing.T) {
 		Stdout:    testwriter.New(t),
 		Stderr:    testwriter.New(t),
 	}).Run(ctx)
-	if err == nil {
-		t.Fatalf("edit must fail")
-	}
-
-	errorMustContain(t, err, fmt.Sprintf("overwrite %q", file))
-	errorMustContain(t, err, "no such file or directory")
-}
-
-func errorMustContain(t *testing.T, err error, needle string) {
-	t.Helper()
-
-	if !strings.Contains(err.Error(), needle) {
-		t.Errorf("error %v must contain %q", err, needle)
-	}
+	assert.Error(t, err, "edit must fail")
+	assert.Contains(t, err.Error(), fmt.Sprintf("overwrite %q", file))
+	assert.Contains(t, err.Error(), "no such file or directory")
 }