feat(sync): automatically update aliased repositories URLs (#38)

* feat(sync): automatically update aliased repositories URLs

---------

Co-authored-by: Gabriel Dugny <[email protected]>
Co-authored-by: Gabriel Dugny <[email protected]>

Author: noirbizarre

README.md

@@ -170,7 +170,7 @@ Feel free to open an issue or a PR if you have any idea, or if you want to help!
 - [ ] Check ref existence before writing?
 - [ ] New feature to convert from pre-commit online to local?
 - [ ] Warning if pre-commit CI auto update is also set?
-- [ ] Support automatic repository URL update (from legacy aliased repositories)
+- [x] Support automatic repository URL update (from legacy aliased repositories)
 
 
 ## Inspiration

src/sync_pre_commit_lock/actions/sync_hooks.py

@@ -138,6 +138,9 @@ def get_pre_commit_repo_new_version(
         )
         return None
 
+    def get_pre_commit_repo_new_url(self, url: str) -> str:
+        return self.mapping[self.mapping_reverse_by_url[url]]["repo"]
+
     def get_pre_commit_repo_new_hooks(self, hooks: Sequence[PreCommitHook]) -> Sequence[PreCommitHook]:
         return [self.get_pre_commit_repo_new_hook(hook) for hook in hooks]
 
@@ -173,7 +176,7 @@ def analyze_repos(
                 continue
 
             new_repo = PreCommitRepo(
-                repo=pre_commit_repo.repo,
+                repo=self.get_pre_commit_repo_new_url(pre_commit_repo.repo),
                 rev=self.get_pre_commit_repo_new_version(pre_commit_repo) or pre_commit_repo.rev,
                 hooks=self.get_pre_commit_repo_new_hooks(pre_commit_repo.hooks),
             )

src/sync_pre_commit_lock/pdm_plugin.py

@@ -17,6 +17,7 @@
 from sync_pre_commit_lock.actions.install_hooks import SetupPreCommitHooks
 from sync_pre_commit_lock.actions.sync_hooks import GenericLockedPackage, SyncPreCommitHooksVersion
 from sync_pre_commit_lock.config import SyncPreCommitLockConfig, load_config
+from sync_pre_commit_lock.utils import url_diff
 
 if TYPE_CHECKING:
     import argparse
@@ -59,8 +60,9 @@ def error(self, msg: str) -> None:
     def success(self, msg: str) -> None:
         self.ui.echo("[success]" + self.prefix_lines(msg) + "[/success]", verbosity=Verbosity.NORMAL)
 
-    def _format_repo_url(self, repo_url: str, package_name: str) -> str:
-        return repo_url.replace(package_name, f"[cyan][bold]{package_name}[/bold][/cyan]")
+    def _format_repo_url(self, old_repo_url: str, new_repo_url: str, package_name: str) -> str:
+        url = url_diff(old_repo_url, new_repo_url, "[cyan]{[/][red]", "[/red][cyan] -> [/][green]", "[/][cyan]}[/]")
+        return url.replace(package_name, f"[cyan][bold]{package_name}[/bold][/cyan]")
 
     def list_updated_packages(self, packages: dict[str, tuple[PreCommitRepo, PreCommitRepo]]) -> None:
         """
@@ -75,7 +77,7 @@ def _format_repo(self, package: str, old: PreCommitRepo, new: PreCommitRepo) ->
         new_version = new.rev != old.rev
         repo = (
             f"[info]{self.plugin_prefix}[/info] {self.success_list_token}",
-            f"[info]{self._format_repo_url(old.repo, package)}[/info]",
+            f"[info]{self._format_repo_url(old.repo, new.repo, package)}[/info]",
             " ",
             f"[error]{old.rev}[/error]" if new_version else "",
             "[info]->[/info]" if new_version else "",

src/sync_pre_commit_lock/poetry_plugin.py

@@ -23,6 +23,7 @@
 from sync_pre_commit_lock.actions.install_hooks import SetupPreCommitHooks
 from sync_pre_commit_lock.actions.sync_hooks import GenericLockedPackage, SyncPreCommitHooksVersion
 from sync_pre_commit_lock.config import load_config
+from sync_pre_commit_lock.utils import url_diff
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -71,7 +72,7 @@ def _format_repo(self, package: str, old: PreCommitRepo, new: PreCommitRepo) ->
         new_version = new.rev != old.rev
         repo = (
             f"<info>{self.plugin_prefix} {self.success_list_token}",
-            self._format_repo_url(old.repo, package),
+            self._format_repo_url(old.repo, new.repo, package),
             " ",
             f"<warning>{old.rev}</>" if new_version else "",
             "->" if new_version else "",
@@ -85,8 +86,9 @@ def _format_repo(self, package: str, old: PreCommitRepo, new: PreCommitRepo) ->
         ]
         return [repo, *hooks] if hooks else [repo]
 
-    def _format_repo_url(self, repo_url: str, package_name: str) -> str:
-        return repo_url.replace(package_name, f"<c1>{package_name}</>")
+    def _format_repo_url(self, old_repo_url: str, new_repo_url: str, package_name: str) -> str:
+        url = url_diff(old_repo_url, new_repo_url, "<c1>{</><warning>", "</><c1> -> </><success>", "</><c1>}</>")
+        return url.replace(package_name, f"<c1>{package_name}</>")
 
     def _format_hook(self, old: PreCommitHook, new: PreCommitHook, last: bool) -> Sequence[Sequence[str]]:
         if not (nb_deps := len(old.additional_dependencies)):

src/sync_pre_commit_lock/utils.py

@@ -1,3 +1,4 @@
+from os.path import commonprefix
 from urllib.parse import urlparse, urlunparse
 
 
@@ -38,3 +39,14 @@ def normalize_git_url(url: str) -> str:
         normalized_url = normalized_url[:-1]
 
     return normalized_url
+
+
+def url_diff(old: str, new: str, diff_open: str = "{", diff_separator: str = " -> ", diff_close: str = "}") -> str:
+    """Represent a change of URL highlighting only the changed part"""
+    if old == new:
+        return new
+    prefix = commonprefix((old, new))
+    old, new = old.removeprefix(prefix), new.removeprefix(prefix)
+    suffix = commonprefix((old[::-1], new[::-1]))[::-1]
+    old, new = old.removesuffix(suffix), new.removesuffix(suffix)
+    return f"{prefix}{diff_open}{old}{diff_separator}{new}{diff_close}{suffix}"

tests/test_actions/test_sync_hooks.py

@@ -462,3 +462,51 @@ def test_analyze_repos_local_but_additional_dependencies() -> None:
     assert to_fix == {
         pre_commit_repo: PreCommitRepo("https://repo_url", "1.2.3", [PreCommitHook("hook", ["lib-name==2.0.0"])])
     }
+
+
+MOCK_DEP_MAPPING = {"dep": {"repo": "https://some.place", "rev": "${dev}"}}
+MOCK_REPO_ALIASES = {"https://some.place": ("https://some.old.place",)}
+
+
+@patch("sync_pre_commit_lock.actions.sync_hooks.DEPENDENCY_MAPPING", MOCK_DEP_MAPPING)
+@patch("sync_pre_commit_lock.actions.sync_hooks.REPOSITORY_ALIASES", MOCK_REPO_ALIASES)
+def test_analyze_repos_renamed() -> None:
+    printer = MagicMock(spec=Printer)
+    pre_commit_config_file_path = MagicMock(spec=Path)
+    locked_packages: dict[str, GenericLockedPackage] = {"ruff": GenericLockedPackage("dep", "1.2.3")}
+    plugin_config = SyncPreCommitLockConfig()
+
+    syncer = SyncPreCommitHooksVersion(
+        printer=printer,
+        pre_commit_config_file_path=pre_commit_config_file_path,
+        locked_packages=locked_packages,
+        plugin_config=plugin_config,
+    )
+    pre_commit_repo = PreCommitRepo("https://some.old.place", "1.2.3")
+    pre_commit_repos = {pre_commit_repo}
+
+    to_fix, _ = syncer.analyze_repos(pre_commit_repos)
+
+    assert to_fix == {pre_commit_repo: PreCommitRepo("https://some.place", "1.2.3")}
+
+
+@patch("sync_pre_commit_lock.actions.sync_hooks.DEPENDENCY_MAPPING", MOCK_DEP_MAPPING)
+@patch("sync_pre_commit_lock.actions.sync_hooks.REPOSITORY_ALIASES", MOCK_REPO_ALIASES)
+def test_analyze_repos_already_last_url() -> None:
+    printer = MagicMock(spec=Printer)
+    pre_commit_config_file_path = MagicMock(spec=Path)
+    locked_packages: dict[str, GenericLockedPackage] = {"ruff": GenericLockedPackage("dep", "1.2.3")}
+    plugin_config = SyncPreCommitLockConfig()
+
+    syncer = SyncPreCommitHooksVersion(
+        printer=printer,
+        pre_commit_config_file_path=pre_commit_config_file_path,
+        locked_packages=locked_packages,
+        plugin_config=plugin_config,
+    )
+    pre_commit_repo = PreCommitRepo("https://some.place", "1.2.3")
+    pre_commit_repos = {pre_commit_repo}
+
+    to_fix, _ = syncer.analyze_repos(pre_commit_repos)
+
+    assert to_fix == {}

tests/test_pdm/test_pdm_plugin.py

@@ -151,3 +151,19 @@ def test_pdm_printer_list_success_repo_with_multiple_hooks_and_additional_depend
     assert "[sync-pre-commit-lock]    └ 2nd-hook" in captured.out
     assert "[sync-pre-commit-lock]      ├ dep                    *      -> 0.1.2" in captured.out
     assert "[sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5" in captured.out
+
+
+def test_pdm_printer_list_success_renamed_repository(capsys: pytest.CaptureFixture[str]) -> None:
+    printer = PDMPrinter(UI())
+
+    printer.list_updated_packages(
+        {
+            "package": (
+                PreCommitRepo("https://old.repo.local/test", "rev1", [PreCommitHook("hook")]),
+                PreCommitRepo("https://new.repo.local/test", "rev2", [PreCommitHook("hook")]),
+            ),
+        }
+    )
+    captured = capsys.readouterr()
+
+    assert "[sync-pre-commit-lock]  ✔ https://{old -> new}.repo.local/test   rev1 -> rev2" in captured.out

tests/test_poetry/test_poetry_plugin.py

@@ -220,6 +220,36 @@ def _write(message: str, new_line: bool = False):
     assert "[sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5" in out
 
 
+def test_poetry_printer_list_success_renamed_repository(capsys: pytest.CaptureFixture[str]) -> None:
+    from cleo.io.inputs.input import Input
+    from cleo.io.io import IO
+    from cleo.io.outputs.output import Output
+
+    from sync_pre_commit_lock.poetry_plugin import PoetryPrinter
+
+    output = Output()
+
+    def _write(message: str, new_line: bool = False):
+        print(message)  # noqa: T201
+
+    output._write = _write
+    printer = PoetryPrinter(IO(input=Input(), output=output, error_output=output))
+
+    printer.list_updated_packages(
+        {
+            "package": (
+                PreCommitRepo("https://old.repo.local/test", "rev1", [PreCommitHook("hook")]),
+                PreCommitRepo("https://new.repo.local/test", "rev2", [PreCommitHook("hook")]),
+            ),
+        }
+    )
+    captured = capsys.readouterr()
+    # Remove all <..> tags, as we don't have the real parser
+    out = re.sub(r"<[^>]*>", "", captured.out)
+
+    assert "[sync-pre-commit-lock]  • https://{old -> new}.repo.local/test   rev1 -> rev2" in out
+
+
 def test_direct_command_invocation():
     with pytest.raises(RuntimeError, match="self.application is None"):
         SyncPreCommitPoetryCommand().handle()

tests/test_utils.py

@@ -1,6 +1,6 @@
 import pytest
 
-from sync_pre_commit_lock.utils import normalize_git_url
+from sync_pre_commit_lock.utils import normalize_git_url, url_diff
 
 
 # Here are the test cases
@@ -23,3 +23,17 @@
 )
 def test_normalize_git_url(url: str, expected: str) -> None:
     assert normalize_git_url(url) == expected
+
+
+@pytest.mark.parametrize(
+    "old,new,expected",
+    [
+        ("https://some.place", "https://some.place", "https://some.place"),
+        ("https://some.old.place", "https://some.new.place", "https://some.{old -> new}.place"),
+        ("https://some.place", "https://another.place", "https://{some -> another}.place"),
+        ("https://some.place/old", "https://a.different/place", "https://{some.place/old -> a.different/place}"),
+        ("https://some.place/old", "https://some.place/new", "https://some.place/{old -> new}"),
+    ],
+)
+def test_url_diff(old: str, new: str, expected: str):
+    assert url_diff(old, new) == expected