feat(stacks): simplify WaitForStatus() BE-11505 (#241)

pkg/libstack/compose/composeplugin_test.go

@@ -59,7 +59,7 @@ services:
 
 	require.True(t, containerExists(composeContainerName))
 
-	waitResult := <-w.WaitForStatus(ctx, projectName, libstack.StatusCompleted)
+	waitResult := w.WaitForStatus(ctx, projectName, libstack.StatusCompleted)
 
 	require.Empty(t, waitResult.ErrorMsg)
 	require.Equal(t, libstack.StatusCompleted, waitResult.Status)

pkg/libstack/compose/status.go

@@ -111,74 +111,66 @@ func aggregateStatuses(services []service) (libstack.Status, string) {
 
 }
 
-func (c *ComposeDeployer) WaitForStatus(ctx context.Context, name string, status libstack.Status) <-chan libstack.WaitResult {
+func (c *ComposeDeployer) WaitForStatus(ctx context.Context, name string, status libstack.Status) libstack.WaitResult {
-	waitResultCh := make(chan libstack.WaitResult)
 	waitResult := libstack.WaitResult{Status: status}
 
-	go func() {
+	for {
-		for {
+		if ctx.Err() != nil {
-			select {
+			waitResult.ErrorMsg = "failed to wait for status: " + ctx.Err().Error()
-			case <-ctx.Done():
-				waitResult.ErrorMsg = "failed to wait for status: " + ctx.Err().Error()
-				waitResultCh <- waitResult
-			default:
-			}
 
-			time.Sleep(1 * time.Second)
+			return waitResult
+		}
 
-			var containerSummaries []api.ContainerSummary
+		time.Sleep(1 * time.Second)
 
-			if err := withComposeService(ctx, nil, libstack.Options{ProjectName: name}, func(composeService api.Service, project *types.Project) error {
+		var containerSummaries []api.ContainerSummary
-				var err error
 
-				psCtx, cancelFunc := context.WithTimeout(context.Background(), time.Minute)
+		if err := withComposeService(ctx, nil, libstack.Options{ProjectName: name}, func(composeService api.Service, project *types.Project) error {
-				defer cancelFunc()
+			var err error
-				containerSummaries, err = composeService.Ps(psCtx, name, api.PsOptions{All: true})
 
-				return err
+			psCtx, cancelFunc := context.WithTimeout(context.Background(), time.Minute)
-			}); err != nil {
+			defer cancelFunc()
-				log.Debug().
+			containerSummaries, err = composeService.Ps(psCtx, name, api.PsOptions{All: true})
-					Str("project_name", name).
-					Err(err).
-					Msg("error from docker compose ps")
-
-				continue
-			}
-
-			services := serviceListFromContainerSummary(containerSummaries)
-
-			if len(services) == 0 && status == libstack.StatusRemoved {
-				waitResultCh <- waitResult
-				return
-			}
-
-			aggregateStatus, errorMessage := aggregateStatuses(services)
-			if aggregateStatus == status {
-				waitResultCh <- waitResult
-				return
-			}
-
-			if status == libstack.StatusRunning && aggregateStatus == libstack.StatusCompleted {
-				waitResult.Status = libstack.StatusCompleted
-				waitResultCh <- waitResult
-				return
-			}
-
-			if errorMessage != "" {
-				waitResult.ErrorMsg = errorMessage
-				waitResultCh <- waitResult
-				return
-			}
 
+			return err
+		}); err != nil {
 			log.Debug().
 				Str("project_name", name).
-				Str("required_status", string(status)).
+				Err(err).
-				Str("status", string(aggregateStatus)).
+				Msg("error from docker compose ps")
-				Msg("waiting for status")
-		}
-	}()
 
-	return waitResultCh
+			continue
+		}
+
+		services := serviceListFromContainerSummary(containerSummaries)
+
+		if len(services) == 0 && status == libstack.StatusRemoved {
+			return waitResult
+		}
+
+		aggregateStatus, errorMessage := aggregateStatuses(services)
+		if aggregateStatus == status {
+			return waitResult
+		}
+
+		if status == libstack.StatusRunning && aggregateStatus == libstack.StatusCompleted {
+			waitResult.Status = libstack.StatusCompleted
+
+			return waitResult
+		}
+
+		if errorMessage != "" {
+			waitResult.ErrorMsg = errorMessage
+
+			return waitResult
+		}
+
+		log.Debug().
+			Str("project_name", name).
+			Str("required_status", string(status)).
+			Str("status", string(aggregateStatus)).
+			Msg("waiting for status")
+	}
 }
 
 func serviceListFromContainerSummary(containerSummaries []api.ContainerSummary) []service {

pkg/libstack/compose/status_integration_test.go

@@ -106,8 +106,7 @@ func waitForStatus(deployer libstack.Deployer, ctx context.Context, stackName st
 	ctx, cancel := context.WithTimeout(ctx, 1*time.Minute)
 	defer cancel()
 
-	statusCh := deployer.WaitForStatus(ctx, stackName, requiredStatus)
+	result := deployer.WaitForStatus(ctx, stackName, requiredStatus)
-	result := <-statusCh
 	if result.ErrorMsg == "" {
 		return result.Status, "", nil
 	}

pkg/libstack/libstack.go

@@ -18,7 +18,7 @@ type Deployer interface {
 	Pull(ctx context.Context, filePaths []string, options Options) error
 	Run(ctx context.Context, filePaths []string, serviceName string, options RunOptions) error
 	Validate(ctx context.Context, filePaths []string, options Options) error
-	WaitForStatus(ctx context.Context, name string, status Status) <-chan WaitResult
+	WaitForStatus(ctx context.Context, name string, status Status) WaitResult
 	Config(ctx context.Context, filePaths []string, options Options) ([]byte, error)
 	GetExistingEdgeStacks(ctx context.Context) ([]EdgeStack, error)
 }