diff --git a/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap b/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
index 6b9d27bbb94798a5cb2db902ac524aefaee6ef8f..2d66d38c4f89dd82d43b9934b47fb0ee645dbd56 100644
--- a/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
+++ b/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
@@ -279,15 +279,19 @@ Array [
},
},
Object {
- "cmd": "docker run --rm --name=renovate_go --label=renovate_child -v \\"/tmp/github/some/repo\\":\\"/tmp/github/some/repo\\" -v \\"/tmp/renovate/cache\\":\\"/tmp/renovate/cache\\" -e GOPROXY -e GOPRIVATE -e GONOPROXY -e GONOSUMDB -e GOFLAGS -e CGO_ENABLED -e GIT_CONFIG_KEY_0 -e GIT_CONFIG_VALUE_0 -e GIT_CONFIG_COUNT -w \\"/tmp/github/some/repo\\" renovate/go:latest bash -l -c \\"go get -d -t ./...\\"",
+ "cmd": "docker run --rm --name=renovate_go --label=renovate_child -v \\"/tmp/github/some/repo\\":\\"/tmp/github/some/repo\\" -v \\"/tmp/renovate/cache\\":\\"/tmp/renovate/cache\\" -e GOPROXY -e GOPRIVATE -e GONOPROXY -e GONOSUMDB -e GOFLAGS -e CGO_ENABLED -e GIT_CONFIG_KEY_0 -e GIT_CONFIG_VALUE_0 -e GIT_CONFIG_KEY_1 -e GIT_CONFIG_VALUE_1 -e GIT_CONFIG_KEY_2 -e GIT_CONFIG_VALUE_2 -e GIT_CONFIG_COUNT -w \\"/tmp/github/some/repo\\" renovate/go:latest bash -l -c \\"go get -d -t ./...\\"",
"options": Object {
"cwd": "/tmp/github/some/repo",
"encoding": "utf-8",
"env": Object {
"CGO_ENABLED": "1",
- "GIT_CONFIG_COUNT": "1",
- "GIT_CONFIG_KEY_0": "url.https://some-token@github.com/.insteadOf",
- "GIT_CONFIG_VALUE_0": "https://github.com/",
+ "GIT_CONFIG_COUNT": "3",
+ "GIT_CONFIG_KEY_0": "url.\\"https://ssh:some-token@github.com/\\".insteadOf",
+ "GIT_CONFIG_KEY_1": "url.\\"https://git:some-token@github.com/\\".insteadOf",
+ "GIT_CONFIG_KEY_2": "url.\\"https://some-token@github.com/\\".insteadOf",
+ "GIT_CONFIG_VALUE_0": "ssh://git@github.com/",
+ "GIT_CONFIG_VALUE_1": "git@github.com:",
+ "GIT_CONFIG_VALUE_2": "https://github.com/",
"GOFLAGS": "-modcacherw",
"GONOPROXY": "noproxy.example.com/*",
"GONOSUMDB": "1",
diff --git a/lib/manager/gomod/artifacts.spec.ts b/lib/manager/gomod/artifacts.spec.ts
index b405e00895383c4aa5210e55613fe7229c67d1d8..abf07a3a456faa424fdec6f4a3cd68b1fb80e740 100644
--- a/lib/manager/gomod/artifacts.spec.ts
+++ b/lib/manager/gomod/artifacts.spec.ts
@@ -246,12 +246,25 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '2',
- GIT_CONFIG_KEY_0: 'url.https://some-token@github.com/.insteadOf',
+ GIT_CONFIG_COUNT: '6',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:some-token@github.com/".insteadOf',
GIT_CONFIG_KEY_1:
- 'url.https://some-enterprise-token@github.enterprise.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_VALUE_1: 'https://github.enterprise.com/',
+ 'url."https://git:some-token@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://some-token@github.com/".insteadOf',
+ GIT_CONFIG_KEY_3:
+ 'url."https://ssh:some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_4:
+ 'url."https://git:some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_5:
+ 'url."https://some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
+ GIT_CONFIG_VALUE_3: 'ssh://git@github.enterprise.com/',
+ GIT_CONFIG_VALUE_4: 'git@github.enterprise.com:',
+ GIT_CONFIG_VALUE_5: 'https://github.enterprise.com/',
}),
}),
}),
@@ -288,10 +301,16 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '1',
+ GIT_CONFIG_COUNT: '3',
GIT_CONFIG_KEY_0:
- 'url.https://gitlab-ci-token:some-enterprise-token@gitlab.enterprise.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://gitlab.enterprise.com/',
+ 'url."https://gitlab-ci-token:some-enterprise-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://gitlab-ci-token:some-enterprise-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://gitlab-ci-token:some-enterprise-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@gitlab.enterprise.com/',
+ GIT_CONFIG_VALUE_1: 'git@gitlab.enterprise.com:',
+ GIT_CONFIG_VALUE_2: 'https://gitlab.enterprise.com/',
}),
}),
}),
@@ -333,13 +352,25 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '2',
+ GIT_CONFIG_COUNT: '6',
GIT_CONFIG_KEY_0:
- 'url.https://gitlab-ci-token:some-enterprise-token-repo1@gitlab.enterprise.com/repo1.insteadOf',
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo1@gitlab.enterprise.com/repo1".insteadOf',
GIT_CONFIG_KEY_1:
- 'url.https://gitlab-ci-token:some-enterprise-token-repo2@gitlab.enterprise.com/repo2.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://gitlab.enterprise.com/repo1',
- GIT_CONFIG_VALUE_1: 'https://gitlab.enterprise.com/repo2',
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo1@gitlab.enterprise.com/repo1".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo1@gitlab.enterprise.com/repo1".insteadOf',
+ GIT_CONFIG_KEY_3:
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo2@gitlab.enterprise.com/repo2".insteadOf',
+ GIT_CONFIG_KEY_4:
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo2@gitlab.enterprise.com/repo2".insteadOf',
+ GIT_CONFIG_KEY_5:
+ 'url."https://gitlab-ci-token:some-enterprise-token-repo2@gitlab.enterprise.com/repo2".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@gitlab.enterprise.com/repo1',
+ GIT_CONFIG_VALUE_1: 'git@gitlab.enterprise.com:repo1',
+ GIT_CONFIG_VALUE_2: 'https://gitlab.enterprise.com/repo1',
+ GIT_CONFIG_VALUE_3: 'ssh://git@gitlab.enterprise.com/repo2',
+ GIT_CONFIG_VALUE_4: 'git@gitlab.enterprise.com:repo2',
+ GIT_CONFIG_VALUE_5: 'https://gitlab.enterprise.com/repo2',
}),
}),
}),
@@ -381,10 +412,16 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '1',
+ GIT_CONFIG_COUNT: '3',
GIT_CONFIG_KEY_0:
- 'url.https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://gitlab.enterprise.com/',
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@gitlab.enterprise.com/',
+ GIT_CONFIG_VALUE_1: 'git@gitlab.enterprise.com:',
+ GIT_CONFIG_VALUE_2: 'https://gitlab.enterprise.com/',
}),
}),
}),
@@ -434,18 +471,43 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '4',
- GIT_CONFIG_KEY_0: 'url.https://some-token@github.com/.insteadOf',
+ GIT_CONFIG_COUNT: '12',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:some-token@github.com/".insteadOf',
GIT_CONFIG_KEY_1:
- 'url.https://some-token@api.github.com/.insteadOf',
+ 'url."https://git:some-token@github.com/".insteadOf',
GIT_CONFIG_KEY_2:
- 'url.https://some-enterprise-token@github.enterprise.com/.insteadOf',
+ 'url."https://some-token@github.com/".insteadOf',
GIT_CONFIG_KEY_3:
- 'url.https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_VALUE_1: 'https://api.github.com/',
- GIT_CONFIG_VALUE_2: 'https://github.enterprise.com/',
- GIT_CONFIG_VALUE_3: 'https://gitlab.enterprise.com/',
+ 'url."https://ssh:some-token@api.github.com/".insteadOf',
+ GIT_CONFIG_KEY_4:
+ 'url."https://git:some-token@api.github.com/".insteadOf',
+ GIT_CONFIG_KEY_5:
+ 'url."https://some-token@api.github.com/".insteadOf',
+ GIT_CONFIG_KEY_6:
+ 'url."https://ssh:some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_7:
+ 'url."https://git:some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_8:
+ 'url."https://some-enterprise-token@github.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_9:
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_10:
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_KEY_11:
+ 'url."https://gitlab-ci-token:some-gitlab-token@gitlab.enterprise.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
+ GIT_CONFIG_VALUE_3: 'ssh://git@api.github.com/',
+ GIT_CONFIG_VALUE_4: 'git@api.github.com:',
+ GIT_CONFIG_VALUE_5: 'https://api.github.com/',
+ GIT_CONFIG_VALUE_6: 'ssh://git@github.enterprise.com/',
+ GIT_CONFIG_VALUE_7: 'git@github.enterprise.com:',
+ GIT_CONFIG_VALUE_8: 'https://github.enterprise.com/',
+ GIT_CONFIG_VALUE_9: 'ssh://git@gitlab.enterprise.com/',
+ GIT_CONFIG_VALUE_10: 'git@gitlab.enterprise.com:',
+ GIT_CONFIG_VALUE_11: 'https://gitlab.enterprise.com/',
}),
}),
}),
@@ -485,9 +547,16 @@ describe('manager/gomod/artifacts', () => {
expect.objectContaining({
options: expect.objectContaining({
env: expect.objectContaining({
- GIT_CONFIG_COUNT: '1',
- GIT_CONFIG_KEY_0: 'url.https://some-token@github.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:some-token@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://git:some-token@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://some-token@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
}),
}),
}),
diff --git a/lib/util/git/auth.spec.ts b/lib/util/git/auth.spec.ts
index 86d0c3fcf442c9db148bcc8d770aa393920c483d..357a34b7fc064fd89b1a8624d3159bc7b8a6ab9c 100644
--- a/lib/util/git/auth.spec.ts
+++ b/lib/util/git/auth.spec.ts
@@ -14,9 +14,31 @@ describe('util/git/auth', () => {
matchHost: 'github.com',
})
).toStrictEqual({
- GIT_CONFIG_KEY_0: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_COUNT: '1',
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
+ });
+ });
+
+ it('returns url with token for different protocols', () => {
+ expect(
+ getGitAuthenticatedEnvironmentVariables('foobar://github.com/', {
+ token: 'token1234',
+ hostType: PlatformId.Github,
+ matchHost: 'github.com',
+ })
+ ).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
});
});
@@ -28,10 +50,16 @@ describe('util/git/auth', () => {
matchHost: 'github.com',
})
).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
GIT_CONFIG_KEY_0:
- 'url.https://x-access-token:token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_COUNT: '1',
+ 'url."https://x-access-token:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://x-access-token:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://x-access-token:token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
});
});
@@ -47,9 +75,13 @@ describe('util/git/auth', () => {
{ GIT_CONFIG_COUNT: '1' }
)
).toStrictEqual({
- GIT_CONFIG_KEY_1: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_1: 'https://github.com/',
- GIT_CONFIG_COUNT: '2',
+ GIT_CONFIG_COUNT: '4',
+ GIT_CONFIG_KEY_1: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_3: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_1: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_2: 'git@github.com:',
+ GIT_CONFIG_VALUE_3: 'https://github.com/',
});
});
@@ -66,9 +98,13 @@ describe('util/git/auth', () => {
{ GIT_CONFIG_COUNT: '1' }
)
).toStrictEqual({
- GIT_CONFIG_KEY_1: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_1: 'https://github.com/',
- GIT_CONFIG_COUNT: '2',
+ GIT_CONFIG_COUNT: '4',
+ GIT_CONFIG_KEY_1: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_3: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_1: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_2: 'git@github.com:',
+ GIT_CONFIG_VALUE_3: 'https://github.com/',
});
});
@@ -81,9 +117,13 @@ describe('util/git/auth', () => {
matchHost: 'github.com',
})
).toStrictEqual({
- GIT_CONFIG_KEY_1: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_1: 'https://github.com/',
- GIT_CONFIG_COUNT: '2',
+ GIT_CONFIG_COUNT: '4',
+ GIT_CONFIG_KEY_1: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_3: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_1: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_2: 'git@github.com:',
+ GIT_CONFIG_VALUE_3: 'https://github.com/',
});
});
@@ -99,9 +139,13 @@ describe('util/git/auth', () => {
{ RANDOM_VARIABLE: 'random' }
)
).toStrictEqual({
- GIT_CONFIG_KEY_0: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_COUNT: '1',
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
RANDOM_VARIABLE: 'random',
});
});
@@ -115,9 +159,13 @@ describe('util/git/auth', () => {
matchHost: 'github.com',
})
).toStrictEqual({
- GIT_CONFIG_KEY_0: 'url.https://token1234@github.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://github.com/',
- GIT_CONFIG_COUNT: '1',
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0: 'url."https://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1: 'url."https://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'https://github.com/',
});
});
@@ -129,10 +177,16 @@ describe('util/git/auth', () => {
matchHost: 'github.com',
})
).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
GIT_CONFIG_KEY_0:
- 'url.https://gitlab-ci-token:token1234@gitlab.com/.insteadOf',
- GIT_CONFIG_VALUE_0: 'https://gitlab.com/',
- GIT_CONFIG_COUNT: '1',
+ 'url."https://gitlab-ci-token:token1234@gitlab.com/".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://gitlab-ci-token:token1234@gitlab.com/".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://gitlab-ci-token:token1234@gitlab.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@gitlab.com/',
+ GIT_CONFIG_VALUE_1: 'git@gitlab.com:',
+ GIT_CONFIG_VALUE_2: 'https://gitlab.com/',
});
});
@@ -152,5 +206,88 @@ describe('util/git/auth', () => {
env: 'value',
});
});
+
+ it('returns url with token for http hosts', () => {
+ expect(
+ getGitAuthenticatedEnvironmentVariables('http://github.com/', {
+ token: 'token1234',
+ hostType: PlatformId.Github,
+ matchHost: 'github.com',
+ })
+ ).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0: 'url."http://ssh:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_1: 'url."http://git:token1234@github.com/".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."http://token1234@github.com/".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
+ GIT_CONFIG_VALUE_1: 'git@github.com:',
+ GIT_CONFIG_VALUE_2: 'http://github.com/',
+ });
+ });
+
+ it('returns url with token for orgs', () => {
+ expect(
+ getGitAuthenticatedEnvironmentVariables('https://github.com/org', {
+ token: 'token1234',
+ hostType: PlatformId.Github,
+ matchHost: 'github.com',
+ })
+ ).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:token1234@github.com/org".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://git:token1234@github.com/org".insteadOf',
+ GIT_CONFIG_KEY_2: 'url."https://token1234@github.com/org".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/org',
+ GIT_CONFIG_VALUE_1: 'git@github.com:org',
+ GIT_CONFIG_VALUE_2: 'https://github.com/org',
+ });
+ });
+
+ it('returns url with token for orgs and projects', () => {
+ expect(
+ getGitAuthenticatedEnvironmentVariables('https://github.com/org/repo', {
+ token: 'token1234',
+ hostType: PlatformId.Github,
+ matchHost: 'github.com',
+ })
+ ).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:token1234@github.com/org/repo".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://git:token1234@github.com/org/repo".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://token1234@github.com/org/repo".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com/org/repo',
+ GIT_CONFIG_VALUE_1: 'git@github.com:org/repo',
+ GIT_CONFIG_VALUE_2: 'https://github.com/org/repo',
+ });
+ });
+
+ it('returns url with token for orgs and projects and ports', () => {
+ expect(
+ getGitAuthenticatedEnvironmentVariables(
+ 'https://github.com:89/org/repo.git',
+ {
+ token: 'token1234',
+ hostType: PlatformId.Github,
+ matchHost: 'github.com',
+ }
+ )
+ ).toStrictEqual({
+ GIT_CONFIG_COUNT: '3',
+ GIT_CONFIG_KEY_0:
+ 'url."https://ssh:token1234@github.com:89/org/repo.git".insteadOf',
+ GIT_CONFIG_KEY_1:
+ 'url."https://git:token1234@github.com:89/org/repo.git".insteadOf',
+ GIT_CONFIG_KEY_2:
+ 'url."https://token1234@github.com:89/org/repo.git".insteadOf',
+ GIT_CONFIG_VALUE_0: 'ssh://git@github.com:89/org/repo.git',
+ GIT_CONFIG_VALUE_1: 'ssh://git@github.com:89/org/repo.git',
+ GIT_CONFIG_VALUE_2: 'https://github.com:89/org/repo.git',
+ });
+ });
});
});
diff --git a/lib/util/git/auth.ts b/lib/util/git/auth.ts
index 49d77dfb61a2c50a1437c8152c5d9e1312b20909..5d2c6c006fee5c456cb1f0e861be69d8fd379465 100644
--- a/lib/util/git/auth.ts
+++ b/lib/util/git/auth.ts
@@ -1,14 +1,16 @@
+import gitUrlParse from 'git-url-parse';
import { PlatformId } from '../../constants';
import { logger } from '../../logger';
import type { HostRule } from '../../types';
-import { getHttpUrl } from './url';
+import { regEx } from '../regex';
+import type { AuthenticationRule } from './types';
/**
* Add authorization to a Git Url and returns a new environment variables object
* @returns a new NodeJS.ProcessEnv object without modifying any input parameters
*/
export function getGitAuthenticatedEnvironmentVariables(
- gitUrl: string,
+ originalGitUrl: string,
{ token, hostType, matchHost }: HostRule,
environmentVariables?: NodeJS.ProcessEnv
): NodeJS.ProcessEnv {
@@ -34,28 +36,83 @@ export function getGitAuthenticatedEnvironmentVariables(
}
}
- const gitUrlWithToken = getUrlWithToken(gitUrl, hostType, token);
+ const authenticationRules = getAuthenticationRulesWithToken(
+ originalGitUrl,
+ hostType,
+ token
+ );
// create a shallow copy of the environmentVariables as base so we don't modify the input parameter object
// add the two new config key and value to the returnEnvironmentVariables object
- // increase the CONFIG_COUNT by one and add it to the object
- return {
+ // increase the CONFIG_COUNT by one for each rule and add it to the object
+ const newEnvironmentVariables = {
...environmentVariables,
- [`GIT_CONFIG_KEY_${gitConfigCount}`]: `url.${gitUrlWithToken}.insteadOf`,
- [`GIT_CONFIG_VALUE_${gitConfigCount}`]: gitUrl,
- GIT_CONFIG_COUNT: (gitConfigCount + 1).toString(),
};
+ for (const rule of authenticationRules) {
+ newEnvironmentVariables[
+ `GIT_CONFIG_KEY_${gitConfigCount}`
+ ] = `url."${rule.url}".insteadOf`;
+ newEnvironmentVariables[`GIT_CONFIG_VALUE_${gitConfigCount}`] =
+ rule.insteadOf;
+ gitConfigCount++;
+ }
+ newEnvironmentVariables['GIT_CONFIG_COUNT'] = gitConfigCount.toString();
+
+ return newEnvironmentVariables;
}
-function getUrlWithToken(
- gitUrl: string,
+function getAuthenticationRulesWithToken(
+ url: string,
hostType: string,
authToken: string
-): string {
+): AuthenticationRule[] {
let token = authToken;
if (hostType === PlatformId.Gitlab) {
- token = `gitlab-ci-token:${token}`;
+ token = `gitlab-ci-token:${authToken}`;
}
+ return getAuthenticationRules(url, token);
+}
+
+/**
+ * Generates the authentication rules for later git usage for the given host
+ * @link https://coolaj86.com/articles/vanilla-devops-git-credentials-cheatsheet/
+ */
+export function getAuthenticationRules(
+ gitUrl: string,
+ token: string
+): AuthenticationRule[] {
+ const authenticationRules = [];
+ const hasUser = token.split(':').length > 1;
+ const insteadUrl = gitUrlParse(gitUrl);
+ const url = { ...insteadUrl };
+ const protocol = regEx(/^https?$/).test(url.protocol)
+ ? url.protocol
+ : 'https';
+
+ // ssh protocol with user if empty
+ url.token = hasUser ? token : `ssh:${token}`;
+ authenticationRules.push({
+ url: url.toString(protocol),
+ // only edge case, need to stringify ourself because the exact syntax is not supported by the library
+ // https://github.com/IonicaBizau/git-url-parse/blob/246c9119fb42c2ea1c280028fe77c53eb34c190c/lib/index.js#L246
+ insteadOf: `ssh://git@${insteadUrl.resource}${
+ insteadUrl.port ? `:${insteadUrl.port}` : ''
+ }/${insteadUrl.full_name}${insteadUrl.git_suffix ? '.git' : ''}`,
+ });
+
+ // alternative ssh protocol with user if empty
+ url.token = hasUser ? token : `git:${token}`;
+ authenticationRules.push({
+ url: url.toString(protocol),
+ insteadOf: insteadUrl.toString('ssh'),
+ });
+
+ // https protocol with no user as default fallback
+ url.token = token;
+ authenticationRules.push({
+ url: url.toString(protocol),
+ insteadOf: insteadUrl.toString(protocol),
+ });
- return getHttpUrl(gitUrl, token);
+ return authenticationRules;
}
diff --git a/lib/util/git/types.ts b/lib/util/git/types.ts
index 42b29df65b957819e87d3e08f902e5f3d423bc1b..a84f56e0e9c2ee2121a4ceb833350ce35b1abfeb 100644
--- a/lib/util/git/types.ts
+++ b/lib/util/git/types.ts
@@ -96,3 +96,12 @@ export interface CommitResult {
sha: string;
files: FileChange[];
}
+
+/**
+ * Represents a git authentication rule in the form of e.g.:
+ * git config --global url."https://api@github.com/".insteadOf "https://github.com/"
+ */
+export interface AuthenticationRule {
+ url: string;
+ insteadOf: string;
+}