Replace some tests with testscripts

Author: bitfield

cmd/gotestdox/main.go

@@ -4,17 +4,8 @@ import (
 	"os"
 
 	"github.com/bitfield/gotestdox"
-	"github.com/mattn/go-isatty"
 )
 
 func main() {
-	td := gotestdox.NewTestDoxer()
-	if isatty.IsTerminal(os.Stdin.Fd()) {
-		td.ExecGoTest(os.Args[1:])
-	} else {
-		td.Filter()
-	}
-	if !td.OK {
-		os.Exit(1)
-	}
+	os.Exit(gotestdox.Main())
 }

go.mod

@@ -6,9 +6,11 @@ require (
 	github.com/fatih/color v1.13.0
 	github.com/google/go-cmp v0.5.7
 	github.com/mattn/go-isatty v0.0.14
+	github.com/rogpeppe/go-internal v1.9.0
 )
 
 require (
 	github.com/mattn/go-colorable v0.1.9 // indirect
+	github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e // indirect
 	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
 )

go.sum

@@ -7,6 +7,10 @@ github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
 github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e h1:aoZm08cpOy4WuID//EZDgcC4zIxODThtZNPirFr42+A=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
+github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=

gotestdox.go

@@ -11,6 +11,7 @@ import (
 	"strings"
 
 	"github.com/fatih/color"
+	"github.com/mattn/go-isatty"
 )
 
 // TestDoxer holds the state and config associated with a particular invocation
@@ -167,3 +168,16 @@ func ParseJSON(line string) (Event, error) {
 	}
 	return event, nil
 }
+
+func Main() int {
+	td := NewTestDoxer()
+	if isatty.IsTerminal(os.Stdin.Fd()) {
+		td.ExecGoTest(os.Args[1:])
+	} else {
+		td.Filter()
+	}
+	if !td.OK {
+		return 1
+	}
+	return 0
+}

gotestdox_test.go

@@ -1,19 +1,31 @@
 package gotestdox_test
 
 import (
-	"bytes"
 	"fmt"
 	"io"
 	"log"
 	"os"
-	"strings"
 	"testing"
 
 	"github.com/bitfield/gotestdox"
 	"github.com/fatih/color"
 	"github.com/google/go-cmp/cmp"
+	"github.com/rogpeppe/go-internal/testscript"
 )
 
+func TestMain(m *testing.M) {
+	os.Exit(testscript.RunMain(m, map[string]func() int{
+		"gotestdox": gotestdox.Main,
+	}))
+}
+
+func TestGotestdoxProducesCorrectOutputWhen(t *testing.T) {
+	t.Parallel()
+	testscript.Run(t, testscript.Params{
+		Dir: "testdata/script",
+	})
+}
+
 func TestParseJSON_ReturnsValidDataForValidJSON(t *testing.T) {
 	t.Parallel()
 	input := `{"Time":"2022-02-28T15:53:43.532326Z","Action":"pass","Package":"github.com/bitfield/script","Test":"TestFindFilesInNonexistentPathReturnsError","Elapsed":0.12}`
@@ -165,163 +177,6 @@ func TestNewTestDoxer_ReturnsTestdoxerWithStandardIOStreams(t *testing.T) {
 	}
 }
 
-func TestFilterSetsOKToTrueIfThereAreNoTestFailures(t *testing.T) {
-	t.Parallel()
-	data, err := os.Open("testdata/passing_tests.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: io.Discard,
-		Stderr: io.Discard,
-	}
-	td.Filter()
-	if !td.OK {
-		t.Error("not OK")
-	}
-}
-
-func TestFilterSetsOKToFalseIfAnyTestFails(t *testing.T) {
-	t.Parallel()
-	data, err := os.Open("testdata/failing_tests.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: io.Discard,
-		Stderr: io.Discard,
-	}
-	td.Filter()
-	if td.OK {
-		t.Error("got OK")
-	}
-}
-
-func TestFilterSkipsIrrelevantEvents(t *testing.T) {
-	t.Parallel()
-	data, err := os.Open("testdata/passing_tests.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	buf := &bytes.Buffer{}
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: buf,
-		Stderr: io.Discard,
-	}
-	td.Filter()
-	if strings.Contains(buf.String(), "Example") {
-		t.Error("irrelevant event (Example)")
-	}
-}
-
-func TestFilterKeepsTrackOfCurrentPackage(t *testing.T) {
-	t.Parallel()
-	data, err := os.Open("testdata/packages.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	buf := &bytes.Buffer{}
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: buf,
-		Stderr: io.Discard,
-	}
-	td.Filter()
-	if strings.Count(buf.String(), "a:") > 1 {
-		t.Error("want package a to be shown only once")
-	}
-}
-
-func TestFilterOrdersTestsByPrettifiedName(t *testing.T) {
-	data, err := os.Open("testdata/unordered_tests.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	buf := &bytes.Buffer{}
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: buf,
-		Stderr: io.Discard,
-	}
-	color.NoColor = true
-	td.Filter()
-	want := "p:\n ✔ A (0.00s)\n x B (0.00s)\n ✔ C (0.00s)\n\n"
-	got := buf.String()
-	if !cmp.Equal(want, got) {
-		t.Error(cmp.Diff(want, got))
-	}
-}
-
-func TestFilterHandlesOutOfOrderPackageEvents(t *testing.T) {
-	data, err := os.Open("testdata/multi_packages.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer data.Close()
-	buf := &bytes.Buffer{}
-	td := gotestdox.TestDoxer{
-		Stdin:  data,
-		Stdout: buf,
-		Stderr: io.Discard,
-	}
-	color.NoColor = true
-	td.Filter()
-	want := "p:\n ✔ A (0.00s)\n x B (0.00s)\n ✔ C (0.00s)\n\nq:\n ✔ A (0.00s)\n ✔ B (0.00s)\n\n"
-	got := buf.String()
-	if !cmp.Equal(want, got) {
-		t.Error(cmp.Diff(want, got))
-	}
-}
-
-func TestFilterSetsOKToFalseOnParsingError(t *testing.T) {
-	t.Parallel()
-	td := gotestdox.TestDoxer{
-		Stdin:  strings.NewReader("invalid"),
-		Stdout: io.Discard,
-		Stderr: io.Discard,
-	}
-	td.Filter()
-	if td.OK {
-		t.Error("got OK")
-	}
-}
-
-func TestExecGoTest_SetsOKToTrueWhenTestsPass(t *testing.T) {
-	t.Parallel()
-	path := newTempTestPath(t, passingTest)
-	td := gotestdox.TestDoxer{
-		Stdin:  strings.NewReader("invalid"),
-		Stdout: io.Discard,
-		Stderr: io.Discard,
-	}
-	td.ExecGoTest([]string{path})
-	if !td.OK {
-		t.Error("want ok")
-	}
-}
-
-func TestExecGoTest_SetsOKToFalseWhenTestsFail(t *testing.T) {
-	t.Parallel()
-	path := newTempTestPath(t, failingTest)
-	td := gotestdox.TestDoxer{
-		Stdin:  strings.NewReader("invalid"),
-		Stdout: io.Discard,
-		Stderr: io.Discard,
-	}
-	td.ExecGoTest([]string{path})
-	if td.OK {
-		t.Error("want not ok")
-	}
-}
-
 func TestExecGoTest_SetsOKToFalseWhenCommandErrors(t *testing.T) {
 	t.Parallel()
 	td := gotestdox.TestDoxer{
@@ -334,30 +189,9 @@ func TestExecGoTest_SetsOKToFalseWhenCommandErrors(t *testing.T) {
 	}
 }
 
-var (
-	preamble    = "package dummy\nimport \"testing\"\nfunc TestDummy(t *testing.T)"
-	passingTest = preamble + "{}"
-	failingTest = preamble + "{t.FailNow()}"
-)
-
-func newTempTestPath(t *testing.T, data string) (path string) {
-	t.Helper()
-	testDir := t.TempDir()
-	err := os.WriteFile(testDir+"/go.mod", []byte("module dummy"), os.ModePerm)
-	if err != nil {
-		t.Fatal(err)
-	}
-	path = testDir + "/dummy_test.go"
-	err = os.WriteFile(path, []byte(data), os.ModePerm)
-	if err != nil {
-		t.Fatal(err)
-	}
-	return path
-}
-
 func ExampleTestDoxer_Filter() {
 	td := gotestdox.NewTestDoxer()
-	data, err := os.Open("testdata/small_passing_tests.txt")
+	data, err := os.Open("testdata/example.json")
 	if err != nil {
 		panic(err)
 	}