fix: use imperative mood in update summary

Example: "add tool v1.0.0" instead of "added tool v1.0.0"

Author: fyhertz

src/ops2deb/parser.py

@@ -200,9 +200,13 @@ def render_fetch_url(
         url = self.fetch if isinstance(self.fetch, str) else self.fetch.url
         return self.render_string(url, version=version, architecture=architecture)
 
-    def render_fetch_urls(self) -> list[str]:
+    def render_fetch_urls(
+        self, version: str | None = None, architecture: str | None = None
+    ) -> list[str]:
         urls = []
-        for architecture, version in product(self.architectures(), self.versions()):
+        architectures = [architecture] if architecture else self.architectures()
+        versions = [version] if version else self.versions()
+        for architecture, version in product(architectures, versions):
             if url := self.render_fetch_url(version=version, architecture=architecture):
                 urls.append(url)
         return urls
@@ -224,10 +228,7 @@ class ConfigurationFile:
     yaml: YAML
     raw_blueprints: list[OrderedDict[str, Any]]
     blueprints: list[Blueprint]
-
-    def save(self) -> None:
-        with self.path.open("w") as output:
-            self.yaml.dump(self.content, output)
+    tainted: bool = False
 
 
 def get_default_lockfile_path(configuration_path: Path) -> Path:
@@ -280,6 +281,13 @@ def load_configuration_file(configuration_path: Path) -> ConfigurationFile:
     )
 
 
+def save_configuration_file(configuration_file: ConfigurationFile) -> None:
+    if configuration_file.tainted is False:
+        return
+    with configuration_file.path.open("w") as output:
+        configuration_file.yaml.dump(configuration_file.content, output)
+
+
 def load_configuration_files(
     configurations_search_pattern: str,
 ) -> list[ConfigurationFile]:
@@ -322,11 +330,12 @@ def get_blueprint_configuration_file(self, blueprint: Blueprint) -> Configuratio
     def get_raw_blueprint(self, blueprint: Blueprint) -> OrderedDict[str, Any]:
         metadata = self.metadatas[blueprint.uid]
         configuration_file = metadata.configuration_file
+        configuration_file.tainted = True
         return configuration_file.raw_blueprints[blueprint.index]
 
     def save(self) -> None:
         for configuration in self.configuration_files:
-            configuration.save()
+            save_configuration_file(configuration)
         for lock in self.lock_files:
             lock.save()
 

src/ops2deb/updater.py

@@ -185,13 +185,6 @@ async def _find_latest_version(
     raise Ops2debUpdaterError(error)
 
 
-def _blueprint_fetch_urls(blueprint: Blueprint, version: str | None = None) -> list[str]:
-    urls: list[str] = []
-    for architecture in blueprint.architectures():
-        urls.append(str(blueprint.render_fetch_url(version, architecture)))
-    return urls
-
-
 async def _find_latest_versions(
     blueprints: list[Blueprint],
 ) -> tuple[list[LatestRelease], list[Ops2debError]]:
@@ -234,7 +227,7 @@ def find_latest_releases(
     releases_by_id: dict[int, LatestRelease] = {}
     for i, release in enumerate(releases):
         releases_by_id[i] = release
-        for url in _blueprint_fetch_urls(release.blueprint, release.version):
+        for url in release.blueprint.render_fetch_urls(release.version):
             fetcher.add_task(url, data=i)
     results, failures = fetcher.run_tasks()
 
@@ -289,14 +282,35 @@ def _update_configuration(
     return removed_versions
 
 
-def _update_lockfile(
+def _remove_versions_from_lockfile(
     configuration: Resources, release: LatestRelease, removed_versions: list[str]
 ) -> None:
     blueprint = release.blueprint
     lock = configuration.get_blueprint_lock(blueprint)
     for version in removed_versions:
-        lock.remove(_blueprint_fetch_urls(blueprint, version))
-    _blueprint_fetch_urls(blueprint, release.version)
+        lock.remove(blueprint.render_fetch_urls(version))
+
+
+def _update_configurations(
+    resources: Resources, max_versions: int, releases: list[LatestRelease]
+) -> list[str]:
+    summary: list[str] = []
+
+    for release in releases:
+        removed_versions = _update_configuration(resources, release, max_versions)
+        if max_versions == 1:
+            lines = [
+                f"Update {release.blueprint.name} from "
+                f"v{release.blueprint.version} to v{release.version}"
+            ]
+        else:
+            lines = [f"Add {release.blueprint.name} v{release.version}"]
+            for version in removed_versions:
+                lines.append(f"Remove {release.blueprint.name} v{version}")
+        _remove_versions_from_lockfile(resources, release, removed_versions)
+        summary.extend(lines)
+
+    return summary
 
 
 def update(
@@ -311,21 +325,7 @@ def update(
     logger.title("Looking for new releases...")
     releases, errors = find_latest_releases(resources, fetcher, skip_names, only_names)
 
-    summary: list[str] = []
-
-    for release in releases:
-        removed_versions = _update_configuration(resources, release, max_versions)
-        if max_versions == 1:
-            line = (
-                f"Updated {release.blueprint.name} from "
-                f"{release.blueprint.version} to {release.version}"
-            )
-        else:
-            line = f"Added {release.blueprint.name} v{release.version}"
-            if removed_versions:
-                line += f" and removed {', '.join([f'v{v}' for v in removed_versions])}"
-        _update_lockfile(resources, release, removed_versions)
-        summary.append(line)
+    summary = _update_configurations(resources, max_versions, releases)
 
     if not releases:
         logger.info("Did not found any updates")

tests/test_ops2deb.py

@@ -584,7 +584,7 @@ def test_update__appends_new_version_to_version_matrix_when_max_versions_is_not_
     raw_blueprints = load_configuration_file(configuration_path).raw_blueprints
     lock = LockFile(lockfile_path)
     sha256 = "f1be6dd36b503641d633765655e81cdae1ff8f7f73a2582b7468adceb5e212a9"
-    assert "Added great-app v1.1.1" in summary_path.read_text()
+    assert "Add great-app v1.1.1" in summary_path.read_text()
     assert "great-app can be bumped from 1.1.0 to 1.1.1" in result.stdout
     assert raw_blueprints[0]["matrix"]["versions"] == ["1.0.0", "1.0.1", "1.1.0", "1.1.1"]
     assert lock.sha256("http://testserver/1.1.1/great-app.tar.gz") == sha256
@@ -619,7 +619,8 @@ def test_update__adds_new_version_and_remove_old_versions_when_max_versions_is_r
     # Then
     raw_blueprints = load_configuration_file(configuration_path).raw_blueprints
     assert raw_blueprints[0]["matrix"]["versions"] == ["1.1.0", "1.1.1"]
-    assert "Added great-app v1.1.1 and removed v1.0.0, v1.0.1" in summary_path.read_text()
+    assert "Add great-app v1.1.1" in summary_path.read_text()
+    assert "Remove great-app v1.0.0\nRemove great-app v1.0.1" in summary_path.read_text()
     assert "http://testserver/1.0.0/great-app.tar.gz" not in lockfile_path.read_text()
     assert "http://testserver/1.0.1/great-app.tar.gz" not in lockfile_path.read_text()
     assert "http://testserver/1.1.0/great-app.tar.gz" in lockfile_path.read_text()
@@ -652,7 +653,7 @@ def test_update__replaces_version_with_versions_matrix_when_max_versions_is_supe
     raw_blueprints = load_configuration_file(configuration_path).raw_blueprints
     assert result.exit_code == 0
     assert raw_blueprints[0]["matrix"]["versions"] == ["1.0.0", "1.1.1"]
-    assert "Added great-app v1.1.1" in summary_path.read_text()
+    assert "Add great-app v1.1.1" in summary_path.read_text()
     assert "http://testserver/1.0.0/great-app.tar.gz" in lockfile_path.read_text()
     assert "http://testserver/1.1.1/great-app.tar.gz" in lockfile_path.read_text()
 
@@ -686,8 +687,8 @@ def test_update__creates_a_summary_of_updated_blueprints_when_called_with_output
     # Then
     summary_lines_set = {
         "",
-        "Updated great-app from 1.0.0 to 1.1.1",
-        "Updated super-app from 1.0.0 to 1.1.1",
+        "Update great-app from v1.0.0 to v1.1.1",
+        "Update super-app from v1.0.0 to v1.1.1",
     }
     assert set(summary_path.read_text().split("\n")) == summary_lines_set