python-kacl 0.6.3__py3-none-any.whl → 0.6.5__py3-none-any.whl

kacl/__init__.py

@@ -1,5 +1,5 @@
 # Version of the python-kacl package
-__version__ = "0.6.3"
+__version__ = "0.6.5"
 
 from kacl.document import KACLDocument
 from kacl.serializer import KACLMarkdownSerializer

kacl/kacl_cli.py

@@ -177,7 +177,12 @@ def next(ctx, version):
 @cli.command()
 @click.pass_context
 @click.argument("version", type=str)
-def get(ctx, version):
+@click.option(
+    "--no-link",
+    is_flag=True,
+    help="This option suppresses a link, even if available.",
+)
+def get(ctx, version, no_link):
     """Returns a given version from the Changelog."""
     kacl_changelog = load_changelog(ctx)
 
@@ -185,6 +190,8 @@ def get(ctx, version):
     kacl_version = kacl_changelog.get(version)
 
     if kacl_version:
+        if no_link:
+            kacl_version.set_link(None)
         kacl_changelog_content = kacl.dump(kacl_version)
         click.echo(kacl_changelog_content)
     else:

kacl/serializer.py

@@ -11,30 +11,37 @@ class KACLMarkdownSerializer:
         pass
 
     def serialize(self, document):
+        data = []
+        link_references = []
         if isinstance(document, KACLDocument):
-            data = []
-
             serialized_metadata = self.__serialize_metadata(document.metadata())
             if serialized_metadata:
                 data.extend(serialized_metadata)
 
             data.append(self.__serialize_header(document.header()))
-            data.append(document.header().body())
+            # check if the body starts with a newline. if not add one
+            if document.header().body().startswith("\n"):
+                data.append(document.header().body())
+            else:
+                data.append("\n" + document.header().body())
 
-            link_references = []
             for version in document.versions():
                 data.extend([self.__serialize_version(version), ""])
                 if version.has_link_reference():
                     link_references.append(self.__serialize_link_reference(version))
 
-            data.extend(link_references)
+        elif isinstance(document, KACLVersion):
+            data.extend([self.__serialize_version(document), ""])
 
-            if data[-1] != "":
-                data.append("")
+            if document.has_link_reference():
+                link_references.append(self.__serialize_link_reference(document))
 
-            return "\n".join(data)
-        elif isinstance(document, KACLVersion):
-            return self.__serialize_version(document)
+        data.extend(link_references)
+
+        if data[-1] != "":
+            data.append("")
+
+        return "\n".join(data)
 
     def __serialize_metadata(self, metadata):
         if not metadata:
@@ -64,11 +71,12 @@ class KACLMarkdownSerializer:
             return f"# {obj.title()}"
 
     def __serialize_version(self, obj):
-        lines = [self.__serialize_header(obj)]
+        lines = [self.__serialize_header(obj), ""]
         for title, changes in obj.sections().items():
             lines.extend(
                 [
                     self.__serialize_header(changes),
+                    "",
                     self.__serialize_list(changes.items()),
                     "",
                 ]

kacl/version.py

@@ -47,9 +47,9 @@ class KACLVersion(KACLElement):
             return self.__link_reference.body()
 
     def set_link(self, link):
-        if isinstance(link, KACLElement):
+        if not link or isinstance(link, KACLElement):
             self.__link_reference = link
-        elif link is not None:
+        else:
             self.__link_reference = KACLElement(title=self.version(), body=link)
 
     def has_link_reference(self):

{python_kacl-0.6.3.dist-info → python_kacl-0.6.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.3
+Version: 0.6.5
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder

python_kacl-0.6.5.dist-info/RECORD

@@ -0,0 +1,22 @@
+kacl/__init__.py,sha256=WUM42QzTkxNY6Yd-x-FEqcO2NFfzXkqDhRoAyqME1EE,644
+kacl/__main__.py,sha256=cpulIGoFUJNN5ZW9oUoNN1PnBvrOyJ24xwtpf_yRwgQ,91
+kacl/changes.py,sha256=A0POz-xFMpFuq7nISnx_K75xOZOMmBuHq6EZ8NOQDsU,661
+kacl/config.py,sha256=Glw-1hRqS3AHpZ-2QRGzHRQ-TSLc1xtneb2MEATWFEQ,3966
+kacl/document.py,sha256=dzeYCIgLA1WzK04jeeCW_AYSOCampc9x2cAHdbnEMpY,24737
+kacl/element.py,sha256=OG02QI8ND5fJpBMceT6dbIHr4uX9gLxK_fPCsOvMDHI,416
+kacl/exception.py,sha256=MfOVpUvhcQtm10rSY__74-oLo445PG8mLFGJPPIfXH0,41
+kacl/jira_client.py,sha256=KPE94bZDkJFKw3okFsCgf2DjoyMlUUTMZKtQGKreVQY,989
+kacl/kacl_cli.py,sha256=KeCT4DydkHjckt5sbTtTwp2BQf0RllXpBUwLj-G5-U0,19987
+kacl/link_provider.py,sha256=tgvMYhJe2ErH1m_qXMlQEacq9Cg_KGp_-sF03sVFP6E,1866
+kacl/parser.py,sha256=EUtRjgaW0beWVqiYaRJ9Rcf6jbuGoTgWzVBdOdUHnv8,2587
+kacl/serializer.py,sha256=PdR2FFCh9rbBhkxXwUYD0fSjQqTG_Mb6mYws3lNAWQ8,3090
+kacl/utils.py,sha256=bHiDDmjoYB868Bm732vNjpfML-6xcNQQqS7NQn_Sfm0,2824
+kacl/validation.py,sha256=b9r_5CyY6Cmi9BePh47IgZ3j64zdVsoB_fFvucieNbw,2125
+kacl/version.py,sha256=IDYCWIIXzxdYyMptUAidMgf0SXJqoETFVJ8NVyKgA9A,9526
+kacl/config/kacl-default.yml,sha256=BdrQytOsx32_vXXBtR3VRp1-nzWrczNVc-gHuCGYuIA,1424
+python_kacl-0.6.5.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
+python_kacl-0.6.5.dist-info/METADATA,sha256=kVBx144zCKsmVBAnZS-RQ1omJ2QiPfIME6DtJRz8loE,24325
+python_kacl-0.6.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_kacl-0.6.5.dist-info/entry_points.txt,sha256=rXqqJKfm6Y7fYfioq_7ay2VWOOM9C-hts1IsoGTtojM,76
+python_kacl-0.6.5.dist-info/top_level.txt,sha256=BcmQgo67JyGnVZ3Jc0Ag8hKMGVOqXc8ex01zW4Njw5M,5
+python_kacl-0.6.5.dist-info/RECORD,,

{python_kacl-0.6.3.dist-info → python_kacl-0.6.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{python_kacl-0.6.3.dist-info → python_kacl-0.6.5.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+kacl = kacl.kacl_cli:start
 kacl-cli = kacl.kacl_cli:start

python_kacl-0.6.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+kacl

python_kacl-0.6.3.dist-info/RECORD

@@ -1,26 +0,0 @@
-kacl/__init__.py,sha256=XekPy57r8cGMBo1Kb3tOG9_THW2FkjplUELdl4BBXQ0,644
-kacl/__main__.py,sha256=cpulIGoFUJNN5ZW9oUoNN1PnBvrOyJ24xwtpf_yRwgQ,91
-kacl/changes.py,sha256=A0POz-xFMpFuq7nISnx_K75xOZOMmBuHq6EZ8NOQDsU,661
-kacl/config.py,sha256=Glw-1hRqS3AHpZ-2QRGzHRQ-TSLc1xtneb2MEATWFEQ,3966
-kacl/document.py,sha256=dzeYCIgLA1WzK04jeeCW_AYSOCampc9x2cAHdbnEMpY,24737
-kacl/element.py,sha256=OG02QI8ND5fJpBMceT6dbIHr4uX9gLxK_fPCsOvMDHI,416
-kacl/exception.py,sha256=MfOVpUvhcQtm10rSY__74-oLo445PG8mLFGJPPIfXH0,41
-kacl/jira_client.py,sha256=KPE94bZDkJFKw3okFsCgf2DjoyMlUUTMZKtQGKreVQY,989
-kacl/kacl_cli.py,sha256=fdTVlhjldQGBRhiSG5x9SnnwKTgysLxhqlkjx8BUSK8,19804
-kacl/link_provider.py,sha256=tgvMYhJe2ErH1m_qXMlQEacq9Cg_KGp_-sF03sVFP6E,1866
-kacl/parser.py,sha256=EUtRjgaW0beWVqiYaRJ9Rcf6jbuGoTgWzVBdOdUHnv8,2587
-kacl/serializer.py,sha256=4HU0G6ETbsvf6TbuRdhuNcuWFfifMT6jAEyhtJkAL8s,2734
-kacl/utils.py,sha256=bHiDDmjoYB868Bm732vNjpfML-6xcNQQqS7NQn_Sfm0,2824
-kacl/validation.py,sha256=b9r_5CyY6Cmi9BePh47IgZ3j64zdVsoB_fFvucieNbw,2125
-kacl/version.py,sha256=_yi7OxKOyM17L-G3imjQ2ZBgiVzUoR5rqhhFX2b4faM,9531
-kacl/config/kacl-default.yml,sha256=BdrQytOsx32_vXXBtR3VRp1-nzWrczNVc-gHuCGYuIA,1424
-python_kacl-0.6.3.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
-tests/__init__.py,sha256=dwb12vsojIwrtIgqwjc2fWhEVgVoiedUaVpZ7kusfY0,23
-tests/snapshot_directory.py,sha256=yH_ZpzJG5nA6F1ZxCrFPpbxBBON6bxSYO5OYZqKuzZA,1264
-tests/test_cli.py,sha256=Fc8DA_72cYyjXQm9AfJdAzz89D5zVJGInIxwIBhqrKA,14286
-tests/test_kacl.py,sha256=7hxrBVnj2srkhJGVrfpt651QEItthq-iDntxGnEbt_g,15919
-python_kacl-0.6.3.dist-info/METADATA,sha256=l3MYi-NX0YVCOZjSUJlLx9xITYn6oLkXxtjPWQwGHB8,24325
-python_kacl-0.6.3.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-python_kacl-0.6.3.dist-info/entry_points.txt,sha256=8oCwuEyBEH-Z1M_xZIUePgfM7HfkYUAwcXdTPdrnwt4,49
-python_kacl-0.6.3.dist-info/top_level.txt,sha256=25gO0j-S3j_-DCptjHqVBlJi3tH_tiN8qyympi1E_Ys,11
-python_kacl-0.6.3.dist-info/RECORD,,

python_kacl-0.6.3.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-kacl
-tests

tests/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.51"

tests/snapshot_directory.py

@@ -1,42 +0,0 @@
-import os
-from pathlib import Path
-
-
-def snapshot_directory(
-    snapshot,
-    directory_path,
-    dir_excludes=[".git"],
-    file_excludes=[],
-    sanitize_callbacks={},
-):
-    snapshot_dir = {}
-
-    for root, dirs, files in os.walk(directory_path, topdown=True):
-        dirs[:] = [d for d in dirs if d not in dir_excludes]
-
-        for file in files:
-            if file in file_excludes:
-                continue
-            current = snapshot_dir
-            parts = Path(root).relative_to(directory_path).parts
-            for part in parts:
-                current = current.setdefault(part, {})
-
-            file_path = os.path.join(root, f"{file}")
-            if __is_binary(file_path):
-                content = open(file_path, "rb").read()
-            else:
-                content = open(file_path, "r").read()
-
-            if file in sanitize_callbacks:
-                callback = sanitize_callbacks[file]
-                content = callback(content)
-
-            current[f"{file}.snap"] = content
-
-    snapshot.assert_match_dir(snapshot_dir, "snapshots")
-
-
-def __is_binary(file_path):
-    textchars = bytearray({7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7F})
-    return bool(open(file_path, "rb").read(1024).translate(None, textchars))

tests/test_cli.py

@@ -1,418 +0,0 @@
-import json
-import os
-import shutil
-
-import pytest
-from click.testing import CliRunner
-from freezegun import freeze_time
-
-from kacl.kacl_cli import cli
-from tests.snapshot_directory import snapshot_directory
-
-
-def test_verify():
-    runner = CliRunner()
-    result = runner.invoke(cli, ["-f", "tests/data/CHANGELOG.md", "verify"])
-    assert result.exit_code == 0
-    assert result.output == "Success\n"
-
-    result = runner.invoke(cli, ["-f", "tests/data/CHANGELOG_invalid.md", "verify"])
-    assert result.exit_code == 10  # spawns 8 errors
-
-
-def test_verify_invalid_duplicates():
-    runner = CliRunner()
-    result = runner.invoke(
-        cli, ["-f", "tests/data/CHANGELOG_invalid_duplicates.md", "verify"]
-    )
-    assert result.exit_code == 2
-
-
-def test_verify_with_json_output():
-    runner = CliRunner()
-    result = runner.invoke(
-        cli, ["-f", "tests/data/CHANGELOG_invalid.md", "verify", "--json"]
-    )
-    validation_result = json.loads(result.output)
-
-    assert len(validation_result["errors"]) == 10
-    assert validation_result["valid"] is False
-
-
-def test_current(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path):
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                changelog_file,
-                "current",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        assert result.output == "1.0.0\n"
-
-
-def test_next(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path):
-        result = runner.invoke(
-            cli,
-            ["-f", changelog_file, "next", "patch"],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        assert result.output == "1.0.1\n"
-
-
-@freeze_time("2023-01-01")
-def test_release_patch(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "patch",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_release_post_bump(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-c",
-                os.path.join(resources_dir, "extension-config.yml"),
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "post",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_release_post_manual(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-c",
-                os.path.join(resources_dir, "extension-config.yml"),
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "2.0.0-hotfix.0",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_release_post_manual_fail(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-c",
-                os.path.join(resources_dir, "extension-config.yml"),
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "0.5.0-hotfix.0",
-                "-m",
-            ],
-            catch_exceptions=True,
-        )
-        assert result.exit_code == 1, result.output
-
-
-@freeze_time("2023-01-01")
-def test_release_version_manual_fail_same_base_after_post(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_post_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-c",
-                os.path.join(resources_dir, "extension-config.yml"),
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "1.0.0",
-                "-m",
-            ],
-            catch_exceptions=True,
-        )
-        assert result.exit_code == 1, result.output
-
-
-@freeze_time("2023-01-01")
-def test_release_post_manual_same_base(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-c",
-                os.path.join(resources_dir, "extension-config.yml"),
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "1.0.0-post.0",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-
-
-@freeze_time("2023-01-01")
-def test_release_minor(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "minor",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_release_major(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "major",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_release_custom(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "release",
-                "2.1.1",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@freeze_time("2023-01-01")
-def test_add_change_security(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "add",
-                "Security",
-                "Important Security Change",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-def test_config(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-
-    result = runner.invoke(
-        cli,
-        [
-            "-c",
-            os.path.join(resources_dir, "config.yml"),
-            "-f",
-            "CHANGELOG.md",
-            "verify",
-        ],
-        catch_exceptions=False,
-    )
-    assert result.exit_code != 0, result.output
-
-
-@freeze_time("2023-01-01")
-def test_squash(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_keepachangelog.com.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "squash",
-                "--from-version",
-                "0.0.1",
-                "--to-version",
-                "0.3.0",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-def test_squash_current(tmp_path, snapshot):
-    runner = CliRunner()
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_keepachangelog.com.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "squash",
-                "--from-version",
-                "0.0.1",
-                "-m",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output
-        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
-
-
-@pytest.mark.skip(reason="No issue tracker openly available, test locally.")
-def test_add_comments(tmp_path):
-    runner = CliRunner()
-    root_dir = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "..",
-    )
-    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
-    changelog_file = os.path.join(resources_dir, "CHANGELOG_issue_management.md")
-
-    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
-        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
-        shutil.copytree(
-            os.path.join(root_dir, ".git"), os.path.join(project_root_path, ".git")
-        )
-        result = runner.invoke(
-            cli,
-            [
-                "-f",
-                "CHANGELOG.md",
-                "add-comments",
-                "1.0.0",
-                "--jira-username",
-                os.getenv("JIRA_USERNAME"),
-                "--jira-password",
-                os.getenv("JIRA_PASSWORD"),
-                "--jira-host",
-                os.getenv("JIRA_HOST"),
-                "--jira-issue-pattern",
-                "JIRA-[0-9]+",
-                "--jira-issue-pattern",
-                "MYJIRA-[0-9]+",
-                "--jira-issue-pattern",
-                "[A-Z]+-[0-9]+",
-            ],
-            catch_exceptions=False,
-        )
-        assert result.exit_code == 0, result.output

tests/test_kacl.py

@@ -1,479 +0,0 @@
-import os
-from unittest import TestCase
-
-import pytest
-import yaml
-
-import kacl
-from kacl.config import KACLConfig
-from kacl.exception import KACLException
-from tests.snapshot_directory import snapshot_directory
-
-
-class TestKacl(TestCase):
-    def test_load_valid(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-
-        self.assertEqual(changelog.title(), "Changelog")
-        self.assertGreater(len(changelog.versions()), 0)
-
-        version = changelog.get("1.0.0")
-        self.assertIsNotNone(version)
-
-        added_changes = version.changes("Added")
-        self.assertIsNotNone(added_changes)
-
-        added_items = added_changes.items()
-        self.assertIsNotNone(added_items)
-
-    def test_dump(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-        changelog_dump = kacl.dump(changelog)
-        self.assertIsNotNone(changelog_dump)
-
-        with open(changelog_file, "r") as reference_file:
-            changelog_reference = reference_file.read()
-        reference_file.close()
-
-        changelog_dump_lines = changelog_dump.split("\n")
-        changelog_reference_lines = changelog_reference.split("\n")
-
-        self.assertEqual(len(changelog_dump_lines), len(changelog_reference_lines))
-        self.assertEqual(changelog_dump, changelog_reference)
-
-    def test_add_change(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-
-        changelog = kacl.load(changelog_file)
-
-        msg = "This is my first added change"
-        changelog.add("Added", msg)
-
-        changelog_dump = kacl.dump(changelog)
-        self.assertIsNotNone(changelog_dump)
-
-        changelog_changed = kacl.parse(changelog_dump)
-        self.assertIsNotNone(changelog_changed)
-
-        unreleased = changelog_changed.get("Unreleased")
-        self.assertIsNotNone(unreleased)
-
-        unreleased_change_sections = unreleased.sections()
-        self.assertIsNotNone(unreleased_change_sections)
-        self.assertIn("Added", unreleased_change_sections)
-
-        unreleased_changes_added = unreleased.changes("Added")
-        self.assertIsNotNone(unreleased_changes_added)
-
-        self.assertIn(msg, unreleased_changes_added.items())
-
-    def test_release(self):
-        valid_files = ["CHANGELOG.md", "CHANGELOG_unrelease_only.md"]
-
-        for filename in valid_files:
-            changelog_file = os.path.join(
-                os.path.dirname(os.path.realpath(__file__)), "data", filename
-            )
-            changelog = kacl.load(changelog_file)
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-
-            changelog.release(version="2.0.0", link="https://my-new-version/2.0.0.html")
-
-            changelog_dump = kacl.dump(changelog)
-            self.assertIsNotNone(changelog_dump)
-
-            changelog_changed = kacl.parse(changelog_dump)
-            self.assertIsNotNone(changelog_changed)
-
-            version = changelog_changed.get("2.0.0")
-            self.assertIsNotNone(version)
-
-            self.assertIn(msg, version.changes("Added").items())
-
-    def test_invalid(self):
-        invalid_files = [
-            "CHANGELOG_invalid.md",
-            "CHANGELOG_missing_sections.md",
-            "CHANGELOG_no_unreleased.md",
-        ]
-
-        for filename in invalid_files:
-            changelog_file = os.path.join(
-                os.path.dirname(os.path.realpath(__file__)), "data", filename
-            )
-            changelog = kacl.load(changelog_file)
-            self.assertFalse(changelog.is_valid())
-
-    def test_valid(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-        self.assertTrue(changelog.is_valid())
-
-        validation = changelog.validate()
-        self.assertGreaterEqual(len(validation.errors()), 0)
-
-    def test_valid_keepachangelogcom(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)),
-            "data/CHANGELOG_keepachangelog.com.md",
-        )
-        changelog = kacl.load(changelog_file)
-        self.assertTrue(changelog.is_valid())
-
-        validation = changelog.validate()
-        self.assertGreaterEqual(len(validation.errors()), 0)
-
-    def test_valid_project_changelog(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.dirname(os.path.realpath(__file__))), "CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-        self.assertTrue(changelog.is_valid())
-
-        validation = changelog.validate()
-        self.assertGreaterEqual(len(validation.errors()), 0)
-
-    def test_load_empty(self):
-        changelog = kacl.parse("")
-        self.assertFalse(changelog.is_valid())
-
-    def test_release_without_changes(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)),
-            "data/CHANGELOG_no_unreleased.md",
-        )
-        changelog = kacl.load(changelog_file)
-
-        self.assertFalse(changelog.has_changes())
-        self.assertRaises(
-            Exception,
-            changelog.release,
-            "1.1.1",
-            "https://gitlab.com/schmieder.matthias/python-kacl.git/-/compare/v1.0.0...HEAD",
-        )
-
-    def test_release_existing_version(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-
-        msg = "This is my first added change"
-        changelog.add("Added", msg)
-
-        self.assertTrue(changelog.has_changes())
-        self.assertRaises(
-            Exception,
-            changelog.release,
-            "1.0.0",
-            "https://gitlab.com/schmieder.matthias/python-kacl.git/-/compare/v1.0.0...HEAD",
-        )
-
-    def test_release_without_older_version(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-
-        msg = "This is my first added change"
-        changelog.add("Added", msg)
-
-        self.assertTrue(changelog.has_changes())
-        self.assertRaises(
-            Exception,
-            changelog.release,
-            "0.9.0",
-            "https://gitlab.com/schmieder.matthias/python-kacl.git/-/compare/v1.0.0...HEAD",
-        )
-
-    def test_release_with_non_semver(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-        changelog = kacl.load(changelog_file)
-
-        msg = "This is my first added change"
-        changelog.add("Added", msg)
-
-        self.assertTrue(changelog.has_changes())
-        self.assertRaises(
-            Exception,
-            changelog.release,
-            "a0.9.0",
-            "https://gitlab.com/schmieder.matthias/python-kacl.git/-/compare/v1.0.0...HEAD",
-        )
-
-    def test_release_with_allow_no_changes_flag(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)),
-            "data/CHANGELOG_without_changes.md",
-        )
-        changelog = kacl.load(changelog_file)
-
-        self.assertFalse(changelog.has_changes())
-        changelog.release("1.0.1", allow_no_changes=True)
-        self.assertEqual("1.0.1", changelog.current_version())
-
-    def test_release_with_increment(self):
-        tests = {
-            "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-        }
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-
-        for increment, expected_version in tests.items():
-            changelog = kacl.load(changelog_file)
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-            changelog.release(increment=increment)
-            self.assertEqual(expected_version, changelog.current_version())
-
-        fail_tests = {"post": "1.0.0-post.1"}
-
-        for increment, expected_version in fail_tests.items():
-            changelog = kacl.load(changelog_file)
-            changelog.config.post_release_version_prefix = None
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-            self.assertRaises(KACLException, changelog.release, increment=increment)
-
-    def test_release_with_increment_extension(self):
-        tests = {
-            "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-            "post": "1.0.0-post.1",
-        }
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-
-        for increment, expected_version in tests.items():
-            changelog = kacl.load(changelog_file)
-            changelog.config.post_release_version_prefix = "post"
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-            changelog.release(increment=increment)
-            self.assertEqual(expected_version, changelog.current_version())
-
-    def test_release_with_increment_extension_hotfix(self):
-        tests = {
-            "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-            "post": "1.0.0-hotfix.1",
-        }
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
-        )
-
-        for increment, expected_version in tests.items():
-            changelog = kacl.load(changelog_file)
-            changelog.config.post_release_version_prefix = "hotfix"
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-            changelog.release(increment=increment)
-            self.assertEqual(expected_version, changelog.current_version())
-
-    def test_post_release_with_increment(self):
-        tests = {
-            "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-            "post": "1.0.0-post.2",
-        }
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG_post.md"
-        )
-
-        for increment, expected_version in tests.items():
-            changelog = kacl.load(changelog_file)
-            changelog.config.post_release_version_prefix = "post"
-
-            msg = "This is my first added change"
-            changelog.add("Added", msg)
-
-            self.assertTrue(changelog.has_changes())
-            changelog.release(increment=increment)
-            self.assertEqual(expected_version, changelog.current_version())
-
-    def test_unreleased_missing_sections(self):
-        changelog_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)),
-            "data/CHANGELOG_missing_sections.md",
-        )
-
-        changelog = kacl.load(changelog_file)
-        changelog.validate()
-        self.assertFalse(changelog.is_valid())
-
-    def test_config(self):
-        config_file = os.path.join(
-            os.path.dirname(os.path.realpath(__file__)), "data/config.yml"
-        )
-        kacl_config = KACLConfig(config_file=config_file)
-
-        default_config = dict()
-        with open("kacl/config/kacl-default.yml", "r") as f:
-            default_config = yaml.safe_load(f)["kacl"]
-
-        # changes in config_file
-        # changelog_file: CHANGELOG.md
-        # allowed_header_titles:
-        #   - ChangeLog
-        # allowed_version_sections:
-        #   - Security
-        # git:
-        #   commit: False
-
-        self.assertNotEqual(
-            kacl_config.allowed_header_titles, default_config["allowed_header_titles"]
-        )
-        self.assertEqual(kacl_config.allowed_header_titles, ["ChangeLog"])
-
-        self.assertNotEqual(
-            kacl_config.allowed_version_sections,
-            default_config["allowed_version_sections"],
-        )
-        self.assertEqual(kacl_config.allowed_version_sections, ["Security"])
-
-        self.assertNotEqual(
-            kacl_config.git_create_commit, default_config["git"]["commit"]
-        )
-        self.assertEqual(kacl_config.git_create_commit, True)
-
-    def test_link_generation(self):
-        valid_files = ["CHANGELOG_unrelease_only.md"]
-
-        for filename in valid_files:
-            changelog_file = os.path.join(
-                os.path.dirname(os.path.realpath(__file__)), "data", filename
-            )
-            changelog = kacl.load(changelog_file)
-
-            changelog = kacl.load(changelog_file)
-            changelog.generate_links()
-
-            versions = changelog.versions()
-            for v in versions:
-                self.assertIsNotNone(v.link())
-
-
-def test_squash(tmp_path, snapshot):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_keepachangelog.com.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    validation = changelog.validate()
-    assert len(validation.errors()) < 1
-
-    changelog.squash(version_start="0.0.1", version_end="0.3.0", keep_version_info=True)
-
-    squashed_changelog_file = os.path.join(tmp_path, "CHANGELOG.md")
-    # Open the file for writing.
-    with open(squashed_changelog_file, "w") as f:
-        f.write(kacl.dump(changelog))
-
-    snapshot_directory(snapshot=snapshot, directory_path=tmp_path)
-
-
-@pytest.mark.skip(reason="No issue tracker openly available, test locally.")
-def test_issue_tracker_comment(tmp_path):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_issue_management.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    changelog.add_comments(version=changelog.current_version())
-
-
-def test_render_comments(tmp_path):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_issue_management.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    rendered_comments = changelog.render_comments(version=changelog.current_version())
-
-    assert "jira" in rendered_comments
-
-
-def test_get_issues(tmp_path):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_issue_management.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    issues = changelog.get_associated_issues(version=changelog.current_version())
-    assert len(issues["jira"]) == 5
-
-
-def test_simple_metadata(tmp_path):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_with_simple_metadata.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    changelog.release(increment="major")
-
-    content = kacl.dump(changelog)
-
-    assert "---\ntitle: CHANGELOG\n---\n" in str(content)
-
-
-def test_complex_metadata(tmp_path):
-    changelog_file = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)),
-        "data/CHANGELOG_with_complex_metadata.md",
-    )
-    changelog = kacl.load(changelog_file)
-    assert changelog.is_valid()
-
-    changelog.release(increment="major")
-
-    content = kacl.dump(changelog)
-
-    assert (
-        "---\nlist:\n- entry1\n- additional: true\n  key: value\ntitle: CHANGELOG\n---\n"
-        in str(content)
-    )