fix(format): only sort blueprints by version when semver is used

Author: fyhertz

pyproject.toml

@@ -79,10 +79,6 @@ exclude = '''
 )
 '''
 
-[tool.isort]
-line_length = 90
-profile = "black"
-
 [tool.mypy]
 files = "src"
 strict = true

src/ops2deb/formatter.py

@@ -3,6 +3,7 @@
 from typing import Any, OrderedDict, Tuple
 
 import yaml
+from semver.version import Version
 
 from ops2deb.exceptions import Ops2debFormatterError
 from ops2deb.parser import (
@@ -15,12 +16,20 @@
 
 
 def sort_blueprints(blueprints: list[OrderedDict[str, Any]]) -> list[dict[str, Any]]:
-    def key(blueprint: dict[str, Any]) -> Tuple[str, str, int]:
+    def key(blueprint: dict[str, Any]) -> Tuple[str, Version, int]:
         try:
-            version = blueprint["matrix"]["versions"][-1]
+            version_str = blueprint["matrix"]["versions"][-1]
         except KeyError:
-            version = blueprint["version"]
-        return blueprint["name"], version, blueprint.get("revision", "1")
+            version_str = blueprint["version"]
+        version: Version = Version(0, 0, 0)
+        if Version.isvalid(version_str):
+            version = Version.parse(version_str)
+        revision_str = blueprint.get("revision", "1")
+        try:
+            revision = int(revision_str)
+        except ValueError:
+            revision = 1
+        return blueprint["name"], version, revision
 
     return sorted(blueprints, key=key)
 

src/ops2deb/utils.py

@@ -43,3 +43,9 @@ class FixIndentEmitter(Emitter):
     def expect_block_sequence(self) -> None:
         self.increase_indent(flow=False, indentless=False)
         self.state = self.expect_first_block_sequence_item
+
+    def choose_scalar_style(self) -> str:
+        style: str = super().choose_scalar_style()
+        style = '"' if style == "'" else style
+        style = "|" if self.analysis.multiline else style
+        return style

tests/test_formatter.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from ops2deb.formatter import format_blueprint, format_description
+from ops2deb.formatter import format_blueprint, format_description, sort_blueprints
 from ops2deb.parser import Blueprint
 
 description_with_empty_line = """
@@ -17,14 +17,14 @@
 """
 
 
-def test_format_description_should_only_remove_empty_lines_at_start_or_end():
+def test_format_description__should_only_remove_empty_lines_at_start_or_end():
     result = format_description(description_with_empty_line)
     assert result[0] != "\n"
     assert result[-1] != "\n"
     assert "\n" in result
 
 
-def test_format_description_should_remove_trailing_spaces():
+def test_format_description__should_remove_trailing_spaces():
     lines = description_with_empty_line.split("\n")
     lines = [line + " " for line in lines]
     description_with_trailing_spaces = "\n".join(lines)
@@ -33,20 +33,20 @@ def test_format_description_should_remove_trailing_spaces():
     assert result[1] == ""
 
 
-def test_format_description_should_wrap_long_lines():
+def test_format_description__should_wrap_long_lines():
     result = format_description(description_with_long_line)
     assert len(result.split("\n")) == 2
 
 
 @pytest.mark.parametrize(
     "description", [description_with_empty_line, description_with_long_line]
 )
-def test_format_description_should_be_idempotent(description):
+def test_format_description__should_be_idempotent(description):
     result = format_description(description)
     assert format_description(result) == result
 
 
-def test_format_blueprint_should_remove_default_values():
+def test_format_blueprint__should_remove_default_values():
     raw_blueprint = dict(
         name="great-app",
         version="1.0.0",
@@ -59,20 +59,20 @@ def test_format_blueprint_should_remove_default_values():
     assert format_blueprint(raw_blueprint_with_defaults) == raw_blueprint
 
 
-def test_format_blueprint_should_not_remove_field_when_value_is_not_default(
+def test_format_blueprint__should_not_remove_field_when_value_is_not_default(
     blueprint_factory,
 ):
     blueprint = blueprint_factory(revision=2, depends=["test"])
     blueprint = format_blueprint(blueprint.dict())
     assert {"revision", "depends", "fetch", "script"}.issubset(blueprint.keys())
 
 
-def test_format_blueprint_should_not_render_templated_values(blueprint_factory):
+def test_format_blueprint__should_not_render_templated_values(blueprint_factory):
     blueprint = blueprint_factory(version="{{env('TEST', 0)}}", construct=True)
     assert format_blueprint(blueprint.dict())["version"] == "{{env('TEST', 0)}}"
 
 
-def test_format_blueprint_should_replace_fetch_object_with_string_when_only_key_is_url():
+def test_format_blueprint__replaces_fetch_object_with_string_when_only_key_is_url():
     raw_blueprint = dict(
         name="great-app",
         version="1.0.0",
@@ -82,13 +82,55 @@ def test_format_blueprint_should_replace_fetch_object_with_string_when_only_key_
     assert format_blueprint(raw_blueprint)["fetch"] == "http://test/app.tar.gz"
 
 
-def test_format_blueprint_should_replace_field_arch_by_architecture():
-    raw_blueprint = dict(
-        name="great-app",
-        version="1.0.0",
-        arch="all",
-        summary="A summary",
+def test_sort_blueprints__sorts_by_name_and_version_when_blueprint_uses_semver():
+    # Given
+    blueprint_0 = dict(name="great-app", version="2.0.0", summary="A summary")
+    blueprint_1 = dict(name="great-app", version="1.0.0", summary="A summary")
+    blueprint_2 = dict(
+        name="great-app", matrix=dict(versions=["0.1.0", "0.2.0"]), summary="A summary"
     )
-    formatted_blueprint = format_blueprint(raw_blueprint)
-    assert formatted_blueprint["architecture"] == "all"
-    assert "arch" not in formatted_blueprint
+
+    # When
+    result = sort_blueprints([blueprint_0, blueprint_1, blueprint_2])
+
+    # Then
+    assert result == [blueprint_2, blueprint_1, blueprint_0]
+
+
+def test_sort_blueprints__does_not_sort_by_version_when_blueprint_does_not_use_semver():
+    # Given
+    blueprint_0 = dict(name="great-app", version="2020", summary="A summary")
+    blueprint_1 = dict(name="great-app", version="2019", summary="A summary")
+    blueprint_2 = dict(name="great-app", version="2023", summary="A summary")
+
+    # When
+    result = sort_blueprints([blueprint_0, blueprint_1, blueprint_2])
+
+    # Then
+    assert result == [blueprint_0, blueprint_1, blueprint_2]
+
+
+def test_sort_blueprints__sorts_by_name_version_and_revision_when_revision_is_an_int():
+    # Given
+    blueprint_0 = dict(name="great-app", version="1.0.0", summary="A summary", revision=2)
+    blueprint_1 = dict(name="great-app", version="1.0.0", summary="A summary", revision=3)
+    blueprint_2 = dict(name="great-app", version="1.0.0", summary="A summary", revision=1)
+
+    # When
+    result = sort_blueprints([blueprint_0, blueprint_1, blueprint_2])
+
+    # Then
+    assert result == [blueprint_2, blueprint_0, blueprint_1]
+
+
+def test_sort_blueprints__does_not_sort_by_revision_when_revision_is_not_an_int():
+    # Given
+    blueprint_0 = dict(name="great-app", version="1.0.0", summary="summary", revision="c")
+    blueprint_1 = dict(name="great-app", version="1.0.0", summary="summary", revision="b")
+    blueprint_2 = dict(name="great-app", version="1.0.0", summary="summary", revision="a")
+
+    # When
+    result = sort_blueprints([blueprint_0, blueprint_1, blueprint_2])
+
+    # Then
+    assert result == [blueprint_0, blueprint_1, blueprint_2]