Skip to content

Refactor VersionDeclaration to use pathlib #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
relekang merged 2 commits into from
Jun 11, 2021
Merged

Refactor VersionDeclaration to use pathlib #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b66a4b1
test: add a failing test to reproduce tomlkit bug
browniebroke Jun 9, 2021
be565e7
refactor: update VersionDeclaration to pathlib
browniebroke Jun 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 18 additions & 22 deletions semantic_release/history/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
import logging
import re
from abc import ABC, abstractmethod
from typing import List, Optional, Set
from pathlib import Path
from typing import List, Optional, Set, Union

import semver
import tomlkit
Expand All @@ -24,8 +25,8 @@


class VersionDeclaration(ABC):
def __init__(self, path: str):
self.path = path
def __init__(self, path: Union[str, Path]):
self.path = Path(path)

@staticmethod
def from_toml(config_str: str):
Expand Down Expand Up @@ -87,23 +88,21 @@ def __init__(self, path, key):
super().__init__(path)
self.key = key

def _read(self):
with open(self.path, "r") as f:
return Dotty(tomlkit.loads(f.read()))
def _read(self) -> Dotty:
toml_doc = tomlkit.loads(self.path.read_text())
return Dotty(toml_doc)

def parse(self) -> Set[str]:
config = self._read()
if self.key in config:
return {config.get(self.key)}
_config = self._read()
if self.key in _config:
return {_config.get(self.key)}
return set()

def replace(self, new_version: str):
config = self._read()
version = self.key in config
if version:
config[self.key] = new_version
with open(self.path, "w") as f:
f.write(tomlkit.dumps(config))
def replace(self, new_version: str) -> None:
_config = self._read()
if self.key in _config:
_config[self.key] = new_version
self.path.write_text(tomlkit.dumps(_config))


class PatternVersionDeclaration(VersionDeclaration):
Expand Down Expand Up @@ -134,8 +133,7 @@ def parse(self) -> Set[str]:
should be the same version in each place), but it falls on the caller
to check for this condition.
"""
with open(self.path, "r") as f:
content = f.read()
content = self.path.read_text()

versions = {
m.group(1) for m in re.finditer(self.pattern, content, re.MULTILINE)
Expand All @@ -156,8 +154,7 @@ def replace(self, new_version: str):
:param new_version: The new version number as a string
"""
n = 0
with open(self.path, "r") as f:
old_content = f.read()
old_content = self.path.read_text()

def swap_version(m):
nonlocal n
Expand All @@ -175,8 +172,7 @@ def swap_version(m):
f"Writing new version number: path={self.path!r} pattern={self.pattern!r} num_matches={n!r}"
)

with open(self.path, mode="w") as f:
f.write(new_content)
self.path.write_text(new_content)


@LoggedFunction(logger)
Expand Down
100 changes: 71 additions & 29 deletions tests/history/test_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from pathlib import Path
from textwrap import dedent

import mock
Expand Down Expand Up @@ -107,7 +108,7 @@ class TestVersionPattern:
[
(
"path:__version__",
"path",
Path("path"),
r'__version__ *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']',
),
],
Expand All @@ -120,8 +121,8 @@ def test_from_variable(self, str, path, pattern):
@pytest.mark.parametrize(
"str, path, pattern",
[
("path:pattern", "path", r"pattern"),
("path:Version: {version}", "path", r"Version: (\d+\.\d+(?:\.\d+)?)"),
("path:pattern", Path("path"), r"pattern"),
("path:Version: {version}", Path("path"), r"Version: (\d+\.\d+(?:\.\d+)?)"),
],
)
def test_from_pattern(self, str, path, pattern):
Expand All @@ -132,8 +133,8 @@ def test_from_pattern(self, str, path, pattern):
@pytest.mark.parametrize(
"str, path, key",
[
("path:some.toml.key", "path", r"some.toml.key"),
("path:some:other:toml.key", "path", r"some:other:toml.key"),
("path:some.toml.key", Path("path"), r"some.toml.key"),
("path:some:other:toml.key", Path("path"), r"some:other:toml.key"),
],
)
def test_from_toml(self, str, path, key):
Expand Down Expand Up @@ -207,15 +208,15 @@ def test_pattern_replace(self, tmp_path, pattern, old_content, new_content):
@pytest.mark.parametrize(
"key, content, hits",
[
(r"root", 'root = "test"', {"test"}),
(r"tool.poetry.version", '[tool.poetry]\nversion = "0.1.0"', {"0.1.0"}),
("root", 'root = "test"', {"test"}),
("tool.poetry.version", '[tool.poetry]\nversion = "0.1.0"', {"0.1.0"}),
],
)
def test_toml_parse(self, tmp_path, key, content, hits):
path = tmp_path / "pyproject.toml"
path.write_text(content)

declaration = TomlVersionDeclaration(str(path), key)
declaration = TomlVersionDeclaration(path, key)
assert declaration.parse() == hits

@pytest.mark.parametrize(
Expand All @@ -224,17 +225,58 @@ def test_toml_parse(self, tmp_path, key, content, hits):
(r"root", "", ""),
(r"root", 'root = "test"', 'root = "-"'),
(
r"tool.poetry.version",
"[tool.poetry]\n"
'version = "0.1.0"\n'
"[tool.poetry.dependencies.pylint]\n"
'version = "^2.5.3"\n'
"optional = true\n",
"[tool.poetry]\n"
'version = "-"\n'
"[tool.poetry.dependencies.pylint]\n"
'version = "^2.5.3"\n'
"optional = true\n",
"tool.poetry.version",
dedent(
"""
[tool.poetry]
version = "0.1.0"
[tool.poetry.dependencies.pylint]
version = "^2.5.3"
optional = true
"""
),
dedent(
"""
[tool.poetry]
version = "-"
[tool.poetry.dependencies.pylint]
version = "^2.5.3"
optional = true
"""
),
),
(
"tool.poetry.version",
dedent(
"""
[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "A super package"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.semantic_release]
version_toml = "pyproject.toml:tool.poetry.version"
"""
),
dedent(
"""
[tool.poetry]
name = "my-package"
version = "-"
description = "A super package"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.semantic_release]
version_toml = "pyproject.toml:tool.poetry.version"
"""
),
),
],
)
Expand Down Expand Up @@ -267,7 +309,7 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
version_variable = "path:__version__"
""",
patterns=[
("path", r'__version__ *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
(Path("path"), r'__version__ *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
],
),
dict(
Expand All @@ -276,8 +318,8 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
version_variable = "path1:var1,path2:var2"
""",
patterns=[
("path1", r'var1 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
("path2", r'var2 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
(Path("path1"), r'var1 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
(Path("path2"), r'var2 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
],
),
dict(
Expand All @@ -289,8 +331,8 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
]
""",
patterns=[
("path1", r'var1 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
("path2", r'var2 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
(Path("path1"), r'var1 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
(Path("path2"), r'var2 *[:=] *["\'](\d+\.\d+(?:\.\d+)?)["\']'),
],
),
dict(
Expand All @@ -299,7 +341,7 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
version_pattern = "path:pattern"
""",
patterns=[
("path", "pattern"),
(Path("path"), "pattern"),
],
),
dict(
Expand All @@ -308,8 +350,8 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
version_pattern = "path1:pattern1,path2:pattern2"
""",
patterns=[
("path1", "pattern1"),
("path2", "pattern2"),
(Path("path1"), "pattern1"),
(Path("path2"), "pattern2"),
],
),
dict(
Expand All @@ -321,8 +363,8 @@ def test_toml_replace(self, tmp_path, key, old_content, new_content):
]
""",
patterns=[
("path1", "pattern1"),
("path2", "pattern2"),
(Path("path1"), "pattern1"),
(Path("path2"), "pattern2"),
],
),
],
Expand Down
8 changes: 5 additions & 3 deletions tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,9 @@ def test_changelog_should_call_functions(mocker, runner):


def test_overload_by_cli(mocker, runner):
mock_open = mocker.patch("semantic_release.history.open", mock_version_file)
mock_read_text = mocker.patch(
"semantic_release.history.Path.read_text", mock_version_file
)
runner.invoke(
main,
[
Expand All @@ -837,8 +839,8 @@ def test_overload_by_cli(mocker, runner):
],
)

mock_open.assert_called_once_with("my_version_path", "r")
mock_open.reset_mock()
mock_read_text.assert_called_once_with()
mock_read_text.reset_mock()


def test_changelog_noop(mocker):
Expand Down