Merge pull request #392 from devcontainers/samruddhikhandale/containerenv-bug

Bug fix: Merge metadata logic for containerEnv - devcontainer build

Author: samruddhikhandale

src/spec-configuration/containerFeaturesConfiguration.ts

@@ -245,6 +245,8 @@ ARG _DEV_CONTAINERS_IMAGE_USER=root
 USER $_DEV_CONTAINERS_IMAGE_USER
 
 #{devcontainerMetadata}
+
+#{containerEnvMetadata}
 `;
 }
 

src/spec-node/containerFeatures.ts

@@ -15,7 +15,7 @@ import { readLocalFile } from '../spec-utils/pfs';
 import { includeAllConfiguredFeatures } from '../spec-utils/product';
 import { createFeaturesTempFolder, DockerResolverParameters, getCacheFolder, getFolderImageName, getEmptyContextFolder, SubstitutedConfig } from './utils';
 import { isEarlierVersion, parseVersion } from '../spec-common/commonUtils';
-import { getDevcontainerMetadata, getDevcontainerMetadataLabel, getImageBuildInfoFromImage, ImageBuildInfo, ImageMetadataEntry, imageMetadataLabel, MergedDevContainerConfig } from './imageMetadata';
+import { getContainerEnvMetadata, getDevcontainerMetadata, getDevcontainerMetadataLabel, getImageBuildInfoFromImage, ImageBuildInfo, ImageMetadataEntry, imageMetadataLabel, MergedDevContainerConfig } from './imageMetadata';
 import { supportsBuildContexts } from './dockerfileUtils';
 import { ContainerError } from '../spec-common/errors';
 
@@ -293,6 +293,7 @@ async function getFeaturesBuildOptions(params: DockerResolverParameters, devCont
 		.replace('#{containerEnv}', generateContainerEnvs(featuresConfig))
 		.replace('#{copyFeatureBuildStages}', getCopyFeatureBuildStages(featuresConfig, buildStageScripts))
 		.replace('#{devcontainerMetadata}', getDevcontainerMetadataLabel(imageMetadata, common.experimentalImageMetadata))
+		.replace('#{containerEnvMetadata}', getContainerEnvMetadata(devContainerConfig.config.containerEnv))
 		;
 	const syntax = imageBuildInfo.dockerfile?.preamble.directives.syntax;
 	const dockerfilePrefixContent = `${useBuildKitBuildContexts && !(imageBuildInfo.dockerfile && supportsBuildContexts(imageBuildInfo.dockerfile)) ?

src/spec-node/imageMetadata.ts

@@ -443,3 +443,13 @@ function toLabelString(obj: object) {
 	return JSON.stringify(obj)
 		.replace(/(?=["\\$])/g, '\\');
 }
+
+export function getContainerEnvMetadata(containerEnv: Record<string, string> | undefined): string {
+	if (!containerEnv) {
+		return '';
+	}
+
+	const keys = Object.keys(containerEnv);
+	const concatenatedEnv = keys.map(k => `ENV ${k}=${containerEnv![k]}`).join('\n');
+	return concatenatedEnv;
+}

src/test/cli.build.test.ts

@@ -222,5 +222,20 @@ describe('Dev Containers CLI', function () {
 				await shellExec(`docker buildx rm ${builderName}`);
 			}
 		});
+
+		it('should follow the correct merge logic for containerEnv', async () => {
+			const res = await shellExec(`${cli} build --workspace-folder ${__dirname}/configs/image-metadata-containerEnv --image-name "test-metadata"`);
+			const response = JSON.parse(res.stdout);
+			assert.equal(response.outcome, 'success');
+
+			const resRun = await shellExec(`docker run -it -d "test-metadata"`);
+			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);
+
+			await shellExec(`docker rm -f ${containerId}`);
+		});
 	});
 });

src/test/cli.up.test.ts

@@ -165,5 +165,18 @@ describe('Dev Containers CLI', function () {
 				});
 			});
 		});
+
+		it('should follow the correct merge logic for containerEnv', async () => {
+			const res = await shellExec(`${cli} up --workspace-folder ${__dirname}/configs/image-metadata-containerEnv`);
+			const response = JSON.parse(res.stdout);
+			assert.equal(response.outcome, 'success');
+			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);
+
+			await shellExec(`docker rm -f ${containerId}`);
+		});
 	});
 });

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

@@ -0,0 +1,11 @@
+{
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/devcontainers/features/java:1": {
+            "version": "none"
+        }
+    },
+    "containerEnv": {
+        "JAVA_HOME": "/usr/lib/jvm/msopenjdk-current"
+    }
+}