X-Git-Url: https://git.giacomolli.uk/onechat/blobdiff_plain/80e348724041a694002fc38f57e8868b9b9a2be9..c76d3832afce8da932860294d27bd167bf8a928c:/tools_test.go?ds=sidebyside

diff --git a/tools_test.go b/tools_test.go
index e1b19bb..3075cbf 100644
--- a/tools_test.go
+++ b/tools_test.go
@@ -29,6 +29,7 @@ func TestToolRunsAfterItsCallIsDurable(t *testing.T) {
 		"flush, marker absent",
 		"echo: done\n",
 	}, log.Events())
+
 	require.FileExists(t, filepath.Join(dir, "ran"))
 }
 
@@ -58,22 +59,22 @@ func TestShellRunsInTheWorkingDirectory(t *testing.T) {
 		output  string
 	}{
 		{
-			name:    "working directory",
+			name:    "runs in the configured working directory",
 			command: "pwd",
 			output:  dir + "\n",
 		},
 		{
-			name:    "error output and exit status",
+			name:    "returns both streams and the failed exit status",
 			command: "echo out; echo err >&2; exit 3",
 			output:  "out\nerr\n\n[exit status 3]",
 		},
 		{
-			name:    "no output",
+			name:    "marks an empty successful output",
 			command: "true",
 			output:  "(no output)",
 		},
 		{
-			name:    "no input",
+			name:    "closes standard input without user input",
 			command: "cat",
 			output:  "(no output)",
 		},
@@ -139,7 +140,7 @@ func TestZoomAndDateReadTheChat(t *testing.T) {
 		output    string
 	}{
 		{
-			name:      "one message whole",
+			name:      "returns one message without shortening it",
 			arguments: `{"id":2,"n":1}`,
 			output:    "user: two",
 		},
@@ -149,12 +150,12 @@ func TestZoomAndDateReadTheChat(t *testing.T) {
 			output:    "0+2|user: zero user: one\n2+2|user: two user: three",
 		},
 		{
-			name:      "an id that is not a multiple of n",
+			name:      "rejects an unaligned line ID",
 			arguments: `{"id":1,"n":2}`,
 			output:    "error: line 1+2 does not exist: n must be a power of 2 and id a multiple of n",
 		},
 		{
-			name:      "a line past the last message",
+			name:      "rejects a line beyond the chat",
 			arguments: `{"id":4,"n":4}`,
 			output:    "error: line 4+4 goes past the last message, 3",
 		},
@@ -243,6 +244,13 @@ func newTestToolbox(t *testing.T, log ToolLog, dir string) *Toolbox {
 	}
 }
 
+func (r *ToolRecordingLog) Events() []string {
+	r.mutex.Lock()
+	defer r.mutex.Unlock()
+
+	return append([]string(nil), r.events...)
+}
+
 func (r *ToolRecordingLog) Append(kind, text string) (Message, error) {
 	r.mutex.Lock()
 	defer r.mutex.Unlock()
@@ -266,10 +274,3 @@ func (r *ToolRecordingLog) Flush(ctx context.Context) error {
 
 	return ctx.Err()
 }
-
-func (r *ToolRecordingLog) Events() []string {
-	r.mutex.Lock()
-	defer r.mutex.Unlock()
-
-	return append([]string(nil), r.events...)
-}