Merge branch 'id-refactor-polling-tests' into 'master'

Use require.Eventually instead of manual polling in tests

See merge request gitlab-org/gitlab!79827

workhorse/internal/artifacts/artifacts_store_test.go

@@ -284,12 +284,9 @@ func TestUploadHandlerMultipartUploadSizeLimit(t *testing.T) {
 	contentBuffer, contentType := createTestMultipartForm(t, make([]byte, uploadSize))
 	response := testUploadArtifacts(t, contentType, ts.URL+Path, &contentBuffer)
 	require.Equal(t, http.StatusRequestEntityTooLarge, response.Code)
-
-	// Poll because AbortMultipartUpload is async
-	for i := 0; os.IsMultipartUpload(test.ObjectPath) && i < 100; i++ {
-		time.Sleep(10 * time.Millisecond)
-	}
-	require.False(t, os.IsMultipartUpload(test.ObjectPath), "MultipartUpload should not be in progress anymore")
+	require.Eventually(t, func() bool {
+		return !os.IsMultipartUpload(test.ObjectPath)
+	}, time.Second, time.Millisecond, "MultipartUpload should not be in progress anymore")
 	require.Empty(t, os.GetObjectMD5(test.ObjectPath), "upload should have failed, so the object should not exists")
 }
 

workhorse/internal/filestore/file_handler_test.go

@@ -28,29 +28,15 @@ func testDeadline() time.Time {
 
 func requireFileGetsRemovedAsync(t *testing.T, filePath string) {
 	var err error
-
-	// Poll because the file removal is async
-	for i := 0; i < 100; i++ {
+	require.Eventually(t, func() bool {
 		_, err = os.Stat(filePath)
-		if err != nil {
-			break
-		}
-		time.Sleep(100 * time.Millisecond)
-	}
-
+		return err != nil
+	}, 10*time.Second, 10*time.Millisecond)
 	require.True(t, os.IsNotExist(err), "File hasn't been deleted during cleanup")
 }
 
 func requireObjectStoreDeletedAsync(t *testing.T, expectedDeletes int, osStub *test.ObjectstoreStub) {
-	// Poll because the object removal is async
-	for i := 0; i < 100; i++ {
-		if osStub.DeletesCnt() == expectedDeletes {
-			break
-		}
-		time.Sleep(10 * time.Millisecond)
-	}
-
-	require.Equal(t, expectedDeletes, osStub.DeletesCnt(), "Object not deleted")
+	require.Eventually(t, func() bool { return osStub.DeletesCnt() == expectedDeletes }, time.Second, time.Millisecond, "Object not deleted")
 }
 
 func TestSaveFileWrongSize(t *testing.T) {

workhorse/internal/objectstore/object_test.go

@@ -56,13 +56,7 @@ func testObjectUploadNoErrors(t *testing.T, startObjectStore osFactory, useDelet
 	if useDeleteURL {
 		expectedDeleteCnt = 1
 	}
-	// Poll because the object removal is async
-	for i := 0; i < 100; i++ {
-		if osStub.DeletesCnt() == expectedDeleteCnt {
-			break
-		}
-		time.Sleep(10 * time.Millisecond)
-	}
+	require.Eventually(t, func() bool { return osStub.DeletesCnt() == expectedDeleteCnt }, time.Second, time.Millisecond)
 
 	if useDeleteURL {
 		require.Equal(t, 1, osStub.DeletesCnt(), "Object hasn't been deleted")

workhorse/internal/redis/keywatcher_test.go

@@ -180,11 +180,7 @@ func TestShutdown(t *testing.T) {
 	}()
 
 	go func() {
-		for countWatchers(runnerKey) == 0 {
-			time.Sleep(time.Millisecond)
-		}
-
-		require.Equal(t, 1, countWatchers(runnerKey))
+		require.Eventually(t, func() bool { return countWatchers(runnerKey) == 1 }, 10*time.Second, time.Millisecond)
 
 		Shutdown()
 		wg.Done()
@@ -192,11 +188,7 @@ func TestShutdown(t *testing.T) {
 
 	wg.Wait()
 
-	for countWatchers(runnerKey) == 1 {
-		time.Sleep(time.Millisecond)
-	}
-
-	require.Equal(t, 0, countWatchers(runnerKey))
+	require.Eventually(t, func() bool { return countWatchers(runnerKey) == 0 }, 10*time.Second, time.Millisecond)
 
 	// Adding a key after the shutdown should result in an immediate response
 	var val WatchKeyStatus

workhorse/internal/upload/uploads_test.go

@@ -581,15 +581,9 @@ func newProxy(url string) *proxy.Proxy {
 
 func waitUntilDeleted(t *testing.T, path string) {
 	var err error
-
-	// Poll because the file removal is async
-	for i := 0; i < 100; i++ {
+	require.Eventually(t, func() bool {
 		_, err = os.Stat(path)
-		if err != nil {
-			break
-		}
-		time.Sleep(100 * time.Millisecond)
-	}
-
+		return err != nil
+	}, 10*time.Second, 10*time.Millisecond)
 	require.True(t, os.IsNotExist(err), "expected the file to be deleted")
 }