Skip to content

Commit 4d716f8

Browse files
pvdlgpvdlg
committed
fix: support repositories within subgroups
1 parent ba75444 commit 4d716f8

File tree

6 files changed

+110
-21
lines changed

6 files changed

+110
-21
lines changed

‎lib/get-repo-id.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
const parsePath = require('parse-path');
2+
const escapeStringRegexp = require('escape-string-regexp');
3+
4+
module.exports = (gitlabUrl, repositoryUrl) => {
5+
return parsePath(repositoryUrl)
6+
.pathname.replace(new RegExp(`^${escapeStringRegexp(parsePath(gitlabUrl).pathname)}`), '')
7+
.replace(/^\//, '')
8+
.replace(/\/$/, '')
9+
.replace(/\.git$/, '');
10+
};

‎lib/publish.js‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
const parseGithubUrl = require('parse-github-url');
21
const urlJoin = require('url-join');
32
const got = require('got');
4-
const debug = require('debug')('semantic-release:github');
3+
const debug = require('debug')('semantic-release:gitlab');
54
const resolveConfig = require('./resolve-config');
5+
const getRepoId = require('./get-repo-id');
66

77
module.exports = async (pluginConfig, {repositoryUrl}, {gitHead, gitTag, notes}, logger) => {
88
const {gitlabToken, gitlabUrl, gitlabApiPathPrefix} = resolveConfig(pluginConfig);
9-
const {name: repo, owner} = parseGithubUrl(repositoryUrl);
9+
const repoId = encodeURIComponent(getRepoId(gitlabUrl, repositoryUrl));
1010

11+
debug('repoId: %o', repoId);
1112
debug('release name: %o', gitTag);
1213
debug('release ref: %o', gitHead);
1314

1415
try {
1516
// Test if the tag already exists
16-
await got.get(urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${owner}%2F${repo}/repository/tags/${gitTag}`), {
17+
await got.get(urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${repoId}/repository/tags/${gitTag}`), {
1718
json: true,
1819
headers: {'Private-Token': gitlabToken},
1920
});
2021
debug('The git tag %o already exists, update the release description', gitTag);
2122
// Update the release notes
2223
await got.post(
23-
urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${owner}%2F${repo}/repository/tags/${gitTag}/release`),
24+
urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${repoId}/repository/tags/${gitTag}/release`),
2425
{json: true, headers: {'Private-Token': gitlabToken}, body: {tag_name: gitTag, description: notes}} // eslint-disable-line camelcase
2526
);
2627
} catch (err) {
@@ -29,14 +30,11 @@ module.exports = async (pluginConfig, {repositoryUrl}, {gitHead, gitTag, notes},
2930
throw err;
3031
}
3132
debug('Create git tag %o with commit %o and release description', gitTag, gitHead);
32-
await got.post(
33-
urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${owner}%2F${repo}/repository/tags/${gitTag}/release`),
34-
{
35-
json: true,
36-
headers: {'PRIVATE-TOKEN': gitlabToken},
37-
body: {tag_name: gitTag, ref: gitHead, release_description: notes}, // eslint-disable-line camelcase
38-
}
39-
);
33+
await got.post(urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${repoId}/repository/tags/${gitTag}/release`), {
34+
json: true,
35+
headers: {'PRIVATE-TOKEN': gitlabToken},
36+
body: {tag_name: gitTag, ref: gitHead, release_description: notes}, // eslint-disable-line camelcase
37+
});
4038
}
4139

4240
logger.log('Published GitLab release: %s', gitTag);

‎lib/verify.js‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
const parseGithubUrl = require('parse-github-url');
21
const urlJoin = require('url-join');
32
const got = require('got');
3+
const debug = require('debug')('semantic-release:gitlab');
44
const SemanticReleaseError = require('@semantic-release/error');
55
const resolveConfig = require('./resolve-config');
6+
const getRepoId = require('./get-repo-id');
67

78
module.exports = async (pluginConfig, {repositoryUrl}, logger) => {
89
const {gitlabToken, gitlabUrl, gitlabApiPathPrefix} = resolveConfig(pluginConfig);
@@ -11,8 +12,11 @@ module.exports = async (pluginConfig, {repositoryUrl}, logger) => {
1112
throw new SemanticReleaseError('No GitLab token specified.', 'ENOGLTOKEN');
1213
}
1314

14-
const {name: repo, owner} = parseGithubUrl(repositoryUrl);
15-
if (!owner || !repo) {
15+
const repoId = getRepoId(gitlabUrl, repositoryUrl);
16+
17+
debug('repoId: %o', repoId);
18+
19+
if (!repoId) {
1620
throw new SemanticReleaseError(
1721
`The git repository URL ${repositoryUrl} is not a valid GitLab URL.`,
1822
'EINVALIDGITURL'
@@ -26,21 +30,21 @@ module.exports = async (pluginConfig, {repositoryUrl}, logger) => {
2630

2731
try {
2832
({body: {permissions: {project_access: projectAccess, group_access: groupAccess}}} = await got.get(
29-
urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${owner}%2F${repo}`),
33+
urlJoin(gitlabUrl, gitlabApiPathPrefix, `/projects/${encodeURIComponent(repoId)}`),
3034
{json: true, headers: {'Private-Token': gitlabToken}}
3135
));
3236
} catch (err) {
3337
if (err.statusCode === 401) {
3438
throw new SemanticReleaseError('Invalid GitLab token.', 'EINVALIDGLTOKEN');
3539
} else if (err.statusCode === 404) {
36-
throw new SemanticReleaseError(`The repository ${owner}/${repo} doesn't exist.`, 'EMISSINGREPO');
40+
throw new SemanticReleaseError(`The repository ${repoId} doesn't exist.`, 'EMISSINGREPO');
3741
}
3842
throw err;
3943
}
4044

4145
if (!((projectAccess && projectAccess.access_level >= 30) || (groupAccess && groupAccess.access_level >= 30))) {
4246
throw new SemanticReleaseError(
43-
`The GitLab token doesn't allow to push on the repository ${owner}/${repo}.`,
47+
`The GitLab token doesn't allow to push on the repository ${repoId}.`,
4448
'EGHNOPERMISSION'
4549
);
4650
}

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@
1818
"dependencies": {
1919
"@semantic-release/error": "^2.1.0",
2020
"debug": "^3.1.0",
21+
"escape-string-regexp": "^1.0.5",
2122
"got": "^8.0.1",
22-
"parse-github-url": "^1.0.2",
23+
"parse-path": "^3.0.2",
2324
"url-join": "^2.0.2"
2425
},
2526
"devDependencies": {

‎test/get-repo-id.test.js‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import test from 'ava';
2+
import getRepoId from '../lib/get-repo-id';
3+
4+
test('Parse repo id with https URL', t => {
5+
t.is(getRepoId('https://gitlbab.com', 'https://gitlab.com/owner/repo.git'), 'owner/repo');
6+
t.is(getRepoId('https://gitlbab.com', 'https://gitlab.com/owner/repo'), 'owner/repo');
7+
});
8+
9+
test('Parse repo id with git URL', t => {
10+
t.is(getRepoId('https://gitlab.com', 'git+ssh://git@gitlab.com/owner/repo.git'), 'owner/repo');
11+
t.is(getRepoId('https://gitlab.com', 'git+ssh://git@gitlab.com/owner/repo'), 'owner/repo');
12+
});
13+
14+
test('Parse repo id with context in repo URL', t => {
15+
t.is(getRepoId('https://gitlbab.com/context', 'https://gitlab.com/context/owner/repo.git'), 'owner/repo');
16+
t.is(getRepoId('https://gitlab.com/context', 'git+ssh://git@gitlab.com/context/owner/repo.git'), 'owner/repo');
17+
});
18+
19+
test('Parse repo id with context not in repo URL', t => {
20+
t.is(getRepoId('https://gitlbab.com/context', 'https://gitlab.com/owner/repo.git'), 'owner/repo');
21+
t.is(getRepoId('https://gitlab.com/context', 'git+ssh://git@gitlab.com/owner/repo.git'), 'owner/repo');
22+
});
23+
24+
test('Parse repo id with organization and subgroup', t => {
25+
t.is(
26+
getRepoId('https://gitlbab.com/context', 'https://gitlab.com/orga/subgroup/owner/repo.git'),
27+
'orga/subgroup/owner/repo'
28+
);
29+
t.is(
30+
getRepoId('https://gitlab.com/context', 'git+ssh://git@gitlab.com/orga/subgroup/owner/repo.git'),
31+
'orga/subgroup/owner/repo'
32+
);
33+
});

‎test/verify.test.js‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,46 @@ test.serial('Verify token and repository access and custom URL', async t => {
101101
t.deepEqual(t.context.log.args[0], ['Verify GitLab authentication (%s)', 'https://othertesturl.com:9090/prefix']);
102102
});
103103

104+
test.serial('Verify token and repository access with subgroup git URL', async t => {
105+
const repoUri = 'orga/subgroup/test_user/test_repo';
106+
process.env.GL_TOKEN = 'gitlab_token';
107+
const gitlabUrl = 'https://customurl.com:9090/context';
108+
const gitlabApiPathPrefix = 'prefix';
109+
const gitlab = authenticate({gitlabUrl, gitlabApiPathPrefix})
110+
.get(`/projects/${encodeURIComponent(repoUri)}`)
111+
.reply(200, {permissions: {project_access: {access_level: 40}}});
112+
113+
await t.notThrows(
114+
verify({gitlabUrl, gitlabApiPathPrefix}, {repositoryUrl: `git@customurl.com:${repoUri}.git`}, t.context.logger)
115+
);
116+
117+
t.true(gitlab.isDone());
118+
t.deepEqual(t.context.log.args[0], [
119+
'Verify GitLab authentication (%s)',
120+
'https://customurl.com:9090/context/prefix',
121+
]);
122+
});
123+
124+
test.serial('Verify token and repository access with subgroup http URL', async t => {
125+
const repoUri = 'orga/subgroup/test_user/test_repo';
126+
process.env.GL_TOKEN = 'gitlab_token';
127+
const gitlabUrl = 'https://customurl.com:9090/context';
128+
const gitlabApiPathPrefix = 'prefix';
129+
const gitlab = authenticate({gitlabUrl, gitlabApiPathPrefix})
130+
.get(`/projects/${encodeURIComponent(repoUri)}`)
131+
.reply(200, {permissions: {project_access: {access_level: 40}}});
132+
133+
await t.notThrows(
134+
verify({gitlabUrl, gitlabApiPathPrefix}, {repositoryUrl: `http://customurl.com/${repoUri}.git`}, t.context.logger)
135+
);
136+
137+
t.true(gitlab.isDone());
138+
t.deepEqual(t.context.log.args[0], [
139+
'Verify GitLab authentication (%s)',
140+
'https://customurl.com:9090/context/prefix',
141+
]);
142+
});
143+
104144
test.serial('Verify token and repository access with empty gitlabApiPathPrefix', async t => {
105145
const owner = 'test_user';
106146
const repo = 'test_repo';
@@ -181,8 +221,11 @@ test.serial('Throw SemanticReleaseError for invalid token', async t => {
181221

182222
test.serial('Throw SemanticReleaseError for invalid repositoryUrl', async t => {
183223
process.env.GITLAB_TOKEN = 'gitlab_token';
224+
const gitlabUrl = 'https://gitlab.com/context';
184225

185-
const error = await t.throws(verify({}, {repositoryUrl: 'invalid_url'}, t.context.logger));
226+
const error = await t.throws(
227+
verify({gitlabUrl}, {repositoryUrl: 'git+ssh://git@gitlab.com/context.git'}, t.context.logger)
228+
);
186229

187230
t.true(error instanceof SemanticReleaseError);
188231
t.is(error.code, 'EINVALIDGITURL');

0 commit comments

Comments
 (0)