Added runs sorting test

Author: kzscisoft

simvue/api/objects/run.py

@@ -47,8 +47,9 @@ def check_column(cls, column: str) -> str:
             and column != "name"
             and not column.startswith("metrics")
             and not column.startswith("metadata.")
+            and column not in ("created", "started", "endtime", "modified")
         ):
-            raise ValueError(f"Invalid sort column for runs '{column}")
+            raise ValueError(f"Invalid sort column for runs '{column}'")
 
         return column
 

simvue/client.py

@@ -182,6 +182,7 @@ def get_runs(
         count_limit: pydantic.PositiveInt | None = 100,
         start_index: pydantic.NonNegativeInt = 0,
         show_shared: bool = False,
+        sort_by_columns: list[tuple[str, bool]] | None = None,
     ) -> DataFrame | typing.Generator[tuple[str, Run], None, None] | None:
         """Retrieve all runs matching filters.
 
@@ -210,6 +211,10 @@ def get_runs(
             the index from which to count entries. Default is 0.
         show_shared : bool, optional
             whether to include runs shared with the current user. Default is False.
+        sort_by_columns : list[tuple[str, bool]], optional
+            sort by columns in the order given,
+            list of tuples in the form (column_name: str, sort_descending: bool),
+            default is None.
 
         Returns
         -------
@@ -236,6 +241,9 @@ def get_runs(
             return_alerts=alerts,
             return_system=system,
             return_metadata=metadata,
+            sorting=[dict(zip(("column", "descending"), a)) for a in sort_by_columns]
+            if sort_by_columns
+            else None,
         )
 
         if output_format == "objects":

tests/functional/test_client.py

@@ -200,11 +200,19 @@ def test_get_artifacts_as_files(
 
 @pytest.mark.dependency
 @pytest.mark.client
-@pytest.mark.parametrize("output_format", ("dict", "dataframe", "objects"))
-def test_get_runs(create_test_run: tuple[sv_run.Run, dict], output_format: str) -> None:
+@pytest.mark.parametrize(
+    "output_format,sorting",
+    [
+        ("dict", None),
+        ("dataframe", [("created", True), ("started", True)]),
+        ("objects", [("metadata.test_identifier", True)]),
+    ],
+    ids=("dict-unsorted", "dataframe-datesorted", "objects-metasorted")
+)
+def test_get_runs(create_test_run: tuple[sv_run.Run, dict], output_format: str, sorting: list[tuple[str, bool]] | None) -> None:
     client = svc.Client()
 
-    _result = client.get_runs(filters=None, output_format=output_format, count_limit=10)
+    _result = client.get_runs(filters=None, output_format=output_format, count_limit=10, sort_by_columns=sorting)
 
     if output_format == "dataframe":
         assert not _result.empty