Fix wrong version ordering in x-repo search

CHANGES/1516.bugfix

@@ -0,0 +1 @@
+Fixed ordering by version in the ``/ansible/search/collection-versions/`` endpoint.

pulp_ansible/app/galaxy/v3/filters.py

@@ -1,11 +1,10 @@
 from django.contrib.postgres.search import SearchQuery
-from django.db.models import fields as db_fields
+from django.db.models import fields as db_fields, Case, When, Value
 from django.db.models import Q
 from django.db.models.expressions import F, Func
 from django_filters import (
     filters,
     FilterSet,
-    OrderingFilter,
 )
 import semantic_version
 from rest_framework.exceptions import ValidationError
@@ -17,6 +16,26 @@
 from pulp_ansible.app import models
 
 
+class SemanticVersionOrderingFilter(filters.OrderingFilter):
+    def filter(self, qs, value):
+        if value is not None and any(v in ["version", "-version"] for v in value):
+            order = "-" if "-version" in value else ""
+
+            return qs.annotate(
+                prerelease=Case(
+                    When(collection_version__version_prerelease="", then=Value(None)),
+                    default="collection_version__version_prerelease",
+                ),
+            ).order_by(
+                f"{order}collection_version__version_major",
+                f"{order}collection_version__version_minor",
+                f"{order}collection_version__version_patch",
+                f"{order}prerelease",
+            )
+
+        return super().filter(qs, value)
+
+
 class CollectionVersionSearchFilter(FilterSet):
     """A custom filterset for cross-repo search."""
 
@@ -49,7 +68,7 @@ class CollectionVersionSearchFilter(FilterSet):
     keywords = filters.CharFilter(field_name="q", method="filter_by_q")
     repository_label = LabelFilter(label_field_name="repository__pulp_labels")
 
-    order_by = OrderingFilter(
+    order_by = SemanticVersionOrderingFilter(
         choices=(
             ("pulp_created", "by CV created"),
             ("-pulp_created", "by CV created (descending)"),
@@ -64,7 +83,6 @@ class CollectionVersionSearchFilter(FilterSet):
             "collection_version__pulp_created": "pulp_created",
             "collection_version__namespace": "namespace",
             "collection_version__name": "name",
-            "collection_version__version": "version",
         },
     )
 

pulp_ansible/tests/functional/api/collection/v3/test_collection_version_search.py

@@ -1523,3 +1523,65 @@ def test_cross_repo_search_index_with_updated_namespace_metadata(
     assert cv2.namespace_metadata.company == "Testing Co. redux"
     assert cv2.namespace_metadata.description == "hello 2"
     assert cv2.namespace_metadata.name == namespace_name
+
+
+def test_cross_repo_search_semantic_version_ordering(
+    ansible_distro_api_client,
+    ansible_repo_api_client,
+    build_and_upload_collection,
+    galaxy_v3_default_search_api_client,
+    gen_object_with_cleanup,
+):
+    """Make sure collections are properly sorted using the order_by='version' parameter."""
+    pulp_repo = gen_object_with_cleanup(ansible_repo_api_client, {"name": str(uuid.uuid4())})
+
+    gen_object_with_cleanup(
+        ansible_distro_api_client,
+        {
+            "name": pulp_repo.name,
+            "base_path": pulp_repo.name,
+            "repository": pulp_repo.pulp_href,
+        },
+    )
+
+    versions = [
+        "2.0.0",
+        "1.22.2",
+        "1.22.1",
+        "1.22.1-rc",
+        "1.22.1-pre",
+        "1.22.1-dev",
+        "1.22.1-beta",
+        "1.22.1-alpha",
+        "1.1.0",
+        "1.0.1",
+        "1.0.0",
+    ]
+
+    for version in versions:
+        build_and_upload_collection(ansible_repo=pulp_repo, config={"version": version})
+
+    resp = galaxy_v3_default_search_api_client.list(
+        limit=1000, order_by=["-version"], repository_name=[pulp_repo.name]
+    )
+
+    built_collection_versions = [col.collection_version.version for col in resp.data]
+
+    versions.sort(key=Version, reverse=True)
+
+    # Make sure versions are correctly sorted according to Semantic Versioning.
+    assert versions == [
+        "2.0.0",
+        "1.22.2",
+        "1.22.1",
+        "1.22.1-rc",
+        "1.22.1-pre",
+        "1.22.1-dev",
+        "1.22.1-beta",
+        "1.22.1-alpha",
+        "1.1.0",
+        "1.0.1",
+        "1.0.0",
+    ]
+
+    assert versions == built_collection_versions