Escape and enclose containerEnv in quotes when writing to Dockerfile (#454)

Author: joshspicer

src/spec-node/imageMetadata.ts

@@ -489,8 +489,9 @@ export function getContainerEnvMetadata(containerEnv: Record<string, string> | u
 	if (!containerEnv) {
 		return '';
 	}
-
 	const keys = Object.keys(containerEnv);
-	const concatenatedEnv = keys.map(k => `ENV ${k}=${containerEnv![k]}`).join('\n');
-	return concatenatedEnv;
+	// https://docs.docker.com/engine/reference/builder/#envs
+	return keys.map(k => `ENV ${k}="${containerEnv[k]
+		.replace(/(?=["\\$])/g, '\\') // escape double quotes, back slash, and dollar sign
+		}"`).join('\n');
 }

src/test/cli.build.test.ts

@@ -232,8 +232,20 @@ describe('Dev Containers CLI', function () {
 			const containerId: string = resRun.stdout.split('\n')[0];
 			assert.ok(containerId, 'Container id not found.');
 
-			const result = await shellExec(`docker exec ${containerId} bash -c 'echo $JAVA_HOME'`);
-			assert.equal('/usr/lib/jvm/msopenjdk-current\n', result.stdout);
+			const expectedContainerEnv = {
+				'JAVA_HOME': '/usr/lib/jvm/msopenjdk-current',
+				'VAR_WITH_SPACES': 'value with spaces',
+				'VAR_WITH_LOTS_OF_SPACES': '    value with lots of spaces.   ',
+				'VAR_WITH_QUOTES_WE_WANT_TO_KEEP': 'value with "quotes" we want to keep',
+				'VAR_WITH_DOLLAR_SIGN': 'value with $dollar sign',
+				'VAR_WITH_BACK_SLASH': 'value with \\back slash',
+				'ENV_WITH_COMMAND': 'bash -c \'echo -n "Hello, World!"\''
+			};
+
+			for (const [key, value] of Object.entries(expectedContainerEnv)) {
+				const result = await shellExec(`docker exec ${containerId} bash -c 'echo $${key}'`);
+				assert.equal(result.stdout, `${value.trim()}\n`);
+			}
 
 			await shellExec(`docker rm -f ${containerId}`);
 		});

src/test/cli.up.test.ts

@@ -173,8 +173,14 @@ describe('Dev Containers CLI', function () {
 			const containerId: string = response.containerId;
 			assert.ok(containerId, 'Container id not found.');
 
-			const result = await shellExec(`docker exec ${containerId} bash -c 'echo $JAVA_HOME'`);
-			assert.equal('/usr/lib/jvm/msopenjdk-current\n', result.stdout);
+			const javaHome = await shellExec(`docker exec ${containerId} bash -c 'echo -n $JAVA_HOME'`);
+			assert.equal('/usr/lib/jvm/msopenjdk-current', javaHome.stdout);
+
+			const envWithSpaces = await shellExec(`docker exec ${containerId} bash -c 'echo -n $VAR_WITH_SPACES'`);
+			assert.equal('value with spaces', envWithSpaces.stdout);
+
+			const evalEnvWithCommand = await shellExec(`docker exec ${containerId} bash -c 'eval $ENV_WITH_COMMAND'`);
+			assert.equal('Hello, World!', evalEnvWithCommand.stdout);
 
 			await shellExec(`docker rm -f ${containerId}`);
 		});

src/test/configs/image-metadata-containerEnv/.devcontainer/devcontainer.json

@@ -6,6 +6,12 @@
         }
     },
     "containerEnv": {
-        "JAVA_HOME": "/usr/lib/jvm/msopenjdk-current"
+        "JAVA_HOME": "/usr/lib/jvm/msopenjdk-current",
+        "VAR_WITH_SPACES": "value with spaces",
+        "VAR_WITH_LOTS_OF_SPACES": "    value with lots of spaces.   ",
+        "VAR_WITH_QUOTES_WE_WANT_TO_KEEP": "value with \"quotes\" we want to keep",
+        "VAR_WITH_DOLLAR_SIGN": "value with $dollar sign",
+        "VAR_WITH_BACK_SLASH": "value with \\back slash",
+        "ENV_WITH_COMMAND": "bash -c 'echo -n \"Hello, World!\"'"
     }
 }