list_scenario_runs() now returns a list of ScenarioRun/AsyncScenarioRun objects

Author: sid-rl

src/runloop_api_client/sdk/async_benchmark_run.py

@@ -5,9 +5,10 @@
 from typing import List
 from typing_extensions import Unpack, override
 
-from ..types import ScenarioRunView, BenchmarkRunView
+from ..types import BenchmarkRunView
 from ._types import BaseRequestOptions, LongRequestOptions, SDKBenchmarkRunListScenarioRunsParams
 from .._client import AsyncRunloop
+from .async_scenario_run import AsyncScenarioRun
 
 
 class AsyncBenchmarkRun:
@@ -112,15 +113,15 @@ async def complete(
     async def list_scenario_runs(
         self,
         **params: Unpack[SDKBenchmarkRunListScenarioRunsParams],
-    ) -> List[ScenarioRunView]:
+    ) -> List[AsyncScenarioRun]:
         """List all scenario runs for this benchmark run.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBenchmarkRunListScenarioRunsParams` for available parameters
-        :return: List of scenario run views
-        :rtype: List[ScenarioRunView]
+        :return: List of async scenario run objects
+        :rtype: List[AsyncScenarioRun]
         """
-        page = self._client.benchmarks.runs.list_scenario_runs(
+        page = await self._client.benchmarks.runs.list_scenario_runs(
             self._id,
             **params,
         )
-        return [item async for item in page]
+        return [AsyncScenarioRun(self._client, run.id, run.devbox_id) for run in page.runs]

src/runloop_api_client/sdk/benchmark_run.py

@@ -5,9 +5,10 @@
 from typing import List
 from typing_extensions import Unpack, override
 
-from ..types import ScenarioRunView, BenchmarkRunView
+from ..types import BenchmarkRunView
 from ._types import BaseRequestOptions, LongRequestOptions, SDKBenchmarkRunListScenarioRunsParams
 from .._client import Runloop
+from .scenario_run import ScenarioRun
 
 
 class BenchmarkRun:
@@ -112,15 +113,15 @@ def complete(
     def list_scenario_runs(
         self,
         **params: Unpack[SDKBenchmarkRunListScenarioRunsParams],
-    ) -> List[ScenarioRunView]:
+    ) -> List[ScenarioRun]:
         """List all scenario runs for this benchmark run.
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBenchmarkRunListScenarioRunsParams` for available parameters
-        :return: List of scenario run views
-        :rtype: List[ScenarioRunView]
+        :return: List of scenario run objects
+        :rtype: List[ScenarioRun]
         """
         page = self._client.benchmarks.runs.list_scenario_runs(
             self._id,
             **params,
         )
-        return list(page)
+        return [ScenarioRun(self._client, run.id, run.devbox_id) for run in page.runs]

tests/sdk/test_async_benchmark_run.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
+from types import SimpleNamespace
 from unittest.mock import AsyncMock
 
-from tests.sdk.conftest import AsyncIterableMock, MockScenarioRunView, MockBenchmarkRunView
+from tests.sdk.conftest import MockScenarioRunView, MockBenchmarkRunView
+from runloop_api_client.sdk.async_scenario_run import AsyncScenarioRun
 from runloop_api_client.sdk.async_benchmark_run import AsyncBenchmarkRun
 
 
@@ -56,39 +58,63 @@ async def test_complete(self, mock_async_client: AsyncMock, benchmark_run_view:
         assert result.state == "completed"
         mock_async_client.benchmarks.runs.complete.assert_awaited_once_with("bench_run_123")
 
-    async def test_list_scenario_runs(
+    async def test_list_scenario_runs_empty(self, mock_async_client: AsyncMock) -> None:
+        """Test list_scenario_runs method with empty results."""
+        page = SimpleNamespace(runs=[])
+        mock_async_client.benchmarks.runs.list_scenario_runs = AsyncMock(return_value=page)
+
+        run = AsyncBenchmarkRun(mock_async_client, "bench_run_123", "bench_123")
+        result = await run.list_scenario_runs()
+
+        assert len(result) == 0
+        mock_async_client.benchmarks.runs.list_scenario_runs.assert_awaited_once_with("bench_run_123")
+
+    async def test_list_scenario_runs_single(
         self, mock_async_client: AsyncMock, scenario_run_view: MockScenarioRunView
     ) -> None:
-        """Test list_scenario_runs method."""
-        mock_async_client.benchmarks.runs.list_scenario_runs.return_value = AsyncIterableMock([scenario_run_view])
+        """Test list_scenario_runs method with single result."""
+        page = SimpleNamespace(runs=[scenario_run_view])
+        mock_async_client.benchmarks.runs.list_scenario_runs = AsyncMock(return_value=page)
 
         run = AsyncBenchmarkRun(mock_async_client, "bench_run_123", "bench_123")
         result = await run.list_scenario_runs()
 
         assert len(result) == 1
-        assert result[0] == scenario_run_view
-        mock_async_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")
+        assert isinstance(result[0], AsyncScenarioRun)
+        assert result[0].id == scenario_run_view.id
+        assert result[0].devbox_id == scenario_run_view.devbox_id
+        mock_async_client.benchmarks.runs.list_scenario_runs.assert_awaited_once_with("bench_run_123")
+
+    async def test_list_scenario_runs_multiple(self, mock_async_client: AsyncMock) -> None:
+        """Test list_scenario_runs method with multiple results."""
+        scenario_run_view1 = MockScenarioRunView(id="run_001", devbox_id="dev_001")
+        scenario_run_view2 = MockScenarioRunView(id="run_002", devbox_id="dev_002")
+        page = SimpleNamespace(runs=[scenario_run_view1, scenario_run_view2])
+        mock_async_client.benchmarks.runs.list_scenario_runs = AsyncMock(return_value=page)
+
+        run = AsyncBenchmarkRun(mock_async_client, "bench_run_123", "bench_123")
+        result = await run.list_scenario_runs()
+
+        assert len(result) == 2
+        assert isinstance(result[0], AsyncScenarioRun)
+        assert isinstance(result[1], AsyncScenarioRun)
+        assert result[0].id == "run_001"
+        assert result[1].id == "run_002"
+        mock_async_client.benchmarks.runs.list_scenario_runs.assert_awaited_once_with("bench_run_123")
 
     async def test_list_scenario_runs_with_params(
         self, mock_async_client: AsyncMock, scenario_run_view: MockScenarioRunView
     ) -> None:
         """Test list_scenario_runs method with filtering parameters."""
-        mock_async_client.benchmarks.runs.list_scenario_runs.return_value = AsyncIterableMock([scenario_run_view])
+        page = SimpleNamespace(runs=[scenario_run_view])
+        mock_async_client.benchmarks.runs.list_scenario_runs = AsyncMock(return_value=page)
 
         run = AsyncBenchmarkRun(mock_async_client, "bench_run_123", "bench_123")
         result = await run.list_scenario_runs(limit=10, state="completed")
 
         assert len(result) == 1
-        mock_async_client.benchmarks.runs.list_scenario_runs.assert_called_once_with(
+        assert isinstance(result[0], AsyncScenarioRun)
+        assert result[0].id == scenario_run_view.id
+        mock_async_client.benchmarks.runs.list_scenario_runs.assert_awaited_once_with(
             "bench_run_123", limit=10, state="completed"
         )
-
-    async def test_list_scenario_runs_empty(self, mock_async_client: AsyncMock) -> None:
-        """Test list_scenario_runs returns empty list when no scenario runs."""
-        mock_async_client.benchmarks.runs.list_scenario_runs.return_value = AsyncIterableMock([])
-
-        run = AsyncBenchmarkRun(mock_async_client, "bench_run_123", "bench_123")
-        result = await run.list_scenario_runs()
-
-        assert result == []
-        mock_async_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")

tests/sdk/test_benchmark_run.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
+from types import SimpleNamespace
 from unittest.mock import Mock
 
 from tests.sdk.conftest import MockScenarioRunView, MockBenchmarkRunView
+from runloop_api_client.sdk.scenario_run import ScenarioRun
 from runloop_api_client.sdk.benchmark_run import BenchmarkRun
 
 
@@ -56,37 +58,59 @@ def test_complete(self, mock_client: Mock, benchmark_run_view: MockBenchmarkRunV
         assert result.state == "completed"
         mock_client.benchmarks.runs.complete.assert_called_once_with("bench_run_123")
 
-    def test_list_scenario_runs(self, mock_client: Mock, scenario_run_view: MockScenarioRunView) -> None:
-        """Test list_scenario_runs method."""
-        mock_page = [scenario_run_view]
-        mock_client.benchmarks.runs.list_scenario_runs.return_value = mock_page
+    def test_list_scenario_runs_empty(self, mock_client: Mock) -> None:
+        """Test list_scenario_runs method with empty results."""
+        page = SimpleNamespace(runs=[])
+        mock_client.benchmarks.runs.list_scenario_runs.return_value = page
+
+        run = BenchmarkRun(mock_client, "bench_run_123", "bench_123")
+        result = run.list_scenario_runs()
+
+        assert len(result) == 0
+        mock_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")
+
+    def test_list_scenario_runs_single(self, mock_client: Mock, scenario_run_view: MockScenarioRunView) -> None:
+        """Test list_scenario_runs method with single result."""
+        page = SimpleNamespace(runs=[scenario_run_view])
+        mock_client.benchmarks.runs.list_scenario_runs.return_value = page
 
         run = BenchmarkRun(mock_client, "bench_run_123", "bench_123")
         result = run.list_scenario_runs()
 
         assert len(result) == 1
-        assert result[0] == scenario_run_view
+        assert isinstance(result[0], ScenarioRun)
+        assert result[0].id == scenario_run_view.id
+        assert result[0].devbox_id == scenario_run_view.devbox_id
+        mock_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")
+
+    def test_list_scenario_runs_multiple(self, mock_client: Mock) -> None:
+        """Test list_scenario_runs method with multiple results."""
+        scenario_run_view1 = MockScenarioRunView(id="run_001", devbox_id="dev_001")
+        scenario_run_view2 = MockScenarioRunView(id="run_002", devbox_id="dev_002")
+        page = SimpleNamespace(runs=[scenario_run_view1, scenario_run_view2])
+        mock_client.benchmarks.runs.list_scenario_runs.return_value = page
+
+        run = BenchmarkRun(mock_client, "bench_run_123", "bench_123")
+        result = run.list_scenario_runs()
+
+        assert len(result) == 2
+        assert isinstance(result[0], ScenarioRun)
+        assert isinstance(result[1], ScenarioRun)
+        assert result[0].id == "run_001"
+        assert result[1].id == "run_002"
         mock_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")
 
     def test_list_scenario_runs_with_params(self, mock_client: Mock, scenario_run_view: MockScenarioRunView) -> None:
         """Test list_scenario_runs method with filtering parameters."""
-        mock_page = [scenario_run_view]
-        mock_client.benchmarks.runs.list_scenario_runs.return_value = mock_page
+        page = SimpleNamespace(runs=[scenario_run_view])
+        mock_client.benchmarks.runs.list_scenario_runs.return_value = page
 
         run = BenchmarkRun(mock_client, "bench_run_123", "bench_123")
         result = run.list_scenario_runs(limit=10, state="completed")
 
         assert len(result) == 1
+        assert isinstance(result[0], ScenarioRun)
+        assert result[0].id == scenario_run_view.id
         mock_client.benchmarks.runs.list_scenario_runs.assert_called_once_with(
             "bench_run_123", limit=10, state="completed"
         )
-
-    def test_list_scenario_runs_empty(self, mock_client: Mock) -> None:
-        """Test list_scenario_runs returns empty list when no scenario runs."""
-        mock_client.benchmarks.runs.list_scenario_runs.return_value = []
-
-        run = BenchmarkRun(mock_client, "bench_run_123", "bench_123")
-        result = run.list_scenario_runs()
-
-        assert result == []
-        mock_client.benchmarks.runs.list_scenario_runs.assert_called_once_with("bench_run_123")

tests/smoketests/sdk/test_async_benchmark_run.py

@@ -10,6 +10,7 @@
 import pytest
 
 from runloop_api_client.sdk import AsyncRunloopSDK
+from runloop_api_client.sdk.async_scenario_run import AsyncScenarioRun
 from runloop_api_client.sdk.async_benchmark_run import AsyncBenchmarkRun
 
 pytestmark = [pytest.mark.smoketest]
@@ -30,8 +31,8 @@ async def test_benchmark_run_from_existing(self, async_sdk_client: AsyncRunloopS
         3. Validates get_info returns correct data
         """
         # List existing benchmark runs via raw API
-        runs_page = async_sdk_client.api.benchmarks.runs.list(limit=1)
-        runs = [run async for run in runs_page]
+        runs_page = await async_sdk_client.api.benchmarks.runs.list(limit=1)
+        runs = runs_page.runs
 
         if not runs:
             pytest.skip("No benchmark runs available to test")
@@ -62,8 +63,8 @@ async def test_benchmark_run_list_scenario_runs(self, async_sdk_client: AsyncRun
         2. Lists its scenario runs
         """
         # List existing benchmark runs via raw API
-        runs_page = async_sdk_client.api.benchmarks.runs.list(limit=1)
-        runs = [run async for run in runs_page]
+        runs_page = await async_sdk_client.api.benchmarks.runs.list(limit=1)
+        runs = runs_page.runs
 
         if not runs:
             pytest.skip("No benchmark runs available to test")
@@ -81,6 +82,12 @@ async def test_benchmark_run_list_scenario_runs(self, async_sdk_client: AsyncRun
         scenario_runs = await benchmark_run.list_scenario_runs()
         assert isinstance(scenario_runs, list)
 
+        # Verify returned items are AsyncScenarioRun objects
+        for scenario_run in scenario_runs:
+            assert isinstance(scenario_run, AsyncScenarioRun)
+            assert scenario_run.id is not None
+            assert scenario_run.devbox_id is not None
+
 
 class TestAsyncBenchmarkRunLifecycle:
     """Test AsyncBenchmarkRun lifecycle operations."""
@@ -96,8 +103,8 @@ async def test_benchmark_run_create_and_cancel(self, async_sdk_client: AsyncRunl
         4. Cancels the run
         """
         # Find an existing benchmark via raw API
-        benchmarks_page = async_sdk_client.api.benchmarks.list(limit=1)
-        benchmarks = [b async for b in benchmarks_page]
+        benchmarks_page = await async_sdk_client.api.benchmarks.list(limit=1)
+        benchmarks = benchmarks_page.benchmarks
 
         if not benchmarks:
             pytest.skip("No benchmarks available to test")

tests/smoketests/sdk/test_benchmark_run.py

@@ -10,6 +10,7 @@
 import pytest
 
 from runloop_api_client.sdk import RunloopSDK
+from runloop_api_client.sdk.scenario_run import ScenarioRun
 from runloop_api_client.sdk.benchmark_run import BenchmarkRun
 
 pytestmark = [pytest.mark.smoketest]
@@ -30,8 +31,7 @@ def test_benchmark_run_from_existing(self, sdk_client: RunloopSDK) -> None:
         3. Validates get_info returns correct data
         """
         # List existing benchmark runs via raw API
-        runs_page = sdk_client.api.benchmarks.runs.list(limit=1)
-        runs = list(runs_page)
+        runs = sdk_client.api.benchmarks.runs.list(limit=1).runs
 
         if not runs:
             pytest.skip("No benchmark runs available to test")
@@ -62,8 +62,7 @@ def test_benchmark_run_list_scenario_runs(self, sdk_client: RunloopSDK) -> None:
         2. Lists its scenario runs
         """
         # List existing benchmark runs via raw API
-        runs_page = sdk_client.api.benchmarks.runs.list(limit=1)
-        runs = list(runs_page)
+        runs = sdk_client.api.benchmarks.runs.list(limit=1).runs
 
         if not runs:
             pytest.skip("No benchmark runs available to test")
@@ -81,6 +80,12 @@ def test_benchmark_run_list_scenario_runs(self, sdk_client: RunloopSDK) -> None:
         scenario_runs = benchmark_run.list_scenario_runs()
         assert isinstance(scenario_runs, list)
 
+        # Verify returned items are ScenarioRun objects
+        for scenario_run in scenario_runs:
+            assert isinstance(scenario_run, ScenarioRun)
+            assert scenario_run.id is not None
+            assert scenario_run.devbox_id is not None
+
 
 class TestBenchmarkRunLifecycle:
     """Test BenchmarkRun lifecycle operations."""
@@ -96,8 +101,7 @@ def test_benchmark_run_create_and_cancel(self, sdk_client: RunloopSDK) -> None:
         4. Cancels the run
         """
         # Find an existing benchmark via raw API
-        benchmarks_page = sdk_client.api.benchmarks.list(limit=1)
-        benchmarks = list(benchmarks_page)
+        benchmarks = sdk_client.api.benchmarks.list(limit=1).benchmarks
 
         if not benchmarks:
             pytest.skip("No benchmarks available to test")