Merge branch 'main' into 127_add_converters

Author: olliesilvester

tests/unit_tests/conftest.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from unittest.mock import patch
 
 import pytest
@@ -7,13 +8,22 @@
 from daq_config_server.whitelist import get_whitelist
 from tests.constants import TEST_WHITELIST_RESPONSE
 
+WHITELIST_PATH = Path(__file__).resolve().parents[2] / "whitelist.yaml"
+
 
 @pytest.fixture(autouse=True)
 def test_friendly_whitelist(request: FixtureRequest):
     # Don't launch threads unless we really need to since it slows down testing
 
     with patch("daq_config_server.whitelist.requests.get") as mock_request:
-        mock_request.return_value = make_test_response(content=TEST_WHITELIST_RESPONSE)
+        if "test_whitelist.py" in str(request.path):
+            with open(WHITELIST_PATH) as f:
+                whitelist_contents = f.read()
+            mock_request.return_value = make_test_response(content=whitelist_contents)
+        else:
+            mock_request.return_value = make_test_response(
+                content=TEST_WHITELIST_RESPONSE
+            )
 
         if request.node.get_closest_marker("use_threading"):  # type: ignore
             with patch("daq_config_server.whitelist.WHITELIST_REFRESH_RATE_S", new=0):

tests/unit_tests/test_whitelist.py

@@ -5,44 +5,33 @@
 
 import pytest
 
-from daq_config_server.testing import make_test_response
 from daq_config_server.whitelist import WhitelistFetcher, get_whitelist
 
-FAKE_WHITELIST_RESPONSE = """\
-whitelist_files:
-  - /test/file1.txt
-  - /test/file2.txt
-whitelist_dirs:
-  - /test/dir1
-  - /test/dir2
-"""
+"""The tests in this file will read directly from the whitelist.yaml in the current
+branch"""
 
 
-def test_fetch_and_update_contructs_whitelist_given_yaml_response():
-    with patch("daq_config_server.whitelist.requests.get") as mock_request:
-        mock_request.return_value = make_test_response(content=FAKE_WHITELIST_RESPONSE)
-        whitelist = get_whitelist()
-        expected_files = {Path("/test/file1.txt"), Path("/test/file2.txt")}
-        expected_dirs = {Path("/test/dir1"), Path("/test/dir2")}
-        assert whitelist.whitelist_files == expected_files
-        assert whitelist.whitelist_dirs == expected_dirs
+def test_fetch_and_update_contructs_whitelist_given_yaml():
+    whitelist = get_whitelist()
+    expected_files = {
+        Path("/tests/test_data/beamline_parameters.txt"),
+    }
+    expected_dirs = {
+        Path("/tests/test_data/"),
+        Path("/dls_sw/i03/software/daq_configuration/"),
+    }
+    assert expected_files.issubset(whitelist.whitelist_files)
+    assert expected_dirs.issubset(whitelist.whitelist_dirs)
 
 
 @patch("daq_config_server.whitelist.LOGGER.info")
-@patch("daq_config_server.whitelist.requests.get")
-def test_initial_load_on_sucessful_fetch(
-    mock_request: MagicMock, mock_log_info: MagicMock
-):
-    mock_request.return_value = make_test_response(content=FAKE_WHITELIST_RESPONSE)
+def test_initial_load_on_sucessful_fetch(mock_log_info: MagicMock):
     get_whitelist()
     mock_log_info.assert_called_once_with("Successfully read whitelist from GitHub.")
 
 
 @patch("daq_config_server.whitelist.LOGGER.error")
-@patch("daq_config_server.whitelist.requests.get")
-def test_initial_load_on_failed_fetch(
-    mock_request: MagicMock, mock_log_error: MagicMock
-):
+def test_initial_load_on_failed_fetch(mock_log_error: MagicMock):
     WhitelistFetcher._fetch_and_update = MagicMock(side_effect=Exception("blah"))
     with pytest.raises(RuntimeError):
         get_whitelist()
@@ -52,10 +41,7 @@ def test_initial_load_on_failed_fetch(
 @pytest.mark.use_threading
 @patch("daq_config_server.whitelist.LOGGER.error")
 @patch("daq_config_server.whitelist.WHITELIST_REFRESH_RATE_S", new=0)
-@patch("daq_config_server.whitelist.requests.get")
-def test_periodically_update_whitelist_on_failed_update(
-    mock_request: MagicMock, mock_log_error: MagicMock
-):
+def test_periodically_update_whitelist_on_failed_update(mock_log_error: MagicMock):
     WhitelistFetcher._initial_load = MagicMock()
     WhitelistFetcher._fetch_and_update = MagicMock(side_effect=Exception("blah"))
     get_whitelist()
@@ -66,10 +52,7 @@ def test_periodically_update_whitelist_on_failed_update(
 @pytest.mark.use_threading
 @patch("daq_config_server.whitelist.LOGGER")
 @patch("daq_config_server.whitelist.WHITELIST_REFRESH_RATE_S", new=0)
-@patch("daq_config_server.whitelist.requests.get")
-def test_periodically_update_whitelist_on_successful_update(
-    mock_request: MagicMock, mock_log: MagicMock
-):
+def test_periodically_update_whitelist_on_successful_update(mock_log: MagicMock):
     logging_event = threading.Event()
     WhitelistFetcher._initial_load = MagicMock()
     WhitelistFetcher._fetch_and_update = MagicMock()

whitelist.yaml

@@ -6,6 +6,15 @@
 #For long-term configuration files
 whitelist_files:
 - /tests/test_data/beamline_parameters.txt
+# The following filepaths should be un-whitelisted once they've been moved to **/daq_configuration/
+# See https://jira.diamond.ac.uk/browse/MXGDA-4204
+- /dls_sw/i03/software/gda/configurations/i03-config/xml/jCameraManZoomLevels.xml
+- /dls_sw/i04/software/bluesky/scratch/jCameraManZoomLevels.xml
+- /dls_sw/i19-1/software/gda_versions/gda/config/xml/jCameraManZoomLevels.xml
+- /dls_sw/i24/software/gda_versions/gda/config/xml/jCameraManZoomLevels.xml
+- /dls_sw/i03/software/gda_versions/var/display.configurations
+- /dls_sw/i04/software/bluesky/scratch/display.configuration
+- /dls_sw/i24/software/gda_versions/var/display.configuration
 
 #For long-term directories with frequently changing files
 whitelist_dirs: