summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRonny Pfannschmidt <opensource@ronnypfannschmidt.de>2023-04-10 12:52:07 +0200
committerRonny Pfannschmidt <opensource@ronnypfannschmidt.de>2023-04-10 12:52:07 +0200
commit1dd9aa76392cddf2ad7368840be7c0449f9de035 (patch)
tree88577521205760661f299df6b361fbeee1b2666f
parent34021926d8ca1d0e597f3a1a8f177bd68de4a024 (diff)
downloadsetuptools-scm-1dd9aa76392cddf2ad7368840be7c0449f9de035.tar.gz
chore: test cleanup - drop wd.version
always use the explicit get_version method
-rw-r--r--testing/test_basic_api.py2
-rw-r--r--testing/test_git.py34
-rw-r--r--testing/test_hg_git.py32
-rw-r--r--testing/test_mercurial.py32
-rw-r--r--testing/wd_wrapper.py7
5 files changed, 51 insertions, 56 deletions
diff --git a/testing/test_basic_api.py b/testing/test_basic_api.py
index bb6a614..f1b4c4f 100644
--- a/testing/test_basic_api.py
+++ b/testing/test_basic_api.py
@@ -30,7 +30,7 @@ def test_data_from_mime(tmp_path: Path) -> None:
def test_version_from_pkginfo(wd: WorkDir) -> None:
wd.write("PKG-INFO", "Version: 0.1")
- assert wd.version == "0.1"
+ assert wd.get_version() == "0.1"
# replicate issue 167
assert wd.get_version(version_scheme="1.{0.distance}.0".format) == "0.1"
diff --git a/testing/test_git.py b/testing/test_git.py
index 4ff0872..9e2e9b5 100644
--- a/testing/test_git.py
+++ b/testing/test_git.py
@@ -147,37 +147,37 @@ def test_not_owner(wd: WorkDir) -> None:
def test_version_from_git(wd: WorkDir) -> None:
- assert wd.version == "0.1.dev0+d20090213"
+ assert wd.get_version() == "0.1.dev0+d20090213"
parsed = git.parse(str(wd.cwd), Configuration(), git.DEFAULT_DESCRIBE)
assert parsed is not None and parsed.branch in ("master", "main")
wd.commit_testfile()
- assert wd.version.startswith("0.1.dev1+g")
- assert not wd.version.endswith("1-")
+ assert wd.get_version().startswith("0.1.dev1+g")
+ assert not wd.get_version().endswith("1-")
wd("git tag v0.1")
- assert wd.version == "0.1"
+ assert wd.get_version() == "0.1"
wd.write("test.txt", "test2")
- assert wd.version.startswith("0.2.dev0+g")
+ assert wd.get_version().startswith("0.2.dev0+g")
wd.commit_testfile()
- assert wd.version.startswith("0.2.dev1+g")
+ assert wd.get_version().startswith("0.2.dev1+g")
wd("git tag version-0.2")
- assert wd.version.startswith("0.2")
+ assert wd.get_version().startswith("0.2")
wd.commit_testfile()
wd("git tag version-0.2.post210+gbe48adfpost3+g0cc25f2")
with pytest.warns(
UserWarning, match="tag '.*' will be stripped of its suffix '.*'"
):
- assert wd.version.startswith("0.2")
+ assert wd.get_version().startswith("0.2")
wd.commit_testfile()
wd("git tag 17.33.0-rc")
- assert wd.version == "17.33.0rc0"
+ assert wd.get_version() == "17.33.0rc0"
# custom normalization
assert wd.get_version(normalize=False) == "17.33.0-rc"
@@ -254,10 +254,10 @@ def test_unicode_version_scheme(wd: WorkDir) -> None:
def test_git_worktree(wd: WorkDir) -> None:
wd.write("test.txt", "test2")
# untracked files dont change the state
- assert wd.version == "0.1.dev0+d20090213"
+ assert wd.get_version() == "0.1.dev0+d20090213"
wd("git add test.txt")
- assert wd.version.startswith("0.1.dev0+d")
+ assert wd.get_version().startswith("0.1.dev0+d")
@pytest.mark.issue(86)
@@ -270,14 +270,14 @@ def test_git_dirty_notag(
wd.commit_testfile()
wd.write("test.txt", "test2")
wd("git add test.txt")
- assert wd.version.startswith("0.1.dev1")
+ version = wd.get_version()
+
if today:
# the date on the tag is in UTC
tag = datetime.now(timezone.utc).date().strftime(".d%Y%m%d")
else:
tag = ".d20090213"
- # we are dirty, check for the tag
- assert tag in wd.version
+ assert version.startswith("0.1.dev1+g") and version.endswith(tag)
@pytest.mark.issue(193)
@@ -342,7 +342,7 @@ def test_parse_no_worktree(tmp_path: Path) -> None:
def test_alphanumeric_tags_match(wd: WorkDir) -> None:
wd.commit_testfile()
wd("git tag newstyle-development-started")
- assert wd.version.startswith("0.1.dev1+g")
+ assert wd.get_version().startswith("0.1.dev1+g")
def test_git_archive_export_ignore(
@@ -446,10 +446,10 @@ def test_non_dotted_tag_no_version_match(wd: WorkDir) -> None:
def test_gitdir(monkeypatch: pytest.MonkeyPatch, wd: WorkDir) -> None:
""" """
wd.commit_testfile()
- normal = wd.version
+ normal = wd.get_version()
# git hooks set this and break subsequent setuptools_scm unless we clean
monkeypatch.setenv("GIT_DIR", __file__)
- assert wd.version == normal
+ assert wd.get_version() == normal
def test_git_getdate(wd: WorkDir) -> None:
diff --git a/testing/test_hg_git.py b/testing/test_hg_git.py
index 082f5ad..9527cb0 100644
--- a/testing/test_hg_git.py
+++ b/testing/test_hg_git.py
@@ -26,15 +26,15 @@ def _check_hg_git() -> None:
def test_base(repositories_hg_git: tuple[WorkDir, WorkDir]) -> None:
wd, wd_git = repositories_hg_git
- assert wd_git.version == "0.1.dev0+d20090213"
- assert wd.version == "0.1.dev0+d20090213"
+ assert wd_git.get_version() == "0.1.dev0+d20090213"
+ assert wd.get_version() == "0.1.dev0+d20090213"
wd_git.commit_testfile()
- version_git = wd_git.version
+ version_git = wd_git.get_version()
wd("hg pull -u")
- version = wd.version
+ version = wd.get_version()
assert version_git.startswith("0.1.dev1+g")
assert version.startswith("0.1.dev1+g")
@@ -44,24 +44,24 @@ def test_base(repositories_hg_git: tuple[WorkDir, WorkDir]) -> None:
wd_git("git tag v0.1")
wd("hg pull -u")
- assert wd_git.version == "0.1"
- assert wd.version == "0.1"
+ assert wd_git.get_version() == "0.1"
+ assert wd.get_version() == "0.1"
wd_git.write("test.txt", "test2")
wd.write("test.txt", "test2")
- assert wd_git.version.startswith("0.2.dev0+g")
- assert wd.version.startswith("0.2.dev0+g")
+ assert wd_git.get_version().startswith("0.2.dev0+g")
+ assert wd.get_version().startswith("0.2.dev0+g")
wd_git.commit_testfile()
wd("hg pull")
wd("hg up -C")
- assert wd_git.version.startswith("0.2.dev1+g")
- assert wd.version.startswith("0.2.dev1+g")
+ assert wd_git.get_version().startswith("0.2.dev1+g")
+ assert wd.get_version().startswith("0.2.dev1+g")
wd_git("git tag version-0.2")
wd("hg pull -u")
- assert wd_git.version.startswith("0.2")
- assert wd.version.startswith("0.2")
+ assert wd_git.get_version().startswith("0.2")
+ assert wd.get_version().startswith("0.2")
wd_git.commit_testfile()
wd_git("git tag version-0.2.post210+gbe48adfpost3+g0cc25f2")
@@ -69,15 +69,15 @@ def test_base(repositories_hg_git: tuple[WorkDir, WorkDir]) -> None:
with pytest.warns(
UserWarning, match="tag '.*' will be stripped of its suffix '.*'"
):
- assert wd_git.version.startswith("0.2")
+ assert wd_git.get_version().startswith("0.2")
with pytest.warns(
UserWarning, match="tag '.*' will be stripped of its suffix '.*'"
):
- assert wd.version.startswith("0.2")
+ assert wd.get_version().startswith("0.2")
wd_git.commit_testfile()
wd_git("git tag 17.33.0-rc")
wd("hg pull -u")
- assert wd_git.version == "17.33.0rc0"
- assert wd.version == "17.33.0rc0"
+ assert wd_git.get_version() == "17.33.0rc0"
+ assert wd.get_version() == "17.33.0rc0"
diff --git a/testing/test_mercurial.py b/testing/test_mercurial.py
index 262d424..1b35d11 100644
--- a/testing/test_mercurial.py
+++ b/testing/test_mercurial.py
@@ -76,31 +76,31 @@ def test_find_files_stop_at_root_hg(
# XXX: better tests for tag prefixes
def test_version_from_hg_id(wd: WorkDir) -> None:
- assert wd.version == "0.0"
+ assert wd.get_version() == "0.0"
wd.commit_testfile()
- assert wd.version.startswith("0.1.dev1+")
+ assert wd.get_version().startswith("0.1.dev1+")
# tagging commit is considered the tag
wd('hg tag v0.1 -u test -d "0 0"')
- assert wd.version == "0.1"
+ assert wd.get_version() == "0.1"
wd.commit_testfile()
- assert wd.version.startswith("0.2.dev2")
+ assert wd.get_version().startswith("0.2.dev2")
wd("hg up v0.1")
- assert wd.version == "0.1"
+ assert wd.get_version() == "0.1"
# commit originating from the tagged revision
- # that is not a actual tag
+ # that is not an actual tag
wd.commit_testfile()
- assert wd.version.startswith("0.2.dev1+")
+ assert wd.get_version().startswith("0.2.dev1+")
# several tags
wd("hg up")
wd('hg tag v0.2 -u test -d "0 0"')
wd('hg tag v0.3 -u test -d "0 0" -r v0.2')
- assert wd.version == "0.3"
+ assert wd.get_version() == "0.3"
def test_version_from_archival(wd: WorkDir) -> None:
@@ -108,14 +108,14 @@ def test_version_from_archival(wd: WorkDir) -> None:
# cleaning the wd ensure this test won't break randomly
wd.cwd.joinpath(".hg").rename(wd.cwd / ".nothg")
wd.write(".hg_archival.txt", "node: 000000000000\n" "tag: 0.1\n")
- assert wd.version == "0.1"
+ assert wd.get_version() == "0.1"
wd.write(
".hg_archival.txt",
"node: 000000000000\n" "latesttag: 0.1\n" "latesttagdistance: 3\n",
)
- assert wd.version == "0.2.dev3+h000000000000"
+ assert wd.get_version() == "0.2.dev3+h000000000000"
@pytest.mark.issue("#72")
@@ -125,7 +125,7 @@ def test_version_in_merge(wd: WorkDir) -> None:
wd("hg up 0")
wd.commit_testfile()
wd("hg merge --tool :merge")
- assert wd.version is not None
+ assert wd.get_version() is not None
@pytest.mark.issue(128)
@@ -157,14 +157,14 @@ def pre_merge_commit_after_tag(version_1_0: WorkDir) -> WorkDir:
@pytest.mark.usefixtures("pre_merge_commit_after_tag")
def test_version_bump_before_merge_commit(wd: WorkDir) -> None:
- assert wd.version.startswith("1.0.1.dev1+")
+ assert wd.get_version().startswith("1.0.1.dev1+")
@pytest.mark.issue(219)
@pytest.mark.usefixtures("pre_merge_commit_after_tag")
def test_version_bump_from_merge_commit(wd: WorkDir) -> None:
wd.commit()
- assert wd.version.startswith("1.0.1.dev3+") # issue 219
+ assert wd.get_version().startswith("1.0.1.dev3+") # issue 219
@pytest.mark.usefixtures("version_1_0")
@@ -174,9 +174,9 @@ def test_version_bump_from_commit_including_hgtag_mods(wd: WorkDir) -> None:
tagfile.write(b"0 0\n")
wd.write("branchfile", "branchtext")
wd(wd.add_command)
- assert wd.version.startswith("1.0.1.dev1+") # bump from dirty version
+ assert wd.get_version().startswith("1.0.1.dev1+") # bump from dirty version
wd.commit() # commits both the testfile _and_ .hgtags
- assert wd.version.startswith("1.0.1.dev2+")
+ assert wd.get_version().startswith("1.0.1.dev2+")
@pytest.mark.issue(229)
@@ -186,7 +186,7 @@ def test_latest_tag_detection(wd: WorkDir) -> None:
Note that will be superseded by the fix for pypa/setuptools_scm/issues/235
"""
wd('hg tag some-random-tag -u test -d "0 0"')
- assert wd.version == "1.0.0"
+ assert wd.get_version() == "1.0.0"
@pytest.mark.usefixtures("version_1_0")
diff --git a/testing/wd_wrapper.py b/testing/wd_wrapper.py
index 087a554..4f856de 100644
--- a/testing/wd_wrapper.py
+++ b/testing/wd_wrapper.py
@@ -68,10 +68,5 @@ class WorkDir:
from setuptools_scm import get_version
version = get_version(root=self.cwd, fallback_root=self.cwd, **kw)
- print(version)
+ print(self.cwd.name, version, sep=": ")
return version
-
- @property
- def version(self) -> str:
- __tracebackhide__ = True
- return self.get_version()