diff --git a/BlockServer/core/ioc_control.py b/BlockServer/core/ioc_control.py index a10de230..80efc6f3 100644 --- a/BlockServer/core/ioc_control.py +++ b/BlockServer/core/ioc_control.py @@ -13,15 +13,15 @@ # along with this program; if not, you can obtain a copy from # https://www.eclipse.org/org/documents/epl-v10.php or # http://opensource.org/licenses/eclipse-1.0.php - from time import sleep, time -from typing import List -from BlockServer.alarm.load_alarm_config import AlarmConfigLoader -from BlockServer.epics.procserv_utils import ProcServWrapper +from server_common.common_exceptions import MaxAttemptsExceededException from server_common.constants import IOCS_NOT_TO_STOP from server_common.utilities import print_and_log +from BlockServer.alarm.load_alarm_config import AlarmConfigLoader +from BlockServer.epics.procserv_utils import ProcServWrapper + class IocControl: """A class for starting, stopping and restarting IOCs""" @@ -45,7 +45,7 @@ def start_ioc(self, ioc: str, restart_alarm_server: bool = True) -> None: self._proc.start_ioc(ioc) if ioc != "ALARM" and restart_alarm_server: AlarmConfigLoader.restart_alarm_server(self) - except Exception as err: + except OSError as err: print_and_log(f"Could not start IOC {ioc}: {err}", "MAJOR") def restart_ioc(self, ioc: str, force: bool = False, restart_alarm_server: bool = True) -> None: @@ -66,7 +66,7 @@ def restart_ioc(self, ioc: str, force: bool = False, restart_alarm_server: bool self._proc.restart_ioc(ioc) if ioc != "ALARM" and restart_alarm_server: AlarmConfigLoader.restart_alarm_server(self) - except Exception as err: + except OSError as err: print_and_log(f"Could not restart IOC {ioc}: {err}", "MAJOR") def stop_ioc(self, ioc: str, force: bool = False) -> None: @@ -83,7 +83,7 @@ def stop_ioc(self, ioc: str, force: bool = False) -> None: self._proc.stop_ioc(ioc) if ioc != "ALARM": AlarmConfigLoader.restart_alarm_server(self) - except Exception as err: + except OSError as err: print_and_log(f"Could not stop IOC {ioc}: {err}", "MAJOR") def get_ioc_status(self, ioc: str) -> str: @@ -108,7 +108,7 @@ def ioc_restart_pending(self, ioc: str) -> bool: """ return self._proc.ioc_restart_pending(ioc) - def start_iocs(self, iocs: List[str]) -> None: + def start_iocs(self, iocs: list[str]) -> None: """Start a number of IOCs. Args: @@ -117,14 +117,14 @@ def start_iocs(self, iocs: List[str]) -> None: for ioc in iocs: self.start_ioc(ioc) - def restart_iocs(self, iocs: List[str], reapply_auto: bool = False) -> None: + def restart_iocs(self, iocs: list[str], reapply_auto: bool = False) -> None: """Restart a number of IOCs. Args: iocs (list): The IOCs to restart reapply_auto (bool): Whether to reapply auto restart settings automatically """ - auto = dict() + auto = {} for ioc in iocs: auto[ioc] = self.get_autorestart(ioc) self.restart_ioc(ioc) @@ -135,7 +135,7 @@ def restart_iocs(self, iocs: List[str], reapply_auto: bool = False) -> None: self.waitfor_running(ioc) self.set_autorestart(ioc, auto[ioc]) - def stop_iocs(self, iocs: List[str]) -> None: + def stop_iocs(self, iocs: list[str]) -> None: """Stop a number of IOCs. Args: @@ -156,7 +156,7 @@ def ioc_exists(self, ioc: str) -> bool: try: self.get_ioc_status(ioc) return True - except Exception: + except OSError: return False def set_autorestart(self, ioc: str, enable: bool) -> None: @@ -178,7 +178,7 @@ def set_autorestart(self, ioc: str, enable: bool) -> None: print_and_log(f"Auto-restart for IOC {ioc} is already {enable}") else: print_and_log(f"Auto-restart for IOC {ioc} unchanged as IOC is not running") - except Exception as err: + except MaxAttemptsExceededException as err: print_and_log(f"Could not set auto-restart IOC {ioc}: {err}", "MAJOR") def get_autorestart(self, ioc: str) -> bool: @@ -192,8 +192,9 @@ def get_autorestart(self, ioc: str) -> bool: """ try: return self._proc.get_autorestart(ioc) - except Exception as err: + except MaxAttemptsExceededException as err: print_and_log(f"Could not get auto-restart setting for IOC {ioc}: {err}", "MAJOR") + return False def waitfor_running(self, ioc: str, timeout: int = 15) -> None: """Waits for the IOC to start running. diff --git a/BlockServer/epics/gateway.py b/BlockServer/epics/gateway.py index ff658171..f1d5113b 100644 --- a/BlockServer/epics/gateway.py +++ b/BlockServer/epics/gateway.py @@ -23,6 +23,8 @@ from server_common.helpers import CONTROL_SYSTEM_PREFIX from server_common.utilities import print_and_log +from BlockServer.config.block import Block + ALIAS_HEADER = """\ ## EVALUATION ORDER ALLOW, DENY @@ -30,21 +32,26 @@ """ ALIAS_FOOTER = r""" -## serve blockserver internal variables, including Flag variables needed by blockserver process to restart gateway +## serve blockserver internal variables, including Flag variables needed by +## blockserver process to restart gateway {0}CS:GATEWAY:BLOCKSERVER:.* ALLOW ANYBODY 1 ## allow anybody to generate gateway reports {0}CS:GATEWAY:BLOCKSERVER:report[1-9]Flag ALLOW ANYBODY 1 -## ignore any request related to run control/alerts etc. (RC,AC,DC) on blocks, these are handled by RUNCTRL ioc +## ignore any request related to run control/alerts etc. (RC,AC,DC) on blocks, +## these are handled by RUNCTRL ioc {0}CS:SB:[^:]*:[ADR]C:.* DENY ## ignore any request not related to local blocks or gateway itself !{0}CS:\(SB\|GATEWAY\):.* DENY -""" # noqa: E501 +""" def build_block_alias_lines( - full_block_pv: str, pv_suffix: str, underlying_pv: str, include_comments: bool = True + full_block_pv: str, + pv_suffix: str | None, + underlying_pv: str, + include_comments: bool = True, ) -> list[str]: - lines = list() + lines = [] if underlying_pv.endswith(":SP"): # The block points at a setpoint if include_comments: @@ -53,7 +60,7 @@ def build_block_alias_lines( "genie_python will append an additional :SP" ) - full_block_pv = r"{}\(:SP\)?".format(full_block_pv) + full_block_pv = rf"{full_block_pv}\(:SP\)?" # Pattern match is for picking up any extras like :RBV or .EGU lines.append(f"{full_block_pv}\\([.:].*\\) ALIAS {underlying_pv}\\2") @@ -121,7 +128,7 @@ def exists(self) -> bool: """ return ChannelAccess.caget(self._gateway_prefix + "pvtotal") is not None - def _reload(self) -> None: + def reload(self) -> None: print_and_log("Reloading gateway") try: # Have to wait after put as the gateway does not do completion callbacks @@ -131,16 +138,16 @@ def _reload(self) -> None: while ChannelAccess.caget(self._gateway_prefix + "newAsFlag") == 1: time.sleep(1) print_and_log("Gateway reloaded") - except Exception as err: + except OSError as err: print_and_log(f"Problem with reloading the gateway {err}") - def _generate_alias_file(self, blocks=None) -> None: + def _generate_alias_file(self, blocks: dict[str, Block] | None = None) -> None: # Generate blocks.pvlist for gateway with open(self._pvlist_file, "w") as f: header = ALIAS_HEADER.format(self._inst_prefix) f.write(header) if blocks is not None: - for name, value in blocks.items(): + for value in blocks.values(): lines = self.generate_alias(value.name, value.pv, value.local) f.write("\n".join(lines) + "\n") f.write(ALIAS_FOOTER.format(self._inst_prefix)) @@ -175,7 +182,9 @@ def generate_alias(self, block_name: str, underlying_pv: str, local: bool) -> li lines.append("") # New line to seperate out each block return lines - def set_new_aliases(self, blocks, configures_block_gateway: bool, config_dir: str) -> None: + def set_new_aliases( + self, blocks: dict[str, Block] | None, configures_block_gateway: bool, config_dir: str + ) -> None: """Creates the aliases for the blocks and restarts the gateway. Args: @@ -187,11 +196,11 @@ def set_new_aliases(self, blocks, configures_block_gateway: bool, config_dir: st """ pvlist_file = os.path.join(config_dir, "gwblock.pvlist") if configures_block_gateway and os.path.exists(pvlist_file): - print_and_log("Using {} to configure block gateway".format(pvlist_file)) + print_and_log(f"Using {pvlist_file} to configure block gateway") copyfile(pvlist_file, self._pvlist_file) elif configures_block_gateway: - print_and_log("File: {} not found generating gwblock.pvlist".format(pvlist_file)) + print_and_log(f"File: {pvlist_file} not found generating gwblock.pvlist") self._generate_alias_file(blocks) else: self._generate_alias_file(blocks) - self._reload() + self.reload() diff --git a/BlockServer/epics/procserv_utils.py b/BlockServer/epics/procserv_utils.py index caac5387..97df02c1 100644 --- a/BlockServer/epics/procserv_utils.py +++ b/BlockServer/epics/procserv_utils.py @@ -13,6 +13,8 @@ # along with this program; if not, you can obtain a copy from # https://www.eclipse.org/org/documents/epl-v10.php or # http://opensource.org/licenses/eclipse-1.0.php +import typing + from server_common.channel_access import ChannelAccess from server_common.utilities import ioc_restart_pending, print_and_log, retry @@ -20,14 +22,14 @@ class ProcServWrapper: """A wrapper for accessing some of the functionality of ProcServ.""" - def __init__(self, prefix: str): + def __init__(self, prefix: str) -> None: """Constructor. Args: prefix (string): The prefix for the instrument """ self.procserv_prefix = f"{prefix}CS:PS:" - def start_ioc(self, ioc: str): + def start_ioc(self, ioc: str) -> None: """Starts the specified IOC. Args: @@ -36,7 +38,7 @@ def start_ioc(self, ioc: str): print_and_log(f"Starting IOC {ioc}") ChannelAccess.caput(f"{self.procserv_prefix}{ioc}:START", 1) - def stop_ioc(self, ioc: str): + def stop_ioc(self, ioc: str) -> None: """Stops the specified IOC. Args: @@ -45,7 +47,7 @@ def stop_ioc(self, ioc: str): print_and_log(f"Stopping IOC {ioc}") ChannelAccess.caput(f"{self.procserv_prefix}{ioc}:STOP", 1, wait=True) - def restart_ioc(self, ioc: str): + def restart_ioc(self, ioc: str) -> None: """Restarts the specified IOC. Args: @@ -54,7 +56,7 @@ def restart_ioc(self, ioc: str): print_and_log(f"Restarting IOC {ioc}") ChannelAccess.caput(f"{self.procserv_prefix}{ioc}:RESTART", 1) - def ioc_restart_pending(self, ioc: str): + def ioc_restart_pending(self, ioc: str) -> bool: """Tests to see if an IOC restart is pending Args: @@ -65,7 +67,7 @@ def ioc_restart_pending(self, ioc: str): """ return ioc_restart_pending(f"{self.procserv_prefix}{ioc}", ChannelAccess) - def get_ioc_status(self, ioc: str): + def get_ioc_status(self, ioc: str) -> str: """Gets the status of the specified IOC. Args: @@ -75,12 +77,12 @@ def get_ioc_status(self, ioc: str): string : The status """ pv_name = f"{self.procserv_prefix}{ioc}:STATUS" - ans = ChannelAccess.caget(pv_name, as_string=True) + ans = typing.cast(str, ChannelAccess.caget(pv_name, as_string=True)) if ans is None: - raise Exception(f"Could not find IOC {ioc} (using pv {pv_name})") + raise OSError(f"Could not find IOC {ioc} (using pv {pv_name})") return ans.upper() - def toggle_autorestart(self, ioc: str): + def toggle_autorestart(self, ioc: str) -> None: """Toggles the auto-restart property. Args: @@ -91,7 +93,7 @@ def toggle_autorestart(self, ioc: str): ChannelAccess.caput(f"{self.procserv_prefix}{ioc}:TOGGLE", 1) @retry(50, 0.1, ValueError) # Retry for 5 seconds to get a valid value on failure - def get_autorestart(self, ioc: str): + def get_autorestart(self, ioc: str) -> bool: """Gets the current auto-restart setting of the specified IOC. Args: diff --git a/BlockServer/test_modules/test_block_server_restart_services.py b/BlockServer/test_modules/test_block_server_restart_services.py new file mode 100644 index 00000000..dc2dc82f --- /dev/null +++ b/BlockServer/test_modules/test_block_server_restart_services.py @@ -0,0 +1,119 @@ +# This file is part of the ISIS IBEX application. +# Copyright (C) 2012-2026 Science & Technology Facilities Council. +# All rights reserved. +# +# This program is distributed in the hope that it will be useful. +# This program and the accompanying materials are made available under the +# terms of the Eclipse Public License v1.0 which accompanies this distribution. +# EXCEPT AS EXPRESSLY SET FORTH IN THE ECLIPSE PUBLIC LICENSE V1.0, THE PROGRAM +# AND ACCOMPANYING MATERIALS ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND. See the Eclipse Public License v1.0 for more details. +# +# You should have received a copy of the Eclipse Public License v1.0 +# along with this program; if not, you can obtain a copy from +# https://www.eclipse.org/org/documents/epl-v10.php or +# http://opensource.org/licenses/eclipse-1.0.php + +import unittest +from unittest.mock import patch + +from ibex_non_ca_helpers.compress_hex import compress_and_hex +from server_common.channel_access import ManagerModeRequiredError +from server_common.helpers import CONTROL_SYSTEM_PREFIX +from server_common.mocks.mock_ca_server import MockCAServer +from server_common.pv_names import BlockserverPVNames, DatabasePVNames + +from block_server import BlockServer + + +class TestBlockServerRestartServiceIoc(unittest.TestCase): + def setUp(self): + self.block_server = BlockServer(MockCAServer(), test_mode=True) + + gateway_patcher = patch.object(self.block_server, "_gateway", create=True) + self.mock_gateway = gateway_patcher.start() + self.addCleanup(gateway_patcher.stop) + + ioc_control_patcher = patch.object(self.block_server, "_ioc_control", create=True) + self.mock_ioc_control = ioc_control_patcher.start() + self.addCleanup(ioc_control_patcher.stop) + + verify_patcher = patch("block_server.verify_manager_mode") + self.mock_verify_manager_mode = verify_patcher.start() + self.addCleanup(verify_patcher.stop) + + ca_patcher = patch("block_server.ChannelAccess") + self.mock_channel_access = ca_patcher.start() + self.addCleanup(ca_patcher.stop) + + exit_patcher = patch("block_server.os._exit") + self.mock_exit = exit_patcher.start() + self.addCleanup(exit_patcher.stop) + + def test_WHEN_restart_service_ioc_pv_written_THEN_restart_queued_with_iocs(self): + value = compress_and_hex('["DBSVR"]').decode("utf-8") + + status = self.block_server.write(BlockserverPVNames.RESTART_SERVICE_IOC, value) + + self.assertTrue(status) + self.assertEqual( + self.block_server.write_queue.get_nowait(), + ( + self.block_server.restart_service_ioc, + (["DBSVR"], True), + "RESTART_SERVICE_IOC", + ), + ) + + def test_GIVEN_manager_mode_WHEN_blocksvr_restarted_THEN_blockserver_restarts(self): + self.block_server.restart_service_ioc(["BLOCKSVR"]) + + self.mock_verify_manager_mode.assert_called_once() + self.mock_exit.assert_called_once_with(0) + + def test_GIVEN_manager_mode_WHEN_gwblock_restarted_THEN_gateway_reloaded(self): + self.block_server.restart_service_ioc(["GWBLOCK"]) + + self.mock_verify_manager_mode.assert_called_once() + self.mock_gateway.reload.assert_called_once() + + def test_GIVEN_manager_mode_WHEN_dbsvr_restarted_THEN_database_server_restart_pv_written( + self, + ): + self.block_server.restart_service_ioc(["DBSVR"]) + + self.mock_verify_manager_mode.assert_called_once() + self.mock_channel_access.caput.assert_called_once_with( + CONTROL_SYSTEM_PREFIX + DatabasePVNames.RESTART, 1 + ) + + def test_GIVEN_manager_mode_WHEN_other_service_ioc_restarted_THEN_restarted_via_ioc_control( + self, + ): + self.block_server.restart_service_ioc(["INSTETC"]) + + self.mock_verify_manager_mode.assert_called_once() + self.mock_ioc_control.restart_ioc.assert_called_once_with("INSTETC", force=True) + + def test_GIVEN_ioc_not_in_service_list_WHEN_restarted_THEN_nothing_restarted(self): + self.block_server.restart_service_ioc(["SIMPLE"]) + + self.mock_verify_manager_mode.assert_not_called() + self.mock_exit.assert_not_called() + self.mock_channel_access.caput.assert_not_called() + self.mock_gateway.reload.assert_not_called() + self.mock_ioc_control.restart_ioc.assert_not_called() + + def test_GIVEN_not_manager_mode_WHEN_service_ioc_restarted_THEN_nothing_restarted( + self, + ): + self.mock_verify_manager_mode.side_effect = ManagerModeRequiredError("not manager") + + with self.assertRaises(ManagerModeRequiredError): + self.block_server.restart_service_ioc(["INSTETC"]) + + self.mock_ioc_control.restart_ioc.assert_not_called() + + +if __name__ == "__main__": + unittest.main() diff --git a/BlockServer/test_modules/test_epics_gateway.py b/BlockServer/test_modules/test_epics_gateway.py index db41e9d3..4ac97cbf 100644 --- a/BlockServer/test_modules/test_epics_gateway.py +++ b/BlockServer/test_modules/test_epics_gateway.py @@ -16,9 +16,9 @@ import os import unittest +from unittest.mock import MagicMock, mock_open, patch -from hamcrest import * -from mock import MagicMock, mock_open, patch +from hamcrest import assert_that, empty from ArchiverAccess.test_modules.stubs import FileStub from BlockServer.config.block import Block @@ -57,18 +57,20 @@ def test_GIVEN_gateway_pv_exists_WHEN_exist_called_THEN_returns_true(self, chann channel_access.caget.assert_called_with(self.gateway_prefix + "pvtotal") def _assert_lines_correct(self, actual_lines, expected_lines): - sanitised_lines = list() + sanitised_lines = [] for line in actual_lines: if not line.startswith("##") and line != "": sanitised_lines.append(line.split()) self.assertListEqual(sanitised_lines, expected_lines) - def test_GIVEN_local_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as_expected(self): + def test_GIVEN_local_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as_expected( + self, + ): blockname, block_pv = "MY_BLOCK", "MY_PV" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "INST:MY_PV\\1"], + [rf"{alias}\([.:].*\)", "ALIAS", "INST:MY_PV\\1"], [alias, "ALIAS", "INST:MY_PV"], ] @@ -76,11 +78,13 @@ def test_GIVEN_local_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as_ self._assert_lines_correct(lines, expected_lines) - def test_GIVEN_remote_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as_expected(self): + def test_GIVEN_remote_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as_expected( + self, + ): blockname, block_pv = "MY_BLOCK", "MY_PV" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "MY_PV\\1"], + [rf"{alias}\([.:].*\)", "ALIAS", "MY_PV\\1"], [alias, "ALIAS", "MY_PV"], ] @@ -88,12 +92,14 @@ def test_GIVEN_remote_PV_without_suffix_or_SP_WHEN_alias_generated_THEN_lines_as self._assert_lines_correct(lines, expected_lines) - def test_GIVEN_local_PV_with_suffix_WHEN_alias_generated_THEN_lines_as_expected(self): + def test_GIVEN_local_PV_with_suffix_WHEN_alias_generated_THEN_lines_as_expected( + self, + ): blockname, block_pv = "MY_BLOCK", "MY_PV.EGU" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "INST:MY_PV\\1"], - ["{}[.]VAL".format(alias), "ALIAS", "INST:MY_PV.EGU"], + [rf"{alias}\([.:].*\)", "ALIAS", "INST:MY_PV\\1"], + [f"{alias}[.]VAL", "ALIAS", "INST:MY_PV.EGU"], [alias, "ALIAS", "INST:MY_PV.EGU"], ] @@ -101,12 +107,14 @@ def test_GIVEN_local_PV_with_suffix_WHEN_alias_generated_THEN_lines_as_expected( self._assert_lines_correct(lines, expected_lines) - def test_GIVEN_remote_PV_with_suffix_WHEN_alias_generated_THEN_lines_as_expected(self): + def test_GIVEN_remote_PV_with_suffix_WHEN_alias_generated_THEN_lines_as_expected( + self, + ): blockname, block_pv = "MY_BLOCK", "MY_PV.RBV" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "MY_PV\\1"], - ["{}[.]VAL".format(alias), "ALIAS", "MY_PV.RBV"], + [rf"{alias}\([.:].*\)", "ALIAS", "MY_PV\\1"], + [f"{alias}[.]VAL", "ALIAS", "MY_PV.RBV"], [alias, "ALIAS", "MY_PV.RBV"], ] @@ -118,8 +126,8 @@ def test_GIVEN_local_PV_with_SP_WHEN_alias_generated_THEN_lines_as_expected(self blockname, block_pv = "MY_BLOCK", "MY_PV:SP" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\(:SP\)?\([.:].*\)".format(alias), "ALIAS", "INST:MY_PV:SP\\2"], - [r"{}\(:SP\)?".format(alias), "ALIAS", "INST:MY_PV:SP"], + [rf"{alias}\(:SP\)?\([.:].*\)", "ALIAS", "INST:MY_PV:SP\\2"], + [rf"{alias}\(:SP\)?", "ALIAS", "INST:MY_PV:SP"], ] lines = self.gateway.generate_alias(blockname, block_pv, True) @@ -130,8 +138,8 @@ def test_GIVEN_remote_PV_with_SP_WHEN_alias_generated_THEN_lines_as_expected(sel blockname, block_pv = "MY_BLOCK", "MY_PV:SP" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\(:SP\)?\([.:].*\)".format(alias), "ALIAS", "MY_PV:SP\\2"], - [r"{}\(:SP\)?".format(alias), "ALIAS", "MY_PV:SP"], + [rf"{alias}\(:SP\)?\([.:].*\)", "ALIAS", "MY_PV:SP\\2"], + [rf"{alias}\(:SP\)?", "ALIAS", "MY_PV:SP"], ] lines = self.gateway.generate_alias(blockname, block_pv, False) @@ -142,8 +150,8 @@ def test_GIVEN_remote_PV_with_VAL_WHEN_alias_generated_THEN_lines_as_expected(se blockname, block_pv = "MY_BLOCK", "MY_TEST.VAL" alias = "INST:BLOCK:MY_BLOCK" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "MY_TEST\\1"], - ["{}".format(alias), "ALIAS", "MY_TEST"], + [rf"{alias}\([.:].*\)", "ALIAS", "MY_TEST\\1"], + [f"{alias}", "ALIAS", "MY_TEST"], ] lines = self.gateway.generate_alias(blockname, block_pv, False) @@ -156,9 +164,9 @@ def test_GIVEN_local_lowercase_PV_without_suffix_or_SP_WHEN_alias_generated_THEN blockname, block_pv = "My_Block", "MY_PV" alias = "INST:BLOCK:My_Block" expected_lines = [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "MY_PV\\1"], + [rf"{alias}\([.:].*\)", "ALIAS", "MY_PV\\1"], [alias, "ALIAS", "MY_PV"], - [r"{}\([.:].*\)".format(alias.upper()), "ALIAS", "MY_PV\\1"], + [rf"{alias.upper()}\([.:].*\)", "ALIAS", "MY_PV\\1"], [alias.upper(), "ALIAS", "MY_PV"], ] @@ -167,7 +175,7 @@ def test_GIVEN_local_lowercase_PV_without_suffix_or_SP_WHEN_alias_generated_THEN self._assert_lines_correct(lines, expected_lines) @patch("BlockServer.epics.gateway.copyfile") - @patch("BlockServer.epics.gateway.Gateway._reload") + @patch("BlockServer.epics.gateway.Gateway.reload") @patch("builtins.open", new_callable=mock_open, mock=FileStub) def test_GIVEN_configuration_has_pvlist_WHEN_set_new_aliases_THEN_pvlist_copied( self, mock_file, reload_mock, copyfile_mock @@ -176,7 +184,15 @@ def test_GIVEN_configuration_has_pvlist_WHEN_set_new_aliases_THEN_pvlist_copied( config_dir = os.path.join(self.config_dir, "non_empty") expected_name = "block" expected_pv = "pv" - blocks = [Block(expected_name, expected_pv, log_periodic=True, log_rate=0, log_deadband=1)] + blocks = { + expected_name: Block( + expected_name, + expected_pv, + log_periodic=True, + log_rate=0, + log_deadband=1, + ) + } self.gateway.set_new_aliases(blocks, True, config_dir) @@ -186,7 +202,7 @@ def test_GIVEN_configuration_has_pvlist_WHEN_set_new_aliases_THEN_pvlist_copied( assert_that(mock_file.file_contents, empty()) @patch("BlockServer.epics.gateway.copyfile") - @patch("BlockServer.epics.gateway.Gateway._reload") + @patch("BlockServer.epics.gateway.Gateway.reload") @patch("builtins.open", new_callable=mock_open, mock=FileStub) def test_GIVEN_configuration_claims_has_pvlist_BUT_does_not_WHEN_set_new_aliases_THEN_pvlist_copied( self, mock_file, reload_mock, copyfile_mock @@ -197,7 +213,11 @@ def test_GIVEN_configuration_claims_has_pvlist_BUT_does_not_WHEN_set_new_aliases expected_pv = "pv" blocks = { expected_name: Block( - expected_name, expected_pv, log_periodic=True, log_rate=0, log_deadband=1 + expected_name, + expected_pv, + log_periodic=True, + log_rate=0, + log_deadband=1, ) } alias = "INST:BLOCK:block" @@ -206,9 +226,13 @@ def test_GIVEN_configuration_claims_has_pvlist_BUT_does_not_WHEN_set_new_aliases for line in ALIAS_HEADER.format("INST:").splitlines() if not line.startswith("##") and line != "" ] + [ - [r"{}\([.:].*\)".format(alias), "ALIAS", "INST:{}\\1".format(expected_pv)], + [rf"{alias}\([.:].*\)", "ALIAS", f"INST:{expected_pv}\\1"], [alias, "ALIAS", "INST:" + expected_pv], - [r"{}\([.:].*\)".format(alias.upper()), "ALIAS", "INST:{}\\1".format(expected_pv)], + [ + rf"{alias.upper()}\([.:].*\)", + "ALIAS", + f"INST:{expected_pv}\\1", + ], [alias.upper(), "ALIAS", "INST:" + expected_pv], ["INST:CS:GATEWAY:BLOCKSERVER:.*", "ALLOW", "ANYBODY", "1"], ["INST:CS:GATEWAY:BLOCKSERVER:report[1-9]Flag", "ALLOW", "ANYBODY", "1"], diff --git a/DatabaseServer/database_server.py b/DatabaseServer/database_server.py index 07665252..80cc9613 100644 --- a/DatabaseServer/database_server.py +++ b/DatabaseServer/database_server.py @@ -1,5 +1,3 @@ -from __future__ import absolute_import, division, print_function, unicode_literals - import argparse import json @@ -22,23 +20,20 @@ import os import sys import traceback +import zlib +from collections.abc import Callable from functools import partial from threading import RLock, Thread from time import sleep -from typing import Callable, Literal +from typing import Literal +import mysql.connector from pcaspy import Driver sys.path.insert(0, os.path.abspath(os.environ["MYDIRBLOCK"])) from genie_python.mysql_abstraction_layer import SQLAbstraction - -from DatabaseServer.exp_data import ExpData, ExpDataSource -from DatabaseServer.mocks.mock_exp_data import MockExpData -from DatabaseServer.moxa_data import MoxaData, MoxaDataSource -from DatabaseServer.options_holder import OptionsHolder -from DatabaseServer.options_loader import OptionsLoader -from DatabaseServer.procserv_utils import ProcServWrapper +from server_common.channel_access import verify_manager_mode from server_common.channel_access_server import CAServer from server_common.constants import IOCS_NOT_TO_STOP from server_common.ioc_data import IOCData @@ -55,6 +50,13 @@ set_logger, ) +from DatabaseServer.exp_data import ExpData, ExpDataSource +from DatabaseServer.mocks.mock_exp_data import MockExpData +from DatabaseServer.moxa_data import MoxaData, MoxaDataSource +from DatabaseServer.options_holder import OptionsHolder +from DatabaseServer.options_loader import OptionsLoader +from DatabaseServer.procserv_utils import ProcServWrapper + set_logger(IsisLogger()) MACROS = { @@ -96,7 +98,7 @@ def __init__( test_mode: Enables starting the server in a mode suitable for unit tests """ if not test_mode: - super(DatabaseServer, self).__init__() + super().__init__() self._blockserver_prefix = blockserver_prefix self._ca_server = ca_server @@ -113,6 +115,10 @@ def __init__( monitor_thread.daemon = True # Daemonise thread monitor_thread.start() + @staticmethod + def restart_pv() -> dict[str, dict[str, str]]: + return {DbPVNames.RESTART: {"type": "int"}} + def _generate_pv_acquisition_info(self) -> dict: """ Generates information needed to get the data for the DB PVs. @@ -203,11 +209,7 @@ def read(self, reason: str) -> bytes: A compressed and hexed JSON formatted string that gives the desired information based on reason. """ - return ( - self.get_data_for_pv(reason) - if reason in self._pv_info.keys() - else self.getParam(reason) - ) + return self.get_data_for_pv(reason) if reason in self._pv_info else self.getParam(reason) def write(self, reason: str, value: str) -> Literal[True]: """ @@ -221,6 +223,10 @@ def write(self, reason: str, value: str) -> Literal[True]: Returns: True """ + if reason == DbPVNames.RESTART: + self._restart() + return True + try: if reason == "ED:RBNUMBER:SP": self._ed.update_experiment_id(value) @@ -230,7 +236,7 @@ def write(self, reason: str, value: str) -> Literal[True]: ) elif reason == "UPDATE_MM": self._moxa_data.update_mappings() - except Exception as e: + except (OSError, ValueError, KeyError, TypeError, zlib.error) as e: value_bytes = compress_and_hex(convert_to_json("Error: " + str(e))) print_and_log(str(e), MAJOR_MSG) self.setParam(reason, value_bytes) @@ -239,6 +245,17 @@ def write(self, reason: str, value: str) -> Literal[True]: self.setParam(reason, value) return True + def _restart(self) -> None: + """ + Exits the process so that the parent procServ restarts it. + """ + verify_manager_mode(message="Attempting to restart the database server") + print_and_log("Restarting Database Server process", INFO_MSG, LOG_TARGET) + + sys.stdout.flush() + sys.stderr.flush() + os._exit(0) + def _update_ioc_monitors(self) -> None: """ Updates all the PVs that hold information on the IOCS and their associated PVs. @@ -257,7 +274,7 @@ def _update_ioc_monitors(self) -> None: ]: encoded_data = self.get_data_for_pv(pv) # No need to update monitors if data hasn't changed - if not self.getParam(pv) == encoded_data: + if self.getParam(pv) != encoded_data: self.setParam(pv, encoded_data) # Update them with self.monitor_lock: @@ -275,8 +292,9 @@ def _check_pv_capacity(self, pv: str, size: int, prefix: str) -> None: """ if size > self._pv_info[pv]["count"]: print_and_log( - "Too much data to encode PV {0}. Current size is {1} characters " - "but {2} are required".format(prefix + pv, self._pv_info[pv]["count"], size), + f"Too much data to encode PV {prefix + pv}. " + f"Current size is {self._pv_info[pv]['count']} characters " + f"but {size} are required", MAJOR_MSG, LOG_TARGET, ) @@ -284,13 +302,16 @@ def _check_pv_capacity(self, pv: str, size: int, prefix: str) -> None: def _get_iocs_info(self) -> dict: iocs = self._iocs.get_iocs() options = self._options_holder.get_config_options() - for iocname in iocs.keys(): + for iocname in iocs: if iocname in options: iocs[iocname].update(options[iocname]) return iocs def _get_pvs( - self, get_method: Callable[[], list | str | dict], replace_pv_prefix: bool, *get_args: str + self, + get_method: Callable[[], list | str | dict], + replace_pv_prefix: bool, + *get_args: str, ) -> list | str | dict: """ Method to get pv data using the given method called with the given arguments and optionally @@ -424,17 +445,18 @@ def _get_iocs_not_to_stop() -> list: if not BLOCKSERVER_PREFIX.endswith(":"): BLOCKSERVER_PREFIX += ":" BLOCKSERVER_PREFIX = BLOCKSERVER_PREFIX.replace("%MYPVPREFIX%", MACROS["$(MYPVPREFIX)"]) - print_and_log("BLOCKSERVER PREFIX = %s" % BLOCKSERVER_PREFIX, INFO_MSG, LOG_TARGET) + print_and_log(f"BLOCKSERVER PREFIX = {BLOCKSERVER_PREFIX}", INFO_MSG, LOG_TARGET) OPTIONS_DIR = os.path.abspath(args.options_dir[0]) - print_and_log("OPTIONS DIRECTORY = %s" % OPTIONS_DIR, INFO_MSG, LOG_TARGET) + print_and_log(f"OPTIONS DIRECTORY = {OPTIONS_DIR}", INFO_MSG, LOG_TARGET) if not os.path.isdir(os.path.abspath(OPTIONS_DIR)): # Create it then os.makedirs(os.path.abspath(OPTIONS_DIR)) SERVER = CAServer(BLOCKSERVER_PREFIX) SERVER.createPV(BLOCKSERVER_PREFIX, DatabaseServer.generate_pv_info()) - SERVER.createPV(MACROS["$(MYPVPREFIX)"], ExpData.EDPV) + SERVER.createPV(BLOCKSERVER_PREFIX, DatabaseServer.restart_pv()) + SERVER.createPV(MACROS["$(MYPVPREFIX)"], ExpData.edpv()) SERVER.createPV(MACROS["$(MYPVPREFIX)"], MoxaData.MDPV) ioc_data = None @@ -451,9 +473,9 @@ def _get_iocs_not_to_stop() -> list: MACROS["$(MYPVPREFIX)"], ) print_and_log("Connected to IOCData database", INFO_MSG, LOG_TARGET) - except Exception: + except (OSError, mysql.connector.Error): print_and_log( - "Problem initialising IOCData DB connection: {}".format(traceback.format_exc()), + f"Problem initialising IOCData DB connection: {traceback.format_exc()}", MAJOR_MSG, LOG_TARGET, ) @@ -463,11 +485,10 @@ def _get_iocs_not_to_stop() -> list: try: exp_data = ExpData(MACROS["$(MYPVPREFIX)"], ExpDataSource()) print_and_log("Connected to experimental details database", INFO_MSG, LOG_TARGET) - except Exception: + except (OSError, mysql.connector.Error): print_and_log( - "Problem connecting to experimental details database: {}".format( - traceback.format_exc() - ), + f"Problem connecting to experimental details database: " + f"{traceback.format_exc()}", MAJOR_MSG, LOG_TARGET, ) @@ -479,11 +500,9 @@ def _get_iocs_not_to_stop() -> list: MACROS["$(MYPVPREFIX)"], ) print_and_log("Connected to moxa details database", INFO_MSG, LOG_TARGET) - except Exception: + except (OSError, mysql.connector.Error): print_and_log( - "Problem connecting to moxa details database: {}".format( - traceback.format_exc() - ), + f"Problem connecting to moxa details database: {traceback.format_exc()}", MAJOR_MSG, LOG_TARGET, ) @@ -500,6 +519,6 @@ def _get_iocs_not_to_stop() -> list: while True: try: SERVER.process(0.1) - except Exception: + except Exception: # noqa BLE001 pcaspy can raise anything from driver callbacks print_and_log(traceback.format_exc(), MAJOR_MSG) break diff --git a/DatabaseServer/exp_data.py b/DatabaseServer/exp_data.py index f3f22d4d..838f2b27 100644 --- a/DatabaseServer/exp_data.py +++ b/DatabaseServer/exp_data.py @@ -1,5 +1,3 @@ -from __future__ import absolute_import, division, print_function, unicode_literals - # This file is part of the ISIS IBEX application. # Copyright (C) 2012-2016 Science & Technology Facilities Council. # All rights reserved. @@ -17,11 +15,11 @@ # http://opensource.org/licenses/eclipse-1.0.php import json import traceback +import typing import unicodedata from typing import TYPE_CHECKING, Union from genie_python.mysql_abstraction_layer import SQLAbstraction - from server_common.channel_access import ChannelAccess from server_common.mocks.mock_ca import MockChannelAccess from server_common.utilities import char_waveform, compress_and_hex, print_and_log @@ -30,7 +28,7 @@ from DatabaseServer.test_modules.test_exp_data import MockExpDataSource -class User(object): +class User: """ A user class to allow for easier conversions from database to json. """ @@ -43,7 +41,7 @@ def __init__( self.role = role -class ExpDataSource(object): +class ExpDataSource: """ This is a humble object containing all the code for accessing the database. """ @@ -74,12 +72,10 @@ def get_team(self, experiment_id: str) -> list: return [] team = [list(element) for element in result] if len(team) == 0: - raise ValueError( - "unable to find team details for experiment ID {}".format(experiment_id) - ) + raise ValueError(f"unable to find team details for experiment ID {experiment_id}") else: return team - except Exception: + except (OSError, ValueError, AssertionError): print_and_log(traceback.format_exc()) return [] @@ -101,25 +97,21 @@ def experiment_exists(self, experiment_id: str) -> bool: if id is None: return False return len(id) >= 1 - except Exception: + except (OSError, AssertionError): print_and_log(traceback.format_exc()) return False -class ExpData(object): +class ExpData: """ A wrapper to connect to the IOC database via MySQL. """ - EDPV = {"ED:RBNUMBER:SP": char_waveform(16000), "ED:USERNAME:SP": char_waveform(16000)} - - _to_ascii = {} - def __init__( self, prefix: str, db: Union[ExpDataSource, "MockExpDataSource"], - ca: Union[ChannelAccess, MockChannelAccess] = ChannelAccess(), + ca: ChannelAccess | MockChannelAccess | None = None, ) -> None: """ Constructor. @@ -138,13 +130,17 @@ def __init__( self._orgspv = prefix + "ED:ORGS" # Set the channel access server to use - self.ca = ca + self.ca = typing.cast(ChannelAccess, ca if not None else ChannelAccess()) # Set the data source to use self._db = db - # Create ascii mappings - ExpData._to_ascii = self._make_ascii_mappings() + @staticmethod + def edpv() -> dict[str, dict[str, str | list[int] | typing.Any]]: + return { + "ED:RBNUMBER:SP": char_waveform(16000), + "ED:USERNAME:SP": char_waveform(16000), + } @staticmethod def _make_ascii_mappings() -> dict: @@ -173,7 +169,7 @@ def encode_for_return(self, data: dict | list) -> bytes: def _get_surname_from_fullname(self, fullname: str) -> str: try: return fullname.split(" ")[-1] - except ValueError | IndexError: + except (ValueError, IndexError): return fullname def update_experiment_id(self, experiment_id: str) -> None: @@ -201,7 +197,7 @@ def update_experiment_id(self, experiment_id: str) -> None: self.ca.caput(self._simnames, self.encode_for_return(names)) self.ca.caput(self._surnamepv, self.encode_for_return(surnames)) self.ca.caput(self._orgspv, self.encode_for_return(orgs)) - raise Exception("error finding the experiment: %s" % experiment_id) + raise OSError(f"error finding the experiment: {experiment_id}") # Get the user information from the database and update the associated PVs if self._db is not None: @@ -211,7 +207,7 @@ def update_experiment_id(self, experiment_id: str) -> None: fullname = str(member[0]) org = str(member[1]) role = str(member[2]) - if not role == "Contact": + if role != "Contact": surnames.append(self._get_surname_from_fullname(fullname)) orgs.append(org) name = User(fullname, org, role.lower()) @@ -250,7 +246,7 @@ def update_username(self, user_str: str) -> None: else: org = team_member["institute"] role = team_member["role"] - if not role == "Contact": + if role != "Contact": surnames.append(self._get_surname_from_fullname(fullname)) orgs.append(org) name = User(fullname, org, role.lower()) @@ -281,4 +277,4 @@ def make_name_list_ascii(names: list) -> bytes: nlist = ",".join(names) nfkd_form = unicodedata.normalize("NFKD", nlist) nlist_no_sc = "".join([c for c in nfkd_form if not unicodedata.combining(c)]) - return nlist_no_sc.translate(ExpData._to_ascii).encode("ascii", "ignore") + return nlist_no_sc.translate(ExpData._make_ascii_mappings()).encode("ascii", "ignore") diff --git a/DatabaseServer/test_modules/test_database_server.py b/DatabaseServer/test_modules/test_database_server.py index 38730c37..eee00b38 100644 --- a/DatabaseServer/test_modules/test_database_server.py +++ b/DatabaseServer/test_modules/test_database_server.py @@ -1,5 +1,3 @@ -from __future__ import absolute_import, division, print_function, unicode_literals - # This file is part of the ISIS IBEX application. # Copyright (C) 2012-2016 Science & Technology Facilities Council. # All rights reserved. @@ -17,8 +15,10 @@ # http://opensource.org/licenses/eclipse-1.0.php import json import os +from unittest import mock +from unittest.mock import patch -import mock +from server_common import channel_access os.environ["MYDIRBLOCK"] = os.path.abspath("..") os.environ["MYPVPREFIX"] = "" @@ -26,8 +26,6 @@ os.environ["ICPCONFIGROOT"] = "" import unittest -from DatabaseServer.database_server import DatabaseServer -from DatabaseServer.mocks.mock_exp_data import MockExpData from server_common.constants import IS_LINUX from server_common.ioc_data import IOCData from server_common.loggers.logger import Logger @@ -43,6 +41,9 @@ ) from server_common.utilities import dehex_and_decompress, set_logger +from DatabaseServer.database_server import DatabaseServer +from DatabaseServer.mocks.mock_exp_data import MockExpData + # Use a dummy logger during tests as real logger requires log server set_logger(Logger()) @@ -78,9 +79,7 @@ def test_interest_high_pvs_correct(self): pv_names = [item[0] for item in pv_data if len(item) > 0] for name in HIGH_PV_NAMES: - self.assertTrue( - name in pv_names, msg="{name} in {pv_names}".format(name=name, pv_names=pv_names) - ) + self.assertTrue(name in pv_names, msg=f"{name} in {pv_names}") @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") def test_interest_medium_pvs_correct(self): @@ -90,9 +89,7 @@ def test_interest_medium_pvs_correct(self): pv_names = [item[0] for item in pv_data if len(item) > 0] for name in MEDIUM_PV_NAMES: - self.assertTrue( - name in pv_names, msg="{name} in {pv_names}".format(name=name, pv_names=pv_names) - ) + self.assertTrue(name in pv_names, msg=f"{name} in {pv_names}") @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") def test_WHEN_asked_for_low_THEN_get_low_pvs(self): @@ -102,9 +99,7 @@ def test_WHEN_asked_for_low_THEN_get_low_pvs(self): pv_names = [item[0] for item in pv_data if len(item) > 0] for name in LOW_PV_NAMES: - self.assertTrue( - name in pv_names, msg="{name} in {pv_names}".format(name=name, pv_names=pv_names) - ) + self.assertTrue(name in pv_names, msg=f"{name} in {pv_names}") @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") def test_interest_facility_pvs_correct(self): @@ -112,14 +107,41 @@ def test_interest_facility_pvs_correct(self): pv_names = [item[0] for item in pv_data if len(item) > 0] for name in FACILITY_PV_NAMES: - self.assertTrue( - name in pv_names, msg="{name} in {pv_names}".format(name=name, pv_names=pv_names) - ) + self.assertTrue(name in pv_names, msg=f"{name} in {pv_names}") @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") def test_iocs_pvs_correct(self): pv_data = json.loads(dehex_and_decompress(self.db_server.read(DatabasePVNames.IOCS))) for name in IOCS: - self.assertTrue( - name in pv_data, msg="{name} in {pv_names}".format(name=name, pv_names=pv_data) - ) + self.assertTrue(name in pv_data, msg=f"{name} in {pv_data}") + + @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") + def test_GIVEN_manager_mode_WHEN_restart_pv_written_THEN_process_restarts(self): + """Writing to DatabasePVNames.RESTART calls os._exit(0) (patched).""" + + with ( + patch( + "DatabaseServer.database_server.verify_manager_mode", + ) as mock_verify_manager_mode, + patch.object(os, "_exit") as mock_exit, + ): + self.db_server.write(reason=DatabasePVNames.RESTART, value="1") + + mock_verify_manager_mode.assert_called_once() + mock_exit.assert_called_with(0) + + @unittest.skipIf(IS_LINUX, "DB server not configured to run properly on Linux build") + def test_GIVEN_not_manager_mode_WHEN_restart_pv_written_THEN_process_does_not_restart(self): + """ManagerModeRequiredError is raised and os._exit is not called.""" + with ( + patch( + "DatabaseServer.database_server.verify_manager_mode", + side_effect=channel_access.ManagerModeRequiredError("not manager"), + ) as mock_verify_manager_mode, + patch.object(os, "_exit") as mock_exit, + ): + with self.assertRaises(channel_access.ManagerModeRequiredError): + self.db_server.write(reason=DatabasePVNames.RESTART, value="1") + + mock_verify_manager_mode.assert_called_once() + mock_exit.assert_not_called() diff --git a/DatabaseServer/test_modules/test_exp_data.py b/DatabaseServer/test_modules/test_exp_data.py index 193b2858..e14ee5a8 100644 --- a/DatabaseServer/test_modules/test_exp_data.py +++ b/DatabaseServer/test_modules/test_exp_data.py @@ -1,5 +1,3 @@ -from __future__ import absolute_import, division, print_function, unicode_literals - import json # This file is part of the ISIS IBEX application. @@ -20,12 +18,13 @@ import typing import unittest -from DatabaseServer.exp_data import ExpData from server_common.mocks.mock_ca import MockChannelAccess from server_common.utilities import dehex_and_decompress +from DatabaseServer.exp_data import ExpData + -class MockExpDataSource(object): +class MockExpDataSource: def __init__(self): self.valid_experiments = { "123456": [["Matt", "ESS", "PI"], ["Dom", "ISIS", ""], ["Jack", "ISIS", "Contact"]] @@ -65,11 +64,8 @@ def test_update_experiment_id_set_orgs_pv(self): self.assertCountEqual(data, ["ESS", "ISIS"]) def test_update_experiment_id_throws_if_experiment_does_not_exists(self): - try: + with self.assertRaises(OSError): self.exp_data.update_experiment_id("000000") - self.fail("Setting invalid experiment id did not throw") - except Exception: - pass def test_single_surname_returns_surname(self): # Arrange diff --git a/block_server.py b/block_server.py index be3e2eb9..49c6351e 100644 --- a/block_server.py +++ b/block_server.py @@ -20,10 +20,15 @@ import os import sys import traceback -from typing import TYPE_CHECKING, Any, Dict +import zlib +import zoneinfo +from pathlib import Path +from typing import TYPE_CHECKING, Any from server_common.channel_access import ManagerModeRequiredError, verify_manager_mode from server_common.channel_access_server import CAServer +from server_common.constants import SERVICE_IOCS +from server_common.mocks.mock_ca_server import MockCAServer sys.path.insert(0, os.path.abspath(os.path.dirname(__file__))) @@ -40,8 +45,13 @@ from pcaspy.driver import Data, manager from server_common.channel_access import ChannelAccess from server_common.file_path_manager import FILEPATH_MANAGER -from server_common.helpers import BLOCK_PREFIX, CONTROL_SYSTEM_PREFIX, MACROS, PVPREFIX_MACRO -from server_common.pv_names import BlockserverPVNames +from server_common.helpers import ( + BLOCK_PREFIX, + CONTROL_SYSTEM_PREFIX, + MACROS, + PVPREFIX_MACRO, +) +from server_common.pv_names import BlockserverPVNames, DatabasePVNames from server_common.utilities import ( char_waveform, convert_from_json, @@ -81,6 +91,9 @@ CURR_CONFIG_NAME_SEVR_VALUE = 0 CONFIG_PUSH_TIME = 300 # 5 minutes INST_SCRIPT_PUSH_TIME = 604800 # 7 days +CONFIG_DIR = "" +SCRIPT_DIR = "" +SCHEMA_DIR = "" # This IOC gets special treatment as it needs to be reloaded on every single config change, # regardless of whether it's macros have changed or not. @@ -117,19 +130,28 @@ "value": CURR_CONFIG_NAME_SEVR_VALUE, "enums": ["NO_ALARM"], }, + BlockserverPVNames.RESTART_SERVICE_IOC: char_waveform(1000), } class BlockServer(Driver): """The class for handling all the static PV access and monitors etc.""" - def __init__(self, ca_server: CAServer) -> None: + def __init__(self, ca_server: CAServer | MockCAServer, test_mode: bool = False) -> None: """Constructor. Args: ca_server (CAServer): The CA server used for generating PVs on the fly """ - super(BlockServer, self).__init__() + + self._test_mode = test_mode + if self._test_mode: + self.write_queue = Queue() + self._service_iocs = SERVICE_IOCS + self.on_the_fly_handlers = [] + return + + super().__init__() # Threading stuff self.monitor_lock = RLock() @@ -151,12 +173,13 @@ def __init__(self, ca_server: CAServer) -> None: self._run_control = None self._syn = None self._devices = None - self.on_the_fly_handlers = list() + self.on_the_fly_handlers = [] self._ioc_control = IocControl(self.instrument_prefix) self.block_rules = BlockRules(self) self.group_rules = GroupRules(self) self.config_desc = ConfigurationDescriptionRules(self) self.spangle_banner = json.dumps(ConfigurationFileManager.get_banner_config()) + self._service_iocs = SERVICE_IOCS # Connect to version control try: @@ -166,13 +189,10 @@ def __init__(self, ca_server: CAServer) -> None: self._config_vc.setup() print_and_log("Config version control initialised correctly", "INFO") except NotUnderVersionControl as err: - print_and_log("Configurations not under version control: %s" % err, "MINOR") + print_and_log(f"Configurations not under version control: {err}", "MINOR") self._config_vc = MockVersionControl() except VersionControlException as err: - print_and_log("Unable to initialise config version control: %s" % err, "MINOR") - self._config_vc = MockVersionControl() - except Exception as err: - print_and_log("Unable to initialise config version control: %s" % err, "MINOR") + print_and_log(f"Unable to initialise config version control: {err}", "MINOR") self._config_vc = MockVersionControl() try: @@ -185,24 +205,22 @@ def __init__(self, ca_server: CAServer) -> None: self._script_vc.setup() print_and_log("Scripting version control initialised correctly", "INFO") except NotUnderVersionControl as err: - print_and_log("Scripts not under version control: %s" % err, "MINOR") + print_and_log(f"Scripts not under version control: {err}", "MINOR") self._script_vc = MockVersionControl() except VersionControlException as err: - print_and_log("Unable to initialise script version control: %s" % err, "MINOR") + print_and_log(f"Unable to initialise script version control: {err}", "MINOR") self._script_vc = MockVersionControl() - except Exception as err: - print_and_log("Unable to initialise script version control: %s" % err, "MINOR") + except Exception as err: # noqa: BLE001 deliberate fallback to MockVersionControl + print_and_log(f"Unable to initialise script version control: {err}", "MINOR") self._script_vc = MockVersionControl() # Import data about all configs try: self._config_list = ConfigListManager(self, ConfigurationFileManager()) - except Exception as err: + except OSError as err: print_and_log( "Error creating inactive config list. " - "Configuration list changes will not be stored " - + "in version control: %s " - % str(err), + "Configuration list changes will not be stored " + f"in version control: {err!s} ", "MINOR", ) self._config_list = ConfigListManager(self, ConfigurationFileManager()) @@ -249,13 +267,13 @@ def initialise_configserver(self, facility: str) -> None: # Import all the synoptic data and create PVs print_and_log("Creating synoptic manager...") if SCHEMA_DIR is not None: - self._syn = SynopticManager(self, SCHEMA_DIR, self._active_configserver) + self._syn = SynopticManager(self, Path(SCHEMA_DIR), self._active_configserver) self.on_the_fly_handlers.append(self._syn) print_and_log("Finished creating synoptic manager") # Import all the devices data and create PVs print_and_log("Creating devices manager...") - self._devices = DevicesManager(self, SCHEMA_DIR) + self._devices = DevicesManager(self, Path(SCHEMA_DIR)) self.on_the_fly_handlers.append(self._devices) print_and_log("Finished creating devices manager") @@ -266,8 +284,8 @@ def initialise_configserver(self, facility: str) -> None: else: print_and_log("Could not connect to gateway - is it running?") self.load_last_config() - except Exception as err: - print_and_log("Could not load last configuration. Message was: %s" % err, "MAJOR") + except Exception as err: # noqa: BLE001 Call chain can cause many types of exceptions + print_and_log(f"Could not load last configuration. Message was: {err}", "MAJOR") self._active_configserver.clear_config() self._initialise_config() @@ -317,7 +335,7 @@ def read(self, reason: str) -> str: return handler.handle_pv_read(reason) value = self.getParam(reason) - except Exception as err: + except Exception as err: # noqa: BLE001 calls arbitrary on_the_fly_handlers and turns any error into a PV value value = compress_and_hex(convert_to_json("Error: " + str(err))) print_and_log(str(err), "MAJOR") return bytes.decode(value, "utf-8") if type(value) is bytes else str(value) @@ -347,7 +365,11 @@ def write(self, reason: str, value: str) -> bool: # type: ignore self.write_queue.put((self.start_iocs, (convert_from_json(data),), "START_IOCS")) elif reason == BlockserverPVNames.STOP_IOCS: self.write_queue.put( - (self._ioc_control.stop_iocs, (convert_from_json(data),), "STOP_IOCS") + ( + self._ioc_control.stop_iocs, + (convert_from_json(data),), + "STOP_IOCS", + ) ) elif reason == BlockserverPVNames.RESTART_IOCS: self.write_queue.put( @@ -357,6 +379,14 @@ def write(self, reason: str, value: str) -> bool: # type: ignore "RESTART_IOCS", ) ) + elif reason == BlockserverPVNames.RESTART_SERVICE_IOC: + self.write_queue.put( + ( + self.restart_service_ioc, + (convert_from_json(data), True), + "RESTART_SERVICE_IOC", + ) + ) elif reason == BlockserverPVNames.SET_CURR_CONFIG_DETAILS: self.write_queue.put((self._set_curr_config, (data,), "SETTING_CONFIG")) elif reason == BlockserverPVNames.SAVE_NEW_CONFIG: @@ -365,7 +395,11 @@ def write(self, reason: str, value: str) -> bool: # type: ignore self.write_queue.put((self.save_config, (data, True), "SAVING_NEW_COMP")) elif reason == BlockserverPVNames.DELETE_CONFIGS: self.write_queue.put( - (self._config_list.delete_configs, (convert_from_json(data),), "DELETE_CONFIGS") + ( + self._config_list.delete_configs, + (convert_from_json(data),), + "DELETE_CONFIGS", + ) ) elif reason == BlockserverPVNames.DELETE_COMPONENTS: self.write_queue.put( @@ -386,7 +420,7 @@ def write(self, reason: str, value: str) -> bool: # type: ignore status = True break - except Exception as err: + except (ValueError, zlib.error) as err: value = str(compress_and_hex(convert_to_json("Error: " + str(err)))) print_and_log(str(err), "MAJOR") else: @@ -394,10 +428,48 @@ def write(self, reason: str, value: str) -> bool: # type: ignore value = str(compress_and_hex(convert_to_json("OK"))) # store the values - if status: + if status and not self._test_mode: self.setParam(reason, value) return status + def restart_service_ioc(self, iocs: list[str], reapply_auto: bool = False) -> None: + """Restart service IOCs. + + Args: + iocs (list): The service IOCs to restart + reapply_auto (bool): Whether to reapply auto restart settings automatically + """ + + for ioc in iocs: + if not ioc.startswith(self._service_iocs): + continue + + verify_manager_mode( + message="Attempting to restart a service IOC')", + ) + + match ioc: + case "BLOCKSVR": + self._restart() + case "GWBLOCK": + self._gateway.reload() + case "DBSVR": + ChannelAccess.caput( + CONTROL_SYSTEM_PREFIX + DatabasePVNames.RESTART, + 1, + ) + case _: + self._ioc_control.restart_ioc(ioc, force=True) + + def _restart(self) -> None: + """Restart the blockserver. + + Assumes it is set up to autorestart by its parent procserv process.""" + print_and_log("Restarting BlockServer process") + sys.stdout.flush() + sys.stderr.flush() + os._exit(0) + def load_last_config(self) -> None: """Loads the last configuration used. @@ -411,7 +483,7 @@ def load_last_config(self) -> None: ) self._active_configserver.clear_config() else: - print_and_log("Loaded last configuration: %s" % last) + print_and_log(f"Loaded last configuration: {last}") self._initialise_config() def _set_curr_config(self, details: str) -> None: @@ -476,7 +548,9 @@ def _initialise_config(self, full_init: bool = False) -> None: self._active_configserver.get_block_details(), self._active_configserver.configures_block_gateway_and_archiver(), os.path.join( - CONFIG_DIR, "configurations", self._active_configserver.get_config_name() + CONFIG_DIR, + "configurations", + self._active_configserver.get_config_name(), ), ) @@ -548,7 +622,7 @@ def load_config(self, config: str, full_init: bool = True) -> None: self._active_configserver.load_active(config) # If we get this far then assume the config is okay self._initialise_config(full_init=full_init) - except Exception as err: + except Exception as err: # noqa: BLE001 Call chain can cause many types of exceptions print_and_log(f"Exception while loading configuration '{config}': {err}", "MAJOR") traceback.print_exc() @@ -559,9 +633,10 @@ def reload_current_config(self) -> None: print_and_log("Reloading current configuration") self._active_configserver.reload_current_config() self._initialise_config(full_init=True) - except Exception as err: + except Exception as err: # noqa: BLE001 Call chain can cause many types of exceptions print_and_log( - "Exception while reloading current configuration: {}".format(err), "MAJOR" + f"Exception while reloading current configuration: {err}", + "MAJOR", ) traceback.print_exc() @@ -597,7 +672,7 @@ def save_config(self, json_data: str, as_comp: bool = False) -> None: "component" if as_comp else "config", config_name ) ) - except IOError: + except OSError: pass # IOError thrown if config we're overwriting didn't exist, i.e. # this is a brand new config/component. @@ -621,9 +696,10 @@ def save_config(self, json_data: str, as_comp: bool = False) -> None: print_and_log(f"Finished saving ({config_name})") - except Exception: + except Exception: # noqa: BLE001 Call chain can cause many types of exceptions print_and_log( - f"Problem occurred saving configuration: {traceback.format_exc()}", "MAJOR" + f"Problem occurred saving configuration: {traceback.format_exc()}", + "MAJOR", ) if self._active_configserver is not None: @@ -644,13 +720,15 @@ def _get_inactive_history(self, name: str, is_component: bool = False) -> list[s inactive.load_inactive(name, is_component) # Get previous history history = inactive.get_history() - except IOError: + except OSError: # Config doesn't exist therefore start new history - history = list() + history = [] return history def _get_timestamp(self) -> str: - return datetime.datetime.strftime(datetime.datetime.now(), "%Y-%m-%d %H:%M:%S") + return datetime.datetime.strftime( + datetime.datetime.now(zoneinfo.ZoneInfo("localtime")), "%Y-%m-%d %H:%M:%S" + ) def update_blocks_monitors(self) -> None: """Updates the PV monitors for the blocks and groups, so the clients can see any changes.""" @@ -706,7 +784,8 @@ def update_wd_details_monitors(self) -> None: } ) self.setParam( - BlockserverPVNames.WD_CONF_DETAILS, compress_and_hex(config_details_json) + BlockserverPVNames.WD_CONF_DETAILS, + compress_and_hex(config_details_json), ) self.updatePVs() @@ -716,9 +795,13 @@ def update_curr_config_name_monitors(self) -> None: if self._active_configserver is not None: with self.monitor_lock: self.setParam( - BlockserverPVNames.CURR_CONFIG_NAME, self._active_configserver.get_config_name() + BlockserverPVNames.CURR_CONFIG_NAME, + self._active_configserver.get_config_name(), + ) + self.setParam( + BlockserverPVNames.CURR_CONFIG_NAME_SEVR, + CURR_CONFIG_NAME_SEVR_VALUE, ) - self.setParam(BlockserverPVNames.CURR_CONFIG_NAME_SEVR, CURR_CONFIG_NAME_SEVR_VALUE) self.updatePVs() def consume_write_queue(self) -> None: @@ -738,7 +821,7 @@ def consume_write_queue(self) -> None: cmd(*arg) if arg is not None else cmd() except ManagerModeRequiredError as err: print_and_log(f"Error, operation requires manager mode: {err}", "MAJOR") - except Exception as err: + except Exception as err: # noqa: BLE001 A worker-thread catch-all that runs arbitrary commands. Narrowing it could kill the thread print_and_log( f"Error executing write queue command {cmd.__name__} for state {state}: {err}", "MAJOR", @@ -746,7 +829,7 @@ def consume_write_queue(self) -> None: traceback.print_exc() self.update_server_status("") - def get_blank_config(self) -> Dict[str, Any]: + def get_blank_config(self) -> dict[str, Any]: """Get a blank configuration which can be used to create a new configuration from scratch. Returns: @@ -831,7 +914,7 @@ def add_string_pv_to_db(self, name: str, count: int = 1000) -> None: data = Data() data.value = manager.pvs[self.port][name].info.value self.pvDB[name] = data - except Exception: + except Exception: # noqa: BLE001 Unclear what createPV raises print_and_log(f"Unable to add PV {name}", "MAJOR") @@ -907,7 +990,11 @@ def add_string_pv_to_db(self, name: str, count: int = 1000) -> None: nargs=1, default=[ os.path.join( - MACROS["$(EPICS_KIT_ROOT)"], "CSS", "master", "ArchiveEngine", "block_config.xml" + MACROS["$(EPICS_KIT_ROOT)"], + "CSS", + "master", + "ArchiveEngine", + "block_config.xml", ) ], help="The XML file containing the new PV Archiver log settings", @@ -972,6 +1059,6 @@ def add_string_pv_to_db(self, name: str, count: int = 1000) -> None: while True: try: SERVER.process(0.1) - except Exception as err: + except OSError as err: print_and_log(err, "MAJOR") break