Fix project name with env variable (#839)

Author: chrmarti

src/spec-node/dockerCompose.ts

@@ -654,16 +654,20 @@ export async function getProjectName(params: DockerCLIParameters | DockerResolve
 			throw err;
 		}
 	}
-	for (let i = composeFiles.length - 1; i >= 0; i--) {
-		try {
-			const fragment = yaml.load((await cliHost.readFile(composeFiles[i])).toString()) || {} as any;
-			if (fragment.name) {
-				return toProjectName(fragment.name, newProjectName);
-			}
-		} catch (error) {
-			// fallback when parsing fails due to custom yaml tags (e.g., !reset)
-			if (composeConfig?.name && composeConfig.name !== 'devcontainer') {
-				return toProjectName(composeConfig.name, newProjectName);
+	if (composeConfig?.name) {
+		if (composeConfig.name !== 'devcontainer') {
+			return toProjectName(composeConfig.name, newProjectName);
+		}
+		// Check if 'devcontainer' is from a compose file or just the default.
+		for (let i = composeFiles.length - 1; i >= 0; i--) {
+			try {
+				const fragment = yaml.load((await cliHost.readFile(composeFiles[i])).toString()) || {} as any;
+				if (fragment.name) {
+					// Use composeConfig.name ('devcontainer') because fragment.name could include environment variables.
+					return toProjectName(composeConfig.name, newProjectName);
+				}
+			} catch (error) {
+				// Ignore when parsing fails due to custom yaml tags (e.g., !reset)
 			}
 		}
 	}

src/test/cli.up.test.ts

@@ -105,6 +105,46 @@ describe('Dev Containers CLI', function () {
 				assert.equal(upResult!.composeProjectName, 'custom-project-name');
 			});
 		});
+		describe('for minimal docker-compose with custom project name using environment variable', () => {
+			let upResult: UpResult | null = null;
+			const testFolder = `${__dirname}/configs/compose-with-name-using-env-var`;
+			before(async () => {
+				// build and start the container
+				upResult = await devContainerUp(cli, testFolder, {
+					logLevel: 'trace',
+					extraArgs: `--docker-compose-path trigger-compose-v2`,
+					env: {
+						...process.env,
+						'CUSTOM_NAME': 'custom-name-with-env-var'
+					}
+				});
+			});
+			after(async () => await devContainerDown({ composeProjectName: upResult?.composeProjectName }));
+			it('should succeed', () => {
+				assert.equal(upResult!.outcome, 'success');
+				assert.equal(upResult!.composeProjectName, 'custom-name-with-env-var');
+			});
+		});
+		describe('for minimal docker-compose with custom project name "devcontainer" using environment variable', () => {
+			let upResult: UpResult | null = null;
+			const testFolder = `${__dirname}/configs/compose-with-name-using-env-var`;
+			before(async () => {
+				// build and start the container
+				upResult = await devContainerUp(cli, testFolder, {
+					logLevel: 'trace',
+					extraArgs: `--docker-compose-path trigger-compose-v2`,
+					env: {
+						...process.env,
+						'CUSTOM_NAME': 'devcontainer'
+					}
+				});
+			});
+			after(async () => await devContainerDown({ composeProjectName: upResult?.composeProjectName }));
+			it('should succeed', () => {
+				assert.equal(upResult!.outcome, 'success');
+				assert.equal(upResult!.composeProjectName, 'devcontainer');
+			});
+		});
 		describe('for minimal docker-compose with custom project name and custom yaml', () => {
 			let upResult: UpResult | null = null;
 			const testFolder = `${__dirname}/configs/compose-with-name-and-custom-yaml`;

src/test/configs/compose-with-name-using-env-var/.devcontainer/devcontainer.json

@@ -0,0 +1,5 @@
+{
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "app",
+	"workspaceFolder": "/workspace"
+}

src/test/configs/compose-with-name-using-env-var/.devcontainer/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.8'
+
+name: ${CUSTOM_NAME}
+
+services:
+  app:
+    image: ubuntu:latest
+    volumes:
+      - ..:/workspace:cached
+    command: sleep infinity