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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-qconnect-base
-Version: 1.2.2
+Version: 1.3.0
 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.2 → robotframework_qconnect_base-1.3.0}/QConnectBase/connection_base.py

@@ -46,6 +46,11 @@ _platform = platform.system().lower()
 class BrokenConnError(Exception):
    pass
 
+class EndOfBlockNotFound(Exception):
+   pass
+
+class NoFilteredMsgFound(Exception):
+   pass
 
 class ConnectionBase(object):
    """
@@ -61,6 +66,8 @@ Base class for all connection classes.
 
    RECV_MSGS_POLLING_INTERVAL = 0.005
 
+   ACCEPT_VERIFY_PARAMS = None
+
    _call_thrd_obj = None
    _call_thrd_init = threading.Event()
    _call_thrd_term = threading.Event()
@@ -398,14 +405,14 @@ Thread to receive data from connection continuously.
                            else:
                               if matchObj is not None:
                                  back_trace_queue.append(msg)
-                              (is_hit, result_obj) = self._filter_msg(regex_filter, "\n".join(back_trace_queue))
+                              if len(back_trace_queue):
+                                 (is_hit, result_obj) = self._filter_msg(regex_filter, "\r\n".join(back_trace_queue))
                         else:
                            (is_hit, result_obj) = self._filter_msg(regex_filter, msg)
                         if is_hit:
                            now = time.time()
-                           if (use_fetch_block is True) and regex_end_block_pattern and (regex_end_block_pattern.pattern != ".*"):
+                           if (use_fetch_block is True) and regex_end_block_pattern and (regex_end_block_pattern.pattern != ".*") and len(back_trace_queue):
                               result_obj = regex_filter.search("\r\n".join(back_trace_queue))
-                              back_trace_queue.clear()
                            msg_queue.put((now, result_obj), False)
                self.post_msg_check(msg)
          except BrokenConnError as reason:
@@ -562,12 +569,20 @@ Suspend the control flow until a Trace message is received which matches to a sp
       except queue.Empty:
          success = False
       finally:
+         back_trace_queue = self._traceq_obj[trq_handle][2]
+         filtered_line_counter = len(back_trace_queue)
+         back_trace_queue.clear()
          self.deactivate_and_delete_trace_queue(trq_handle, trace_queue)
 
       BuiltIn().log('Completed %s' % _mident, constants.LOG_LEVEL_DEBUG)
+
+      if match is None and filtered_line_counter == 0 and filter_pattern != ".*":
+         raise NoFilteredMsgFound()
       if success:
          return match
       else:
+         if end_of_block_pattern is not None:
+            raise EndOfBlockNotFound()
          return None
 
    def wait_4_trace_continuously(self, trace_queue, timeout=0, *fct_args):

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

@@ -27,7 +27,7 @@
 #
 # *******************************************************************************
 from QConnectBase.utils import *
-from QConnectBase.connection_base import ConnectionBase
+from QConnectBase.connection_base import ConnectionBase, EndOfBlockNotFound, NoFilteredMsgFound
 from robot.libraries.BuiltIn import BuiltIn
 from os.path import dirname
 from QConnectBase.utils import DictToClass
@@ -145,6 +145,31 @@ Constructor for ConnectionManager class.
       self.ROBOT_LIBRARY_LISTENER = self
       self.ROBOT_LISTENER_API_VERSION = 3
 
+   def __validate_optional_verify_parameters(self, optional_params, conn_name):
+      """
+Validate optional parameters for verify keyword.
+
+**Arguments:**
+
+* ``optional_params``
+
+  / *Condition*: required / *Type*: dict /
+
+  Dictionary of optional parameters
+  """
+      connection_obj = self.get_connection_by_name(conn_name, raise_exception=True)
+      accept_verify_params = getattr(connection_obj, 'ACCEPT_VERIFY_PARAMS', None)
+      if accept_verify_params is None:
+         return
+
+      msg_supported_params = ''
+      if len(accept_verify_params) > 0:
+         msg_supported_params = f" Valid params: {', '.join(accept_verify_params)}"
+
+      invalid_params = [k for k in optional_params.keys() if k not in accept_verify_params]
+      if len(invalid_params) > 0:
+         raise Exception(f"Unexpected 'verify' parameter(s) found for '{connection_obj._CONNECTION_TYPE}' connection type: {', '.join(invalid_params)}.{msg_supported_params}")
+
    @staticmethod
    def import_modules_from_paths(paths):
       """
@@ -757,6 +782,7 @@ Verify a pattern from connection response after sending a command.
   - ``${res}[1]`` will be **command**, i.e. the second *captured string* defined in the pattern ``(command)``.
 
       """
+      self.__validate_optional_verify_parameters(kwargs, conn_name)
       validate_regex_pattern(search_pattern, 'search_pattern')
       if timeout is not None and timeout < self.MIN_VERIFY_TIMEOUT:
          raise Exception(
@@ -794,9 +820,16 @@ Verify a pattern from connection response after sending a command.
 
       BuiltIn().log(f"sending command '{send_cmd}' to '{conn_name}' ...", constants.LOG_LEVEL_INFO)
       res = None
+      eob_found = True
+      has_filtered_msg = True
       for i in range(1, match_try+1):
          kwargs['send_cmd'] = send_cmd
-         res = connection_obj.wait_4_trace(search_pattern, timeout, fetch_block, eob_pattern, filter_pattern, **kwargs)
+         try:
+            res = connection_obj.wait_4_trace(search_pattern, timeout, fetch_block, eob_pattern, filter_pattern, **kwargs)
+         except EndOfBlockNotFound:
+            eob_found = False
+         except NoFilteredMsgFound:
+            has_filtered_msg = False
          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)
@@ -804,7 +837,12 @@ Verify a pattern from connection response after sending a command.
             break
 
       if not res:
-         raise AssertionError(f"Failed to match the pattern '{search_pattern}' within '{match_try}' {'try' if match_try == 1 else 'tries'} ({conn_name}).")
+         if not eob_found:
+            raise AssertionError(f"Failed to match the end of block pattern '{eob_pattern}' within '{match_try}' {'try' if match_try == 1 else 'tries'} ({conn_name}).")
+         elif not has_filtered_msg:
+            raise AssertionError(f"Failed to receive any message that matches the filter pattern '{filter_pattern}' within '{match_try}' {'try' if match_try == 1 else 'tries'} ({conn_name}).")
+         else:
+            raise AssertionError(f"Failed to match the pattern '{search_pattern}' within '{match_try}' {'try' if match_try == 1 else 'tries'} ({conn_name}).")
 
       # Determine if the pattern has capturing groups
       has_groups = has_capturing_groups(search_pattern) if search_pattern else False

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

@@ -163,6 +163,7 @@ Check if the connection config is supported by this handler.
       return isinstance(config.logfile, str) and \
              config.logfile != 'nonlog' and \
              config.logfile != 'console' and \
+             config.logfile != '' and \
              config.logfile != constants.DEFAULT_LOGGER
 
 
@@ -250,7 +251,8 @@ Check if the connection config is supported by this handler.
   False if the config is not supported.
       """
       return (isinstance(config.logfile, bool) and config.logfile) or \
-             config.logfile == constants.DEFAULT_LOGGER
+             config.logfile == constants.DEFAULT_LOGGER or \
+             config.logfile == ''
 
 
 class QConsoleHandler(logging.StreamHandler):

{robotframework_qconnect_base-1.2.2 → robotframework_qconnect_base-1.3.0}/QConnectBase/serialclient/serial_base.py

@@ -58,6 +58,7 @@ Class for handling serial connection.
    """
    _CONNECTION_TYPE = "SerialBase"
    _socket_instance = 0
+   ACCEPT_VERIFY_PARAMS = []
 
    def __init__(self, _mode, config):
       """

{robotframework_qconnect_base-1.2.2 → robotframework_qconnect_base-1.3.0}/QConnectBase/tcp/raw/raw_tcp.py

@@ -92,6 +92,7 @@ class RawTCPServer(TCPBaseServer, RawTCPBase):
 Class for a raw tcp connection server.
    """
    _CONNECTION_TYPE = "TCPIPServer"
+   ACCEPT_VERIFY_PARAMS = []
 
    def __init__(self, mode=None, config=None):
       """
@@ -120,6 +121,7 @@ class RawTCPClient(TCPBaseClient, RawTCPBase):
 Class for a raw tcp connection client.
    """
    _CONNECTION_TYPE = "TCPIPClient"
+   ACCEPT_VERIFY_PARAMS = []
 
    def __init__(self, mode=None, config=None):
       """

{robotframework_qconnect_base-1.2.2 → robotframework_qconnect_base-1.3.0}/QConnectBase/tcp/ssh/ssh_client.py

@@ -55,6 +55,8 @@ Class to store the configuration for SSH connection.
    password = ''
    authentication = 'password'
    key_filename = None
+   prompt_regex = r'[#$>] ?$'
+   timeout = 10
 
 
 class SSHClient(TCPBase, TCPBaseClient):
@@ -62,6 +64,7 @@ class SSHClient(TCPBase, TCPBaseClient):
 SSH client connection class.
    """
    _CONNECTION_TYPE = "SSHClient"
+   ACCEPT_VERIFY_PARAMS = []
 
    def __init__(self, _mode, config):
       """
@@ -86,6 +89,7 @@ Constructor for SSHClient class.
       self._llrecv_thrd_obj = None
       self.chan = None
       self.client = None
+      self.shell_ready = threading.Event()
 
       self.config = SSHConfig(**config)
       config_tcp = {
@@ -98,6 +102,8 @@ Constructor for SSHClient class.
       self._password = self.config.password
       self._key_filename = self.config.key_filename
       self._authentication = self.config.authentication
+      self._conn_timeout = getattr(self.config, 'timeout', 10)
+      self._prompt_regex = re.compile(getattr(self.config, 'prompt_regex', r'[#$>] ?$'))
 
       # create the queue for this connection
       self.SSHq = queue.Queue()
@@ -132,6 +138,10 @@ Implementation the thread for getting data from ssh connection.
             for character in data:
                self.SSHq.put(character)
 
+            if not self.shell_ready.is_set():
+               if self._prompt_regex.search(data):
+                  self.shell_ready.set()
+
             if self.chan.closed is True:
                break
 
@@ -219,7 +229,8 @@ Implementation for creating a SSH connection.
       # Therefore we need to open a shell.
       self.chan = self.client.invoke_shell()
       BuiltIn().log("%s: successfully invoked SSH shell for secure communication." % _mident, constants.LOG_LEVEL_DEBUG)
-
+      if not self.shell_ready.wait(timeout=self._conn_timeout):
+         raise TimeoutError(f"Shell prompt is not ready within {self._conn_timeout} seconds after invoking shell.")
       # switch echo off for this terminal
       # echo disturbs when the command contains part of the exepcted reponse, then regexp filtering will
       # fetch the command instead of the response.

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-qconnect-base
-Version: 1.2.2
+Version: 1.3.0
 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