cgse 2024.7.0__py3-none-any.whl → 2025.0.2__py3-none-any.whl

egse/confman/confman.yaml

@@ -1,70 +0,0 @@
-UserInterface:
-    egse.confman.confman_ui
-
-Commands:
-
-    # Each of these groups is parsed and used on both the server and the client side.
-    #
-    # The group name (aka command name, e.g. start_observation) will be monkey patched in the Proxy
-    # class for the device or service.
-    #
-    # The other field are:
-    #   description:   Used by the doc_string method to generate a help string
-    #   cmd:           Command string that will eventually be send to the hardware controller for
-    #                  the device. This cmd string is also used at the client side to parse and
-    #                  validate the arguments.
-    #   device_method: The name of the method to be called on the device class.
-    #                  These should all be defined by the interface class for the device, i.e.
-    #                  PunaInterface in this case.
-    #                  When the device_method is the same as the group name, it can be omitted.
-    #   response:      The name of the method to be called from the device protocol.
-    #                  This method should exist in the subclass of the CommandProtocol base class,
-    #                  i.e. in this case it will be the PunaProtocol class.
-    #                  The default (when no response is given) is 'handle_device_method'.
-
-    # Commands to start/end/maintain an Observation/Test
-
-    start_observation:
-        description:    Start a new observation aka test.
-        cmd:            '{function_info}'
-
-    end_observation:
-        description:    End the current observation.
-
-    get_obsid:
-        description:    Return the observation identifier (OBSID) for the current test.
-
-                        When no test is running, i.e. we have not started an observation,
-                        then a Message is returned.
-
-    # Commands for handling Setups
-
-    load_setup:
-        description:    Loads the Setup for the given `id` in the configuration manager.
-        cmd:            "{id}"
-
-    get_setup:
-        description:    Returns the current Setup that is loaded in the configuration manager.
-        cmd:            "*"
-
-    reload_setups:
-        description:    Clears the cache and reloads the available Setups
-
-    list_setups:
-        description:    Returns a list of Setups that is available for the tests. The returned
-                        list is a list of named tuples with the fields `id` and `site`.
-        cmd:            "**"
-
-    submit_setup:
-        description:    Submit a (new) Setup to the configuration manager. The Setup will be
-                        assigned a unique identifier and committed to the git repository.
-        cmd:            "{setup} {description} {replace}"
-
-    get_listener_names:
-        description:    Returns a list of names of listeners that need to be notified when a new Setup is loaded.
-    
-    # Commands that are mainly used by the ProcessManager
-
-    get_setup_for_obsid:
-        description:    Returns the Setup that was used for the given `obsid`.
-        cmd:            "{obsid}"

egse/confman/confman_cs.py

@@ -1,240 +0,0 @@
-"""
-The Configuration Manager is a server that controls and distributes configuration settings.
-
-The following functionality is provided:
-
-* creation and distribution of observation identifiers
-* start and end of observations or tests
-* maintain proper Setups and distribute the latest Setup on demand
-
-"""
-import logging
-import multiprocessing
-import sys
-from pathlib import Path
-
-import click
-import zmq
-from prometheus_client import start_http_server
-
-from egse.confman import ConfigurationManagerProtocol
-from egse.confman import ConfigurationManagerProxy
-from egse.confman import is_configuration_manager_active
-from egse.control import ControlServer
-from egse.control import Response
-from egse.control import Success
-from egse.settings import Settings
-from egse.system import replace_environment_variable
-
-# Use explicit name here otherwise the logger will probably be called __main__
-
-logger = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("Configuration Manager Control Server")
-
-
-class ConfigurationManagerControlServer(ControlServer):
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = ConfigurationManagerProtocol(self)
-
-        self.logger = logger
-        self.logger.debug(f"Binding ZeroMQ socket to {self.device_protocol.get_bind_address()}")
-
-        self.device_protocol.bind(self.dev_ctrl_cmd_sock)
-
-        self.poller.register(self.dev_ctrl_cmd_sock, zmq.POLLIN)
-
-    def get_communication_protocol(self):
-        return CTRL_SETTINGS.PROTOCOL
-
-    def get_commanding_port(self):
-        return CTRL_SETTINGS.COMMANDING_PORT
-
-    def get_service_port(self):
-        return CTRL_SETTINGS.SERVICE_PORT
-
-    def get_monitoring_port(self):
-        return CTRL_SETTINGS.MONITORING_PORT
-
-    def get_storage_mnemonic(self):
-        try:
-            return CTRL_SETTINGS.STORAGE_MNEMONIC
-        except AttributeError:
-            return "CM"
-
-    def before_serve(self):
-        start_http_server(CTRL_SETTINGS.METRICS_PORT)
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-def start():
-    """
-    Starts the Configuration Manager (cm_cs). The cm_cs is a server which handles the
-    configuration (aka Setup) of your test system.
-
-    The cm_cs is normally started automatically on egse-server boot.
-    """
-
-    multiprocessing.current_process().name = "confman_cs"
-
-    try:
-        check_prerequisites()
-    except RuntimeError as exc:
-        logger.info(exc)
-        return 0
-
-    try:
-        control_server = ConfigurationManagerControlServer()
-        control_server.serve()
-    except KeyboardInterrupt:
-        print("Shutdown requested...exiting")
-    except SystemExit as exit_code:
-        print("System Exit with code {}.".format(exit_code))
-        sys.exit(exit_code)
-    except Exception:
-        import traceback
-
-        traceback.print_exc(file=sys.stdout)
-
-    return 0
-
-
-@cli.command()
-def stop():
-    """Send a 'quit_server' command to the Configuration Manager."""
-    with ConfigurationManagerProxy() as cm:
-        sp = cm.get_service_proxy()
-        sp.quit_server()
-
-
-@cli.command()
-def status():
-    """Print the status of the control server."""
-
-    import rich
-
-    rich.print('Configuration manager:')
-    if is_configuration_manager_active():
-        rich.print('  Status: [green]active')
-        with ConfigurationManagerProxy() as cm:
-            obsid: Success = cm.get_obsid()
-            obsid = obsid.return_code
-            setup = cm.get_setup()
-            try:
-                rich.print(f"  Site ID: {setup.site_id}")
-            except AttributeError:
-                rich.print('  Site ID: [red]UNKNOWN')
-
-            if obsid:
-                rich.print(f"  Running observation: {obsid}")
-            else:
-                rich.print("  No observation running")
-
-            try:
-                if setup.has_private_attribute("_setup_id"):
-                    setup_id = setup.get_private_attribute("_setup_id")
-                    rich.print(f"  Setup loaded: {setup_id}")
-                else:
-                    rich.print('  [red]No Setup loaded')
-            except Exception as exc:
-                rich.print(setup)
-                rich.print(exc)
-
-            rich.print(f"  Hostname: {cm.get_ip_address()}")
-            rich.print(f"  Monitoring port: {cm.get_monitoring_port()}")
-            rich.print(f"  Commanding port: {cm.get_commanding_port()}")
-            rich.print(f"  Service port: {cm.get_service_port()}")
-            rich.print(f"  Listeners: {', '.join(cm.get_listener_names())}")
-    else:
-        rich.print('  Status: [red]not active')
-
-
-@cli.command()
-def list_setups(**attr):
-    """List available Setups."""
-
-    with ConfigurationManagerProxy() as cm:
-        setups = cm.list_setups(**attr)
-    if setups:
-        # We want to have the most recent (highest id number) last, but keep the site together
-        setups = sorted(setups, key=lambda x: (x[1], x[0]))
-        print("\n".join(f"{setup}" for setup in setups))
-
-
-@cli.command()
-@click.argument('setup_id', type=int)
-def load_setup(setup_id):
-    """Load the given Setup on the configuration manager."""
-
-    with ConfigurationManagerProxy() as cm:
-        setup = cm.load_setup(setup_id)
-    if isinstance(setup, Response):
-        print(setup)
-        return
-    if setup.has_private_attribute("_setup_id"):
-        setup_id = setup.get_private_attribute("_setup_id")
-        print(f"{setup_id} loaded on configuration manager.")
-
-
-@cli.command()
-def reload_setups():
-    """ Clears the cache and re-loads the available setups.
-
-    Note that this does not affect the currently loaded setup.
-    """
-
-    with ConfigurationManagerProxy() as pm:
-        pm.reload_setups()
-
-
-def check_prerequisites():
-    """Checks if all prerequisites for running the Configuration Manager are met.
-
-    Raises:
-        RuntimeError when one or more of the prerequisites is not met.
-    """
-
-    fails = 0
-
-    # We need a proper location for storing the configuration data.
-
-    location = CTRL_SETTINGS.FILE_STORAGE_LOCATION
-    location = replace_environment_variable(location)
-
-    if not location:
-        raise RuntimeError(
-            "The environment variable referenced in the Settings.yaml file for the "
-            "FILE_STORAGE_LOCATION of the Configuration Manager does not exist, please set "
-            "the environment variable."
-        )
-
-    location = Path(location)
-
-    if not location.exists():
-        logger.error(
-            f"The directory {location} does not exist, provide a writable location for "
-            f"storing the configuration data."
-        )
-        fails += 1
-
-    # logger.debug(f"Storage location for configuration data = {location}")
-
-    # now raise the final verdict
-
-    if fails:
-        raise RuntimeError(
-            "Some of the prerequisites for the Configuration Manager haven't met. "
-            "Please check the logs."
-        )
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())

egse/confman/confman_ui.py

@@ -1,381 +0,0 @@
-import pickle
-from pathlib import Path
-
-import sys
-
-import zmq
-from PyQt5.QtCore import Qt, QThread, pyqtSignal, pyqtSlot, QObject, QLockFile
-from PyQt5.QtGui import QPixmap, QIcon, QCloseEvent
-from PyQt5.QtWidgets import (QApplication, QFrame, QHBoxLayout, QLabel, QMainWindow, QTextBrowser, QVBoxLayout, QAction,
-                             QMessageBox)
-from rich.console import Console
-
-from egse.config import find_file
-from egse.confman import (ConfigurationManagerProxy, is_configuration_manager_active)
-from egse.confman.setup_ui import SetupUIView
-from egse.resource import get_resource
-from egse.settings import Settings
-from egse.zmq_ser import set_address_port
-
-CTRL_SETTINGS = Settings.load("Configuration Manager Control Server")
-
-
-class ConfigurationManagerUIView(QMainWindow):
-
-    def __init__(self):
-
-        """ Initialisation of the Configuration Manager GUI.
-
-        The components are placed in the window and a thread is created to
-        listen to the monitoring port of the configuration manager.  When the
-        obsid and/or setup change, this information is updated in the GUI.
-        """
-
-        super().__init__()
-
-        self.setGeometry(300, 300, 1000, 500)
-        self.setWindowTitle("Configuration Manager")
-
-        self.setup_ui = SetupUIView()
-
-        # Build GUI
-
-        self.toolbar = self.addToolBar("MainToolbar")
-
-        self.init_gui()
-
-        # Listen to the monitoring port of the CM in the background (i.e. in a
-        # separate thread) and update the content of the GUI if needed
-
-        self.start_monitoring()
-
-    def start_monitoring(self):
-        """ Start listening to the monitoring port.
-
-        Create and start a thread that listens on the monitoring port in the
-        background.  If the obsid and/or setup have changed, the information
-        in the GUI is updated.
-        """
-
-        self.monitoring_thread = QThread(self)
-        self.monitoring_worker = MonitoringWorker()
-        self.monitoring_worker.moveToThread(self.monitoring_thread)
-
-        self.monitoring_worker.monitoring_signal.connect(self.update_values)
-        self.monitoring_thread.started.connect(self.monitoring_worker.start_process)
-
-    def closeEvent(self, close_event: QCloseEvent) -> None:
-        """ Make sure that the thread is stopped when the GUI is closed.
-
-        Args:
-            - close_event: Close event received when the GUI is closed.
-        """
-
-        self.monitoring_worker.active = False
-        self.monitoring_thread.quit()
-        self.monitoring_thread.wait()
-
-    def update_values(self, monitoring_info):
-        """ Update the obsid and setup in the GUI.
-
-        If the obsid and/or the setup have changed, this information needs to
-        be updated in the GUI.
-
-        Args:
-            - monitoring_info: Information received from the monitoring port
-                               of the Configuration Manager.  This contains
-                               the obsid and setup.
-        """
-
-        # Update the obsid in the GUI
-
-        self.update_obsid(monitoring_info["obsid"])
-
-        # Update the setup in the GUI
-
-        self.update_setup(monitoring_info["setup"])
-
-    def update_obsid(self, obsid):
-        """ Update the obsid in the GUI.
-
-        If the give obsid is None, no observation is running (which will be
-        shown in the GUI).  The frame around the GUI will turn green, to
-        indicate that it is safe to shut down the EGSE Control Servers.
-        Otherwise, an observation (with the given identifier is running):
-        the obsid will be shown in the GUI and the frame around the GUI will
-        turn red, indicating that it is not safe to shut down the EGSE Control
-        Servers.
-
-        Args:
-            - obsid: New obsid to show in the GUI.  None if no observation is
-                     running.
-        """
-
-        # No observation is running
-
-        if obsid is None:
-
-            self.setStyleSheet('QMainWindow{border: 3px solid green;}')
-
-            self.obsid.setText("No observation is running")
-
-        # Observation is running
-
-        else:
-
-            self.setStyleSheet('QMainWindow{border: 3px solid red;}')
-
-            self.obsid.setText(str(obsid))
-
-    def update_setup(self, setup):
-        """ Update the setup in the GUI.
-
-        Args:
-            - setup: New setup to show in the GUI.
-        """
-
-        self.setup.setText(setup.pretty_str())
-
-        console = Console(width=120, force_terminal=False, force_jupyter=False)
-        with console.capture() as capture:
-            console.print(setup)
-        text = capture.get()
-
-        self.setup.setText(text)
-
-    def init_gui(self):
-        """ Put the components in the GUI window.
-
-        The GUI comprises the following components:
-            - text field with the obsid;
-            - scrollable area with the current setup (loaded by the
-              Configuration Manager).
-        """
-
-        app_frame = QFrame()
-        app_frame.setObjectName("AppFrame")
-
-        self.add_toolbar()
-
-        box = QVBoxLayout()
-
-        # Obsid
-
-        hbox = QHBoxLayout()
-
-        hbox.addWidget(QLabel("Obsid"))
-
-        self.obsid = QLabel("No observation is running")
-        hbox.addWidget(self.obsid)
-
-        box.addLayout(hbox)
-
-        # Setup
-
-        self.setup = QTextBrowser(self)
-        self.setup.setText("No setup loaded")
-
-        self.setup.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOn)
-        self.setup.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOn)
-
-        box.addWidget(QLabel("Setup"))
-        box.addWidget(self.setup)
-
-        app_frame.setLayout(box)
-
-        self.setCentralWidget(app_frame)
-
-    def add_toolbar(self):
-
-        search_pix = QPixmap(str(find_file("search.png", in_dir="images")))
-        search_icon = QIcon()
-        search_icon.addPixmap(search_pix, QIcon.Normal, QIcon.On)
-
-        inspect_setup_action = QAction(search_icon, "Inspect available setups", self)
-        inspect_setup_action.setToolTip(
-            "Open separate window to inspect all available setups.")
-        inspect_setup_action.setCheckable(False)
-        inspect_setup_action.triggered.connect(self.open_setup_ui)
-
-        self.toolbar.addAction(inspect_setup_action)
-
-        return self.toolbar
-
-    def open_setup_ui(self):
-        """ Open separate window to inspect the available setups.
-        """
-
-        self.setup_ui.show()
-
-
-class ConfigurationManagerUIModel:
-
-    def __init__(self):
-
-        """ Initialisation of the Configuration Manager UI model.
-        """
-
-        try:
-
-            self.cm = ConfigurationManagerProxy()
-
-        except ConnectionError:
-
-            self.cm = None
-
-    def is_connected(self):
-        """ Checks whether the Configuration Manager is active.
-
-        Returns:
-            - True if the Configuration Manager is active; False otherwise.
-        """
-
-        return is_configuration_manager_active()
-
-    def update(self, changed_object):
-        pass
-
-    def do(self):
-        pass
-
-
-class MonitoringWorker(QObject):
-
-    # The thread will send a signal with the monitoring information:
-    #   - The obsid;
-    #   - The setup that has been loaded by the configuration manager.
-
-    monitoring_signal = pyqtSignal(dict)
-
-    def __init__(self):
-
-        """ Initialisation of a monitoring thread.
-
-        This monitoring thread will listen on the monitoring port of the
-        Control Server.  At this point the socket (that will connect to the
-        monitoring port) is not created yet.
-        """
-
-        super(MonitoringWorker, self).__init__()
-
-        self.obsid = None   # Previous obsid
-        self.setup = None   # Previous setup
-
-        self.active = False
-
-    def connect_socket(self, proxy):
-        """ Create a socket and connect to the monitoring port.
-
-        Args:
-            - proxy_type: Proxy type (needed to read the connection details).
-        """
-
-        # Start listening to the monitoring port
-
-        self.socket = zmq.Context().socket(zmq.SUB)
-
-        endpoint = proxy.get_endpoint()
-        monitoring_port = proxy.get_monitoring_port()
-        address = set_address_port(endpoint, monitoring_port)
-
-        self.socket.connect(address)
-        self.socket.setsockopt_string(zmq.SUBSCRIBE, "")
-
-    def start_process(self):
-        """ Start listening on the monitoring port.
-        """
-
-        self.run()
-
-    @pyqtSlot()
-    def run(self):
-        """ Keep on listening on the monitoring port.
-
-        If monitoring information is received before the timeout, it is
-        checked whether the obsid and/or current setup have changed.  If so, a
-        signal with the monitoring information is emitted.
-        """
-
-        self.active = True
-
-        while self.active:
-
-            socket_list, _, _ = zmq.select([self.socket], [], [], timeout=1)
-
-            # Monitoring information was received (before timeout)
-
-            if self.socket in socket_list:
-
-                pickle_string = self.socket.recv()
-                monitoring_info = pickle.loads(pickle_string)
-
-                new_obsid = monitoring_info["obsid"]  # New obsid
-                new_setup = monitoring_info["setup"]  # New setup
-
-                # The obsid and/or setup have changed
-
-                if (new_obsid != self.obsid) or (new_setup != self.setup):
-
-                    self.obsid = new_obsid
-                    self.setup = new_setup
-
-                    # Emit the monitoring info
-
-                    self.monitoring_signal.emit(monitoring_info)
-
-        self.socket.close(linger=0)
-
-
-class ConfigurationManagerUIController:
-
-    def __init__(self, model: ConfigurationManagerUIModel,
-                 view: ConfigurationManagerUIView):
-
-        """ Initialisation of the Controller for the Process Manager GUI.
-
-        Args:
-            - model: Configuration Manager UI model.
-            - view: Configuration Manager UI view.
-        """
-
-        self.model = model
-        self.view = view
-
-        self.view.monitoring_worker.connect_socket(self.model.cm)
-        self.view.monitoring_thread.start()
-
-    def update(self, changed_object):
-        pass
-
-    def do(self):
-        pass
-
-
-def main():
-    """ Main method to launch the Configuration Manager GUI.
-    """
-
-    lock_file = QLockFile(str(Path("~/cm_ui.app.lock").expanduser()))
-
-    app = QApplication(sys.argv)
-    app.setWindowIcon(QIcon(str(get_resource(":/icons/settings.svg"))))
-
-    if lock_file.tryLock(100):
-        view = ConfigurationManagerUIView()
-        model = ConfigurationManagerUIModel()
-        ConfigurationManagerUIController(model, view)
-
-        view.show()
-        sys.exit(app.exec_())
-    else:
-        error_message = QMessageBox()
-        error_message.setIcon(QMessageBox.Warning)
-        error_message.setWindowTitle("Error")
-        error_message.setText("The Configuration Manager (CM) GUI application is already running!")
-        error_message.setStandardButtons(QMessageBox.Ok)
-
-        return error_message.exec()
-
-
-if __name__ == "__main__":
-    main()