unknown flag: --env-file with docker compose v2 when using withEnvironmentFile function

[viswanr]

Expected Behaviour
The DockerComposeEnvironment is successfully created

Actual Behaviour
Errors out with:
unknown flag: --env-file
See 'docker --help'.

Usage:  docker [OPTIONS] COMMAND

Steps to Reproduce

1. Install Docker Desktop on Windows with WSL enabled and Docker Compose V2 enabled.

The following code fails:

// Setup docker compose environment
    const env = new DockerComposeEnvironment(
      ".",
      "docker-compose.yml"
    ).withBuild();
    if (envFile && envFile.length > 0) {
      env.withEnvironmentFile(envFile);
    }

    // Starting services within container
    this.sandbox = await env.up(this.functionAppServices);

Environment Information

• Operating System: Windows
• Docker Version: Docker Desktop 4.16.3 (96739), Docker Engine v20.10.22
• Node version: v16.19.0
• Testcontainers version: "^9.1.3"

Looks like there is some ordering problem of arguments to docker with compose v2?

[cristianrgreco]

Hi @viswanr, thanks for raising - I've tried on a Mac with compose V2 and it works. I see there's a similar issue here about this feature not working in Windows, could it be what you're seeing? docker/compose#6965

[viswanr]

@cristianrgreco I don't think it's the same thing. I clearly see an error saying --env-file is an unknown flag. Any idea how I can grab test container logs?

[viswanr]

Callstack:

at node_modules/testcontainers/dist/docker-compose/functions/docker-compose-up.js:37:15
          at Generator.throw (<anonymous>)
      at rejected (node_modules/testcontainers/dist/docker-compose/functions/docker-compose-up.js:6:65)

[viswanr]

So if i select the following, it fails. If i deselect, it works. How can we set the version of docker compose between v1 and v2?

[cristianrgreco]

I've tested this just now on a Windows machine with both versions of compose and it works. What is the name of the file you are providing? There is an acceptance test for this functionality here:

testcontainers-node/src/docker-compose-environment/docker-compose-environment.test.ts

Lines 207 to 220 in a2a74c8

	it("should load the values in the environment file if the environment file option is set", async () => {
	const overrideFixtures = path.resolve(fixtures, "docker-compose-with-env-file");
	const startedEnvironment = await new DockerComposeEnvironment(overrideFixtures, "docker-compose.yml")
	.withEnvironmentFile(".env.override")
	.up();
	const container = startedEnvironment.getContainer(await composeContainerName("container"));
	const response = await fetch(`http://${container.getHost()}:${container.getMappedPort(8080)}/env`);
	const responseBody = await response.json();
	expect(responseBody["ENV_VAR"]).toBe("override");
	await startedEnvironment.down();
	});

[cristianrgreco]

I've just tested an environment file with spaces, also no issue.
If the issue persists please provide a small repro and I will re-open, closing this for now.

[Lysander086]

The command option order really matters. The below is what works for my Windows 11.

docker compose -f .\local.yml --env-file .\docker_local.env up