Add system tests WIP

Author: jacob720

src/daq_config_server/converters/_converter_utils.py

@@ -31,9 +31,10 @@ def parse_lut_to_dict(
     """Converts a lookup table to a dict, containing the names of each column and
     the rows as a 2D list.
 
-    Any args after the contents should be a tuple of (column name, type | None).
+    Any args after the contents provide the column names and optionally, python types
+    for values in a column to be converted to. e.g: (energy_EV, float), (pixels, int).
     If a type is provided, the values in that column will be converted to that type.
-    Otherwise, the type will be inferred. Please include units in the column name.
+    Otherwise, the type will be inferred. Units should be included in the column name.
     """
     data: list[list[Any]] = []
     column_names = [param[0] for param in params]

src/daq_config_server/converters/_file_converter_map.py

@@ -1,6 +1,8 @@
 from collections.abc import Callable
 from typing import Any
 
+from tests.constants import ServerFilePaths
+
 from daq_config_server.converters._converters import (
     beamline_parameters_to_dict,
     beamline_pitch_lut_to_dict,
@@ -12,6 +14,7 @@
 )
 
 FILE_TO_CONVERTER_MAP: dict[str, Callable[[str], Any]] = {
+    str(ServerFilePaths.GOOD_LUT): undulator_energy_gap_lut_to_dict,  # For system tests
     "/dls_sw/i23/software/aithre/aithre_display.configuration": display_config_to_dict,
     "/dls_sw/i03/software/gda_versions/var/display.configuration": display_config_to_dict,
     "/dls_sw/i04/software/bluesky/scratch/display.configuration": display_config_to_dict,

tests/conftest.py

@@ -0,0 +1,30 @@
+from collections.abc import Callable, Generator
+from typing import Any
+from unittest.mock import patch
+
+import pytest
+
+from daq_config_server.converters._converters import (
+    beamline_parameters_to_dict,
+    display_config_to_dict,
+    undulator_energy_gap_lut_to_dict,
+    xml_to_dict,
+)
+from tests.constants import ServerFilePaths, TestDataPaths
+
+
+@pytest.fixture
+def mock_file_converter_map() -> Generator[dict[str, Callable[[str], Any]], None, None]:
+    with patch(
+        "daq_config_server.converters._file_converter_map.FILE_TO_CONVERTER_MAP",
+        {
+            str(TestDataPaths.TEST_GOOD_XML_PATH): xml_to_dict,
+            str(
+                TestDataPaths.TEST_BEAMLINE_PARAMETERS_PATH
+            ): beamline_parameters_to_dict,
+            str(TestDataPaths.TEST_GOOD_LUT_PATH): undulator_energy_gap_lut_to_dict,
+            str(TestDataPaths.TEST_GOOD_DISPLAY_CONFIG_PATH): display_config_to_dict,
+            str(ServerFilePaths.GOOD_LUT): undulator_energy_gap_lut_to_dict,
+        },
+    ) as mock_map:
+        yield mock_map

tests/constants.py

@@ -52,6 +52,7 @@ class ServerFilePaths:
     GOOD_JSON_FILE = Path("/tests/test_data/test_good_json.json")
     BAD_JSON_FILE = Path("/tests/test_data/test_bad_json")
     FILE_IN_GOOD_DIR = Path("/tests/test_data/test_bad_json")
+    GOOD_LUT = Path("/tests/test_data/test_good_lut.txt")
 
 
 TEST_CONFIG_PATH = TEST_DATA_DIR_PATH.joinpath("test_config.yaml")

tests/system_tests/test_client.py

@@ -6,6 +6,7 @@
 import pytest
 import requests
 
+import daq_config_server.converters._file_converter_map as file_converter_map
 from daq_config_server.client import ConfigServer
 from tests.constants import (
     ServerFilePaths,
@@ -104,3 +105,20 @@ def test_request_with_file_not_on_whitelist(server: ConfigServer):
         server.get_file_contents(
             file_path,
         )
+
+
+@pytest.mark.requires_local_server
+def test_request_for_file_with_converter_works(server: ConfigServer):
+    expected = {
+        "column_names": ["energy_eV", "gap_mm"],
+        "data": [[5700, 5.4606], [5760, 5.5], [6000, 5.681], [6500, 6.045]],
+    }
+    result = server.get_file_contents(ServerFilePaths.GOOD_LUT, dict)
+    assert result == expected
+
+
+@pytest.mark.requires_local_server
+def test_all_files_in_file_converter_map_can_be_converted_to_dict(server: ConfigServer):
+    for filename in file_converter_map.FILE_TO_CONVERTER_MAP.keys():
+        result = server.get_file_contents(filename, dict)
+        assert isinstance(result, dict)

tests/unit_tests/test_convert.py

@@ -1,7 +1,8 @@
 import json
+from collections.abc import Callable
 from pathlib import Path
 from typing import Any
-from unittest.mock import MagicMock, patch
+from unittest.mock import MagicMock
 
 import pytest
 
@@ -27,14 +28,15 @@ def test_all_files_in_dict_can_be_parsed_with_no_errors():
         get_converted_file_contents(Path(filename))
 
 
-def test_get_converted_file_contents_uses_converter_if_file_in_map():
+def test_get_converted_file_contents_uses_converter_if_file_in_map(
+    mock_file_converter_map: dict[str, Callable[[str], Any]],
+):
     file_to_convert = TestDataPaths.TEST_GOOD_XML_PATH
     mock_convert_function = MagicMock()
-    with patch(
-        "daq_config_server.converters._file_converter_map.FILE_TO_CONVERTER_MAP",
-        {str(file_to_convert): mock_convert_function},
-    ):
-        get_converted_file_contents(file_to_convert)
+    mock_file_converter_map[str(TestDataPaths.TEST_GOOD_XML_PATH)] = (
+        mock_convert_function
+    )
+    get_converted_file_contents(file_to_convert)
 
     mock_convert_function.assert_called_once()