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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
|
from __future__ import annotations
from dataclasses import replace
from datetime import date
from datetime import timedelta
from typing import Any
import pytest
from setuptools_scm import Configuration
from setuptools_scm import NonNormalizedVersion
from setuptools_scm.version import ScmVersion
from setuptools_scm.version import calver_by_date
from setuptools_scm.version import format_version
from setuptools_scm.version import guess_next_date_ver
from setuptools_scm.version import guess_next_version
from setuptools_scm.version import meta
from setuptools_scm.version import no_guess_dev_version
from setuptools_scm.version import only_version
from setuptools_scm.version import release_branch_semver_version
from setuptools_scm.version import simplified_semver_version
c = Configuration()
c_non_normalize = Configuration(version_cls=NonNormalizedVersion)
@pytest.mark.parametrize(
("version", "expected_next"),
[
pytest.param(meta("1.0.0", config=c), "1.0.0", id="exact"),
pytest.param(meta("1.0", config=c), "1.0.0", id="short_tag"),
pytest.param(
meta("1.0.0", distance=2, branch="default", config=c),
"1.0.1.dev2",
id="normal_branch",
),
pytest.param(
meta("1.0", distance=2, branch="default", config=c),
"1.0.1.dev2",
id="normal_branch_short_tag",
),
pytest.param(
meta("1.0.0", distance=2, branch="feature", config=c),
"1.1.0.dev2",
id="feature_branch",
),
pytest.param(
meta("1.0", distance=2, branch="feature", config=c),
"1.1.0.dev2",
id="feature_branch_short_tag",
),
pytest.param(
meta("1.0.0", distance=2, branch="features/test", config=c),
"1.1.0.dev2",
id="feature_in_branch",
),
pytest.param(
meta(NonNormalizedVersion("v1.0"), distance=2, branch="default", config=c),
"1.0.1.dev2",
id="non-normalized-allowed",
),
],
)
def test_next_semver(version: ScmVersion, expected_next: str) -> None:
computed = simplified_semver_version(version)
assert computed == expected_next
def test_next_semver_bad_tag() -> None:
version = meta("1.0.0-foo", preformatted=True, config=c)
with pytest.raises(
ValueError, match=r"1\.0\.0-foo.* can't be parsed as numeric version"
):
simplified_semver_version(version)
@pytest.mark.parametrize(
("version", "expected_next"),
[
pytest.param(meta("1.0.0", config=c), "1.0.0", id="exact"),
pytest.param(
meta("1.0.0", distance=2, branch="master", config=c),
"1.1.0.dev2",
id="development_branch",
),
pytest.param(
meta("1.0.0rc1", distance=2, branch="master", config=c),
"1.1.0.dev2",
id="development_branch_release_candidate",
),
pytest.param(
meta("1.0.0", distance=2, branch="maintenance/1.0.x", config=c),
"1.0.1.dev2",
id="release_branch_legacy_version",
),
pytest.param(
meta("1.0.0", distance=2, branch="v1.0.x", config=c),
"1.0.1.dev2",
id="release_branch_with_v_prefix",
),
pytest.param(
meta("1.0.0", distance=2, branch="release-1.0", config=c),
"1.0.1.dev2",
id="release_branch_with_prefix",
),
pytest.param(
meta("1.0.0", distance=2, branch="bugfix/3434", config=c),
"1.1.0.dev2",
id="false_positive_release_branch",
),
],
)
def test_next_release_branch_semver(version: ScmVersion, expected_next: str) -> None:
computed = release_branch_semver_version(version)
assert computed == expected_next
def m(tag: str, **kw: Any) -> ScmVersion:
return meta(tag, **kw, config=c)
@pytest.mark.parametrize(
("version", "expected_next"),
[
pytest.param(
m("1.0.0", distance=2),
"1.0.0.post1.dev2",
id="dev_distance",
),
pytest.param(
m("1.0.dev0", distance=2), "1.0.dev2", id="dev_distance_after_dev_tag"
),
pytest.param(
m("1.0", distance=2),
"1.0.post1.dev2",
id="dev_distance_short_tag",
),
pytest.param(
m("1.0.0"),
"1.0.0",
id="no_dev_distance",
),
],
)
def test_no_guess_version(version: ScmVersion, expected_next: str) -> None:
computed = no_guess_dev_version(version)
assert computed == expected_next
@pytest.mark.parametrize(
("version", "match"),
[
("1.0.dev1", "choosing custom numbers for the `.devX` distance"),
("1.0.post1", "already is a post release"),
],
)
def test_no_guess_version_bad(version: str, match: str) -> None:
with pytest.raises(ValueError, match=match):
no_guess_dev_version(m(version, distance=1))
def test_bump_dev_version_zero() -> None:
assert guess_next_version(m("1.0.dev0")) == "1.0"
def test_bump_dev_version_nonzero_raises() -> None:
match = (
"choosing custom numbers for the `.devX` distance "
"is not supported.\n "
"The 1.0.dev1 can't be bumped\n"
"Please drop the tag or create a new supported one ending in .dev0"
)
with pytest.raises(ValueError, match=match):
guess_next_version(m("1.0.dev1"))
@pytest.mark.parametrize(
"version",
[
"1.dev0",
"1.0.dev456",
"1.0a1",
"1.0a2.dev456",
"1.0a12.dev456",
"1.0a12",
"1.0b1.dev456",
"1.0b2",
"1.0b2.post345.dev456",
"1.0b2.post345",
"1.0rc1.dev456",
"1.0rc1",
"1.0",
"1.0.post456.dev34",
"1.0.post456",
"1.0.15",
"1.1.dev1",
],
)
def test_only_version(version: str) -> None:
assert version == only_version(meta(version, config=c))
assert version == only_version(meta(version, distance=2, config=c))
@pytest.mark.parametrize(
("tag", "expected"),
[
("v1.0.0", "1.0.0"),
("v1.0.0-rc.1", "1.0.0rc1"),
("v1.0.0-rc.1+-25259o4382757gjurh54", "1.0.0rc1"),
],
)
def test_tag_regex1(tag: str, expected: str) -> None:
if "+" in tag:
# pytest bug wrt cardinality
with pytest.warns(UserWarning): # noqa: PT030
result = meta(tag, config=c)
else:
result = meta(tag, config=c)
assert not isinstance(result.tag, str)
assert result.tag.public == expected
@pytest.mark.issue("https://github.com/pypa/setuptools-scm/issues/471")
def test_version_bump_bad() -> None:
class YikesVersion:
val: str
def __init__(self, val: str) -> None:
self.val = val
def __str__(self) -> str:
return self.val
config = Configuration(version_cls=YikesVersion) # type: ignore[arg-type]
with pytest.raises(
ValueError,
match=r".*does not end with a number to bump, "
"please correct or use a custom version scheme",
):
guess_next_version(tag_version=meta("2.0.0-alpha.5-PMC", config=config))
def test_format_version_schemes() -> None:
version = meta(
"1.0",
config=replace(
c,
local_scheme="no-local-version",
version_scheme=[ # type: ignore[arg-type]
lambda v: None,
"guess-next-dev",
],
),
)
assert format_version(version) == "1.0"
def test_custom_version_schemes() -> None:
version = meta(
"1.0",
config=replace(
c,
local_scheme="no-local-version",
version_scheme="setuptools_scm.version:no_guess_dev_version",
),
)
custom_computed = format_version(version)
assert custom_computed == no_guess_dev_version(version)
def date_offset(base_date: date | None = None, days_offset: int = 0) -> date:
if base_date is None:
from setuptools_scm.version import _source_epoch_or_utc_now
base_date = _source_epoch_or_utc_now().date()
return base_date - timedelta(days=days_offset)
def date_to_str(
base_date: date | None = None,
days_offset: int = 0,
fmt: str = "%y.%m.%d",
) -> str:
return format(date_offset(base_date, days_offset), fmt)
@pytest.mark.parametrize(
("version", "expected_next"),
[
pytest.param(
meta(date_to_str(days_offset=3), config=c_non_normalize),
date_to_str(days_offset=3),
id="exact",
),
pytest.param(
meta(date_to_str() + ".1", config=c_non_normalize),
date_to_str() + ".1",
id="exact patch",
),
pytest.param(
meta("20.01.02", config=c),
"20.1.2",
id="leading 0s",
),
pytest.param(
meta(date_to_str(days_offset=3), config=c_non_normalize, dirty=True),
date_to_str() + ".0.dev0",
id="dirty other day",
),
pytest.param(
meta(date_to_str(), config=c_non_normalize, distance=2, branch="default"),
date_to_str() + ".1.dev2",
id="normal branch",
),
pytest.param(
meta(date_to_str(fmt="%Y.%m.%d"), config=c_non_normalize),
date_to_str(fmt="%Y.%m.%d"),
id="4 digits year",
),
pytest.param(
meta(
date_to_str(),
config=c_non_normalize,
distance=2,
branch="release-2021.05.06",
),
"2021.05.06",
id="release branch",
),
pytest.param(
meta(
date_to_str() + ".2",
config=c_non_normalize,
distance=2,
branch="release-21.5.1",
),
"21.5.1",
id="release branch short",
),
pytest.param(
meta(
date_to_str(days_offset=3) + ".2",
config=c_non_normalize,
node_date=date_offset(days_offset=2),
),
date_to_str(days_offset=3) + ".2",
id="node date clean",
),
pytest.param(
meta(
date_to_str(days_offset=2) + ".2",
config=c_non_normalize,
distance=2,
node_date=date_offset(days_offset=2),
),
date_to_str(days_offset=2) + ".3.dev2",
id="node date distance",
),
pytest.param(
meta(
"1.2.0",
config=c_non_normalize,
distance=2,
node_date=date_offset(days_offset=2),
),
date_to_str(days_offset=2) + ".0.dev2",
marks=pytest.mark.filterwarnings(
"ignore:.*not correspond to a valid versioning date.*:UserWarning"
),
id="using on old version tag",
),
],
)
def test_calver_by_date(version: ScmVersion, expected_next: str) -> None:
computed = calver_by_date(version)
assert computed == expected_next
@pytest.mark.parametrize(
("version", "expected_next"),
[
pytest.param(meta("1.0.0", config=c), "1.0.0", id="SemVer exact stays"),
pytest.param(
meta("1.0.0", config=c_non_normalize, dirty=True),
"09.02.13.1.dev0",
id="SemVer dirty is replaced by date",
marks=pytest.mark.filterwarnings("ignore:.*legacy version.*:UserWarning"),
),
],
)
def test_calver_by_date_semver(version: ScmVersion, expected_next: str) -> None:
computed = calver_by_date(version)
assert computed == expected_next
def test_calver_by_date_future_warning() -> None:
with pytest.warns(UserWarning, match="your previous tag*"):
calver_by_date(
meta(date_to_str(days_offset=-2), config=c_non_normalize, distance=2)
)
@pytest.mark.parametrize(
("tag", "node_date", "expected"),
[
pytest.param("20.03.03", date(2020, 3, 4), "20.03.04.0", id="next day"),
pytest.param("20.03.03", date(2020, 3, 3), "20.03.03.1", id="same day"),
pytest.param(
"20.03.03.2", date(2020, 3, 3), "20.03.03.3", id="same day with patch"
),
pytest.param(
"v20.03.03", date(2020, 3, 4), "v20.03.04.0", id="next day with v prefix"
),
],
)
def test_calver_guess_next_data(tag: str, node_date: date, expected: str) -> None:
version = meta(tag, config=c_non_normalize, node_date=node_date)
next = guess_next_date_ver(
version,
node_date=node_date,
version_cls=c_non_normalize.version_cls,
)
assert next == expected
def test_custom_version_cls() -> None:
"""Test that we can pass our own version class instead of pkg_resources"""
class MyVersion:
def __init__(self, tag_str: str) -> None:
self.tag = tag_str
def __str__(self) -> str:
return f"Custom {self.tag}"
def __repr__(self) -> str:
return f"MyVersion<Custom{self.tag}>"
config = Configuration(version_cls=MyVersion) # type: ignore[arg-type]
scm_version = meta("1.0.0-foo", config=config)
assert isinstance(scm_version.tag, MyVersion)
assert str(scm_version.tag) == "Custom 1.0.0-foo"
|