Support additional Docker build options (#85)

Author: chrmarti

src/spec-configuration/configuration.ts

@@ -119,6 +119,7 @@ export type DevContainerFromDockerfileConfig = {
 				target?: string;
 				args?: Record<string, string>;
 				cacheFrom?: string | string[];
+				options?: string[];
 			};
 		}
 		|
@@ -129,6 +130,7 @@ export type DevContainerFromDockerfileConfig = {
 				target?: string;
 				args?: Record<string, string>;
 				cacheFrom?: string | string[];
+				options?: string[];
 			};
 		}
 	);

src/spec-node/singleContainer.ts

@@ -243,6 +243,10 @@ async function buildAndExtendImage(buildParams: DockerResolverParameters, config
 			args.push('--build-arg', `${key}=${buildArgs[key]}`);
 		}
 	}
+	const buildOptions = config.build?.options;
+	if (buildOptions?.length) {
+		args.push(...buildOptions);
+	}
 	args.push(...additionalBuildArgs);
 	args.push(await uriToWSLFsPath(getDockerContextPath(cliHost, config), cliHost));
 	try {

src/test/cli.build.test.ts

@@ -315,5 +315,15 @@ describe('Dev Containers CLI', function () {
 			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');
 		});
+
+		it('should apply build options', async () => {
+			const testFolder = `${__dirname}/configs/dockerfile-with-target`;
+			const res = await shellExec(`${cli} build --workspace-folder ${testFolder}`);
+			const response = JSON.parse(res.stdout);
+			assert.equal(response.outcome, 'success');
+			assert.ok(response.imageName);
+			const details = JSON.parse((await shellExec(`docker inspect ${response.imageName}`)).stdout)[0] as ImageDetails;
+			assert.strictEqual(details.Config.Labels?.test_build_options, 'success');
+		});
 	});
 });

src/test/configs/dockerfile-with-target/.devcontainer.json

@@ -4,7 +4,8 @@
 		"target": "desired-image",
 		"args": { 
 			"VARIANT": "16-bullseye"
-		}
+		},
+		"options": [ "--label", "test_build_options=success" ]
 	},
 	"postCreateCommand": "touch /tmp/postCreateCommand.testmarker",
 	"postStartCommand": "touch /tmp/postStartCommand.testmarker",