Add --config to build command (microsoft/vscode-remote-release#8068)

Author: chrmarti

src/spec-node/devContainersSpecCLI.ts

@@ -452,6 +452,7 @@ function buildOptions(y: Argv) {
 		'docker-path': { type: 'string', description: 'Docker CLI path.' },
 		'docker-compose-path': { type: 'string', description: 'Docker Compose CLI path.' },
 		'workspace-folder': { type: 'string', required: true, description: 'Workspace folder path. The devcontainer.json will be looked up relative to this path.' },
+		'config': { type: 'string', description: 'devcontainer.json path. The default is to use .devcontainer/devcontainer.json or, if that does not exist, .devcontainer.json in the workspace folder.' },
 		'log-level': { choices: ['info' as 'info', 'debug' as 'debug', 'trace' as 'trace'], default: 'info' as 'info', description: 'Log level.' },
 		'log-format': { choices: ['text' as 'text', 'json' as 'json'], default: 'text' as 'text', description: 'Log format.' },
 		'no-cache': { type: 'boolean', default: false, description: 'Builds the image with `--no-cache`.' },
@@ -486,6 +487,7 @@ async function doBuild({
 	'docker-path': dockerPath,
 	'docker-compose-path': dockerComposePath,
 	'workspace-folder': workspaceFolderArg,
+	config: configParam,
 	'log-level': logLevel,
 	'log-format': logFormat,
 	'no-cache': buildNoCache,
@@ -505,7 +507,7 @@ async function doBuild({
 	};
 	try {
 		const workspaceFolder = path.resolve(process.cwd(), workspaceFolderArg);
-		const configFile: URI | undefined = /* config ? URI.file(path.resolve(process.cwd(), config)) : */ undefined; // TODO
+		const configFile: URI | undefined = configParam ? URI.file(path.resolve(process.cwd(), configParam)) : undefined;
 		const overrideConfigFile: URI | undefined = /* overrideConfig ? URI.file(path.resolve(process.cwd(), overrideConfig)) : */ undefined;
 		const addCacheFroms = addCacheFrom ? (Array.isArray(addCacheFrom) ? addCacheFrom as string[] : [addCacheFrom]) : [];
 		const additionalFeatures = additionalFeaturesJson ? jsonc.parse(additionalFeaturesJson) as Record<string, string | boolean | Record<string, string | boolean>> : {};

src/test/cli.build.test.ts

@@ -8,6 +8,8 @@ import * as assert from 'assert';
 import * as path from 'path';
 import * as os from 'os';
 import { buildKitOptions, shellExec } from './testUtils';
+import { ImageDetails } from '../spec-shutdown/dockerUtils';
+import { envListToObj } from '../spec-node/utils';
 
 const pkg = require('../../package.json');
 
@@ -249,5 +251,14 @@ describe('Dev Containers CLI', function () {
 
 			await shellExec(`docker rm -f ${containerId}`);
 		});
+
+		it('should build with config in subfolder', async () => {
+			const res = await shellExec(`${cli} build --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json --image-name test-subfolder-config`);
+			const response = JSON.parse(res.stdout);
+			assert.strictEqual(response.outcome, 'success');
+
+			const details = JSON.parse((await shellExec(`docker inspect test-subfolder-config`)).stdout)[0] as ImageDetails;
+			assert.strictEqual(envListToObj(details.Config.Env).SUBFOLDER_CONFIG_IMAGE_ENV, 'true');
+		});
 	});
 });

src/test/cli.exec.base.ts

@@ -363,6 +363,17 @@ export function describeTests2({ text, options }: BuildKitOption) {
 					assert.equal(success, false, 'expect non-successful call');
 				});
 			}
+
+			it('should exec with config in subfolder', async () => {
+				const upRes = await shellExec(`${cli} up --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json`);
+				const response = JSON.parse(upRes.stdout);
+				assert.strictEqual(response.outcome, 'success');
+
+				const execRes = await shellExec(`${cli} exec --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json bash -c 'printenv SUBFOLDER_CONFIG_REMOTE_ENV'`);
+				assert.strictEqual(execRes.stdout.trim(), 'true');
+
+				await shellExec(`docker rm -f ${response.containerId}`);
+			});
 		});
 	});
 }

src/test/cli.test.ts

@@ -52,6 +52,22 @@ describe('Dev Containers CLI', function () {
 			}
 			assert.equal(success, false, 'expect non-successful call');
 		});
+
+		it('should run with config in subfolder', async () => {
+			const upRes = await shellExec(`${cli} up --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json --skip-post-create`);
+			const upResponse = JSON.parse(upRes.stdout);
+			assert.strictEqual(upResponse.outcome, 'success');
+
+			await shellExec(`docker exec ${upResponse.containerId} bash -c '! test -f /subfolderConfigPostCreateCommand.txt'`);
+
+			const runRes = await shellExec(`${cli} run-user-commands --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json`);
+			const runResponse = JSON.parse(runRes.stdout);
+			assert.strictEqual(runResponse.outcome, 'success');
+
+			await shellExec(`docker exec ${upResponse.containerId} test -f /subfolderConfigPostCreateCommand.txt`);
+
+			await shellExec(`docker rm -f ${upResponse.containerId}`);
+		});
 	});
 
 	describe('Command read-configuration', () => {
@@ -102,5 +118,11 @@ describe('Dev Containers CLI', function () {
 				await shellExec(`docker rm -f ${containerId}`);
 			}
 		});
+
+		it('should read config in subfolder', async () => {
+			const res = await shellExec(`${cli} read-configuration --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json`);
+			const response = JSON.parse(res.stdout);
+			assert.strictEqual(response.configuration.remoteEnv.SUBFOLDER_CONFIG_REMOTE_ENV, 'true');
+		});
 	});
 });

src/test/cli.up.test.ts

@@ -184,5 +184,15 @@ describe('Dev Containers CLI', function () {
 
 			await shellExec(`docker rm -f ${containerId}`);
 		});
+
+		it('should run with config in subfolder', async () => {
+			const upRes = await shellExec(`${cli} up --workspace-folder ${__dirname}/configs/dockerfile-without-features --config ${__dirname}/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json`);
+			const response = JSON.parse(upRes.stdout);
+			assert.strictEqual(response.outcome, 'success');
+
+			await shellExec(`docker exec ${response.containerId} test -f /subfolderConfigPostCreateCommand.txt`);
+
+			await shellExec(`docker rm -f ${response.containerId}`);
+		});
 	});
 });

src/test/configs/dockerfile-without-features/.devcontainer/subfolder/Dockerfile

@@ -0,0 +1,3 @@
+FROM ubuntu:latest
+
+ENV SUBFOLDER_CONFIG_IMAGE_ENV=true

src/test/configs/dockerfile-without-features/.devcontainer/subfolder/devcontainer.json

@@ -0,0 +1,9 @@
+{
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"remoteEnv": {
+		"SUBFOLDER_CONFIG_REMOTE_ENV": "true"
+	},
+	"postCreateCommand": "touch /subfolderConfigPostCreateCommand.txt"
+}