cgse 0.16.3__tar.gz → 0.16.5__tar.gz

{cgse-0.16.3 → cgse-0.16.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 0.16.3
+Version: 0.16.5
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.16.3"
+version = "0.16.5"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-common/src/egse/env.py

@@ -573,6 +573,15 @@ def print_env():
         console.print(f"  {get_local_settings_env_name():{col_width}s}: {get_local_settings_path()}")
 
 
+def bool_env(var_name: str) -> bool:
+    """Return True if the environment variable is set to 1, true, yes, or on. All case-insensitive."""
+
+    if value := os.getenv(var_name):
+        return value.strip().lower() in {"1", "true", "yes", "on"}
+
+    return False
+
+
 @contextlib.contextmanager
 def env_var(**kwargs: str | int | float | bool | None):
     """

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-common/tests/test_env.py

@@ -2,6 +2,7 @@ import logging
 
 import pytest
 
+from egse.env import bool_env
 from egse.env import get_conf_repo_location
 from egse.env import get_project_name
 from egse.env import get_site_id
@@ -207,3 +208,13 @@ def test_main(capsys):
         assert "PYTHONSTARTUP=my_script.py" in captured.out  # noqa
 
     _LOGGER.info(f"{get_project_name() = }, {get_site_id() = }")
+
+
+def test_bool_env():
+    for option in ["1", "true", "True", "TRUE", "on", "On", "ON", "yes", "Yes", "YES"]:
+        with env_var(VERBOSE_DEBUG=option):
+            assert bool_env("VERBOSE_DEBUG")
+
+    for option in ["0", "false", "no", "off"]:
+        with env_var(VERBOSE_DEBUG=option):
+            assert not bool_env("VERBOSE_DEBUG")

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-coordinates/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-coordinates"
-version = "0.16.3"
+version = "0.16.5"
 description = "Reference Frames and Coordinate Transofrmations for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-core"
-version = "0.16.3"
+version = "0.16.5"
 description = "Core services for the CGSE framework"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/cgse_core/_start.py

@@ -9,7 +9,7 @@ from egse.system import redirect_output_to_log
 def start_rm_cs(log_level: str):
     rich.print("Starting the service registry manager core service...")
 
-    out = redirect_output_to_log(".rm_cs.start.log")
+    out = redirect_output_to_log("rm_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.registry.server", "start", "--log-level", log_level],
@@ -23,7 +23,7 @@ def start_rm_cs(log_level: str):
 def start_log_cs():
     rich.print("Starting the logging core service...")
 
-    out = redirect_output_to_log(".log_cs.start.log")
+    out = redirect_output_to_log("log_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.logger.log_cs", "start"],
@@ -37,7 +37,7 @@ def start_log_cs():
 def start_sm_cs():
     rich.print("Starting the storage manager core service...")
 
-    out = redirect_output_to_log(".sm_cs.start.log")
+    out = redirect_output_to_log("sm_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.storage.storage_cs", "start"],
@@ -51,7 +51,7 @@ def start_sm_cs():
 def start_cm_cs():
     rich.print("Starting the configuration manager core service...")
 
-    out = redirect_output_to_log(".cm_cs.start.log")
+    out = redirect_output_to_log("cm_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.confman.confman_cs", "start"],
@@ -65,7 +65,7 @@ def start_cm_cs():
 def start_pm_cs():
     rich.print("Starting the process manager core service...")
 
-    out = redirect_output_to_log(".pm_cs.start.log")
+    out = redirect_output_to_log("pm_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.procman.procman_cs", "start"],
@@ -79,7 +79,7 @@ def start_pm_cs():
 def start_notifyhub():
     rich.print("Starting the notification hub core service...")
 
-    out = redirect_output_to_log(".nh_cs.start.log")
+    out = redirect_output_to_log("nh_cs.start.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.notifyhub.server", "start"],

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/cgse_core/_stop.py

@@ -15,7 +15,7 @@ from egse.system import waiting_for
 def stop_rm_cs():
     rich.print("Terminating the service registry manager core service...")
 
-    out = redirect_output_to_log(".rm_cs.stop.log")
+    out = redirect_output_to_log("rm_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.registry.server", "stop"],
@@ -35,7 +35,7 @@ def stop_rm_cs():
 def stop_log_cs():
     rich.print("Terminating the logging core service...")
 
-    out = redirect_output_to_log(".log_cs.stop.log")
+    out = redirect_output_to_log("log_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.logger.log_cs", "stop"],
@@ -49,7 +49,7 @@ def stop_log_cs():
 def stop_sm_cs():
     rich.print("Terminating the storage manager core service...")
 
-    out = redirect_output_to_log(".sm_cs.stop.log")
+    out = redirect_output_to_log("sm_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.storage.storage_cs", "stop"],
@@ -69,7 +69,7 @@ def stop_sm_cs():
 def stop_cm_cs():
     rich.print("Terminating the configuration manager core service...")
 
-    out = redirect_output_to_log(".cm_cs.stop.log")
+    out = redirect_output_to_log("cm_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.confman.confman_cs", "stop"],
@@ -89,7 +89,7 @@ def stop_cm_cs():
 def stop_pm_cs():
     rich.print("Terminating the process manager core service...")
 
-    out = redirect_output_to_log(".pm_cs.stop.log")
+    out = redirect_output_to_log("pm_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.procman.procman_cs", "stop"],
@@ -109,7 +109,7 @@ def stop_pm_cs():
 def stop_notifyhub():
     rich.print("Terminating the notification hub core service...")
 
-    out = redirect_output_to_log(".nh_cs.stop.log")
+    out = redirect_output_to_log("nh_cs.stop.log")
 
     subprocess.Popen(
         [sys.executable, "-m", "egse.notifyhub.server", "stop"],

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/cgse_core/services.py

@@ -75,12 +75,6 @@ def stop_core_services():
 @core.command(name="status")
 def status_core_services(full: bool = False, suppress_errors: bool = True):
     """Print the status of the core services."""
-    # from scripts._status import status_log_cs, status_sm_cs, status_cm_cs
-
-    logging.basicConfig(
-        level=logging.WARNING,
-        format="[%(asctime)s] %(threadName)-12s %(levelname)-8s %(name)-20s %(lineno)5d:%(module)-20s %(message)s",
-    )
 
     rich.print("[green]Status of the core services...[/]")
 

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/cgse_core/settings.yaml

@@ -52,7 +52,7 @@ Process Manager Control Server:                  # PM_CS
 
 Notify Hub:
     
-    SERVICE_TYPE:            NOTIFY_HUB
+    SERVICE_TYPE:                 NH_CS
     SERVICE_ID:                 nh_cs_1
     PROCESS_NAME:                 nh_cs
     COLLECTOR_PORT:                6125
@@ -61,7 +61,7 @@ Notify Hub:
     
 Metrics Hub:
     
-    SERVICE_TYPE:           METRICS_HUB
+    SERVICE_TYPE:                 MH_CS
     SERVICE_ID:                 mh_cs_1
     PROCESS_NAME:                 mh_cs
     COLLECTOR_PORT:                6130

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/egse/async_control_claude.py

@@ -805,91 +805,3 @@ class ControlServer(abc.ABC):
             the `egse.storage` module might not be available, it is provided by the `cgse-core` package.
         """
         pass
-
-    async def notify_listeners(self, event_id: int = 0, context: dict = None):
-        """
-        Notifies registered listeners about an event.
-
-        This function creates an Event object with the provided `event_id` and `context`
-        and notifies all registered listeners with the created event.
-
-        Args:
-            event_id (int, optional): The identifier for the event. Defaults to 0.
-            context (dict, optional): Additional context information associated with the event.
-                Defaults to None.
-
-        Note:
-            The notification is performed by the `notify_listeners` method of the `listeners` object
-            associated with this instance.
-            The notification is executed as a task to avoid blocking the commanding chain.
-        """
-        self.logger.info(f"Notifying listeners for {EVENT_ID(event_id).name}")
-
-        # Create a task for notification instead of a daemon thread
-        event = Event(event_id=event_id, context=context)
-        asyncio.create_task(self.listeners.notify_listeners_async(event))
-
-    def get_listener_names(self):
-        return self.listeners.get_listener_names()
-
-    async def register_as_listener(self, proxy: Type, listener: dict):
-        """
-        Registers a listener with the specified proxy.
-
-        This function attempts to add the provided listener to the specified proxy.
-        It employs a retry mechanism to handle potential ConnectionError exceptions.
-
-        Args:
-            proxy: A callable object representing the proxy to which the listener will be added.
-            listener (dict): The listener to be registered. Should be a dictionary containing
-                listener details.
-
-        Raises:
-            ConnectionError: If the connection to the proxy encounters issues even after
-                multiple retry attempts.
-        """
-
-        @retry_with_exponential_backoff(exceptions=[ConnectionError])
-        async def _add_listener(proxy, listener):
-            async with proxy() as x, x.get_service_proxy() as srv:
-                rc = await srv.add_listener_async(listener)
-                _LOGGER.info(f"Response from {proxy.__name__} service add_listener: {rc}")
-
-        _LOGGER.info(f"Registering {self.__class__.__name__} as a listener to {proxy.__name__}")
-        await _add_listener(proxy, listener)
-
-    async def unregister_as_listener(self, proxy: Type, listener: dict):
-        """
-        Removes a registered listener from the specified proxy.
-
-        This function attempts to remove the provided listener from the specified proxy.
-        It employs a retry mechanism to handle potential ConnectionError exceptions.
-
-        Args:
-            proxy: A callable object representing the proxy from which the listener will be removed.
-            listener (dict): The listener to be removed. Should be a dictionary containing
-                listener details.
-
-        Raises:
-            ConnectionError: If the connection to the proxy encounters issues even after
-                multiple retry attempts.
-        """
-
-        @retry(times=5, exceptions=[ConnectionError])
-        async def _remove_listener(proxy, listener):
-            async with proxy() as x, x.get_service_proxy() as srv:
-                rc = await srv.remove_listener_async(listener)
-                _LOGGER.debug(f"Response from remove_listener: {rc=}")
-
-        # Check if the CS is available
-        try:
-            async with proxy():
-                pass
-        except ConnectionError:
-            _LOGGER.warning(
-                f"The {proxy.__class__.__name__} endpoint is not responding, {listener['name']} not un-registered."
-            )
-            return
-
-        _LOGGER.info(f"Removing {self.__class__.__name__} as a listener from {proxy.__name__}")
-        await _remove_listener(proxy, listener)

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/egse/confman/__init__.py

@@ -138,7 +138,6 @@ from egse.env import get_conf_repo_location
 from egse.env import get_project_name
 from egse.env import get_site_id
 from egse.exceptions import InternalError
-from egse.listener import EVENT_ID
 from egse.log import logger
 from egse.notifyhub.event import NotificationEvent
 from egse.notifyhub.services import EventPublisher
@@ -552,10 +551,6 @@ class ConfigurationManagerInterface:
     def get_setup_for_obsid(self, obsid):
         raise NotImplementedError
 
-    @dynamic_interface
-    def get_listener_names(self):
-        raise NotImplementedError
-
 
 class ConfigurationManagerController(ConfigurationManagerInterface):
     """Handles the commands that are sent to the configuration manager.
@@ -763,12 +758,6 @@ class ConfigurationManagerController(ConfigurationManagerInterface):
             self._sut_name = _get_sut_id_for_setup(self._setup)
             logger.info(f"New Setup loaded from {setup_file}")
             save_last_setup_id(self._setup_id)
-            if self._control_server:
-                logger.info("Notifying listeners for a new Setup!")
-                with Timer(f"Notify Listeners for Setup change, Setup={self._setup_id}"):
-                    self._control_server.notify_listeners(
-                        EVENT_ID.SETUP, {"event_type": "new_setup", "setup_id": self._setup_id}
-                    )
 
             with EventPublisher() as pub:
                 pub.publish(
@@ -952,12 +941,6 @@ class ConfigurationManagerController(ConfigurationManagerInterface):
             logger.info(f"New Setup was submitted and loaded: {setup_id=}")
             self._sut_name = self._setup.camera.ID.lower()
             save_last_setup_id(setup_id)
-            if self._control_server:
-                logger.info("Notifying listeners for a new Setup!")
-                with Timer(f"Notify Listeners for Setup change, Setup={self._setup_id}"):
-                    self._control_server.notify_listeners(
-                        EVENT_ID.SETUP, {"event_type": "new_setup", "setup_id": setup_id}
-                    )
 
             with EventPublisher() as pub:
                 pub.publish(
@@ -980,10 +963,6 @@ class ConfigurationManagerController(ConfigurationManagerInterface):
 
         return int(setup_id) + 1
 
-    def get_listener_names(self):
-        """Returns the names of the control servers that are listening for a new Setup."""
-        return self._control_server.get_listener_names()
-
 
 class ConfigurationManagerCommand(ClientServerCommand):
     pass
@@ -1119,7 +1098,6 @@ def get_status():
                     Monitoring port: {cm.get_monitoring_port()}
                     Commanding port: {cm.get_commanding_port()}
                     Service port: {cm.get_service_port()}
-                    Listeners: {", ".join(cm.get_listener_names())}
                 """
             )
     except ConnectionError as exc:

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/egse/confman/confman.yaml

@@ -62,9 +62,6 @@ Commands:
         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
 

cgse-0.16.5/libs/cgse-core/src/egse/connect.py

@@ -0,0 +1,55 @@
+from egse.env import bool_env
+from egse.log import logging
+from egse.zmq_ser import connect_address
+
+logger = logging.getLogger("egse.connect")
+
+# random.seed(time.monotonic())  # uncomment for testing only, main application should set a seed.
+
+VERBOSE_DEBUG = bool_env("VERBOSE_DEBUG")
+
+
+def get_endpoint(
+    service_type: str,
+    protocol: str = None,
+    hostname: str = None,
+    port: int = 0,
+):
+    """
+    Returns the endpoint for a service, either from the registry or by constructing
+    it from protocol, hostname and port.
+
+    If port is 0 (the default), attempt to retrieve the endpoint from the service registry.
+
+    Args:
+        service_type: The service type to look up in the registry.
+        protocol: Protocol to use if constructing the endpoint.
+        hostname: Hostname to use if constructing the endpoint.
+        port: Port to use if constructing the endpoint.
+
+    Returns:
+        The endpoint string.
+
+    Raises:
+        RuntimeError: If no endpoint can be determined.
+    """
+    endpoint = None
+    from egse.registry.client import RegistryClient
+
+    if port == 0:
+        with RegistryClient() as reg:
+            endpoint = reg.get_endpoint(service_type)
+        if endpoint:
+            if VERBOSE_DEBUG:
+                logger.debug(f"Endpoint for {service_type} found in registry: {endpoint}")
+        else:
+            logger.warning(f"No endpoint for {service_type} found in registry.")
+
+    if not endpoint:
+        if port == 0:
+            raise RuntimeError(f"No service registered as {service_type} and no port provided.")
+        endpoint = connect_address(protocol, hostname, port)
+        if VERBOSE_DEBUG:
+            logger.debug(f"Endpoint constructed from protocol/hostname/port: {endpoint}")
+
+    return endpoint

{cgse-0.16.3 → cgse-0.16.5}/libs/cgse-core/src/egse/control.py

@@ -634,6 +634,7 @@ class ControlServer(metaclass=abc.ABCMeta):
         # FIXME: not sure if the stop heartbeat is necessary here, but I see that after
         #        a re-registration signal, the heartbeat socket is None.
         # self.registry.stop_heartbeat()
+
         self.register_service(self.service_type)
 
     def register_service(self, service_type: str):
@@ -748,127 +749,3 @@ class ControlServer(metaclass=abc.ABCMeta):
         """
 
         pass
-
-    def notify_listeners(self, event_id: int = 0, context: dict = None):
-        """
-        Notifies registered listeners about an event.
-
-        This function creates an Event object with the provided `event_id` and `context`
-        and notifies all registered listeners with the created event.
-
-        Args:
-            event_id (int, optional): The identifier for the event. Defaults to 0.
-            context (dict, optional): Additional context information associated with the event.
-                Defaults to None.
-
-        Note:
-            The notification is performed by the `notify_listeners` method of the `listeners` object
-            associated with this instance.
-            The notification is executed in a daemon thread to avoid blocking the commanding
-            chain.
-
-        """
-        from egse.listener import Event, EVENT_ID
-
-        self.logger.info(f"Notifying listeners for {EVENT_ID(event_id).name}")
-
-        retry_thread = threading.Thread(
-            target=self.listeners.notify_listeners, args=(Event(event_id=event_id, context=context),)
-        )
-        retry_thread.daemon = True
-        retry_thread.start()
-
-    def get_listener_names(self):
-        return self.listeners.get_listener_names()
-
-    def register_as_listener(self, proxy: Type, listener: dict):
-        """
-        Registers a listener with the specified proxy.
-
-        This function attempts to add the provided listener to the specified proxy.
-        It employs a retry mechanism to handle potential ConnectionError exceptions,
-        making up to 5 attempts to add the listener.
-
-        Args:
-            proxy: A callable object representing the proxy to which the listener will be added.
-            listener (dict): The listener to be registered. Should be a dictionary containing
-                listener details.
-
-        Raises:
-            ConnectionError: If the connection to the proxy encounters issues even after
-                multiple retry attempts.
-
-        Note:
-            The function runs in a separate daemon thread to avoid blocking the main thread.
-
-        """
-
-        @retry_with_exponential_backoff(exceptions=[ConnectionError])
-        def _add_listener(proxy, listener):
-            try:
-                with proxy() as x, x.get_service_proxy() as srv:
-                    response = srv.add_listener(listener)
-                    logger.info(f"Response from {proxy.__name__} service add_listener: {response}")
-            except Exception as exc:
-                logger.error(f"Caught {type_name(exc)}: {exc} – listener '{listener['name']}' could not be registered")
-
-        logger.info(f"Registering {self.__class__.__name__} as a listener to {proxy.__name__}")
-
-        retry_thread = threading.Thread(target=_add_listener, args=(proxy, listener))
-        retry_thread.daemon = True
-        retry_thread.start()
-
-    def unregister_as_listener(self, proxy: Type, listener: dict):
-        """
-        Removes a registered listener from the specified proxy.
-
-        This function attempts to remove the provided listener from the specified proxy.
-        It employs a retry mechanism to handle potential ConnectionError exceptions,
-        making up to 5 attempts to add the listener.
-
-        Args:
-            proxy: A callable object representing the proxy from which the listener will be removed.
-            listener (dict): The listener to be removed. Should be a dictionary containing
-                listener details.
-
-        Raises:
-            ConnectionError: If the connection to the proxy encounters issues even after
-                multiple retry attempts.
-
-        Note:
-            The function runs in a separate thread but will block until the de-registration is finished.
-            The reason being that this method is usually called in a `after_serve` block so it needs to
-            finish before the ZeroMQ context is destroyed.
-
-        """
-
-        @retry(times=5, exceptions=[ConnectionError])
-        def _remove_listener(proxy, listener):
-            with proxy() as x, x.get_service_proxy() as srv:
-                rc = srv.remove_listener(listener)
-                logger.debug(f"Response from remove_listener: {rc=}")
-
-        # Since we do not have the endpoint available, we can not check if the CS is active, and to get the endpoint
-        # we have to use the proxy anyway. So, let's use the proxy object to check if the CS is available.
-
-        try:
-            with proxy():
-                pass
-        except ConnectionError:
-            logger.warning(
-                f"The {proxy.__class__.__name__} endpoint is not responding, {listener['name']} not un-registered."
-            )
-            return
-
-        logger.info(f"Removing {self.__class__.__name__} as a listener from {proxy.__name__}")
-
-        retry_thread = threading.Thread(target=_remove_listener, args=(proxy, listener))
-        retry_thread.daemon = False
-        retry_thread.start()
-
-        # Block until the listener has been removed. This is needed because this unregister function will usually
-        # be called in the `after_server()` method of the control server (which is the listener) and if we do not
-        # wait until the thread is finished the ZeroMQ Context will be destroyed before the reply can be sent.
-        # Note: we could probably do without the thread, and directly call the `_remove_listener()` function.
-
-        retry_thread.join()