|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | + * Licensed under the MIT License. See License.txt in the project root for license information. |
| 4 | + *--------------------------------------------------------------------------------------------*/ |
| 5 | + |
| 6 | +import * as path from 'path'; |
| 7 | +import { assert } from 'chai'; |
| 8 | +import { URI } from 'vscode-uri'; |
| 9 | +import { getCLIHost, loadNativeModule } from '../spec-common/commonUtils'; |
| 10 | +import { DevContainerConfig, DevContainerFromImageConfig } from '../spec-configuration/configuration'; |
| 11 | +import { readDevContainerConfigFile } from '../spec-node/configContainer'; |
| 12 | +import { mergeDevContainerConfigs } from '../spec-node/imageMetadata'; |
| 13 | +import { Workspace } from '../spec-utils/workspaces'; |
| 14 | +import { nullLog } from '../spec-utils/log'; |
| 15 | + |
| 16 | +const workspace: Workspace = { |
| 17 | + isWorkspaceFile: false, |
| 18 | + workspaceOrFolderPath: '/foo/bar', |
| 19 | + rootFolderPath: '/foo/bar', |
| 20 | + configFolderPath: '/foo/bar', |
| 21 | +}; |
| 22 | + |
| 23 | +async function readConfig(relativePath: string) { |
| 24 | + const cliHost = await getCLIHost(process.cwd(), loadNativeModule, false); |
| 25 | + const configFile = URI.file(path.resolve(relativePath)); |
| 26 | + return readDevContainerConfigFile(cliHost, workspace, configFile, false, false, nullLog); |
| 27 | +} |
| 28 | + |
| 29 | +describe('readDevContainerConfigFile', function () { |
| 30 | + it('can read a basic configuration file', async function () { |
| 31 | + const configs = await readConfig('./src/test/configs/example/.devcontainer.json'); |
| 32 | + assert.isOk(configs); |
| 33 | + assert.property(configs, 'config'); |
| 34 | + assert.isOk(configs?.config.config); |
| 35 | + |
| 36 | + const features = configs?.config.config.features as Record<string, string | boolean | Record<string, string | boolean>>; |
| 37 | + assert.hasAllKeys(features, ['ghcr.io/devcontainers/features/github-cli:1']); |
| 38 | + }); |
| 39 | + |
| 40 | + it('can resolve an "extends" file reference', async function () { |
| 41 | + const configs = await readConfig('./src/test/configs/extends/.devcontainer.json'); |
| 42 | + assert.isOk(configs); |
| 43 | + const expectedConfig = { |
| 44 | + name: 'Overrides', |
| 45 | + image: 'mcr.microsoft.com/devcontainers/base:latest', |
| 46 | + forwardPorts: [80, 443], |
| 47 | + capAdd: ['SYS_PTRACE', 'NET_ADMIN'], |
| 48 | + hostRequirements: { |
| 49 | + cpus: 2, |
| 50 | + memory: `${8 * 2 ** 30}`, |
| 51 | + storage: undefined, |
| 52 | + gpu: undefined, |
| 53 | + }, |
| 54 | + remoteEnv: { |
| 55 | + FROM_BASE: 'base', |
| 56 | + OVERRIDE_ME: 'child', |
| 57 | + }, |
| 58 | + features: { |
| 59 | + 'ghcr.io/devcontainers/features/docker-in-docker:1': { |
| 60 | + version: 'latest', |
| 61 | + moby: true, |
| 62 | + }, |
| 63 | + 'ghcr.io/devcontainers/features/go:1': { |
| 64 | + version: 'latest', |
| 65 | + }, |
| 66 | + }, |
| 67 | + }; |
| 68 | + |
| 69 | + assert.deepEqual(configs?.config.raw as any, expectedConfig); |
| 70 | + assert.notProperty(configs?.config.raw as any, 'extends'); |
| 71 | + }); |
| 72 | + |
| 73 | + it('can resolve nested "extends" file references', async function () { |
| 74 | + const configs = await readConfig('./src/test/configs/extends/.devcontainer.nested.json'); |
| 75 | + assert.isOk(configs); |
| 76 | + assert.strictEqual(configs?.config.raw.name, 'Nested'); |
| 77 | + assert.deepEqual(configs?.config.raw.forwardPorts, [80, 443, 2222]); |
| 78 | + assert.strictEqual((configs?.config.raw as DevContainerFromImageConfig).image, 'mcr.microsoft.com/devcontainers/base:latest'); |
| 79 | + }); |
| 80 | + |
| 81 | + it('rejects a cyclic "extends" reference', async function () { |
| 82 | + try { |
| 83 | + await readConfig('./src/test/configs/extends/.devcontainer.cycle-a.json'); |
| 84 | + assert.fail('expected cyclic extends to throw'); |
| 85 | + } catch (err: any) { |
| 86 | + assert.match(String(err.description || err.message), /cyclic "extends" reference/); |
| 87 | + } |
| 88 | + }); |
| 89 | + |
| 90 | + it('rejects a missing "extends" file', async function () { |
| 91 | + try { |
| 92 | + await readConfig('./src/test/configs/extends/.devcontainer.missing.json'); |
| 93 | + assert.fail('expected missing extends to throw'); |
| 94 | + } catch (err: any) { |
| 95 | + assert.match(String(err.description || err.message), /was not found/); |
| 96 | + } |
| 97 | + }); |
| 98 | +}); |
| 99 | + |
| 100 | +describe('mergeDevContainerConfigs', function () { |
| 101 | + it('uses image metadata merge logic for overlapping properties', function () { |
| 102 | + const base: DevContainerConfig = { |
| 103 | + image: 'mcr.microsoft.com/devcontainers/base:latest', |
| 104 | + init: false, |
| 105 | + privileged: true, |
| 106 | + forwardPorts: [80], |
| 107 | + hostRequirements: { |
| 108 | + cpus: 4, |
| 109 | + memory: '4gb', |
| 110 | + }, |
| 111 | + remoteUser: 'vscode', |
| 112 | + onCreateCommand: 'echo base', |
| 113 | + }; |
| 114 | + const overlay: DevContainerConfig = { |
| 115 | + image: 'mcr.microsoft.com/devcontainers/javascript-node:latest', |
| 116 | + init: true, |
| 117 | + forwardPorts: [443], |
| 118 | + hostRequirements: { |
| 119 | + cpus: 2, |
| 120 | + memory: '8gb', |
| 121 | + }, |
| 122 | + onCreateCommand: 'echo overlay', |
| 123 | + }; |
| 124 | + |
| 125 | + const merged = mergeDevContainerConfigs(base, overlay); |
| 126 | + assert.strictEqual((merged as DevContainerFromImageConfig).image, 'mcr.microsoft.com/devcontainers/javascript-node:latest'); |
| 127 | + assert.strictEqual(merged.init, true); |
| 128 | + assert.strictEqual(merged.privileged, true); |
| 129 | + assert.deepEqual(merged.forwardPorts, [80, 443]); |
| 130 | + assert.strictEqual(merged.hostRequirements?.cpus, 4); |
| 131 | + assert.strictEqual(merged.hostRequirements?.memory, `${8 * 2 ** 30}`); |
| 132 | + assert.strictEqual(merged.remoteUser, 'vscode'); |
| 133 | + assert.strictEqual(merged.onCreateCommand, 'echo overlay'); |
| 134 | + }); |
| 135 | +}); |
0 commit comments