[test] Fix parallel limiter unlocking before ws stopped (#18839)

Author: WVerlaek

test/pkg/integration/workspace.go

@@ -474,20 +474,29 @@ func LaunchWorkspaceWithOptions(t *testing.T, ctx context.Context, opts *LaunchW
 
 func stopWsF(t *testing.T, instanceID string, workspaceID string, api *ComponentAPI, isPrebuild bool) StopWorkspaceFunc {
 	var already bool
-	return func(waitForStop bool, api *ComponentAPI) (*wsmanapi.WorkspaceStatus, error) {
+	var unlocked bool
+	return func(waitForStop bool, api *ComponentAPI) (s *wsmanapi.WorkspaceStatus, err error) {
 		if already {
 			t.Logf("already sent stop request: %s", instanceID)
 			return nil, nil
 		}
+		already = true
+
+		tryUnlockParallelLimiter := func() {
+			if !unlocked {
+				unlocked = true
+				<-parallelLimiter
+			}
+		}
 
-		var err error
 		defer func() {
-			if already {
+			if err == nil {
 				return
-			} else {
-				<-parallelLimiter
 			}
-			already = true
+
+			// Only unlock on error here, otherwise we'll unlock below
+			// after waiting for the workspace to stop.
+			tryUnlockParallelLimiter()
 		}()
 
 		sctx, scancel := context.WithTimeout(context.Background(), perCallTimeout)
@@ -528,11 +537,8 @@ func stopWsF(t *testing.T, instanceID string, workspaceID string, api *Component
 			break
 		}
 
-		if !waitForStop {
-			return nil, nil
-		}
-
-		for {
+		waitAndUnlock := func() (*wsmanapi.WorkspaceStatus, error) {
+			defer tryUnlockParallelLimiter()
 			select {
 			case err := <-errCh:
 				return nil, err
@@ -541,6 +547,19 @@ func stopWsF(t *testing.T, instanceID string, workspaceID string, api *Component
 				return s, nil
 			}
 		}
+
+		if !waitForStop {
+			// Still wait for stop asynchroniously to unblock the parallelLimiter
+			go func() {
+				_, err = waitAndUnlock()
+				if err != nil {
+					t.Logf("error while waiting asynchronously for workspace to stop: %v", err)
+				}
+			}()
+			return nil, nil
+		}
+
+		return waitAndUnlock()
 	}
 }
 
@@ -698,7 +717,7 @@ func WaitForWorkspaceStart(t *testing.T, ctx context.Context, instanceID string,
 					return nil, false, nil
 				}
 				if !cfg.CanFail {
-					return nil, true, xerrors.New("the workspace couldn't be found")
+					return nil, true, xerrors.Errorf("the workspace %s couldn't be found", instanceID)
 				}
 				return nil, true, nil
 			}