test: rewrite test

DanielleMaywood · DanielleMaywood · commit 4b0056c37d93 · 2024-09-20T08:40:00.000Z
diff --git a/agent/agentscripts/agentscripts_test.go b/agent/agentscripts/agentscripts_test.go
@@ -1,9 +1,11 @@
 package agentscripts_test
 
 import (
+	"cmp"
 	"context"
 	"path/filepath"
 	"runtime"
+	"slices"
 	"testing"
 	"time"
 
@@ -18,6 +20,7 @@ import (
 	"github.com/coder/coder/v2/agent/agentscripts"
 	"github.com/coder/coder/v2/agent/agentssh"
 	"github.com/coder/coder/v2/agent/agenttest"
+	"github.com/coder/coder/v2/agent/proto"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/codersdk/agentsdk"
 	"github.com/coder/coder/v2/testutil"
@@ -119,11 +122,13 @@ func TestTimeout(t *testing.T) {
 func TestScriptReportsTiming(t *testing.T) {
 	t.Parallel()
 
-	tests := []struct {
+	type test struct {
 		displayName string
 		script      string
 		exitCode    int32
-	}{
+	}
+
+	tests := []test{
 		{
 			displayName: "exit-0",
 			script:      "exit 0",
@@ -136,29 +141,45 @@ func TestScriptReportsTiming(t *testing.T) {
 		},
 	}
 
+	ctx := testutil.Context(t, testutil.WaitShort)
+	fLogger := newFakeScriptLogger()
+	runner := setup(t, func(uuid2 uuid.UUID) agentscripts.ScriptLogger {
+		return fLogger
+	})
+	defer runner.Close()
+	aAPI := agenttest.NewFakeAgentAPI(t, slogtest.Make(t, nil), nil, nil)
+
+	scripts := []codersdk.WorkspaceAgentScript{}
 	for _, tt := range tests {
-		ctx := testutil.Context(t, testutil.WaitShort)
-		fLogger := newFakeScriptLogger()
-		runner := setup(t, func(uuid2 uuid.UUID) agentscripts.ScriptLogger {
-			return fLogger
-		})
-		defer runner.Close()
-		aAPI := agenttest.NewFakeAgentAPI(t, slogtest.Make(t, nil), nil, nil)
-		err := runner.Init([]codersdk.WorkspaceAgentScript{{
+		scripts = append(scripts, codersdk.WorkspaceAgentScript{
 			DisplayName: tt.displayName,
 			LogSourceID: uuid.New(),
 			Script:      tt.script,
-		}}, aAPI.ScriptCompleted)
-		require.NoError(t, err)
-		require.NoError(t, runner.Execute(context.Background(), func(script codersdk.WorkspaceAgentScript) bool {
-			return true
-		}))
-		_ = testutil.RequireRecvCtx(ctx, t, fLogger.logs)
+		})
+	}
+
+	err := runner.Init(scripts, aAPI.ScriptCompleted)
+	require.NoError(t, err)
+	require.NoError(t, runner.Execute(context.Background(), func(script codersdk.WorkspaceAgentScript) bool {
+		return true
+	}))
+	_ = testutil.RequireRecvCtx(ctx, t, fLogger.logs)
+
+	timing := aAPI.GetTiming()
+	require.Equal(t, len(timing), len(tests))
+
+	// Sort the tests and timing by display name to ensure
+	// consistent order.
+	slices.SortFunc(timing, func(a, b *proto.Timing) int {
+		return cmp.Compare(a.DisplayName, b.DisplayName)
+	})
+	slices.SortFunc(tests, func(a, b test) int {
+		return cmp.Compare(a.displayName, b.displayName)
+	})
 
-		require.Equal(t, len(aAPI.GetTiming()), 1)
-		timing := aAPI.GetTiming()[0]
-		require.Equal(t, timing.DisplayName, tt.displayName)
-		require.Equal(t, timing.ExitCode, tt.exitCode)
+	for i, tt := range tests {
+		require.Equal(t, timing[i].DisplayName, tt.displayName)
+		require.Equal(t, timing[i].ExitCode, tt.exitCode)
 	}
 }
 
