Support compose depends_on with condition: service_completed_successfully

Author: jubr

internal/app/up/up.go

@@ -1127,9 +1127,13 @@ func (u *upRunner) setAppMaxObservedPodStatus(app *app, s podStatus) {
 		switch {
 		case s == podStatusStarted:
 			app.reporterRow.AddStatus(reporter.StatusRunning)
-		case s >= podStatusReady:
+		case s == podStatusReady:
 			app.reporterRow.RemoveStatus(reporter.StatusRunning)
 			app.reporterRow.AddStatus(reporter.StatusReady)
+		case s >= podStatusCompleted:
+			app.reporterRow.RemoveStatus(reporter.StatusRunning)
+			app.reporterRow.RemoveStatus(reporter.StatusReady)
+			app.reporterRow.AddStatus(reporter.StatusCompleted)
 		}
 	}
 	app.newLogEntry().Debugf("pod status %s", &app.maxObservedPodStatus)
@@ -1159,14 +1163,20 @@ func (u *upRunner) createPodsIfNeeded() error {
 		for name, healthiness := range app1.composeService.DockerComposeService.DependsOn {
 			composeService := u.cfg.Services[name]
 			app2 := u.apps[composeService.Name()]
-			if healthiness == dockerComposeConfig.ServiceHealthy {
+			switch healthiness {
+			case dockerComposeConfig.ServiceHealthy:
 				if app2.maxObservedPodStatus != podStatusReady {
 					createPod = false
 				}
-			} else {
+			case dockerComposeConfig.ServiceStarted:
 				if app2.maxObservedPodStatus != podStatusStarted && app2.maxObservedPodStatus != podStatusReady {
 					createPod = false
 				}
+			case dockerComposeConfig.ServiceCompletedSuccessfully:
+				// Note the assumption here is made that podStatusCompleted implies successfully. PRs welcome.
+				if app2.maxObservedPodStatus != podStatusCompleted {
+					createPod = false
+				}
 			}
 		}
 		if createPod {
@@ -1190,10 +1200,13 @@ func (u *upRunner) formatCreatePodReason(app1 *app) string {
 			reason.WriteString(", ")
 		}
 		reason.WriteString(name)
-		if healthiness == dockerComposeConfig.ServiceHealthy {
-			reason.WriteString(": ready")
-		} else {
+		switch healthiness {
+		case dockerComposeConfig.ServiceStarted:
 			reason.WriteString(": running")
+		case dockerComposeConfig.ServiceHealthy:
+			reason.WriteString(": ready")
+		case dockerComposeConfig.ServiceCompletedSuccessfully:
+			reason.WriteString(": completed")
 		}
 		comma = true
 	}

internal/app/up/up_test.go

@@ -130,3 +130,25 @@ func TestFormatCreatePodReason(t *testing.T) {
 		t.Error(s)
 	}
 }
+
+func TestFormatCreatePodReasonCompleted(t *testing.T) {
+	cfg := &config.Config{}
+	serviceA := cfg.AddService(&dockerComposeConfig.Service{
+		Name: "a",
+	})
+	cfg.AddService(&dockerComposeConfig.Service{
+		Name: "b",
+	})
+	serviceA.DockerComposeService.DependsOn = map[string]dockerComposeConfig.ServiceHealthiness{}
+	serviceA.DockerComposeService.DependsOn["b"] = dockerComposeConfig.ServiceCompletedSuccessfully
+
+	u := &upRunner{
+		cfg: cfg,
+	}
+	u.initApps()
+	appA := u.apps["a"]
+	s := u.formatCreatePodReason(appA)
+	if s != "all depends_on conditions satisfied (b: completed)" {
+		t.Error(s)
+	}
+}

internal/pkg/progress/reporter/reporter.go

@@ -57,6 +57,11 @@ var (
 		TextWidth: 8,
 		Priority:  3,
 	}
+	StatusCompleted = &Status{
+		Text:      "completed ✅", // checkmark
+		TextWidth: 12,
+		Priority:  4,
+	}
 )
 
 type Status struct {

pkg/docker/compose/config/parse.go

@@ -98,6 +98,8 @@ func (t *dependsOn) Decode(into mapdecode.Into) error {
 				t.Values[service] = ServiceHealthy
 			case "service_started":
 				t.Values[service] = ServiceStarted
+			case "service_completed_successfully":
+				t.Values[service] = ServiceCompletedSuccessfully
 			default:
 				return fmt.Errorf("depends_on map contains an entry with an invalid condition: %s", obj.Condition)
 			}

pkg/docker/compose/config/parse_test.go

@@ -270,6 +270,9 @@ func TestDependsOnDecode_MapSuccess(t *testing.T) {
 		"service-bla-2": {
 			"condition": "service_started",
 		},
+		"service-bla-3": {
+			"condition": "service_completed_successfully",
+		},
 	}
 	var dst dependsOn
 	err := mapdecode.Decode(&dst, src)
@@ -279,6 +282,7 @@ func TestDependsOnDecode_MapSuccess(t *testing.T) {
 	if !reflect.DeepEqual(dst.Values, map[string]ServiceHealthiness{
 		"service-bla-1": ServiceHealthy,
 		"service-bla-2": ServiceStarted,
+		"service-bla-3": ServiceCompletedSuccessfully,
 	}) {
 		t.Error(dst)
 	}

pkg/docker/compose/config/service_healthiness.go

@@ -4,6 +4,7 @@ package config
 type ServiceHealthiness int
 
 const (
-	ServiceStarted ServiceHealthiness = 0
-	ServiceHealthy ServiceHealthiness = 1
+	ServiceStarted               ServiceHealthiness = 0
+	ServiceHealthy               ServiceHealthiness = 1
+	ServiceCompletedSuccessfully ServiceHealthiness = 2
 )