Allow empty value for remote env (devcontainers/ci#231)

devcontainers · Mar 5, 2024 · ab79dd6 · ab79dd6
1 parent 30d2105
commit ab79dd6
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/src/spec-node/devContainersSpecCLI.ts b/src/spec-node/devContainersSpecCLI.ts
@@ -149,7 +149,7 @@ function provisionOptions(y: Argv) {
 				throw new Error('Unmatched argument format: mount must match type=<bind|volume>,source=<source>,target=<target>[,external=<true|false>]');
 			}
 			const remoteEnvs = (argv['remote-env'] && (Array.isArray(argv['remote-env']) ? argv['remote-env'] : [argv['remote-env']])) as string[] | undefined;
-			if (remoteEnvs?.some(remoteEnv => !/.+=.+/.test(remoteEnv))) {
+			if (remoteEnvs?.some(remoteEnv => !/.+=.*/.test(remoteEnv))) {
 				throw new Error('Unmatched argument format: remote-env must match <name>=<value>');
 			}
 			return true;
@@ -334,7 +334,7 @@ function setUpOptions(y: Argv) {
 	})
 		.check(argv => {
 			const remoteEnvs = (argv['remote-env'] && (Array.isArray(argv['remote-env']) ? argv['remote-env'] : [argv['remote-env']])) as string[] | undefined;
-			if (remoteEnvs?.some(remoteEnv => !/.+=.+/.test(remoteEnv))) {
+			if (remoteEnvs?.some(remoteEnv => !/.+=.*/.test(remoteEnv))) {
 				throw new Error('Unmatched argument format: remote-env must match <name>=<value>');
 			}
 			return true;
@@ -742,7 +742,7 @@ function runUserCommandsOptions(y: Argv) {
 				throw new Error('Unmatched argument format: id-label must match <name>=<value>');
 			}
 			const remoteEnvs = (argv['remote-env'] && (Array.isArray(argv['remote-env']) ? argv['remote-env'] : [argv['remote-env']])) as string[] | undefined;
-			if (remoteEnvs?.some(remoteEnv => !/.+=.+/.test(remoteEnv))) {
+			if (remoteEnvs?.some(remoteEnv => !/.+=.*/.test(remoteEnv))) {
 				throw new Error('Unmatched argument format: remote-env must match <name>=<value>');
 			}
 			if (!argv['container-id'] && !idLabels?.length && !argv['workspace-folder']) {
@@ -1197,7 +1197,7 @@ function execOptions(y: Argv) {
 				throw new Error('Unmatched argument format: id-label must match <name>=<value>');
 			}
 			const remoteEnvs = (argv['remote-env'] && (Array.isArray(argv['remote-env']) ? argv['remote-env'] : [argv['remote-env']])) as string[] | undefined;
-			if (remoteEnvs?.some(remoteEnv => !/.+=.+/.test(remoteEnv))) {
+			if (remoteEnvs?.some(remoteEnv => !/.+=.*/.test(remoteEnv))) {
 				throw new Error('Unmatched argument format: remote-env must match <name>=<value>');
 			}
 			if (!argv['container-id'] && !idLabels?.length && !argv['workspace-folder']) {

diff --git a/src/test/cli.exec.base.ts b/src/test/cli.exec.base.ts
@@ -70,6 +70,18 @@ export function describeTests1({ text, options }: BuildKitOption) {
 					assert.equal(res.signal, undefined);
 					assert.match(res.cmdOutput, /BARhiBAR/);
 				});
+				it('should pass along --remote-env', async () => {
+					const res = await shellBufferExec(`${cli} exec --workspace-folder ${testFolder} --remote-env FOO=BAR --remote-env BAZ= printenv`);
+					assert.strictEqual(res.code, 0);
+					assert.equal(res.signal, undefined);
+					const stdout = res.stdout.toString();
+					const env = stdout
+						.split('\n')
+						.map(l => l.split('='))
+						.reduce((m, [k, v]) => { m[k] = v; return m; }, {} as { [key: string]: string });
+					assert.strictEqual(env.FOO, 'BAR');
+					assert.strictEqual(env.BAZ, '');
+				});
 			});
 			describe(`with valid (image) config containing features [${text}]`, () => {
 				let containerId: string | null = null;