test added to check the --label applied successfully

Author: prathameshzarkar9

.vscode/launch.json

@@ -30,24 +30,12 @@
                 "-r",
                 "ts-node/register",
                 "--exit",
-                "src/test/cli.build.test.ts"
+                "src/test/*.test.ts"
             ],
             "env": {
                 "TS_NODE_PROJECT": "src/test/tsconfig.json"
             },
             "console": "integratedTerminal",
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Launch Help",
-            "program": "${workspaceFolder}/src/spec-node/devContainersSpecCLI.ts",
-            "cwd": "${workspaceFolder}",
-            "args": [
-                "build",
-                "--help"
-            ],
-            "console": "integratedTerminal",
         }
     ]
 }

src/spec-node/containerFeatures.ts

@@ -113,7 +113,7 @@ export async function extendImage(params: DockerResolverParameters, config: Subs
 		'--target', featureBuildInfo.overrideTarget,
 		'-f', dockerfilePath,
 		...additionalImageNames.length > 0 ? additionalImageNames.map(name => ['-t', name]).flat() : ['-t', updatedImageName],
-		...imageLabels.length > 0 ? imageLabels.map(name => ['-t', name]).flat() : ['-t', imageLabels],
+		...imageLabels.length > 0 ? imageLabels.map(label => ['--label', label]).flat() : ['--label', imageLabels.toString()],
 		emptyTempDir
 	);
 

src/spec-node/singleContainer.ts

@@ -122,12 +122,13 @@ function getDefaultName(config: DevContainerFromDockerfileConfig | DevContainerF
 export async function buildNamedImageAndExtend(params: DockerResolverParameters, configWithRaw: SubstitutedConfig<DevContainerFromDockerfileConfig | DevContainerFromImageConfig>, additionalFeatures: Record<string, string | boolean | Record<string, string | boolean>>, canAddLabelsToContainer: boolean, argImageNames?: string[], imageLabels?: string[]): Promise<{ updatedImageName: string[]; imageMetadata: SubstitutedConfig<ImageMetadataEntry[]>; imageDetails: () => Promise<ImageDetails>; labels?: Record<string, string> }> {
 	const { config } = configWithRaw;
 	const imageNames = argImageNames ?? [getDefaultName(config, params)];
+	const imagelabel = imageLabels ?? [getDefaultName(config, params)];
 	params.common.progress(ResolverProgress.BuildingImage);
 	if (isDockerFileConfig(config)) {
 		return await buildAndExtendImage(params, configWithRaw as SubstitutedConfig<DevContainerFromDockerfileConfig>, imageNames, params.buildNoCache ?? false, additionalFeatures);
 	}
 	// image-based dev container - extend
-	return await extendImage(params, configWithRaw, imageNames[0], argImageNames || [], imageLabels || [], additionalFeatures, canAddLabelsToContainer);
+	return await extendImage(params, configWithRaw, imageNames[0], argImageNames || [], imagelabel || [], additionalFeatures, canAddLabelsToContainer);
 }
 
 async function buildAndExtendImage(buildParams: DockerResolverParameters, configWithRaw: SubstitutedConfig<DevContainerFromDockerfileConfig>, baseImageNames: string[], noCache: boolean, additionalFeatures: Record<string, string | boolean | Record<string, string | boolean>>) {

src/test/cli.build.test.ts

@@ -27,6 +27,15 @@ describe('Dev Containers CLI', function () {
 
 	describe('Command build', () => {
 
+		it('should build successfully with valid image metadata --label property', async () => {
+			const testFolder = `${__dirname}/configs/example`;
+			const response = await shellExec(`${cli} build --workspace-folder ${testFolder} --label 'name=label-test' --label 'type=multiple-labels'`);
+			const res = JSON.parse(response.stdout);
+			assert.equal(res.outcome, 'success');
+			const labels = await shellExec(`docker inspect --format '{{json .Config.Labels}}' ${res.imageName} | jq`);
+			assert.match(labels.stdout.toString(), /\"name\": \"label-test\"/);
+		});
+
 		it('should fail to build with correct error message for local feature', async () => {
 			const testFolder = `${__dirname}/configs/image-with-local-feature`;
 			try {