Break up TestExecute into subtests

core/execute_test.go

@@ -6,19 +6,19 @@ import (
 )
 
 func TestExecute(t *testing.T) {
-	assertLen := func(items []Item, length int) {
+	assertLen := func(t *testing.T, items []Item, length int) {
 		t.Helper()
 		if len(items) != length {
 			t.Fatalf("Expected %d items, got %d", length, len(items))
 		}
 	}
-	assertNil := func(err error) {
+	assertNil := func(t *testing.T, err error) {
 		t.Helper()
 		if err != nil {
 			t.Fatal(err)
 		}
 	}
-	assertNotNil := func(err error) {
+	assertNotNil := func(t *testing.T, err error) {
 		t.Helper()
 		if err == nil {
 			t.Fatal("expected err")
@@ -29,138 +29,165 @@ func TestExecute(t *testing.T) {
 		return item, err
 	}
 
+	t.Run("Noop", func(t *testing.T) {
 		res, err := execute([]string{"true"})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 0)
+		assertLen(t, res, 0)
+	})
 
-	// Exit with error code
+	t.Run("ExitWithErrorCode", func(t *testing.T) {
-	res, err = execute([]string{"false"})
+		res, err := execute([]string{"false"})
-	assertNotNil(err)
+		assertNotNil(t, err)
-	assertLen(res, 0)
+		assertLen(t, res, 0)
+	})
 
-	res, err = execute([]string{"sh", "-c", "exit 22"})
+	t.Run("ExitWithSpecificErrorCode", func(t *testing.T) {
-	assertNotNil(err)
+		res, err := execute([]string{"sh", "-c", "exit 22"})
-	assertLen(res, 0)
+		assertNotNil(t, err)
+		assertLen(t, res, 0)
+	})
 
-	// Timeout
+	t.Run("Timeout", func(t *testing.T) {
-	res, _, err = Execute("_", []string{"sleep", "10"}, nil, nil, "", time.Millisecond, nil)
+		res, _, err := Execute("_", []string{"sleep", "10"}, nil, nil, "", time.Millisecond, nil)
-	assertNotNil(err)
+		assertNotNil(t, err)
-	assertLen(res, 0)
+		assertLen(t, res, 0)
+	})
 
-	// Returning items
+	t.Run("ReturningItems", func(t *testing.T) {
-	res, err = execute([]string{"jq", "-cn", `{id: "foo"}`})
+		res, err := execute([]string{"jq", "-cn", `{id: "foo"}`})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Id != "foo" {
 			t.Fatal("jq -cn test failed")
 		}
+	})
 
-	// Read from stdin
+	t.Run("ReadFromStdin", func(t *testing.T) {
-	res, _, err = Execute("_", []string{"jq", "-cR", `{id: .}`}, nil, nil, "bar", time.Minute, nil)
+		res, _, err := Execute("_", []string{"jq", "-cR", `{id: .}`}, nil, nil, "bar", time.Minute, nil)
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Id != "bar" {
 			t.Fatal("jq -cR test failed")
 		}
+	})
 
-	// Set env
+	t.Run("SetEnv", func(t *testing.T) {
-	res, _, err = Execute("_", []string{"jq", "-cn", `{id: env.HELLO}`}, []string{"HELLO=baz"}, nil, "", time.Minute, nil)
+		res, _, err := Execute("_", []string{"jq", "-cn", `{id: env.HELLO}`}, []string{"HELLO=baz"}, nil, "", time.Minute, nil)
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Id != "baz" {
 			t.Fatal("jq -cn env test failed")
 		}
-
+	})
-	// With logging on stderr
+	t.Run("StderrLogging", func(t *testing.T) {
-	res, err = execute([]string{"sh", "-c", `echo 1>&2 Hello; jq -cn '{id: "box"}'; echo 1>&2 World`})
+		res, err := execute([]string{"sh", "-c", `echo 1>&2 Hello; jq -cn '{id: "box"}'; echo 1>&2 World`})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Id != "box" {
 			t.Fatal("stderr test failed")
 		}
+	})
 
-	// Unsupported item field is silently discarded
+	t.Run("UnknownFieldIgnored", func(t *testing.T) {
-	res, err = execute([]string{"jq", "-cn", `{id: "test", unknownField: "what is this"}`})
+		res, err := execute([]string{"jq", "-cn", `{id: "test", unknownField: "what is this"}`})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
+	})
 
-	// Field with incorrect type fails
+	t.Run("IncorrectIdType", func(t *testing.T) {
-	res, err = execute([]string{"jq", "-cn", `{id: ["list"]}`})
+		res, err := execute([]string{"jq", "-cn", `{id: ["list"]}`})
-	assertNotNil(err)
+		assertNotNil(t, err)
-	assertLen(res, 0)
+		assertLen(t, res, 0)
+	})
 
-	res, err = execute([]string{"jq", "-cn", `{id: "test", time: "0"}`})
+	t.Run("IncorrectTimeType", func(t *testing.T) {
-	assertNotNil(err)
+		res, err := execute([]string{"jq", "-cn", `{id: "test", time: "0"}`})
-	assertLen(res, 0)
+		assertNotNil(t, err)
+		assertLen(t, res, 0)
+	})
 
-	res, err = execute([]string{"jq", "-cn", `{id: null}`})
+	t.Run("NullId", func(t *testing.T) {
-	assertNotNil(err)
+		res, err := execute([]string{"jq", "-cn", `{id: null}`})
-	assertLen(res, 0)
+		assertNotNil(t, err)
+		assertLen(t, res, 0)
+	})
 
-	// Items with duplicate ids is not a fetch error, but it will fail to update
+	// TODO maybe this *should* be an Execute error, via a map[string]bool
-	res, err = execute([]string{"jq", "-cn", `["a", "a"] | .[] | {id: .}`})
+	t.Run("DuplicateItemIds", func(t *testing.T) {
-	assertNil(err)
+		res, err := execute([]string{"jq", "-cn", `["a", "a"] | .[] | {id: .}`})
-	assertLen(res, 2)
+		assertNil(t, err)
+		assertLen(t, res, 2)
+	})
 
-	// Action keys are detected even with empty values
+	t.Run("ActionNullValueOk", func(t *testing.T) {
-	res, err = execute([]string{"jq", "-cn", `{id: "test", action: {"hello": null}}`})
+		res, err := execute([]string{"jq", "-cn", `{id: "test", action: {"hello": null}}`})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Action["hello"] == nil {
 			t.Fatal("missing hello action")
 		}
 		if res[0].Action["goodbye"] != nil {
 			t.Fatal("nonexistent action should key to nil in Action")
 		}
+	})
 
-	res, err = execute([]string{"jq", "-cn", `{id: "test", action: {"hello": ""}}`})
+	t.Run("ActionEmptyStringOk", func(t *testing.T) {
-	assertNil(err)
+		res, err := execute([]string{"jq", "-cn", `{id: "test", action: {"hello": ""}}`})
-	assertLen(res, 1)
+		assertNil(t, err)
+		assertLen(t, res, 1)
 		if res[0].Action["hello"] == nil {
 			t.Fatal("missing hello action")
 		}
+	})
 
-	res, err = execute([]string{"jq", "-cn", `{id: "test", action: {"hello": []}}`})
+	t.Run("ActionEmptyArrayOk", func(t *testing.T) {
-	assertNil(err)
+		res, err := execute([]string{"jq", "-cn", `{id: "test", action: {"hello": []}}`})
-	assertLen(res, 1)
+		assertNil(t, err)
+		assertLen(t, res, 1)
 		if res[0].Action["hello"] == nil {
 			t.Fatal("missing hello action")
 		}
+	})
 
-	res, err = execute([]string{"jq", "-cn", `{id: "test", action: {"hello": {}}}`})
+	t.Run("ActionEmptyObjectOk", func(t *testing.T) {
-	assertNil(err)
+		res, err := execute([]string{"jq", "-cn", `{id: "test", action: {"hello": {}}}`})
-	assertLen(res, 1)
+		assertNil(t, err)
+		assertLen(t, res, 1)
 		if res[0].Action["hello"] == nil {
 			t.Fatal("missing hello action")
 		}
+	})
 
-	// Read state
+	t.Run("ReadState", func(t *testing.T) {
 		argv := []string{"sh", "-c", `cat $STATE_PATH | jq -cR '{id: "greeting", title: .} | .title = "Hello " + .title'`}
-	res, _, err = Execute("_", argv, nil, []byte("world"), "", time.Minute, nil)
+		res, _, err := Execute("_", argv, nil, []byte("world"), "", time.Minute, nil)
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Title != "Hello world" {
 			t.Fatalf("expected 'Hello world' from read state, got '%s'", res[0].Title)
 		}
+	})
 
-	// Write state
+	t.Run("WriteState", func(t *testing.T) {
-	argv = []string{"sh", "-c", `printf "Hello world" > $STATE_PATH; jq -cn '{id: "test"}'`}
+		argv := []string{"sh", "-c", `printf "Hello world" > $STATE_PATH; jq -cn '{id: "test"}'`}
 		res, newState, err := Execute("_", argv, nil, nil, "", time.Minute, nil)
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if string(newState) != "Hello world" {
 			t.Fatalf("expected 'Hello world' from write state, got %s", string(newState))
 		}
+	})
 
-	// Postprocessing function
+	t.Run("PostprocessSetTtl", func(t *testing.T) {
-	argv = []string{"jq", "-cn", `{id: "foo"}`}
+		argv := []string{"jq", "-cn", `{id: "foo"}`}
-	res, _, err = Execute("_", argv, nil, nil, "", time.Minute, func(item Item) Item {
+		res, _, err := Execute("_", argv, nil, nil, "", time.Minute, func(item Item) Item {
 			item.Ttl = 123456
 			return item
 		})
-	assertNil(err)
+		assertNil(t, err)
-	assertLen(res, 1)
+		assertLen(t, res, 1)
 		if res[0].Ttl != 123456 {
 			t.Fatalf("expected ttl to be set to 123456, got %d", res[0].Ttl)
 		}
+	})
 }