Skip to content

Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ndeloof wants to merge 1 commit into from
Closed

Add e2e tests for reconciliation behavior #13749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions pkg/e2e/compose_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
c := NewCLI(t)
const projectName = "replace-label"
t.Cleanup(func() {
c.cleanupWithDown(t, projectName)
})

// First up: fresh container has no replace label
c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
"--project-name", projectName, "up", "-d")
res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
"-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
res.Assert(t, icmd.Expected{Out: ""})

// Second up with changed env triggers recreate
cli := NewCLI(t, WithEnv("TAG=v2"))
res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
"--project-name", projectName, "up", "-d")
assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

// Recreated container should have replace label pointing to old name
res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
"-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
"expected replace label with 'svc-1', got: %s", res.Stdout())
}
6 changes: 6 additions & 0 deletions pkg/e2e/fixtures/replace-label/compose.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
svc:
image: alpine
command: sleep infinity
environment:
- TAG=${TAG:-v1}
31 changes: 31 additions & 0 deletions pkg/e2e/networks_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
c := NewCLI(t)
const projectName = "network_config_reconnect"
t.Cleanup(func() {
c.cleanupWithDown(t, projectName)
})

c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
"--project-name", projectName, "up", "-d")

netName := fmt.Sprintf("%s_test", projectName)
res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
initialNetID := strings.TrimSpace(res.Stdout())

// Change network config (label) -> network recreated
cli := NewCLI(t, WithEnv("FOO=changed"))
cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
"--project-name", projectName, "up", "-d")

// Network ID must have changed
res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
newNetID := strings.TrimSpace(res.Stdout())
assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

// Container must be connected to the new network
res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
"-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
"expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
c := NewCLI(t)
const projectName = "network_recreate"
Expand Down
31 changes: 31 additions & 0 deletions pkg/e2e/restart_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
c := NewCLI(t, WithEnv(
"COMPOSE_PROJECT_NAME=e2e-dep-restart",
))
t.Cleanup(func() {
c.RunDockerComposeCmd(t, "down", "--remove-orphans")
})

// First up
c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

// Recreate nginx (change label) → with-restart depends with restart:true
// so it should be stopped then restarted (same container, not replaced)
cli := NewCLI(t, WithEnv(
"COMPOSE_PROJECT_NAME=e2e-dep-restart",
"LABEL=recreate",
))
res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
out := res.Combined()

// The dependent with restart:true should have been stopped then started
assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
"expected dependent container in output: %s", out)

// All 3 containers should be running after convergence
res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
}
}

func TestRestartWithProfiles(t *testing.T) {
c := NewParallelCLI(t, WithEnv(
"COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down
27 changes: 27 additions & 0 deletions pkg/e2e/up_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
c := NewCLI(t)
const projectName = "compose-e2e-idempotent"
t.Cleanup(func() {
c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
})

c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
"--project-name", projectName, "up", "-d")

res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
initialID := strings.TrimSpace(res.Stdout())

// Second up with no changes
res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
"--project-name", projectName, "up", "-d")

assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
"expected Running in output: %s", res.Stderr())
assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
"unexpected Recreated: %s", res.Stderr())

// Container ID unchanged
res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
c := NewCLI(t)
const projectName = "compose-e2e-dependency-not-required"
Expand Down
25 changes: 25 additions & 0 deletions pkg/e2e/volumes_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
c := NewCLI(t)
const projectName = "compose-e2e-recreate-vol-ctr"
t.Cleanup(func() {
c.cleanupWithDown(t, projectName)
})

c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
"--project-name", projectName, "up", "-d")

// Get initial container ID
res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
initialID := strings.TrimSpace(res.Stdout())

// Change volume config + auto-confirm → volume and container recreated
c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
"--project-name", projectName, "up", "-d", "-y")

// Container ID should have changed (container was removed and recreated
// because Docker requires container removal to delete a volume)
res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
newID := strings.TrimSpace(res.Stdout())
assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
c := NewCLI(t)
const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add e2e tests for reconciliation behavior by ndeloof · Pull Request #13749 · docker/compose · GitHub
Skip to content
Add e2e tests for reconciliation behavior#13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

ndeloof
wants to merge
1
commit into

from

 Closed


Add e2e tests for reconciliation behavior
#13749
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


27 changes: 27 additions & 0 deletions
pkg/e2e/compose_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -406,3 +406,30 @@ func TestUnnecessaryResources(t *testing.T) {
	c.RunDockerComposeCmd(t, "-f", "./fixtures/external/compose.yaml", "-p", projectName, "up", "-d", "test")
	// Should not fail as missing external network is not used
}

func TestReplaceLabelOnRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "replace-label"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	// First up: fresh container has no replace label
	c.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	res.Assert(t, icmd.Expected{Out: ""})

	// Second up with changed env triggers recreate
	cli := NewCLI(t, WithEnv("TAG=v2"))
	res = cli.RunDockerComposeCmd(t, "-f", "./fixtures/replace-label/compose.yaml",
 "--project-name", projectName, "up", "-d")
	assert.Assert(t, strings.Contains(res.Stderr(), "Recreated"), res.Stderr())

	// Recreated container should have replace label pointing to old name
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-svc-1", projectName),
 "-f", `{{ index .Config.Labels "com.docker.compose.replace" }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), "svc-1"),
 "expected replace label with 'svc-1', got: %s", res.Stdout())
}

6 changes: 6 additions & 0 deletions
pkg/e2e/fixtures/replace-label/compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
services:
 svc:
 image: alpine
 command: sleep infinity
 environment:
 - TAG=${TAG:-v1}

31 changes: 31 additions & 0 deletions
pkg/e2e/networks_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,37 @@ func TestInterfaceName(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "foobar@"})
}

func TestNetworkConfigChangeReconnectsContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_config_reconnect"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	netName := fmt.Sprintf("%s_test", projectName)
	res := c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	initialNetID := strings.TrimSpace(res.Stdout())

	// Change network config (label) -> network recreated
	cli := NewCLI(t, WithEnv("FOO=changed"))
	cli.RunDockerComposeCmd(t, "-f", "./fixtures/network-recreate/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Network ID must have changed
	res = c.RunDockerCmd(t, "network", "inspect", netName, "-f", "{{ .Id }}")
	newNetID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newNetID != initialNetID, "expected network to be recreated with new ID")

	// Container must be connected to the new network
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-web-1", projectName),
 "-f", `{{ range .NetworkSettings.Networks }}{{ .NetworkID }}{{ end }}`)
	assert.Assert(t, strings.Contains(res.Stdout(), newNetID),
 "expected container on new network %s, got: %s", newNetID, res.Stdout())
}

func TestNetworkRecreate(t *testing.T) {
	c := NewCLI(t)
	const projectName = "network_recreate"
Expand Down

31 changes: 31 additions & 0 deletions
pkg/e2e/restart_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,37 @@ func TestRestartWithDependencies(t *testing.T) {
	assert.Assert(t, strings.Contains(out, fmt.Sprintf("Container e2e-restart-deps-%s-1 Running", depNoRestart)), out)
}

func TestDependentContainerRestartedOnRecreate(t *testing.T) {
	c := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
	))
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "down", "--remove-orphans")
	})

	// First up
	c.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")

	// Recreate nginx (change label) → with-restart depends with restart:true
	// so it should be stopped then restarted (same container, not replaced)
	cli := NewCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-dep-restart",
 "LABEL=recreate",
	))
	res := cli.RunDockerComposeCmd(t, "-f", "./fixtures/restart-test/compose-depends-on.yaml", "up", "-d")
	out := res.Combined()

	// The dependent with restart:true should have been stopped then started
	assert.Assert(t, strings.Contains(out, "e2e-dep-restart-with-restart-1"),
 "expected dependent container in output: %s", out)

	// All 3 containers should be running after convergence
	res = c.RunDockerComposeCmd(t, "ps", "--format", "{{.State}}")
	for _, line := range strings.Split(strings.TrimSpace(res.Stdout()), "\n") {
 assert.Equal(t, strings.TrimSpace(line), "running", "expected all containers running")
	}
}

func TestRestartWithProfiles(t *testing.T) {
	c := NewParallelCLI(t, WithEnv(
 "COMPOSE_PROJECT_NAME=e2e-restart-profiles",
Expand Down

27 changes: 27 additions & 0 deletions
pkg/e2e/up_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,33 @@ func TestScaleDoesntRecreate(t *testing.T) {
	assert.Check(t, !strings.Contains(res.Combined(), "Recreated"))
}

func TestUpIdempotent(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-idempotent"
	t.Cleanup(func() {
 c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
	})

	c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Second up with no changes
	res = c.RunDockerComposeCmd(t, "-f", "fixtures/simple-composefile/compose.yaml",
 "--project-name", projectName, "up", "-d")

	assert.Assert(t, strings.Contains(res.Stderr(), "Running"),
 "expected Running in output: %s", res.Stderr())
	assert.Assert(t, !strings.Contains(res.Stderr(), "Recreated"),
 "unexpected Recreated: %s", res.Stderr())

	// Container ID unchanged
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-simple-1", projectName), "-f", "{{ .Id }}")
	assert.Equal(t, strings.TrimSpace(res.Stdout()), initialID)
}

func TestUpWithDependencyNotRequired(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-dependency-not-required"
Expand Down

25 changes: 25 additions & 0 deletions
pkg/e2e/volumes_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,31 @@ func TestUpRecreateVolumes(t *testing.T) {
	res.Assert(t, icmd.Expected{Out: "zot"})
}

func TestUpRecreateVolumesAlsoRecreatesContainers(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-vol-ctr"
	t.Cleanup(func() {
 c.cleanupWithDown(t, projectName)
	})

	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml",
 "--project-name", projectName, "up", "-d")

	// Get initial container ID
	res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	initialID := strings.TrimSpace(res.Stdout())

	// Change volume config + auto-confirm → volume and container recreated
	c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml",
 "--project-name", projectName, "up", "-d", "-y")

	// Container ID should have changed (container was removed and recreated
	// because Docker requires container removal to delete a volume)
	res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ .Id }}")
	newID := strings.TrimSpace(res.Stdout())
	assert.Assert(t, newID != initialID, "expected container to be recreated after volume change")
}

func TestUpRecreateVolumes_IgnoreBinds(t *testing.T) {
	c := NewCLI(t)
	const projectName = "compose-e2e-recreate-volumes"
Expand Down
Loading