Merge pull request #1636 from saireddythfc/codegen-bot/sort-collections-list-all

Order return of collections.list_all() alphabetically by key

Author: tsmith023

integration/test_collections_sorting.py

@@ -0,0 +1,44 @@
+import pytest
+from integration.conftest import ClientFactory
+
+
+@pytest.fixture
+def sorting_test_client(client_factory: ClientFactory):
+    client = client_factory()
+    try:
+        yield client
+    finally:
+        client.close()
+
+
+def test_collections_list_all_sorting(sorting_test_client):
+    """Test that collections.list_all() returns collections sorted alphabetically by key."""
+    client = sorting_test_client
+
+    try:
+        # Create collections with names in non-alphabetical order
+        client.collections.create(name="SortingTestCollectionC")
+        client.collections.create(name="SortingTestCollectionA")
+        client.collections.create(name="SortingTestCollectionB")
+
+        # Get all collections
+        collections = client.collections.list_all()
+
+        # Get the keys and filter only our test collections
+        collection_keys = list(collections.keys())
+        test_collections = [k for k in collection_keys if k.startswith("SortingTestCollection")]
+
+        # Verify they are in alphabetical order
+        assert test_collections == sorted(test_collections)
+
+        # Test with simple=False as well
+        collections = client.collections.list_all(simple=False)
+        collection_keys = list(collections.keys())
+        test_collections = [k for k in collection_keys if k.startswith("SortingTestCollection")]
+        assert test_collections == sorted(test_collections)
+
+    finally:
+        # Clean up
+        client.collections.delete(
+            ["SortingTestCollectionA", "SortingTestCollectionB", "SortingTestCollectionC"]
+        )

test/collection/test_collections_sorting.py

@@ -0,0 +1,51 @@
+from unittest.mock import MagicMock, patch
+from weaviate.collections.classes.config_methods import (
+    _collection_configs_from_json,
+    _collection_configs_simple_from_json,
+)
+
+
+def test_collection_configs_from_json_sorting():
+    """Test that _collection_configs_from_json returns collections sorted by key."""
+    # Mock schema with collections in non-alphabetical order
+    mock_schema = {
+        "classes": [
+            {"class": "CollectionC", "description": "Collection C"},
+            {"class": "CollectionA", "description": "Collection A"},
+            {"class": "CollectionB", "description": "Collection B"},
+        ]
+    }
+
+    # Mock the _collection_config_from_json function to return a simple object
+    with patch(
+        "weaviate.collections.classes.config_methods._collection_config_from_json",
+        return_value=MagicMock(),
+    ):
+        # Call the function
+        result = _collection_configs_from_json(mock_schema)
+
+        # Check that the keys are in alphabetical order
+        assert list(result.keys()) == ["CollectionA", "CollectionB", "CollectionC"]
+
+
+def test_collection_configs_simple_from_json_sorting():
+    """Test that _collection_configs_simple_from_json returns collections sorted by key."""
+    # Mock schema with collections in non-alphabetical order
+    mock_schema = {
+        "classes": [
+            {"class": "CollectionC", "description": "Collection C"},
+            {"class": "CollectionA", "description": "Collection A"},
+            {"class": "CollectionB", "description": "Collection B"},
+        ]
+    }
+
+    # Mock the _collection_config_simple_from_json function to return a simple object
+    with patch(
+        "weaviate.collections.classes.config_methods._collection_config_simple_from_json",
+        return_value=MagicMock(),
+    ):
+        # Call the function
+        result = _collection_configs_simple_from_json(mock_schema)
+
+        # Check that the keys are in alphabetical order
+        assert list(result.keys()) == ["CollectionA", "CollectionB", "CollectionC"]

weaviate/collections/classes/config_methods.py

@@ -343,15 +343,19 @@ def _collection_config_from_json(schema: Dict[str, Any]) -> _CollectionConfig:
 
 
 def _collection_configs_from_json(schema: Dict[str, Any]) -> Dict[str, _CollectionConfig]:
-    return {schema["class"]: _collection_config_from_json(schema) for schema in schema["classes"]}
+    configs = {
+        schema["class"]: _collection_config_from_json(schema) for schema in schema["classes"]
+    }
+    return dict(sorted(configs.items()))
 
 
 def _collection_configs_simple_from_json(
     schema: Dict[str, Any]
 ) -> Dict[str, _CollectionConfigSimple]:
-    return {
+    configs = {
         schema["class"]: _collection_config_simple_from_json(schema) for schema in schema["classes"]
     }
+    return dict(sorted(configs.items()))
 
 
 def _nested_properties_from_config(props: List[Dict[str, Any]]) -> List[_NestedProperty]: