Skip to content
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

fix(docker): Skip lookup of dependencies with variable in image name #13951

Merged
merged 3 commits into from
Feb 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions lib/manager/dockerfile/extract.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -665,5 +665,53 @@ Object {
}
`);
});

it('skips depName containing a non default variable at start', () => {
const res = getDep('$CI_REGISTRY/alpine:3.15');
expect(res).toMatchInlineSnapshot(`
Object {
"autoReplaceStringTemplate": "{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}",
"datasource": "docker",
"replaceString": "$CI_REGISTRY/alpine:3.15",
"skipReason": "contains-variable",
}
`);
});

it('skips depName containing a non default variable with brackets at start', () => {
const res = getDep('${CI_REGISTRY}/alpine:3.15');
expect(res).toMatchInlineSnapshot(`
Object {
"autoReplaceStringTemplate": "{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}",
"datasource": "docker",
"replaceString": "\${CI_REGISTRY}/alpine:3.15",
"skipReason": "contains-variable",
}
`);
});

it('skips depName containing a non default variable', () => {
const res = getDep('docker.io/$PREFIX/alpine:3.15');
expect(res).toMatchInlineSnapshot(`
Object {
"autoReplaceStringTemplate": "{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}",
"datasource": "docker",
"replaceString": "docker.io/$PREFIX/alpine:3.15",
"skipReason": "contains-variable",
}
`);
});

it('skips depName containing a non default variable with brackets', () => {
const res = getDep('docker.io/${PREFIX}/alpine:3.15');
expect(res).toMatchInlineSnapshot(`
Object {
"autoReplaceStringTemplate": "{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}",
"datasource": "docker",
"replaceString": "docker.io/\${PREFIX}/alpine:3.15",
"skipReason": "contains-variable",
}
`);
});
});
});
9 changes: 8 additions & 1 deletion lib/manager/dockerfile/extract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,14 @@ export function splitImageParts(currentFrom: string): PackageDependency {
depName = depTagSplit.join(':');
}

if (currentValue && currentValue.indexOf(variableMarker) !== -1) {
if (depName?.includes(variableMarker)) {
// If depName contains a variable, after cleaning, e.g. "$REGISTRY/alpine", we currently not support this.
return {
skipReason: 'contains-variable',
};
}

if (currentValue?.includes(variableMarker)) {
// If tag contains a variable, e.g. "5.0${VERSION_SUFFIX}", we do not support this.
return {
skipReason: 'contains-variable',
Expand Down
17 changes: 17 additions & 0 deletions lib/manager/gitlabci/__fixtures__/gitlab-ci.7.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
image:
# comment
name: $VARIABLE/renovate/renovate:31.65.1-slim

services:
# comment
- name: $VARIABLE/other/image1:1.0.0
alias: imagealias1
# comment
- name: ${VARIABLE}/other/image1:2.0.0
alias: imagealias2
# comment
- name: docker.io/$VARIABLE/image1:3.0.0
alias: imagealias1
# comment
- name: docker.io/${VARIABLE}/image1:4.0.0
alias: imagealias2
53 changes: 53 additions & 0 deletions lib/manager/gitlabci/extract.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,58 @@ describe('manager/gitlabci/extract', () => {
expect(res).toBeNull();
expect(logger.logger.warn).toHaveBeenCalled();
});

it('skips images with variables', async () => {
const res = await extractAllPackageFiles(config, [
'lib/manager/gitlabci/__fixtures__/gitlab-ci.7.yaml',
]);
expect(res).toEqual([
{
deps: [
{
autoReplaceStringTemplate:
'{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
datasource: 'docker',
depType: 'image-name',
replaceString: '$VARIABLE/renovate/renovate:31.65.1-slim',
skipReason: 'contains-variable',
},
{
autoReplaceStringTemplate:
'{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
datasource: 'docker',
depType: 'service-image',
replaceString: '$VARIABLE/other/image1:1.0.0',
skipReason: 'contains-variable',
},
{
autoReplaceStringTemplate:
'{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
datasource: 'docker',
depType: 'service-image',
replaceString: '${VARIABLE}/other/image1:2.0.0',
skipReason: 'contains-variable',
},
{
autoReplaceStringTemplate:
'{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
datasource: 'docker',
depType: 'service-image',
replaceString: 'docker.io/$VARIABLE/image1:3.0.0',
skipReason: 'contains-variable',
},
{
autoReplaceStringTemplate:
'{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
datasource: 'docker',
depType: 'service-image',
replaceString: 'docker.io/${VARIABLE}/image1:4.0.0',
skipReason: 'contains-variable',
},
],
packageFile: 'lib/manager/gitlabci/__fixtures__/gitlab-ci.7.yaml',
},
]);
});
});
});