Add changelog command group to azpysdk CLI wrapping Chronus

Adds `azpysdk changelog {add,verify,create,status}` subcommands that
delegate to `npx chronus` at the repository root, enabling developers
to manage changelogs without leaving the azpysdk CLI.

Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-python/sessions/a188ee1e-f36a-4ca9-be34-654196dd5328

Co-authored-by: l0lawrence <100643745+l0lawrence@users.noreply.github.com>

Author: Copilot

eng/tools/azure-sdk-tools/azpysdk/changelog.py

@@ -0,0 +1,124 @@
+import argparse
+import os
+import shutil
+import subprocess
+from typing import Optional, List
+
+from .Check import Check, REPO_ROOT
+from ci_tools.logging import logger
+
+
+class changelog(Check):
+    """Manage changelogs with Chronus.
+
+    Wraps Chronus CLI commands (add, verify, create, status) so they can be
+    invoked through the ``azpysdk`` CLI.  Unlike most checks that operate on
+    individual packages, changelog commands run at the **repository root**
+    level via ``npx chronus``.
+    """
+
+    def __init__(self) -> None:
+        super().__init__()
+
+    def register(
+        self, subparsers: "argparse._SubParsersAction", parent_parsers: Optional[List[argparse.ArgumentParser]] = None
+    ) -> None:
+        """Register the ``changelog`` command group.
+
+        The *parent_parsers* (common args like ``target``, ``--isolate``) are
+        intentionally **not** used here because changelog commands operate at
+        the repository level via Chronus, not on individual packages.
+        """
+        p = subparsers.add_parser(
+            "changelog",
+            help="Manage changelogs with Chronus (add, verify, create, status)",
+        )
+
+        changelog_sub = p.add_subparsers(title="changelog commands", dest="changelog_command")
+
+        # changelog add
+        add_p = changelog_sub.add_parser("add", help="Add a chronus change entry for modified packages")
+        add_p.add_argument(
+            "package",
+            nargs="?",
+            default=None,
+            help=(
+                "Package path (e.g. sdk/storage/azure-storage-blob) to add an entry for. "
+                "If omitted, chronus detects modified packages interactively."
+            ),
+        )
+        add_p.set_defaults(func=self._run_add)
+
+        # changelog verify
+        verify_p = changelog_sub.add_parser("verify", help="Verify all modified packages have change entries")
+        verify_p.set_defaults(func=self._run_verify)
+
+        # changelog create
+        create_p = changelog_sub.add_parser(
+            "create", help="Generate CHANGELOG.md from pending chronus entries"
+        )
+        create_p.set_defaults(func=self._run_create)
+
+        # changelog status
+        status_p = changelog_sub.add_parser(
+            "status", help="Show a summary of pending changes and resulting version bumps"
+        )
+        status_p.set_defaults(func=self._run_status)
+
+        # Default behaviour when no subcommand is given
+        p.set_defaults(func=self._no_subcommand, _changelog_parser=p)
+
+    # ------------------------------------------------------------------
+    # Internal helpers
+    # ------------------------------------------------------------------
+
+    def _no_subcommand(self, args: argparse.Namespace) -> int:
+        """Print help when no changelog subcommand is provided."""
+        args._changelog_parser.print_help()
+        return 1
+
+    def _get_npx(self) -> str:
+        """Locate the ``npx`` executable on *PATH*."""
+        npx = shutil.which("npx")
+        if not npx:
+            logger.error(
+                "npx is not installed. Chronus requires Node.js. "
+                "Please install Node.js (LTS) from https://nodejs.org/ and try again."
+            )
+            raise FileNotFoundError("npx not found on PATH")
+        return npx
+
+    def _run_chronus(self, chronus_args: List[str]) -> int:
+        """Run a chronus command via ``npx`` from the repository root.
+
+        stdin/stdout/stderr are inherited so that interactive prompts
+        (e.g. ``chronus add``) work transparently.
+        """
+        npx = self._get_npx()
+        cmd = [npx, "chronus"] + chronus_args
+        logger.info(f"Running: {' '.join(cmd)}")
+        return subprocess.call(cmd, cwd=REPO_ROOT)
+
+    # ------------------------------------------------------------------
+    # Subcommand handlers
+    # ------------------------------------------------------------------
+
+    def _run_add(self, args: argparse.Namespace) -> int:
+        """Run ``chronus add`` to interactively add a change entry."""
+        chronus_args = ["add"]
+        package = getattr(args, "package", None)
+        if package:
+            chronus_args.append(package)
+        return self._run_chronus(chronus_args)
+
+    def _run_verify(self, args: argparse.Namespace) -> int:
+        """Run ``chronus verify`` to check for missing change entries."""
+        return self._run_chronus(["verify"])
+
+    def _run_create(self, args: argparse.Namespace) -> int:
+        """Run ``chronus changelog`` to generate CHANGELOG.md files."""
+        return self._run_chronus(["changelog"])
+
+    def _run_status(self, args: argparse.Namespace) -> int:
+        """Run ``chronus status`` to show pending changes."""
+        return self._run_chronus(["status"])

eng/tools/azure-sdk-tools/azpysdk/main.py

@@ -41,6 +41,7 @@
 from .devtest import devtest
 from .optional import optional
 from .update_snippet import update_snippet
+from .changelog import changelog
 
 from ci_tools.logging import configure_logging, logger
 
@@ -117,6 +118,7 @@ def build_parser() -> argparse.ArgumentParser:
     devtest().register(subparsers, [common])
     optional().register(subparsers, [common])
     update_snippet().register(subparsers, [common])
+    changelog().register(subparsers, [common])
 
     return parser
 

eng/tools/azure-sdk-tools/tests/test_changelog_commands.py

@@ -0,0 +1,160 @@
+"""Tests for the ``azpysdk changelog`` command group."""
+
+import argparse
+from unittest.mock import patch, MagicMock
+
+import pytest
+
+from azpysdk.changelog import changelog
+
+
+# ---------------------------------------------------------------------------
+# Helper – build a minimal parser that includes the changelog subcommands
+# ---------------------------------------------------------------------------
+
+def _build_parser():
+    parser = argparse.ArgumentParser(prog="azpysdk")
+    subparsers = parser.add_subparsers(title="commands", dest="command")
+    changelog().register(subparsers)
+    return parser
+
+
+# ---------------------------------------------------------------------------
+# Parser / registration tests
+# ---------------------------------------------------------------------------
+
+
+class TestChangelogRegistration:
+    """Verify that the changelog command is registered correctly."""
+
+    def test_changelog_subcommand_exists(self):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "verify"])
+        assert args.command == "changelog"
+        assert args.changelog_command == "verify"
+
+    def test_changelog_add_without_package(self):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "add"])
+        assert args.changelog_command == "add"
+        assert args.package is None
+
+    def test_changelog_add_with_package(self):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "add", "sdk/storage/azure-storage-blob"])
+        assert args.changelog_command == "add"
+        assert args.package == "sdk/storage/azure-storage-blob"
+
+    def test_changelog_create(self):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "create"])
+        assert args.changelog_command == "create"
+
+    def test_changelog_status(self):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "status"])
+        assert args.changelog_command == "status"
+
+    def test_changelog_no_subcommand_prints_help(self):
+        """When no subcommand is given, the handler should print help and return 1."""
+        parser = _build_parser()
+        args = parser.parse_args(["changelog"])
+        assert hasattr(args, "func")
+        # func should be the _no_subcommand method
+        result = args.func(args)
+        assert result == 1
+
+
+# ---------------------------------------------------------------------------
+# Execution tests (npx / chronus invocation)
+# ---------------------------------------------------------------------------
+
+
+class TestChangelogExecution:
+    """Verify that each subcommand invokes chronus with the right arguments."""
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_add_calls_chronus_add(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "add"])
+        result = args.func(args)
+        assert result == 0
+        mock_call.assert_called_once()
+        cmd = mock_call.call_args[0][0]
+        assert cmd == ["/usr/bin/npx", "chronus", "add"]
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_add_with_package_passes_package(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "add", "sdk/core/azure-core"])
+        result = args.func(args)
+        assert result == 0
+        cmd = mock_call.call_args[0][0]
+        assert cmd == ["/usr/bin/npx", "chronus", "add", "sdk/core/azure-core"]
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_verify_calls_chronus_verify(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "verify"])
+        result = args.func(args)
+        assert result == 0
+        cmd = mock_call.call_args[0][0]
+        assert cmd == ["/usr/bin/npx", "chronus", "verify"]
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_create_calls_chronus_changelog(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "create"])
+        result = args.func(args)
+        assert result == 0
+        cmd = mock_call.call_args[0][0]
+        assert cmd == ["/usr/bin/npx", "chronus", "changelog"]
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_status_calls_chronus_status(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "status"])
+        result = args.func(args)
+        assert result == 0
+        cmd = mock_call.call_args[0][0]
+        assert cmd == ["/usr/bin/npx", "chronus", "status"]
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=0)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_chronus_runs_from_repo_root(self, mock_which, mock_call):
+        """Chronus must run from the repository root directory."""
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "verify"])
+        args.func(args)
+        _, kwargs = mock_call.call_args
+        from azpysdk.changelog import REPO_ROOT
+        assert kwargs["cwd"] == REPO_ROOT
+
+    @patch("azpysdk.changelog.subprocess.call", return_value=1)
+    @patch("azpysdk.changelog.shutil.which", return_value="/usr/bin/npx")
+    def test_nonzero_exit_code_propagated(self, mock_which, mock_call):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "verify"])
+        result = args.func(args)
+        assert result == 1
+
+
+# ---------------------------------------------------------------------------
+# Error handling tests
+# ---------------------------------------------------------------------------
+
+
+class TestChangelogErrors:
+    """Verify error handling when prerequisites are missing."""
+
+    @patch("azpysdk.changelog.shutil.which", return_value=None)
+    def test_npx_not_found_raises(self, mock_which):
+        parser = _build_parser()
+        args = parser.parse_args(["changelog", "verify"])
+        with pytest.raises(FileNotFoundError, match="npx not found"):
+            args.func(args)