Support for rollback config in compose 3.7

Signed-off-by: Vincent Demeester <[email protected]>

cli/compose/convert/service.go

@@ -159,9 +159,10 @@ func Service(
 				Preferences: getPlacementPreference(service.Deploy.Placement.Preferences),
 			},
 		},
-		EndpointSpec: endpoint,
-		Mode:         mode,
-		UpdateConfig: convertUpdateConfig(service.Deploy.UpdateConfig),
+		EndpointSpec:   endpoint,
+		Mode:           mode,
+		UpdateConfig:   convertUpdateConfig(service.Deploy.UpdateConfig),
+		RollbackConfig: convertUpdateConfig(service.Deploy.RollbackConfig),
 	}
 
 	// add an image label to serviceSpec

cli/compose/convert/service_test.go

@@ -550,3 +550,17 @@ func (c *fakeClient) ConfigList(ctx context.Context, options types.ConfigListOpt
 	}
 	return []swarm.Config{}, nil
 }
+
+func TestConvertUpdateConfigParallelism(t *testing.T) {
+	parallel := uint64(4)
+
+	// test default behavior
+	updateConfig := convertUpdateConfig(&composetypes.UpdateConfig{})
+	assert.Check(t, is.Equal(uint64(1), updateConfig.Parallelism))
+
+	// Non default value
+	updateConfig = convertUpdateConfig(&composetypes.UpdateConfig{
+		Parallelism: &parallel,
+	})
+	assert.Check(t, is.Equal(parallel, updateConfig.Parallelism))
+}

cli/compose/loader/full-example.yml

@@ -1,4 +1,4 @@
-version: "3.6"
+version: "3.7"
 
 services:
   foo:
@@ -39,6 +39,13 @@ services:
       mode: replicated
       replicas: 6
       labels: [FOO=BAR]
+      rollback_config:
+        parallelism: 3
+        delay: 10s
+        failure_action: continue
+        monitor: 60s
+        max_failure_ratio: 0.3
+        order: start-first
       update_config:
         parallelism: 3
         delay: 10s

cli/compose/loader/full-struct_test.go

@@ -10,7 +10,7 @@ import (
 
 func fullExampleConfig(workingDir, homeDir string) *types.Config {
 	return &types.Config{
-		Version:  "3.6",
+		Version:  "3.7",
 		Services: services(workingDir, homeDir),
 		Networks: networks(),
 		Volumes:  volumes(),
@@ -41,6 +41,14 @@ func services(workingDir, homeDir string) []types.ServiceConfig {
 				Mode:     "replicated",
 				Replicas: uint64Ptr(6),
 				Labels:   map[string]string{"FOO": "BAR"},
+				RollbackConfig: &types.UpdateConfig{
+					Parallelism:     uint64Ptr(3),
+					Delay:           time.Duration(10 * time.Second),
+					FailureAction:   "continue",
+					Monitor:         time.Duration(60 * time.Second),
+					MaxFailureRatio: 0.3,
+					Order:           "start-first",
+				},
 				UpdateConfig: &types.UpdateConfig{
 					Parallelism:     uint64Ptr(3),
 					Delay:           time.Duration(10 * time.Second),
@@ -393,7 +401,7 @@ func volumes() map[string]types.VolumeConfig {
 }
 
 func fullExampleYAML(workingDir string) string {
-	return fmt.Sprintf(`version: "3.6"
+	return fmt.Sprintf(`version: "3.7"
 services:
   foo:
     build:
@@ -436,6 +444,13 @@ services:
         monitor: 1m0s
         max_failure_ratio: 0.3
         order: start-first
+      rollback_config:
+        parallelism: 3
+        delay: 10s
+        failure_action: continue
+        monitor: 1m0s
+        max_failure_ratio: 0.3
+        order: start-first
       resources:
         limits:
           cpus: "0.001"

cli/compose/loader/types_test.go

@@ -19,7 +19,7 @@ func TestMarshallConfig(t *testing.T) {
 	assert.Check(t, is.Equal(expected, string(actual)))
 
 	// Make sure the expected still
-	dict, err := ParseYAML([]byte("version: '3.6'\n" + expected))
+	dict, err := ParseYAML([]byte("version: '3.7'\n" + expected))
 	assert.NilError(t, err)
 	_, err = Load(buildConfigDetails(dict, map[string]string{}))
 	assert.NilError(t, err)

cli/compose/schema/data/config_schema_v3.7.json

@@ -348,6 +348,20 @@
         "endpoint_mode": {"type": "string"},
         "replicas": {"type": "integer"},
         "labels": {"$ref": "#/definitions/list_or_dict"},
+        "rollback_config": {
+          "type": "object",
+          "properties": {
+            "parallelism": {"type": "integer"},
+            "delay": {"type": "string", "format": "duration"},
+            "failure_action": {"type": "string"},
+            "monitor": {"type": "string", "format": "duration"},
+            "max_failure_ratio": {"type": "number"},
+            "order": {"type": "string", "enum": [
+              "start-first", "stop-first"
+            ]}
+          },
+          "additionalProperties": false
+        },
         "update_config": {
           "type": "object",
           "properties": {

cli/compose/schema/schema_test.go

@@ -114,3 +114,92 @@ func TestValidateIsolation(t *testing.T) {
 	}
 	assert.NilError(t, Validate(config, "3.5"))
 }
+
+func TestValidateRollbackConfig(t *testing.T) {
+	config := dict{
+		"version": "3.4",
+		"services": dict{
+			"foo": dict{
+				"image": "busybox",
+				"deploy": dict{
+					"rollback_config": dict{
+						"parallelism": 1,
+					},
+				},
+			},
+		},
+	}
+
+	assert.NilError(t, Validate(config, "3.7"))
+}
+
+func TestValidateRollbackConfigWithOrder(t *testing.T) {
+	config := dict{
+		"version": "3.4",
+		"services": dict{
+			"foo": dict{
+				"image": "busybox",
+				"deploy": dict{
+					"rollback_config": dict{
+						"parallelism": 1,
+						"order":       "start-first",
+					},
+				},
+			},
+		},
+	}
+
+	assert.NilError(t, Validate(config, "3.7"))
+}
+
+func TestValidateRollbackConfigWithUpdateConfig(t *testing.T) {
+	config := dict{
+		"version": "3.4",
+		"services": dict{
+			"foo": dict{
+				"image": "busybox",
+				"deploy": dict{
+					"update_config": dict{
+						"parallelism": 1,
+						"order":       "start-first",
+					},
+					"rollback_config": dict{
+						"parallelism": 1,
+						"order":       "start-first",
+					},
+				},
+			},
+		},
+	}
+
+	assert.NilError(t, Validate(config, "3.7"))
+}
+
+func TestValidateRollbackConfigWithUpdateConfigFull(t *testing.T) {
+	config := dict{
+		"version": "3.4",
+		"services": dict{
+			"foo": dict{
+				"image": "busybox",
+				"deploy": dict{
+					"update_config": dict{
+						"parallelism":    1,
+						"order":          "start-first",
+						"delay":          "10s",
+						"failure_action": "pause",
+						"monitor":        "10s",
+					},
+					"rollback_config": dict{
+						"parallelism":    1,
+						"order":          "start-first",
+						"delay":          "10s",
+						"failure_action": "pause",
+						"monitor":        "10s",
+					},
+				},
+			},
+		},
+	}
+
+	assert.NilError(t, Validate(config, "3.7"))
+}

cli/compose/types/types.go

@@ -190,14 +190,15 @@ type LoggingConfig struct {
 
 // DeployConfig the deployment configuration for a service
 type DeployConfig struct {
-	Mode          string         `yaml:",omitempty"`
-	Replicas      *uint64        `yaml:",omitempty"`
-	Labels        Labels         `yaml:",omitempty"`
-	UpdateConfig  *UpdateConfig  `mapstructure:"update_config" yaml:"update_config,omitempty"`
-	Resources     Resources      `yaml:",omitempty"`
-	RestartPolicy *RestartPolicy `mapstructure:"restart_policy" yaml:"restart_policy,omitempty"`
-	Placement     Placement      `yaml:",omitempty"`
-	EndpointMode  string         `mapstructure:"endpoint_mode" yaml:"endpoint_mode,omitempty"`
+	Mode           string         `yaml:",omitempty"`
+	Replicas       *uint64        `yaml:",omitempty"`
+	Labels         Labels         `yaml:",omitempty"`
+	UpdateConfig   *UpdateConfig  `mapstructure:"update_config" yaml:"update_config,omitempty"`
+	RollbackConfig *UpdateConfig  `mapstructure:"rollback_config" yaml:"rollback_config,omitempty"`
+	Resources      Resources      `yaml:",omitempty"`
+	RestartPolicy  *RestartPolicy `mapstructure:"restart_policy" yaml:"restart_policy,omitempty"`
+	Placement      Placement      `yaml:",omitempty"`
+	EndpointMode   string         `mapstructure:"endpoint_mode" yaml:"endpoint_mode,omitempty"`
 }
 
 // HealthCheckConfig the healthcheck configuration for a service