Skip to content

Commit 5dd850d

Browse files
committed
docs: add docstring to test_scenario
1 parent cd1007c commit 5dd850d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

tests_integration/test_integration.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,22 @@ def test_scenario(
254254
mitmproxy,
255255
request: pytest.FixtureRequest,
256256
):
257+
"""
258+
Execute the test scenario given by the scenario fixture (note that the fixture is
259+
parameterized and therefore we run this for all scenarios).
260+
All steps of the bot are executed in sequence to test its end-to-end functionality.
261+
262+
A test scenario assigns one test case to each feedstock. For details on
263+
the testing setup, please refer to the README.md in the tests_integration
264+
(i.e., parent) directory.
265+
266+
:param use_containers: Whether container mode is enabled or not.
267+
:param scenario: The test scenario to run. This is a tuple of (scenario_id, scenario),
268+
where scenario is a dictionary with the feedstock name as key and the test case name as value.
269+
:param repositories_setup: The fixture that sets up the repositories.
270+
:param mitmproxy: The fixture that sets up the mitmproxy.
271+
:param request: The pytest fixture request object.
272+
"""
257273
_, scenario = scenario
258274

259275
if not use_containers:

0 commit comments

Comments
 (0)