1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
from __future__ import annotations
import os
from unittest import mock
import pytest
from semantic_release.hvcs.bitbucket import Bitbucket
from tests.const import EXAMPLE_HVCS_DOMAIN, EXAMPLE_REPO_NAME, EXAMPLE_REPO_OWNER
@pytest.fixture
def default_bitbucket_client():
remote_url = (
f"git@{Bitbucket.DEFAULT_DOMAIN}:{EXAMPLE_REPO_OWNER}/{EXAMPLE_REPO_NAME}.git"
)
return Bitbucket(remote_url=remote_url)
@pytest.mark.parametrize(
str.join(
", ",
[
"patched_os_environ",
"hvcs_domain",
"hvcs_api_domain",
"expected_hvcs_domain",
"expected_api_url",
"insecure",
],
),
[
# No env vars as CI is handled by Bamboo or Jenkins (which require user defined defaults)
# API paths are different in BitBucket Cloud (bitbucket.org) vs BitBucket Data Center
(
# Default values (BitBucket Cloud)
{},
None,
None,
f"https://{Bitbucket.DEFAULT_DOMAIN}",
Bitbucket.DEFAULT_API_URL_CLOUD,
False,
),
(
# Explicitly set default values
{},
Bitbucket.DEFAULT_DOMAIN,
Bitbucket.DEFAULT_API_URL_CLOUD,
f"https://{Bitbucket.DEFAULT_DOMAIN}",
Bitbucket.DEFAULT_API_URL_CLOUD,
False,
),
(
# Explicitly set custom values with full api path
{},
EXAMPLE_HVCS_DOMAIN,
f"{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
f"https://{EXAMPLE_HVCS_DOMAIN}",
f"https://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
False,
),
(
# Explicitly defined api as subdomain
# POSSIBLY WRONG ASSUMPTION of Api path for BitBucket Server
{},
f"https://{EXAMPLE_HVCS_DOMAIN}",
f"https://api.{EXAMPLE_HVCS_DOMAIN}",
f"https://{EXAMPLE_HVCS_DOMAIN}",
f"https://api.{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
False,
),
(
# Custom domain for on premise BitBucket Server (derive api endpoint)
{},
EXAMPLE_HVCS_DOMAIN,
None,
f"https://{EXAMPLE_HVCS_DOMAIN}",
f"https://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
False,
),
(
# Custom domain with path prefix
{},
"special.custom.server/bitbucket",
None,
"https://special.custom.server/bitbucket",
"https://special.custom.server/bitbucket/rest/api/1.0",
False,
),
(
# Allow insecure http connections explicitly
{},
f"http://{EXAMPLE_HVCS_DOMAIN}",
f"http://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
f"http://{EXAMPLE_HVCS_DOMAIN}",
f"http://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
True,
),
(
# Allow insecure http connections explicitly & imply insecure api domain
{},
f"http://{EXAMPLE_HVCS_DOMAIN}",
None,
f"http://{EXAMPLE_HVCS_DOMAIN}",
f"http://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
True,
),
(
# Infer insecure connection from user configuration
{},
EXAMPLE_HVCS_DOMAIN,
f"{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
f"http://{EXAMPLE_HVCS_DOMAIN}",
f"http://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
True,
),
(
# Infer insecure connection from user configuration & imply insecure api domain
{},
EXAMPLE_HVCS_DOMAIN,
None,
f"http://{EXAMPLE_HVCS_DOMAIN}",
f"http://{EXAMPLE_HVCS_DOMAIN}/rest/api/1.0",
True,
),
],
)
@pytest.mark.parametrize(
"remote_url",
[
f"git@{Bitbucket.DEFAULT_DOMAIN}:{EXAMPLE_REPO_OWNER}/{EXAMPLE_REPO_NAME}.git",
f"https://{Bitbucket.DEFAULT_DOMAIN}/{EXAMPLE_REPO_OWNER}/{EXAMPLE_REPO_NAME}.git",
],
)
@pytest.mark.parametrize("token", ("abc123", None))
def test_bitbucket_client_init(
patched_os_environ: dict[str, str],
hvcs_domain: str | None,
hvcs_api_domain: str | None,
expected_hvcs_domain: str,
expected_api_url: str,
remote_url: str,
token: str | None,
insecure: bool,
):
with mock.patch.dict(os.environ, patched_os_environ, clear=True):
client = Bitbucket(
remote_url=remote_url,
hvcs_domain=hvcs_domain,
hvcs_api_domain=hvcs_api_domain,
token=token,
allow_insecure=insecure,
)
assert expected_hvcs_domain == str(client.hvcs_domain)
assert expected_api_url == str(client.api_url)
assert token == client.token
assert remote_url == client._remote_url
@pytest.mark.parametrize(
"hvcs_domain, hvcs_api_domain, insecure",
[
# Bad base domain schemes
(f"ftp://{EXAMPLE_HVCS_DOMAIN}", None, False),
(f"ftp://{EXAMPLE_HVCS_DOMAIN}", None, True),
# Unallowed insecure connections when base domain is insecure
(f"http://{EXAMPLE_HVCS_DOMAIN}", None, False),
# Bad API domain schemes
(None, f"ftp://api.{EXAMPLE_HVCS_DOMAIN}", False),
(None, f"ftp://api.{EXAMPLE_HVCS_DOMAIN}", True),
# Unallowed insecure connections when api domain is insecure
(None, f"http://{EXAMPLE_HVCS_DOMAIN}", False),
],
)
def test_bitbucket_client_init_with_invalid_scheme(
hvcs_domain: str | None,
hvcs_api_domain: str | None,
insecure: bool,
):
with pytest.raises(ValueError), mock.patch.dict(os.environ, {}, clear=True):
Bitbucket(
remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/{EXAMPLE_REPO_OWNER}/{EXAMPLE_REPO_NAME}.git",
hvcs_domain=hvcs_domain,
hvcs_api_domain=hvcs_api_domain,
allow_insecure=insecure,
)
@pytest.mark.parametrize(
"patched_os_environ, expected_owner, expected_name",
[
({}, None, None),
({"BITBUCKET_REPO_FULL_NAME": "path/to/repo/foo"}, "path/to/repo", "foo"),
],
)
def test_bitbucket_get_repository_owner_and_name(
default_bitbucket_client: Bitbucket,
patched_os_environ: dict[str, str],
expected_owner: str,
expected_name: str,
):
# expected results should be a tuple[namespace, repo_name]
# when None, the default values are used which matches default_bitbucket_client's setup
expected_result = (
expected_owner or EXAMPLE_REPO_OWNER,
expected_name or EXAMPLE_REPO_NAME,
)
with mock.patch.dict(os.environ, patched_os_environ, clear=True):
# Execute in mocked environment
result = default_bitbucket_client._get_repository_owner_and_name()
# Evaluate (expected -> actual)
assert expected_result == result
def test_compare_url(default_bitbucket_client: Bitbucket):
start_rev = "revA"
end_rev = "revB"
expected_url = (
"{server}/{owner}/{repo}/branches/compare/{from_rev}%0D{to_rev}".format(
server=default_bitbucket_client.hvcs_domain.url,
owner=default_bitbucket_client.owner,
repo=default_bitbucket_client.repo_name,
from_rev=start_rev,
to_rev=end_rev,
)
)
actual_url = default_bitbucket_client.compare_url(
from_rev=start_rev, to_rev=end_rev
)
assert expected_url == actual_url
@pytest.mark.parametrize(
"patched_os_environ, use_token, token, remote_url, expected_auth_url",
[
(
{"BITBUCKET_USER": "foo"},
False,
"",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
),
(
{},
False,
"aabbcc",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
),
(
{},
True,
"aabbcc",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
f"https://x-token-auth:aabbcc@{Bitbucket.DEFAULT_DOMAIN}/custom/example.git",
),
(
{"BITBUCKET_USER": "foo"},
False,
"aabbcc",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
),
(
{"BITBUCKET_USER": "foo"},
True,
"aabbcc",
f"git@{Bitbucket.DEFAULT_DOMAIN}:custom/example.git",
f"https://foo:aabbcc@{Bitbucket.DEFAULT_DOMAIN}/custom/example.git",
),
],
)
def test_remote_url(
default_bitbucket_client: Bitbucket,
patched_os_environ: dict[str, str],
use_token: bool,
token: str,
remote_url: str,
expected_auth_url: str,
):
with mock.patch.dict(os.environ, patched_os_environ, clear=True):
default_bitbucket_client._remote_url = remote_url
default_bitbucket_client.token = token
assert expected_auth_url == default_bitbucket_client.remote_url(
use_token=use_token
)
def test_commit_hash_url(default_bitbucket_client: Bitbucket):
sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
expected_url = "{server}/{owner}/{repo}/commits/{sha}".format(
server=default_bitbucket_client.hvcs_domain,
owner=default_bitbucket_client.owner,
repo=default_bitbucket_client.repo_name,
sha=sha,
)
assert expected_url == default_bitbucket_client.commit_hash_url(sha)
def test_commit_hash_url_w_custom_server():
"""
Test the commit hash URL generation for a self-hosted Bitbucket server with prefix.
ref: https://github.com/python-semantic-release/python-semantic-release/issues/1204
"""
sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
expected_url = "{server}/{owner}/{repo}/commits/{sha}".format(
server=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
owner="foo",
repo=EXAMPLE_REPO_NAME,
sha=sha,
)
with mock.patch.dict(os.environ, {}, clear=True):
actual_url = Bitbucket(
remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo/foo/{EXAMPLE_REPO_NAME}.git",
hvcs_domain=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
).commit_hash_url(sha)
assert expected_url == actual_url
@pytest.mark.parametrize("pr_number", (666, "666", "#666"))
def test_pull_request_url(default_bitbucket_client: Bitbucket, pr_number: int | str):
expected_url = "{server}/{owner}/{repo}/pull-requests/{pr_number}".format(
server=default_bitbucket_client.hvcs_domain,
owner=default_bitbucket_client.owner,
repo=default_bitbucket_client.repo_name,
pr_number=str(pr_number).lstrip("#"),
)
actual_url = default_bitbucket_client.pull_request_url(pr_number=pr_number)
assert expected_url == actual_url
|
