introduce depends_on.service

Signed-off-by: Nicolas De Loof <[email protected]>

loader/full-struct_test.go

@@ -96,8 +96,8 @@ func services(workingDir, homeDir string) types.Services {
 			},
 			ContainerName: "my-web-container",
 			DependsOn: types.DependsOnConfig{
-				"db":    {Condition: types.ServiceConditionStarted, Required: true},
-				"redis": {Condition: types.ServiceConditionStarted, Required: true},
+				"db":    {Service: "db", Condition: types.ServiceConditionStarted, Required: true},
+				"redis": {Service: "redis", Condition: types.ServiceConditionStarted, Required: true},
 			},
 			Deploy: &types.DeployConfig{
 				Mode:     "replicated",
@@ -678,9 +678,11 @@ services:
     container_name: my-web-container
     depends_on:
       db:
+        service: db
         condition: service_started
         required: true
       redis:
+        service: redis
         condition: service_started
         required: true
     deploy:
@@ -1262,10 +1264,12 @@ func fullExampleJSON(workingDir, homeDir string) string {
       "container_name": "my-web-container",
       "depends_on": {
         "db": {
+          "service": "db",
           "condition": "service_started",
           "required": true
         },
         "redis": {
+          "service": "redis",
           "condition": "service_started",
           "required": true
         }

loader/loader_test.go

@@ -2702,7 +2702,7 @@ services:
 			Name:        "foo",
 			Image:       "busybox",
 			Environment: types.MappingWithEquals{},
-			DependsOn:   types.DependsOnConfig{"imported": {Condition: "service_started", Required: true}},
+			DependsOn:   types.DependsOnConfig{"imported": {Service: "imported", Condition: "service_started", Required: true}},
 		},
 		"imported": {
 			Name:          "imported",
@@ -2844,9 +2844,9 @@ services:
 			Image:       "nginx",
 			Environment: types.MappingWithEquals{},
 			DependsOn: types.DependsOnConfig{
-				"bar": {Condition: types.ServiceConditionStarted, Required: true},
-				"baz": {Condition: types.ServiceConditionHealthy, Required: false},
-				"qux": {Condition: types.ServiceConditionCompletedSuccessfully, Required: true},
+				"bar": {Service: "bar", Condition: types.ServiceConditionStarted, Required: true},
+				"baz": {Service: "baz", Condition: types.ServiceConditionHealthy, Required: false},
+				"qux": {Service: "qux", Condition: types.ServiceConditionCompletedSuccessfully, Required: true},
 			},
 		},
 	})
@@ -3546,6 +3546,7 @@ services:
 	test := p.Services["test"]
 	assert.DeepEqual(t, test.DependsOn, types.DependsOnConfig{
 		"x-foo": types.ServiceDependency{
+			Service:   "x-foo",
 			Condition: types.ServiceConditionStarted,
 			Required:  true,
 		},

loader/validate.go

@@ -69,12 +69,12 @@ func checkConsistency(project *types.Project) error {
 			}
 		}
 
-		for dependedService, cfg := range s.DependsOn {
-			if _, err := project.GetService(dependedService); err != nil {
+		for _, cfg := range s.DependsOn {
+			if _, err := project.GetService(cfg.Service); err != nil {
 				if errors.Is(err, errdefs.ErrDisabled) && !cfg.Required {
 					continue
 				}
-				return fmt.Errorf("service %q depends on undefined service %q: %w", s.Name, dependedService, errdefs.ErrInvalid)
+				return fmt.Errorf("service %q depends on undefined service %q: %w", s.Name, cfg.Service, errdefs.ErrInvalid)
 			}
 		}
 

schema/compose-spec.json

@@ -198,6 +198,7 @@
                   "additionalProperties": false,
                   "patternProperties": {"^x-": {}},
                   "properties": {
+                    "service": {"type": "string"},
                     "restart": {"type": ["boolean", "string"]},
                     "required": {
                       "type":  "boolean",

transform/dependson.go

@@ -25,17 +25,20 @@ import (
 func transformDependsOn(data any, p tree.Path, _ bool) (any, error) {
 	switch v := data.(type) {
 	case map[string]any:
-		for i, e := range v {
+		for k, e := range v {
 			d, ok := e.(map[string]any)
 			if !ok {
-				return nil, fmt.Errorf("%s.%s: unsupported value %s", p, i, v)
+				return nil, fmt.Errorf("%s.%s: unsupported value %s", p, k, v)
 			}
 			if _, ok := d["condition"]; !ok {
 				d["condition"] = "service_started"
 			}
 			if _, ok := d["required"]; !ok {
 				d["required"] = true
 			}
+			if _, ok := d["service"]; !ok {
+				d["service"] = k
+			}
 		}
 		return v, nil
 	case []any:
@@ -44,6 +47,7 @@ func transformDependsOn(data any, p tree.Path, _ bool) (any, error) {
 			d[k.(string)] = map[string]any{
 				"condition": "service_started",
 				"required":  true,
+				"service":   k,
 			}
 		}
 		return d, nil

types/types.go

@@ -249,8 +249,8 @@ const (
 // GetDependencies retrieves all services this service depends on
 func (s ServiceConfig) GetDependencies() []string {
 	var dependencies []string
-	for service := range s.DependsOn {
-		dependencies = append(dependencies, service)
+	for _, dependency := range s.DependsOn {
+		dependencies = append(dependencies, dependency.Service)
 	}
 	return dependencies
 }
@@ -259,8 +259,8 @@ func (s ServiceConfig) GetDependencies() []string {
 func (s ServiceConfig) GetDependents(p *Project) []string {
 	var dependent []string
 	for _, service := range p.Services {
-		for name := range service.DependsOn {
-			if name == s.Name {
+		for _, dependency := range service.DependsOn {
+			if dependency.Service == s.Name {
 				dependent = append(dependent, service.Name)
 			}
 		}
@@ -761,6 +761,7 @@ const (
 type DependsOnConfig map[string]ServiceDependency
 
 type ServiceDependency struct {
+	Service    string     `yaml:"service,omitempty" json:"service,omitempty"`
 	Condition  string     `yaml:"condition,omitempty" json:"condition,omitempty"`
 	Restart    bool       `yaml:"restart,omitempty" json:"restart,omitempty"`
 	Extensions Extensions `yaml:"#extensions,inline,omitempty" json:"-"`