Merge pull request #4550 from ChengyuZhu6/compose

compose: align convergence with Docker Compose

Author: AkihiroSuda

cmd/nerdctl/compose/compose_create_linux_test.go

@@ -27,6 +27,7 @@ import (
 	"github.com/containerd/nerdctl/mod/tigron/test"
 	"github.com/containerd/nerdctl/mod/tigron/tig"
 
+	"github.com/containerd/nerdctl/v2/pkg/composer/serviceparser"
 	"github.com/containerd/nerdctl/v2/pkg/testutil"
 	"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
 )
@@ -204,3 +205,24 @@ services:
 	base.ComposeCmd("-f", comp.YAMLFullPath(), "images", "svc0").AssertOutContains(imageSvc0)
 	base.ComposeCmd("-f", comp.YAMLFullPath(), "ps", "svc0", "-a").AssertOutContainsAny("Created", "created")
 }
+
+func TestComposeCreateWritesConfigHashLabel(t *testing.T) {
+	var dockerComposeYAML = fmt.Sprintf(`
+services:
+  svc0:
+    image: %s
+`, testutil.CommonImage)
+
+	base := testutil.NewBase(t)
+	comp := testutil.NewComposeDir(t, dockerComposeYAML)
+	defer comp.CleanUp()
+	projectName := comp.ProjectName()
+	t.Logf("projectName=%q", projectName)
+
+	base.ComposeCmd("-f", comp.YAMLFullPath(), "create").AssertOK()
+	defer base.ComposeCmd("-f", comp.YAMLFullPath(), "down", "-v").Run()
+
+	container := serviceparser.DefaultContainerName(projectName, "svc0", "1")
+	base.Cmd("inspect", "--format", "{{json .Config.Labels}}", container).
+		AssertOutContains("com.docker.compose.config-hash")
+}

cmd/nerdctl/compose/compose_up_linux_test.go

@@ -377,6 +377,46 @@ services:
 	base.ComposeCmd("-f", comp.YAMLFullPath(), "down").AssertOK()
 }
 
+func TestComposeUpNoRecreateDependencies(t *testing.T) {
+	base := testutil.NewBase(t)
+
+	var dockerComposeYAML = fmt.Sprintf(`
+services:
+  foo:
+    image: %s
+    command: "sleep infinity"
+  bar:
+    image: %s
+    command: "sleep infinity"
+    depends_on:
+      - foo
+`, testutil.CommonImage, testutil.CommonImage)
+
+	comp := testutil.NewComposeDir(t, dockerComposeYAML)
+	defer comp.CleanUp()
+	projectName := comp.ProjectName()
+	t.Logf("projectName=%q", projectName)
+
+	base.ComposeCmd("-f", comp.YAMLFullPath(), "up", "-d", "foo").AssertOK()
+	defer base.ComposeCmd("-f", comp.YAMLFullPath(), "down", "-v").Run()
+
+	fooName := serviceparser.DefaultContainerName(projectName, "foo", "1")
+	id1Cmd := base.Cmd("inspect", fooName, "--format", "{{.Id}}")
+	id1Res := id1Cmd.Run()
+	out1 := strings.TrimSpace(id1Res.Stdout())
+	assert.Assert(id1Cmd.Base.T, id1Res.ExitCode == 0, id1Res.Stdout()+id1Res.Stderr())
+
+	// Bring up dependent service; ensure foo is not recreated (ID unchanged)
+	base.ComposeCmd("-f", comp.YAMLFullPath(), "up", "-d", "bar").AssertOK()
+
+	id2Cmd := base.Cmd("inspect", fooName, "--format", "{{.Id}}")
+	id2Res := id2Cmd.Run()
+	out2 := strings.TrimSpace(id2Res.Stdout())
+	assert.Assert(id2Cmd.Base.T, id2Res.ExitCode == 0, id2Res.Stdout()+id2Res.Stderr())
+
+	assert.Equal(base.T, out1, out2)
+}
+
 func TestComposeUpWithExternalNetwork(t *testing.T) {
 	testCase := nerdtest.Setup()
 

pkg/composer/create.go

@@ -188,10 +188,15 @@ func (c *Composer) createServiceContainer(ctx context.Context, service *servicep
 	cidFilename := filepath.Join(tempDir, "cid")
 
 	//add metadata labels to container https://github.com/compose-spec/compose-spec/blob/master/spec.md#labels
+	currentHash, err := ServiceHash(*service.Unparsed)
+	if err != nil {
+		return "", fmt.Errorf("failed computing service hash for %s: %w", container.Name, err)
+	}
 	container.RunArgs = append([]string{
 		"--cidfile=" + cidFilename,
 		fmt.Sprintf("-l=%s=%s", labels.ComposeProject, c.project.Name),
 		fmt.Sprintf("-l=%s=%s", labels.ComposeService, service.Unparsed.Name),
+		fmt.Sprintf("-l=%s=%s", labels.ComposeConfigHash, currentHash),
 	}, container.RunArgs...)
 
 	cmd := c.createNerdctlCmd(ctx, append([]string{"create"}, container.RunArgs...)...)

pkg/composer/up.go

@@ -85,7 +85,7 @@ func (c *Composer) Up(ctx context.Context, uo UpOptions, services []string) erro
 
 	var parsedServices []*serviceparser.Service
 	// use WithServices to sort the services in dependency order
-	if err := c.project.ForEachService(services, func(name string, svc *types.ServiceConfig) error {
+	forEachFn := func(name string, svc *types.ServiceConfig) error {
 		if replicas, ok := uo.Scale[svc.Name]; ok {
 			if svc.Deploy == nil {
 				svc.Deploy = &types.DeployConfig{}
@@ -98,7 +98,9 @@ func (c *Composer) Up(ctx context.Context, uo UpOptions, services []string) erro
 		}
 		parsedServices = append(parsedServices, ps)
 		return nil
-	}); err != nil {
+	}
+	err := c.project.ForEachService(services, forEachFn)
+	if err != nil {
 		return err
 	}
 

pkg/composer/up_service.go

@@ -155,6 +155,28 @@ func (c *Composer) upServiceContainer(ctx context.Context, service *serviceparse
 
 	// delete container if it already exists
 	if existingCid != "" {
+		// Default behavior for RecreateDiverged: compare stored hash with current service hash
+		if recreate == RecreateDiverged {
+			currentHash, err := ServiceHash(*service.Unparsed)
+			if err != nil {
+				return "", fmt.Errorf("failed computing service hash for %s: %w", container.Name, err)
+			}
+			con, err := c.client.LoadContainer(ctx, existingCid)
+			if err != nil {
+				return "", fmt.Errorf("failed to load container %s: %w", existingCid, err)
+			}
+			lbls, err := con.Labels(ctx)
+			if err != nil {
+				return "", fmt.Errorf("failed to read labels for %s: %w", existingCid, err)
+			}
+			if lbls[labels.ComposeConfigHash] == currentHash {
+				cmd := c.createNerdctlCmd(ctx, append([]string{"start"}, existingCid)...)
+				if err := c.executeUpCmd(ctx, cmd, container.Name, runFlagD, service.Unparsed.StdinOpen); err != nil {
+					return "", fmt.Errorf("error while starting existing container %s: %w", container.Name, err)
+				}
+				return existingCid, nil
+			}
+		}
 		log.G(ctx).Debugf("Container %q already exists, deleting", container.Name)
 		delCmd := c.createNerdctlCmd(ctx, "rm", "-f", container.Name)
 		if err = delCmd.Run(); err != nil {
@@ -184,10 +206,15 @@ func (c *Composer) upServiceContainer(ctx context.Context, service *serviceparse
 	}
 
 	//add metadata labels to container https://github.com/compose-spec/compose-spec/blob/master/spec.md#labels
+	currentHash, err := ServiceHash(*service.Unparsed)
+	if err != nil {
+		return "", fmt.Errorf("failed computing service hash for %s: %w", container.Name, err)
+	}
 	container.RunArgs = append([]string{
 		"--cidfile=" + cidFilename,
 		fmt.Sprintf("-l=%s=%s", labels.ComposeProject, c.project.Name),
 		fmt.Sprintf("-l=%s=%s", labels.ComposeService, service.Unparsed.Name),
+		fmt.Sprintf("-l=%s=%s", labels.ComposeConfigHash, currentHash),
 	}, container.RunArgs...)
 
 	cmd := c.createNerdctlCmd(ctx, append([]string{"run"}, container.RunArgs...)...)

pkg/labels/labels.go

@@ -41,6 +41,9 @@ const (
 	//Compose Volume Name
 	ComposeVolume = "com.docker.compose.volume"
 
+	// ComposeConfigHash stores the service configuration hash used for convergence decisions
+	ComposeConfigHash = "com.docker.compose.config-hash"
+
 	// Hostname
 	Hostname = Prefix + "hostname"