Repository navigation
Add support for the extends keyword
#1306
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Sam Frost (SamuelFrost)
wants to merge
5
commits into
devcontainers:main
Choose a base branch
from
SamuelFrost:extends
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2585113
Add support for the extends keyword
SamuelFrost 7c7d1ca
Add extendsMergeMode for combine vs override extends merging
SamuelFrost ff4be89
Add extends and extendsMergeMode integration tests
SamuelFrost c4e9697
Use spread semantics for extendsMergeMode override
SamuelFrost 6302f11
Refine extends tests with fixtures and unit merge coverage.
SamuelFrost File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import * as assert from 'assert'; | ||
| import * as path from 'path'; | ||
| import { devContainerDown, devContainerUp, shellExec } from './testUtils'; | ||
|
|
||
| const pkg = require('../../package.json'); | ||
|
|
||
| describe('Dev Containers CLI extends', function () { | ||
| this.timeout('240s'); | ||
|
|
||
| const tmp = path.relative(process.cwd(), path.join(__dirname, 'tmp')); | ||
| const cli = `npx --prefix ${tmp} devcontainer`; | ||
| const testFolder = path.join(__dirname, 'configs/extends-up'); | ||
| const overrideTestFolder = path.join(__dirname, 'configs/extends-up-override'); | ||
|
|
||
| before('Install packaged CLI', async () => { | ||
| await shellExec(`rm -rf ${tmp}/node_modules`); | ||
| await shellExec(`mkdir -p ${tmp}`); | ||
| await shellExec(`npm --prefix ${tmp} install devcontainers-cli-${pkg.version}.tgz`); | ||
| }); | ||
|
|
||
| describe('Command up with extends', () => { | ||
| describe('combine (default extendsMergeMode)', () => { | ||
| let containerId: string | null = null; | ||
|
|
||
| before(async () => { | ||
| const res = await shellExec( | ||
| `${cli} up --workspace-folder ${testFolder} --buildkit=never --include-configuration --include-merged-configuration`, | ||
| ); | ||
| const response = JSON.parse(res.stdout); | ||
| assert.equal(response.outcome, 'success'); | ||
| containerId = response.containerId; | ||
| assert.ok(containerId, 'Container id not found.'); | ||
| assert.equal(response.configuration?.name, 'extends-up-combine'); | ||
| assert.equal(response.configuration?.remoteEnv?.FROM_BASE, 'base'); | ||
| assert.equal(response.configuration?.remoteEnv?.OVERRIDE_ME, 'child'); | ||
| assert.equal(response.configuration?.remoteEnv?.EXTENDS_UP, 'combine'); | ||
| assert.notProperty(response.configuration ?? {}, 'extends'); | ||
| assert.notProperty(response.configuration ?? {}, 'extendsMergeMode'); | ||
| }); | ||
|
|
||
| after(async () => await devContainerDown({ containerId })); | ||
|
|
||
| it('starts a container with merged remoteEnv from the extends chain', async () => { | ||
| const env = await shellExec(`docker exec ${containerId} printenv OVERRIDE_ME`); | ||
| assert.equal(env.stdout.trim(), 'child'); | ||
| const marker = await shellExec(`docker exec ${containerId} printenv EXTENDS_UP`); | ||
| assert.equal(marker.stdout.trim(), 'combine'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('override (extendsMergeMode)', () => { | ||
| let containerId: string | null = null; | ||
|
|
||
| before(async () => { | ||
| const res = await shellExec( | ||
| `${cli} up --workspace-folder ${overrideTestFolder} --buildkit=never --include-configuration`, | ||
| ); | ||
| const response = JSON.parse(res.stdout); | ||
| assert.equal(response.outcome, 'success'); | ||
| containerId = response.containerId; | ||
| assert.ok(containerId, 'Container id not found.'); | ||
| assert.equal(response.configuration?.name, 'extends-up-override'); | ||
| assert.equal(response.configuration?.remoteEnv?.EXTENDS_UP, 'override'); | ||
| assert.deepEqual(response.configuration?.forwardPorts, [9999]); | ||
| }); | ||
|
|
||
| after(async () => await devContainerDown({ containerId })); | ||
|
|
||
| it('starts a container using override merge semantics', async () => { | ||
| const env = await shellExec(`docker exec ${containerId} printenv EXTENDS_UP`); | ||
| assert.equal(env.stdout.trim(), 'override'); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.