robotframework-qconnect-base 1.2.1__tar.gz → 1.2.2__tar.gz

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-qconnect-base
-Version: 1.2.1
+Version: 1.2.2
 Summary: Robot Framework test library for TCP, SSH, serial connection
 Home-page: https://github.com/test-fullautomation/robotframework-qconnect-base
 Author: Nguyen Huynh Tri Cuong

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/connection_base.py

@@ -517,7 +517,7 @@ Suspend the control flow until a Trace message is received which matches to a sp
 
 * ``timeout``
 
-  / *Condition*: optional / *Type*: int / *Default*: 0 /
+  / *Condition*: optional / *Type*: float / *Default*: 0 /
 
   Timeout parameter specified as a floating point number in the unit 'seconds'.
 

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/connection_manager.py

@@ -32,6 +32,7 @@ from robot.libraries.BuiltIn import BuiltIn
 from os.path import dirname
 from QConnectBase.utils import DictToClass
 from robot.api.deco import keyword
+from robot.api.deco import library
 from robot.utils import timestr_to_secs
 import os
 import importlib
@@ -95,18 +96,16 @@ Class for storing parameters for verify action.
    element_def = {}
    args = None
 
-
+@library(scope='GLOBAL', version=VERSION, auto_keywords=False, doc_format="reST")
 class ConnectionManager(Singleton):
    """
 Class to manage all connections.
    """
-   ROBOT_LIBRARY_SCOPE = 'GLOBAL'
-   ROBOT_AUTO_KEYWORDS = False
    LIBRARY_EXTENSION_PREFIX = 'robotframework_qconnect'
    LIBRARY_EXTENSION_PREFIX2 = 'QConnect'
+   MIN_VERIFY_TIMEOUT = 0.001
    DEFAULT_VERIFY_TIMEOUT = 5
    DEFAULT_EMERGENCY_TIMEOUT = 60 * 30
-   ROBOT_LIBRARY_VERSION = VERSION
 
    id = 0
 
@@ -137,25 +136,7 @@ Constructor for ConnectionManager class.
       all_libs = [main_lib_path]
       all_libs.extend(extension_lib_paths)
       all_libs = list(set(all_libs))
-      for path in all_libs:
-         if path not in sys.path:
-            sys.path.append(path)
-      for module_loader, name, is_pkg in pkgutil.walk_packages(all_libs):
-         # noinspection PyBroadException
-         try:
-            if not is_pkg and not name.startswith("setup"):
-               importlib.import_module(name)
-            else:
-               # _module = module_loader.find_module(name).load_module(name)
-               spec = importlib.util.find_spec(name)
-               if spec and spec.loader:
-                  module = importlib.util.module_from_spec(spec)
-                  spec.loader.exec_module(module)
-               else:
-                  print(f"⚠️ Could not load module: {name}")
-         except Exception as _ex:
-            pass
-
+      ConnectionManager.import_modules_from_paths(all_libs)
       supported_connection_classes_list = Utils.get_all_descendant_classes(ConnectionBase)
       self.supported_connection_classes_dict = {cls._CONNECTION_TYPE: cls for cls in supported_connection_classes_list}
 
@@ -164,6 +145,49 @@ Constructor for ConnectionManager class.
       self.ROBOT_LIBRARY_LISTENER = self
       self.ROBOT_LISTENER_API_VERSION = 3
 
+   @staticmethod
+   def import_modules_from_paths(paths):
+      """
+Import all modules from given paths.
+
+**Arguments:**
+
+* ``paths``
+
+  / *Condition*: required / *Type*: list /
+
+  List of paths to import modules from.
+      """
+      for path in paths:
+         for prefix in [ConnectionManager.LIBRARY_EXTENSION_PREFIX, ConnectionManager.LIBRARY_EXTENSION_PREFIX2]:
+            if prefix in path:
+               if os.path.isdir(path):
+                  for root, dirs, files in os.walk(path):
+                     for file in files:
+                        if file.endswith('.py'):
+                           module_path = os.path.join(root, file)
+                           module_name = os.path.splitext(os.path.relpath(module_path, os.path.dirname(path)))[0].replace(
+                              os.sep, '.')
+                           if module_name not in sys.modules:
+                              spec = importlib.util.spec_from_file_location(module_name, module_path)
+                              if spec and spec.loader:
+                                 module = importlib.util.module_from_spec(spec)
+                                 sys.modules[module_name] = module
+                                 try:
+                                    spec.loader.exec_module(module)
+                                 except Exception as _ex:
+                                    pass
+               elif os.path.isfile(path) and path.endswith('.py'):
+                  module_name = os.path.splitext(os.path.basename(path))[0]
+                  if module_name not in sys.modules:
+                     spec = importlib.util.spec_from_file_location(module_name, path)
+                     if spec and spec.loader:
+                        module = importlib.util.module_from_spec(spec)
+                        sys.modules[module_name] = module
+                        try:
+                           spec.loader.exec_module(module)
+                        except Exception as _ex:
+                           pass
 
    def __del__(self):
       """
@@ -234,8 +258,7 @@ Remove a connection by name.
       if conn_name in self.connection_manage_dict.keys():
          del self.connection_manage_dict[conn_name]
 
-
-   def get_connection_by_name(self, conn_name):
+   def get_connection_by_name(self, conn_name, raise_exception=False):
       """
 Get an exist connection by name.
 
@@ -247,6 +270,12 @@ Get an exist connection by name.
 
   Connection's name.
 
+* ``raise_exception``
+
+  / *Condition*: optional / *Type*: bool /
+
+  If True, raise exception when connection is not found.
+
 **Returns:**
 
 * ``conn``
@@ -258,6 +287,10 @@ Get an exist connection by name.
       conn = None
       if conn_name in self.connection_manage_dict.keys():
          conn = self.connection_manage_dict[conn_name]
+
+      if raise_exception and conn is None:
+         raise Exception(constants.String.CONNECTION_NOT_CONNECTED % conn_name)
+
       return conn
 
    @keyword
@@ -306,13 +339,11 @@ Making a connection.
 
   Example ``conn_conf`` for ``TCPIPClient``:
 
-  ```
-  {
-    "conn_type": "TCPIPClient",
-    "address": [server host], # Optional. Default value is "localhost".
-    "port": [server port]     # Optional. Default value is 1234.
-  }
-  ```
+  |   {
+  |      "conn_type": "TCPIPClient",
+  |      "address": [server host], # Optional. Default value is "localhost".
+  |      "port": [server port]     # Optional. Default value is 1234.
+  |   }
 
 * ``conn_type`` (deprecated)
 
@@ -321,6 +352,7 @@ Making a connection.
   Type of connection. It can be specified in ``conn_conf`` dictionary.
 
   Supported connection types:
+
   - ``TCPIPClient``: Create a Raw TCP/IP connection to TCP Server.
   - ``SSHClient``: Create a client connection to a SSH server.
   - ``SerialClient``: Create a client connection via Serial Port.
@@ -429,9 +461,7 @@ Send command to a connection.
 
 (*no returns*)
       """
-      if conn_name not in self.connection_manage_dict.keys():
-         raise AssertionError("The '%s' connection hasn't been established. Please connect first." % conn_name)
-      connection_obj = self.connection_manage_dict[conn_name]
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
       try:
          connection_obj.send_obj(command, **kwargs)
          BuiltIn().log(f"command '{command}' is sent to '{conn_name}'", constants.LOG_LEVEL_INFO)
@@ -478,13 +508,11 @@ Transfer file from local to remote and vice versa.
 
 (*no returns*)
       """
-      if conn_name not in self.connection_manage_dict.keys():
-         raise AssertionError(f"The '{conn_name}' connection  hasn't been established. Please connect first.")
-      connection_obj = self.connection_manage_dict[conn_name]
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
       try:
          connection_obj.transfer_file(src, dest, type)
       except AttributeError:
-         raise Exception(f"'{connection_obj._CONNECTION_TYPE}' connection type has not been supported for transferring file.") from None
+         raise Exception(constants.String.CONNECTION_UNSUPPORTED_KEYWORD % (connection_obj._CONNECTION_TYPE, "file transfer")) from None
       except Exception as ex:
          raise Exception(f"Unable to transfer file to '{conn_name}' connection. Exception: '{ex}'") from None
 
@@ -527,17 +555,14 @@ Transfer item from local to remote and vice versa.
 
 (*no returns*)
       """
-      if conn_name not in self.connection_manage_dict.keys():
-         raise AssertionError(f"The '{conn_name}' connection  hasn't been established. Please connect first.")
-      connection_obj = self.connection_manage_dict[conn_name]
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
       try:
          connection_obj.transfer_item(src, dest, type)
       except AttributeError:
-         raise Exception(f"'{connection_obj._CONNECTION_TYPE}' connection type has not been supported for transferring item.") from None
+         raise Exception(constants.String.CONNECTION_UNSUPPORTED_KEYWORD % (connection_obj._CONNECTION_TYPE, "item transfer")) from None
       except Exception as ex:
          raise Exception(f"Unable to transfer item to '{conn_name}' connection. Exception: '{ex}'") from None
 
-
    @keyword
    def execute_script(self, conn_name, script_path):
       """
@@ -561,14 +586,12 @@ Executes a script file by sending commands to a device through the provided conn
 
 (*no returns*)
       """
-      if conn_name not in self.connection_manage_dict.keys():
-         raise AssertionError("The '%s' connection hasn't been established. Please connect first." % conn_name)
-      connection_obj = self.connection_manage_dict[conn_name]
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
       try:
          connection_obj.execute_script(script_path)
       except AttributeError as attrErr:
          test = inspect.getfile(connection_obj.__class__)
-         raise Exception("'%s' connection type has not been supported for execute script." % connection_obj._CONNECTION_TYPE) from None
+         raise Exception(constants.String.CONNECTION_UNSUPPORTED_KEYWORD % (connection_obj._CONNECTION_TYPE, "script execution")) from None
       except Exception as ex:
          raise Exception("Unable to execute script path '%s'. Exception: %s" % (script_path, str(ex))) from None
 
@@ -578,6 +601,7 @@ Executes a script file by sending commands to a device through the provided conn
 Set the default verify timeout value for the connection.
 
 Supports flexible input formats such as:
+
 - Duration with units (e.g. '1h 10s', '2m30s', '500ms')
 - HH:MM:SS format (e.g. '01:00:10' for 1 hour, 0 minutes, 10 seconds)
 - Plain numeric values (e.g. '42') interpreted as seconds
@@ -593,6 +617,7 @@ Supports flexible input formats such as:
     - ``m``  for minutes (or ``ms`` for milliseconds)
     - ``s``  for seconds
     - ``ms`` for milliseconds
+
   If no unit is specified, the value is interpreted as seconds.
       """
       time_second = timestr_to_secs(time_out)
@@ -621,6 +646,7 @@ Supports flexible input formats such as:
     - ``m``  for minutes (or ``ms`` for milliseconds)
     - ``s``  for seconds
     - ``ms`` for milliseconds
+
   If no unit is specified, the value is interpreted as seconds.
       """
       time_second = timestr_to_secs(time_out)
@@ -648,6 +674,7 @@ Verify a pattern from connection response after sending a command.
   Expectation expressed as a **regular expression pattern** (more robust than a plain string comparison).
 
   It will match:
+
   - a single line by default (``fetch_block`` not used)
   - multiple lines if ``fetch_block`` is enabled
 
@@ -725,14 +752,17 @@ Verify a pattern from connection response after sending a command.
   then the returned list will be ``['1st', 'command']``.
 
   Thus:
-  - ``${res}[0]`` will be **1st**,
-  i.e. the first *captured string* defined in the pattern ``([0-9]..)``.
 
-  - ``${res}[1]`` will be **command**,
-  i.e. the second *captured string* defined in the pattern ``(command)``.
+  - ``${res}[0]`` will be **1st**, i.e. the first *captured string* defined in the pattern ``([0-9]..)``.
+  - ``${res}[1]`` will be **command**, i.e. the second *captured string* defined in the pattern ``(command)``.
 
       """
       validate_regex_pattern(search_pattern, 'search_pattern')
+      if timeout is not None and timeout < self.MIN_VERIFY_TIMEOUT:
+         raise Exception(
+            f"Timeout value '{timeout}' is too small. "
+            f"Please enter a value of {self.MIN_VERIFY_TIMEOUT} seconds or higher."
+         )
       # Parameter validation: eob_pattern and filter_pattern are only valid when fetch_block is True
       if not fetch_block:
          if eob_pattern != None:
@@ -747,16 +777,13 @@ Verify a pattern from connection response after sending a command.
          if filter_pattern and has_capturing_groups(filter_pattern, 'filter_pattern'):
             BuiltIn().log(f"Warning: Capturing groups are not supported within the filter_pattern '{filter_pattern}'.", constants.LOG_LEVEL_WARNING)
 
-      if conn_name not in self.connection_manage_dict.keys():
-         raise AssertionError("The '%s' connection hasn't been established. Please connect first." % conn_name)
-
       # if search_pattern is None:
       #    raise Exception("The 'search_pattern' have to be a regex string instead of None.")
 
       if send_cmd is None:
          send_cmd = ''
 
-      connection_obj = self.connection_manage_dict[conn_name]
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
       if connection_obj.get_connection_type() in ["DLT", "DLTConnector", "TTFisclient"]:
          match_try = 5
 
@@ -769,7 +796,7 @@ Verify a pattern from connection response after sending a command.
       res = None
       for i in range(1, match_try+1):
          kwargs['send_cmd'] = send_cmd
-         res = connection_obj.wait_4_trace(search_pattern, int(timeout), fetch_block, eob_pattern, filter_pattern, **kwargs)
+         res = connection_obj.wait_4_trace(search_pattern, timeout, fetch_block, eob_pattern, filter_pattern, **kwargs)
          if res is None:
             log_level = constants.LOG_LEVEL_WARNING if (i == match_try) else constants.LOG_LEVEL_INFO
             BuiltIn().log(f"[{conn_name}] Match try {i}/{match_try} timed out ('{search_pattern}')", log_level)

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/constants.py

@@ -38,6 +38,8 @@ LOG_LEVEL_DEBUG = 'DEBUG'
 LOG_LEVEL_ERROR = 'ERROR'
 LOG_LEVEL_WARNING = 'WARN'
 
+DEFAULT_LOGGER = "DEFAULT_FILE"
+
 LOG_FORMATTER = "%(asctime)s [%(threadName)-.128s] [%(levelname)-5.5s]  %(message)s"
 platform_ = platform.system().lower()
 if platform_.startswith(OS_WINDOWS_STR):
@@ -65,3 +67,5 @@ class String:
    CONNECTION_TYPE_CONFUSED = "Mismatch: 'conn_type' (%s) and 'con_conf[\"conn_type\"]' (%s) both set but differ. Expected: set in only one or identical in both."
    CONNECTION_MODE_CONFUSED = "Mismatch: 'conn_mode' (%s) and 'con_conf[\"conn_mode\"]' (%s) both set but differ. Expected: set in only one or identical in both."
    CONNECTION_BROKEN = "Connection has been broken while trying to match the pattern."
+   CONNECTION_UNSUPPORTED_KEYWORD = "'%s' connection type is not supported for %s."
+   CONNECTION_NOT_CONNECTED = "The '%s' connection hasn't been established. Please connect first."

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/qlogger.py

@@ -31,6 +31,7 @@ from QConnectBase.utils import *
 import QConnectBase.constants as constants
 import logging
 import os
+import sys
 
 
 class ColorFormatter(logging.Formatter):
@@ -104,7 +105,7 @@ Constructor for QFileHandler class.
   Log's formatter.
       """
       path = self.get_log_path(config)
-      super(QFileHandler, self).__init__(path)
+      super(QFileHandler, self).__init__(path, mode='w')
       self.setFormatter(formatter)
 
    @staticmethod
@@ -126,13 +127,17 @@ Get the log file path for this handler.
 
   Log file path.
       """
-      out_dir = BuiltIn()._context.output._settings.output_directory
+      try:
+         out_dir = BuiltIn()._context.output._settings.output_directory
+      except Exception:
+         out_dir = os.getcwd()
+
       dir_log = os.path.dirname(config.logfile)
       if not os.path.isabs(dir_log):
-         dir_log = out_dir + '/' + dir_log
+         dir_log = os.path.join(out_dir, dir_log)
       if not os.path.exists(dir_log):
          os.makedirs(dir_log)
-      return "{0}/{1}".format(dir_log, os.path.basename(config.logfile))
+      return os.path.join(dir_log, os.path.basename(config.logfile))
 
    @staticmethod
    def get_config_supported(config):
@@ -155,7 +160,10 @@ Check if the connection config is supported by this handler.
 
   False if the config is not supported.
       """
-      return config.logfile is not None and config.logfile != 'nonlog' and config.logfile != 'console'
+      return isinstance(config.logfile, str) and \
+             config.logfile != 'nonlog' and \
+             config.logfile != 'console' and \
+             config.logfile != constants.DEFAULT_LOGGER
 
 
 class QDefaultFileHandler(logging.FileHandler):
@@ -214,8 +222,11 @@ Get the log file path for this handler.
 
   Log file path.
       """
-      out_dir = BuiltIn()._context.output._settings.output_directory
-      return "{0}/{1}.log".format(out_dir, logger_name + "_trace")
+      try:
+         out_dir = BuiltIn()._context.output._settings.output_directory
+      except Exception:
+         out_dir = os.getcwd()
+      return os.path.join(out_dir, logger_name + "_trace.log")
 
    @staticmethod
    def get_config_supported(config):
@@ -238,7 +249,8 @@ Check if the connection config is supported by this handler.
 
   False if the config is not supported.
       """
-      return config.logfile is None
+      return (isinstance(config.logfile, bool) and config.logfile) or \
+             config.logfile == constants.DEFAULT_LOGGER
 
 
 class QConsoleHandler(logging.StreamHandler):
@@ -247,7 +259,7 @@ Handler class for console log.
    """
    def __init__(self, _config, _logger_name, _formatter):
       """
-Constructor for QDefaultFileHandler class.
+Constructor for QConsoleHandler class.
 
 **Arguments:**
 
@@ -273,7 +285,7 @@ Constructor for QDefaultFileHandler class.
 
 (*no returns*)
       """
-      super(QConsoleHandler, self).__init__()
+      super(QConsoleHandler, self).__init__(sys.__stdout__)
       self.setFormatter(ColorFormatter())
 
    @staticmethod
@@ -370,11 +382,11 @@ Set handler for logger.
       for handler in supported_handler_classes_list:
          # noinspection PyBroadException
          try:
-            if handler.get_config_supported(config):
+            if hasattr(handler, 'get_config_supported') and handler.get_config_supported(config):
                handler_ins = handler(config, self.logger_name, self.formatter)
                handler_ins.setLevel(log_level)
                self.logger.addHandler(handler_ins)
                return handler_ins
-         except:
-            pass
+         except Exception as reason:
+            raise Exception(f"Failed to initialize logger for '{config.logfile}'. Reason: {reason}.") from None
       return None

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/utils.py

@@ -67,7 +67,7 @@ class DictToClass:
 Class for converting dictionary to class object.
    """
    exclude_list = []
-   logfile = None
+   logfile = constants.DEFAULT_LOGGER
    encoding = 'utf-8'
 
    def __init__(self, **dictionary):
@@ -86,6 +86,13 @@ Class for converting dictionary to class object.
                   self.__dict__[k] = v
       except Exception as ex:
          raise Exception(f"The configuration 'conn_conf' is invalid. Details: {ex}") from None
+
+      if not isinstance(self.logfile, (bool, str)) and self.logfile is not None:
+         raise TypeError(
+            f"The configuration parameter 'logfile' inside 'conn_conf' must be of type bool, str, or None. "
+            f"Received type: {type(self.logfile).__name__} with value: {self.logfile!r}."
+         )
+
       self.validate()
 
    def validate(self):

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/QConnectBase/version.py

@@ -12,5 +12,5 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-VERSION      = '1.2.1'
-VERSION_DATE = '06.11.2025'
+VERSION      = '1.2.2'
+VERSION_DATE = '25.11.2025'

{robotframework_qconnect_base-1.2.1 → robotframework_qconnect_base-1.2.2}/robotframework_qconnect_base.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-qconnect-base
-Version: 1.2.1
+Version: 1.2.2
 Summary: Robot Framework test library for TCP, SSH, serial connection
 Home-page: https://github.com/test-fullautomation/robotframework-qconnect-base
 Author: Nguyen Huynh Tri Cuong