[ci skip] table test

johnstcn · johnstcn · commit d61b44720683 · 2025-02-05T12:11:53.000Z
diff --git a/agent/containers_internal_test.go b/agent/containers_internal_test.go
@@ -73,80 +73,105 @@ func TestContainersHandler(t *testing.T) {
 	t.Run("list", func(t *testing.T) {
 		t.Parallel()
 
-		// Given: a containersHandler backed by a mock
-		var (
-			ctx        = testutil.Context(t, testutil.WaitShort)
-			clk        = quartz.NewMock(t)
-			ctrl       = gomock.NewController(t)
-			mockLister = NewMockContainerLister(ctrl)
-			now        = time.Now().UTC()
-			ch         = containersHandler{
-				cacheDuration: time.Second,
-				cl:            mockLister,
-				clock:         clk,
-			}
-			expected = []codersdk.WorkspaceAgentContainer{fakeContainer(t)}
-		)
-
-		clk.Set(now).MustWait(ctx)
-
-		// When: getContainers is called for the first time
-		ch.mtime = time.Time{}
-		mockLister.EXPECT().List(gomock.Any()).Return(expected, nil)
-		actual, err := ch.getContainers(ctx)
-
-		// Then: the underlying lister is called and the result is returned
-		require.NoError(t, err, "expected no error on first call")
-		require.Equal(t, expected, actual, "expected containers to be equal on first call")
-		// Then: the result is cached
-		require.Equal(t, now, ch.mtime, "expected container mtime to be set on first call")
-		require.NotEmpty(t, ch.containers, "expected cached data to not be empty on first call")
-
-		// When: getContainers is called again
-		actual, err = ch.getContainers(ctx)
-
-		// Then: the underlying lister is not called and the cached result is
-		// returned
-		require.NoError(t, err, "expected no error on second call")
-		require.Equal(t, expected, actual, "expected containers to be equal on second call")
-		// Then: the result is cached
-		require.Equal(t, now, ch.mtime, "expected container mtime to not have changed on second call")
-		require.Equal(t, expected, ch.containers, "expected cached data to not have changed on second call")
-
-		// When: getContainers is called after the cache duration has expired
-		expected = append(expected, fakeContainer(t))
-		later := now.Add(defaultGetContainersCacheDuration).Add(time.Second)
-		clk.Set(later).MustWait(ctx)
-		mockLister.EXPECT().List(gomock.Any()).Return(expected, nil)
-		actual, err = ch.getContainers(ctx)
-
-		// Then: the underlying lister is called and the result is returned
-		require.NoError(t, err, "expected no error on third call")
-		require.Equal(t, expected, actual, "expected containers to be equal on third call")
-		// Then: the result is cached
-		require.Equal(t, later, ch.mtime, "expected container mtime to later on third call")
-		require.Equal(t, expected, ch.containers, "expected cached data to not have changed on third call")
-
-		// When: getContainers is called again but the underlying lister returns an error
-		actual, err = ch.getContainers(ctx)
-		require.NoError(t, err)
-
-		// Then: the cached data is not updated
-		require.Equal(t, expected, actual, "expected containers to be equal on fourth call")
-		require.Equal(t, later, ch.mtime, "expected container mtime to not have changed on fourth call")
-		require.Equal(t, expected, ch.containers, "expected cached data to not have changed on fourth call")
-
-		// When: time advances past mtime
-		laterlater := later.Add(defaultGetContainersCacheDuration).Add(time.Second)
-		clk.Set(laterlater).MustWait(ctx)
-		mockLister.EXPECT().List(gomock.Any()).Return(nil, assert.AnError)
-		actual, err = ch.getContainers(ctx)
-		// Then: the underlying error is returned
-		require.ErrorContains(t, err, assert.AnError.Error(), "expected error on fifth call")
-		require.Nil(t, actual, "expected no data to be returned on fifth call")
-		// Then: the underlying cached data remains the same
-		require.Equal(t, later, ch.mtime, "expected container mtime to not have changed on fifth call")
-		require.Equal(t, expected, ch.containers, "expected cached data to not have changed on fifth call")
+		fakeCt := fakeContainer(t)
+		fakeCt2 := fakeContainer(t)
+
+		// Each test case is called multiple times to ensure idempotency
+		for _, tc := range []struct {
+			name string
+			// data to be stored in the handler
+			cacheData []codersdk.WorkspaceAgentContainer
+			// duration of cache
+			cacheDur time.Duration
+			// relative age of the cached data
+			cacheAge time.Duration
+			// function to set up expectations for the mock
+			setupMock func(*MockContainerLister)
+			// expected result
+			expected []codersdk.WorkspaceAgentContainer
+			// expected error
+			expectedErr string
+		}{
+			{
+				name: "no cache",
+				setupMock: func(mcl *MockContainerLister) {
+					mcl.EXPECT().List(gomock.Any()).Return([]codersdk.WorkspaceAgentContainer{fakeCt}, nil).AnyTimes()
+				},
+				expected: []codersdk.WorkspaceAgentContainer{fakeCt},
+			},
+			{
+				name:      "no data",
+				cacheData: nil,
+				cacheAge:  2 * time.Second,
+				cacheDur:  time.Second,
+				setupMock: func(mcl *MockContainerLister) {
+					mcl.EXPECT().List(gomock.Any()).Return([]codersdk.WorkspaceAgentContainer{fakeCt}, nil).AnyTimes()
+				},
+				expected: []codersdk.WorkspaceAgentContainer{fakeCt},
+			},
+			{
+				name:      "cached data",
+				cacheAge:  time.Second,
+				cacheData: []codersdk.WorkspaceAgentContainer{fakeCt},
+				cacheDur:  2 * time.Second,
+				expected:  []codersdk.WorkspaceAgentContainer{fakeCt},
+			},
+			{
+				name: "lister error",
+				setupMock: func(mcl *MockContainerLister) {
+					mcl.EXPECT().List(gomock.Any()).Return(nil, assert.AnError).AnyTimes()
+				},
+				expectedErr: assert.AnError.Error(),
+			},
+			{
+				name:      "stale cache",
+				cacheAge:  2 * time.Second,
+				cacheData: []codersdk.WorkspaceAgentContainer{fakeCt},
+				cacheDur:  time.Second,
+				setupMock: func(mcl *MockContainerLister) {
+					mcl.EXPECT().List(gomock.Any()).Return([]codersdk.WorkspaceAgentContainer{fakeCt2}, nil).AnyTimes()
+				},
+				expected: []codersdk.WorkspaceAgentContainer{fakeCt2},
+			},
+		} {
+			tc := tc
+			t.Run(tc.name, func(t *testing.T) {
+				t.Parallel()
+				var (
+					ctx        = testutil.Context(t, testutil.WaitShort)
+					clk        = quartz.NewMock(t)
+					ctrl       = gomock.NewController(t)
+					mockLister = NewMockContainerLister(ctrl)
+					now        = time.Now().UTC()
+					ch         = containersHandler{
+						cacheDuration: tc.cacheDur,
+						cl:            mockLister,
+						clock:         clk,
+						containers:    tc.cacheData,
+					}
+				)
+				if tc.cacheAge != 0 {
+					ch.mtime = now.Add(-tc.cacheAge)
+				}
+				if tc.setupMock != nil {
+					tc.setupMock(mockLister)
+				}
+
+				clk.Set(now).MustWait(ctx)
+
+				// Repeat the test to ensure idempotency
+				for i := 0; i < 2; i++ {
+					actual, err := ch.getContainers(ctx)
+					if tc.expectedErr != "" {
+						require.Empty(t, actual, "expected no data (attempt %d)", i)
+						require.ErrorContains(t, err, tc.expectedErr, "expected error (attempt %d)", i)
+					} else {
+						require.NoError(t, err, "expected no error (attempt %d)", i)
+						require.Equal(t, tc.expected, actual, "expected containers to be equal (attempt %d)", i)
+					}
+				}
+			})
+		}
 	})
 }
 
