Add dependency updates to changelog

Author: ArBridgeman

exasol/toolbox/nox/_release.py

@@ -119,7 +119,9 @@ def prepare_release(session: Session) -> None:
     _ = _update_project_version(session, new_version)
 
     changelogs = Changelogs(
-        changes_path=PROJECT_CONFIG.doc / "changes", version=new_version
+        changes_path=PROJECT_CONFIG.doc / "changes",
+        source_path=PROJECT_CONFIG.root,
+        version=new_version,
     )
     changelogs.update_changelogs_for_release()
     changed_files = changelogs.get_changed_files()

exasol/toolbox/util/dependencies/poetry_dependencies.py

@@ -2,6 +2,7 @@
 
 import subprocess
 import tempfile
+from collections import OrderedDict
 from pathlib import Path
 from typing import Optional
 
@@ -105,8 +106,10 @@ def _extract_from_poetry_show(
         }
 
     @property
-    def direct_dependencies(self) -> dict[str, dict[NormalizedPackageStr, Package]]:
-        dependencies = {}
+    def direct_dependencies(
+        self,
+    ) -> OrderedDict[str, dict[NormalizedPackageStr, Package]]:
+        dependencies = OrderedDict()
         for group in self.groups:
             command = (
                 "poetry",
@@ -127,7 +130,7 @@ def direct_dependencies(self) -> dict[str, dict[NormalizedPackageStr, Package]]:
         return dependencies
 
     @property
-    def all_dependencies(self) -> dict[str, dict[NormalizedPackageStr, Package]]:
+    def all_dependencies(self) -> OrderedDict[str, dict[NormalizedPackageStr, Package]]:
         command = ("poetry", "show", "--no-truncate")
         output = subprocess.run(
             command,

exasol/toolbox/util/release/changelog.py

@@ -2,42 +2,48 @@
 
 from datetime import datetime
 from inspect import cleandoc
+from itertools import chain
 from pathlib import Path
 
+from exasol.toolbox.util.dependencies.poetry_dependencies import (
+    get_dependencies,
+    get_dependencies_from_latest_tag,
+)
+from exasol.toolbox.util.dependencies.track_changes import DependencyChanges
 from exasol.toolbox.util.version import Version
 
 UNRELEASED_INITIAL_CONTENT = "# Unreleased\n"
 
 
 class Changelogs:
-    def __init__(self, changes_path: Path, version: Version) -> None:
+    def __init__(self, changes_path: Path, source_path: Path, version: Version) -> None:
         self.version = version
         self.unreleased_md: Path = changes_path / "unreleased.md"
         self.versioned_changelog_md: Path = changes_path / f"changes_{version}.md"
         self.changelog_md: Path = changes_path / "changelog.md"
+        self.source_path: Path = source_path
 
     def _create_new_unreleased(self):
         """
         Write a new unreleased changelog file.
         """
         self.unreleased_md.write_text(UNRELEASED_INITIAL_CONTENT)
 
-    def _create_versioned_changelog(self, content: str) -> None:
+    def _create_versioned_changelog(self, unreleased_content: str) -> None:
         """
         Create a changelog entry for a specific version.
 
         Args:
-            content: The content of the changelog entry.
+            unreleased_content: The content of the changelog entry.
 
         """
-        template = cleandoc(
-            f"""
-            # {self.version} - {datetime.today().strftime("%Y-%m-%d")}
+        template = f"# {self.version} - {datetime.today().strftime('%Y-%m-%d')}"
+        template += f"\n{unreleased_content}"
 
-            {content}
-            """
-        )
-        self.versioned_changelog_md.write_text(template)
+        if dependency_content := self._prepare_dependency_update():
+            template += f"\n## Dependency Updates\n{dependency_content}"
+
+        self.versioned_changelog_md.write_text(cleandoc(template))
 
     def _extract_unreleased_notes(self) -> str:
         """
@@ -50,6 +56,36 @@ def _extract_unreleased_notes(self) -> str:
         unreleased_content += "\n"
         return unreleased_content
 
+    def _prepare_dependency_update(self) -> str:
+        old_dependencies_in_groups = get_dependencies_from_latest_tag()
+        current_dependencies_in_groups = get_dependencies(
+            working_directory=self.source_path
+        )
+
+        content = ""
+        # preserve order of keys from old group
+        groups = list(
+            dict.fromkeys(
+                chain(
+                    old_dependencies_in_groups.keys(),
+                    current_dependencies_in_groups.keys(),
+                )
+            )
+        )
+        for group in groups:
+            old_dependencies = old_dependencies_in_groups.get(group, {})
+            current_dependencies = current_dependencies_in_groups.get(group, {})
+            changes = DependencyChanges(
+                old_dependencies=old_dependencies,
+                current_dependencies=current_dependencies,
+            ).changes
+            if changes:
+                # nicer group heading
+                content += f"\n### `{group}`\n"
+                content += "\n".join(str(change) for change in changes)
+                content += "\n"
+        return content
+
     def _update_changelog_table_of_contents(self) -> None:
         """
         Read in existing `changelog.md` and append to appropriate sections

test/unit/util/conftest.py

@@ -0,0 +1,31 @@
+from collections import OrderedDict
+
+import pytest
+
+from exasol.toolbox.util.dependencies.poetry_dependencies import PoetryGroup
+from exasol.toolbox.util.dependencies.shared_models import Package
+
+
+@pytest.fixture(scope="module")
+def main_group():
+    return PoetryGroup(name="main", toml_section="project.dependencies")
+
+
+@pytest.fixture(scope="module")
+def dev_group():
+    return PoetryGroup(name="dev", toml_section="tool.poetry.group.dev.dependencies")
+
+
+@pytest.fixture(scope="module")
+def old_dependencies(main_group, dev_group):
+    deps = OrderedDict()
+    deps[main_group.name] = {"package1": Package(name="package1", version="0.0.1")}
+    return deps
+
+
+@pytest.fixture(scope="module")
+def dependencies(main_group, dev_group):
+    deps = OrderedDict()
+    deps[main_group.name] = {"package1": Package(name="package1", version="0.1.0")}
+    deps[dev_group.name] = {"package2": Package(name="package2", version="0.2.0")}
+    return deps

test/unit/util/dependencies/licenses_test.py

@@ -9,13 +9,6 @@
     _normalize,
     _packages_from_json,
 )
-from exasol.toolbox.util.dependencies.poetry_dependencies import PoetryGroup
-from exasol.toolbox.util.dependencies.shared_models import (
-    Package,
-)
-
-MAIN_GROUP = PoetryGroup(name="main", toml_section="project.dependencies")
-DEV_GROUP = PoetryGroup(name="dev", toml_section="tool.poetry.group.dev.dependencies")
 
 
 class TestPackageLicense:
@@ -101,15 +94,7 @@ def test_packages_from_json():
     }
 
 
-@pytest.fixture(scope="class")
-def dependencies():
-    return {
-        MAIN_GROUP.name: {"package1": Package(name="package1", version="0.1.0")},
-        DEV_GROUP.name: {"package2": Package(name="package2", version="0.2.0")},
-    }
-
-
-@pytest.fixture(scope="class")
+@pytest.fixture(scope="module")
 def package_license_report(dependencies):
     licenses = {
         "package1": PackageLicense(
@@ -131,9 +116,9 @@ def package_license_report(dependencies):
 
 class TestPackageLicenseReport:
     @staticmethod
-    def test_format_group_table_header(package_license_report):
+    def test_format_group_table_header(package_license_report, main_group):
         result = package_license_report._format_group_table_header(
-            group=MAIN_GROUP.name
+            group=main_group.name
         )
 
         assert (
@@ -142,11 +127,11 @@ def test_format_group_table_header(package_license_report):
         )
 
     @staticmethod
-    def test_format_group_table(package_license_report, dependencies):
-        group_package_names = set(dependencies[MAIN_GROUP.name].keys())
+    def test_format_group_table(package_license_report, dependencies, main_group):
+        group_package_names = set(dependencies[main_group.name].keys())
 
         result = package_license_report._format_group_table(
-            group=MAIN_GROUP.name, group_package_names=group_package_names
+            group=main_group.name, group_package_names=group_package_names
         )
 
         assert result == (

test/unit/util/release/changelog_test.py

@@ -1,4 +1,5 @@
 from inspect import cleandoc
+from unittest import mock
 
 import pytest
 
@@ -70,9 +71,35 @@ def unreleased_md(changelogs):
     )
 
 
+@pytest.fixture(scope="function")
+def mock_dependencies(dependencies, old_dependencies):
+    with mock.patch.multiple(
+        "exasol.toolbox.util.release.changelog",
+        get_dependencies_from_latest_tag=lambda: old_dependencies,
+        get_dependencies=lambda working_directory: dependencies,
+    ):
+        yield
+
+
+@pytest.fixture(scope="function")
+def mock_no_dependencies():
+    with mock.patch.multiple(
+        "exasol.toolbox.util.release.changelog",
+        get_dependencies_from_latest_tag=lambda: {},
+        get_dependencies=lambda working_directory: {},
+    ):
+        yield
+
+
 @pytest.fixture(scope="function")
 def changelogs(tmp_path) -> Changelogs:
-    return Changelogs(changes_path=tmp_path, version=Version(major=1, minor=0, patch=0))
+    changes_path = tmp_path / "doc/changes"
+    changes_path.mkdir(parents=True)
+    return Changelogs(
+        changes_path=changes_path,
+        source_path=tmp_path,
+        version=Version(major=1, minor=0, patch=0),
+    )
 
 
 class TestChangelogs:
@@ -90,7 +117,7 @@ def test_create_new_unreleased(changelogs):
         assert changelogs.unreleased_md.read_text() == UNRELEASED_INITIAL_CONTENT
 
     @staticmethod
-    def test_create_versioned_changelog(changelogs):
+    def test_create_versioned_changelog(changelogs, mock_dependencies):
         changelogs._create_versioned_changelog(SampleContent.changelog)
         saved_text = changelogs.versioned_changelog_md.read_text()
 
@@ -103,14 +130,28 @@ def test_extract_unreleased_notes(changelogs, unreleased_md):
 
         assert result == SampleContent.changelog + "\n"
 
+    @staticmethod
+    def test_prepare_dependency_update(changelogs, mock_dependencies):
+        result = changelogs._prepare_dependency_update()
+        assert result == (
+            "\n"
+            "### `main`\n"
+            "* Updated dependency `package1:0.0.1` to `0.1.0`\n"
+            "\n"
+            "### `dev`\n"
+            "* Added dependency `package2:0.2.0`\n"
+        )
+
     @staticmethod
     def test_update_changelog_table_of_contents(changelogs, changes_md):
         changelogs._update_changelog_table_of_contents()
 
         assert changelogs.changelog_md.read_text() == SampleContent.altered_changes
 
     @staticmethod
-    def test_update_changelogs_for_release(changelogs, unreleased_md, changes_md):
+    def test_update_changelogs_for_release(
+        changelogs, mock_dependencies, unreleased_md, changes_md
+    ):
         changelogs.update_changelogs_for_release()
 
         # changes.md
@@ -119,5 +160,48 @@ def test_update_changelogs_for_release(changelogs, unreleased_md, changes_md):
         assert changelogs.unreleased_md.read_text() == UNRELEASED_INITIAL_CONTENT
         # versioned.md
         saved_text = changelogs.versioned_changelog_md.read_text()
-        assert "1.0.0" in saved_text
-        assert SampleContent.changelog in saved_text
+        assert saved_text == cleandoc(
+            """# 1.0.0 - 2025-07-24
+            ## Added
+            * Added Awesome feature
+
+            ## Changed
+            * Some behaviour
+
+            ## Fixed
+            * Fixed nasty bug
+
+            ## Dependency Updates
+
+            ### `main`
+            * Updated dependency `package1:0.0.1` to `0.1.0`
+
+            ### `dev`
+            * Added dependency `package2:0.2.0`
+        """
+        )
+
+    @staticmethod
+    def test_update_changelogs_for_release_with_no_dependencies(
+        changelogs, mock_no_dependencies, unreleased_md, changes_md
+    ):
+        changelogs.update_changelogs_for_release()
+
+        # changes.md
+        assert changelogs.changelog_md.read_text() == SampleContent.altered_changes
+        # unreleased.md
+        assert changelogs.unreleased_md.read_text() == UNRELEASED_INITIAL_CONTENT
+        # versioned.md
+        saved_text = changelogs.versioned_changelog_md.read_text()
+        assert saved_text == cleandoc(
+            """# 1.0.0 - 2025-07-24
+            ## Added
+            * Added Awesome feature
+
+            ## Changed
+            * Some behaviour
+
+            ## Fixed
+            * Fixed nasty bug
+        """
+        )