Merge pull request #39 from paulsuh/feature-responses-native-file-load

Feature - Responses native file load

Author: paulsuh

CHANGES.md

@@ -1,5 +1,9 @@
 # Change Log
 
+#### 1.3.0 - 2025-09-02
+
+- Add loading of native Responses files.
+
 #### 1.2.1 - 2025-08-11
 
 - Update tests to ensure compatibility with pytest 8.4.

README.md

@@ -35,7 +35,8 @@ YAML format.
 - Can specify indirect parameterization
 - Intuitive and sane data file structure
 - Integration with [Responses][link08]
-- **NEW** - Integration with [Respx][link09]
+- **NEW** - Can load native Responses files
+- Integration with [Respx][link09]
 
 ### Compatibility
 

docs/source/about.rst

@@ -15,11 +15,13 @@ open source software.
 
 Future Directions
 -----------------
-- Support for loading native Responses files is planned.
 - Support for additional matchers for both Responses and Respx (for matching
   headers, query parameters, json body, etc.) is under consideration.
 - An automated method for specifying Responses or Respx overrides is under
   consideration.
+- I'm going to see if there is any traction for rolling the (relatively simple)
+  code to specify parameterization into ``pytest`` so that it becomes easier
+  for other people.
 
 Motivation
 ----------
@@ -45,6 +47,10 @@ many of them, and also which group of values corresponds to which test id. The f
 structure uses a dict to keep the test case id’s, fixture names, and data values
 together in a way that is easier on the human brain.
 
+Loading the native Responses save files wasn't too hard. The worst part was figuring
+out how to specify the file to be loaded, and fixing up the tests so that they covered
+the cases.
+
 ----
 
 This plug-in was originally named ``pytest-parameterize-from-files``. It was inspired by

docs/source/conf.py

@@ -13,7 +13,7 @@
 project = "Pytest Scenario Files"
 copyright = "2024, 2025 Paul Suh"
 author = "Paul Suh"
-release = "1.2"
+release = "1.3"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/responses_integration.rst

@@ -72,6 +72,21 @@ code checks to see whether the loaded value is a dict or a list and
 handles it accordingly. Having both suffixes is just to make reading
 the data files easier for humans.
 
+If a fixture with a name that ends in ``_response`` or ``_responses``
+has a string value, the string will be treated as the name of a file in the
+native Responses format. The contents of this file will be loaded into the
+``psf_responses`` fixture using the Responses internal data file loading
+mechanism in addition to any other responses. The search path for locating
+this file will be the same as for other data files.
+
+.. code-block:: yaml
+
+    scenario_3:
+      native_file_responses: responses_replay_data.yaml
+
+Responses data for scenario_3 will be loaded from a file named
+``responses_replay_data.yaml``.
+
 The ``psf-responses`` fixture
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Pytest-Scenario-Files provides a ``psf_responses`` fixture that is used

src/pytest_scenario_files/plugin.py

@@ -5,6 +5,7 @@
 from contextlib import AbstractContextManager, nullcontext
 from json import load
 from os.path import join
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Literal, NamedTuple, Union, cast
 
 import pytest
@@ -301,7 +302,10 @@ def psf_responses(request: pytest.FixtureRequest) -> Generator[RequestsMock, Non
     psf_fire_all_responses = _psf_configs.psf_fire_all_responses
     with RequestsMock(assert_all_requests_are_fired=psf_fire_all_responses) as rsps:
         for one_response in request.param:
-            rsps.add(**one_response)
+            if isinstance(one_response, Path):
+                rsps._add_from_file(one_response)
+            else:
+                rsps.add(**one_response)
         yield rsps
 
 
@@ -403,6 +407,7 @@ def _extract_responses(
     :param fixture_key: name of the fixture key that will be added
     :type fixture_key: value must be "psf_responses_indirect" or "psf_respx_mock_indirect"
     """
+    # TODO: once we hit a minimum of Python 3.11, switch fixture_key to be a StrEnum
     # for each scenario
     #   for each fixture
     #       check if fixture name ends with _responses or _response
@@ -421,18 +426,32 @@ def _extract_responses(
         # Need to differentiate between the case where responses are not specified
         # at all and where there are only null responses
         if len(responses_fixture_names) > 0:
-            psf_responses_data = []
+            psf_responses_data: list[dict[str, str] | Path] = []
             for one_fixture_name in responses_fixture_names:
                 current_fixture_data = one_scenario.pop(one_fixture_name)
                 # TODO: once Python 3.9 is EOL, change this to the cleaner structural
                 #  pattern matching form.
                 # It's entirely possible that the contents of either the list
                 # or the dict are not usable, but that will be caught when the
                 # mocks are constructed.
+                # breakpoint()
                 if isinstance(current_fixture_data, list):
                     psf_responses_data.extend(current_fixture_data)
                 elif isinstance(current_fixture_data, dict):
                     psf_responses_data.append(current_fixture_data)
+                elif isinstance(current_fixture_data, str) and fixture_key == "psf_responses_indirect":
+                    # if it doesn't find the Responses file (or it finds it more than once) raise an exception
+                    file_loc = tuple(Path.cwd().rglob(current_fixture_data))
+                    if len(file_loc) == 0:
+                        raise RuntimeError(
+                            f"Pytest-Scenario-Files: {one_fixture_name}: file '{current_fixture_data}' not found."
+                        )
+                    elif len(file_loc) > 1:
+                        raise RuntimeError(
+                            f"Pytest-Scenario-Files: {one_fixture_name}: file '{current_fixture_data}' multiple copies found."
+                        )
+                    file_abs_path_obj = file_loc[0].resolve(strict=True)
+                    psf_responses_data.append(file_abs_path_obj)
                 elif current_fixture_data is None:
                     pass
                 else:

tests/failure cases/test_load_responses_failure.py

@@ -0,0 +1,41 @@
+"""Test indirect fixture loading"""
+
+import pytest
+
+# skip these tests if the responses module is not present
+responses = pytest.importorskip("responses")
+
+
+def test_load_native_responses_failure_bad_filename(pytester: pytest.Pytester):
+    # create the test code file
+    test_file_path = pytester.copy_example("example_test_native_responses_failure_tester.py")
+    test_file_path.rename("test_native_responses_failure_tester.py")
+
+    # create the data file and native Responses file
+    pytester.copy_example("data_native_responses_failure_tester_bad_filename.yaml")
+
+    result = pytester.runpytest("-v", "--psf-load-responses")
+
+    result.assert_outcomes(errors=1)
+
+
+def test_load_native_responses_failure_duplicate_files(pytester: pytest.Pytester):
+    # create the test code file
+    test_file_path = pytester.copy_example("example_test_native_responses_failure_tester.py")
+    test_file_path.rename("test_native_responses_failure_tester.py")
+
+    # create the data file and two copies of the native Responses file
+    pytester.copy_example("data_native_responses_failure_tester_duplicate_files.yaml")
+
+    # first copy goes into subdir
+    datafile_path = pytester.copy_example("responses_replay_data.yaml")
+    subdir_path = datafile_path.parent / "subdir"
+    subdir_path.mkdir()
+    datafile_path.rename(subdir_path / datafile_path.name)
+
+    # second copy at top level
+    pytester.copy_example("responses_replay_data.yaml")
+
+    result = pytester.runpytest("-v", "--psf-load-responses")
+
+    result.assert_outcomes(errors=1)

tests/failure cases/test_responses_fixture_data_not_dict_or_list.py

@@ -11,9 +11,7 @@ def test_responses_fixture_data_not_dict_or_list(pytester):
     # create the data files
     pytester.copy_example("data_responses_fixture_data_not_dict_or_list_tester_1.yaml")
 
-    result = pytester.runpytest(
-        "-k", "test_responses_fixture_data_not_dict_or_list_tester", "--psf-load-responses", "-v"
-    )
+    result = pytester.runpytest("-k", "test_responses_fixture_data_not_dict_or_list_tester", "--psf-load-respx", "-v")
 
     result.assert_outcomes(errors=1)
     result.stdout.fnmatch_lines("E   RuntimeError: Pytest-Scenario-Files: example_responses is not a list or dict.")

tests/pytester_example_files/data_native_responses_failure_tester_bad_filename.yaml

@@ -0,0 +1,5 @@
+test_1:
+  native_file_responses: bad_filename.yaml
+  psf_expected_result_indirect:
+    expected_exception_name: RuntimeError
+  target_url: https://httpstat.us/202

tests/pytester_example_files/data_native_responses_failure_tester_duplicate_files.yaml

@@ -0,0 +1,10 @@
+#test_1:
+#  native_file_responses: bad_filename.yaml
+#  psf_expected_result_indirect:
+#    expected_exception_name: RuntimeError
+#  target_url: https://httpstat.us/202
+
+test_2:
+  native_file_responses: responses_replay_data.yaml
+  psf_expected_result_indirect: 202 Accepted
+  target_url: https://httpstat.us/202