[consutil, config]: add supporting command for console monitor utility (#4208)

What I did
Add new modification and new commands to support console monitor feature. HLD

How I did it
Modify show line commands. Display 2 new column, Oper State and State Duration.
Add new commands config console heartbeat {enable/disable}. Provide configuration ability of console monitor dte (heartbeat sending) service.

How to verify it
Manually tested on physical testbed.

---------

Signed-off-by: cliffchen <t-cliffchen+github@microsoft.com>
Signed-off-by: Zhijian Li <zhijianli@microsoft.com>
Co-authored-by: Zhijian Li <zhijianli@microsoft.com>

Author: wiperi

config/console.py

@@ -57,6 +57,27 @@ def disable_console_switch(db):
 
 
 #
+# 'console heartbeat' group ('config console heartbeat ...')
+#
+@console.command('heartbeat')
+@clicommon.pass_db
+@click.argument('mode', metavar='<mode>', required=True, type=click.Choice(["enable", "disable"]))
+def update_console_heartbeat(db, mode):
+    """Enable/Disable console heartbeat on controlled device (DTE side)"""
+    config_db = ValidatedConfigDBConnector(db.cfgdb)
+
+    table = "CONSOLE_SWITCH"
+    dataKey1 = 'controlled_device'
+    dataKey2 = 'enabled'
+
+    data = {dataKey2: "yes" if mode == "enable" else "no"}
+    try:
+        config_db.mod_entry(table, dataKey1, data)
+    except ValueError as e:
+        ctx = click.get_current_context()
+        ctx.fail("Invalid ConfigDB. Error: {}".format(e))
+
+
 # 'console default_escape' group ('config console default_escape A|B|...')
 #
 @console.command('default_escape')

consutil/lib.py

@@ -9,6 +9,8 @@
 import re
 import subprocess
 import sys
+import time
+
 
 import click
 from sonic_py_common import device_info
@@ -39,6 +41,8 @@
 STATE_KEY = "state"
 PID_KEY = "pid"
 START_TIME_KEY = "start_time"
+OPER_STATE_KEY = "oper_state"
+LAST_STATE_CHANGE_KEY = "last_state_change"
 
 BUSY_FLAG = "busy"
 IDLE_FLAG = "idle"
@@ -49,6 +53,8 @@
 
 UDEV_PREFIX_CONF_FILENAME = "udevprefix.conf"
 
+PTY_SYMLINK_SUFFIX = "-PTS"
+
 TIMEOUT_SEC = 0.2
 
 class ConsolePortProvider(object):
@@ -176,6 +182,48 @@ def busy(self):
     def session_pid(self):
         return self.cur_state[PID_KEY] if PID_KEY in self.cur_state else None
 
+    @property
+    def oper_state(self):
+        return self.cur_state[OPER_STATE_KEY] if OPER_STATE_KEY in self.cur_state else None
+
+    @property
+    def last_state_change(self):
+        return self.cur_state[LAST_STATE_CHANGE_KEY] if LAST_STATE_CHANGE_KEY in self.cur_state else None
+
+    @property
+    def state_duration(self):
+        """Calculate and format the duration since last state change.
+        Format: XdXhXmXs (only shows non-zero parts)
+        """
+        if not self.last_state_change:
+            return None
+        try:
+            ts = int(self.last_state_change)
+            now = int(time.time())
+            diff = now - ts
+            if diff < 0:
+                return None
+
+            # Calculate time components
+            days, remainder = divmod(diff, 24 * 3600)
+            hours, remainder = divmod(remainder, 3600)
+            minutes, seconds = divmod(remainder, 60)
+
+            # Build formatted string, only include non-zero parts for d/h/m, always show seconds
+            parts = []
+            if days > 0:
+                parts.append(f"{days}d")
+            if hours > 0 or days > 0:
+                parts.append(f"{hours}h")
+            if minutes > 0 or hours > 0 or days > 0:
+                parts.append(f"{minutes}m")
+
+            parts.append(f"{seconds}s")  # Always show seconds
+
+            return "".join(parts)
+        except (ValueError, OSError):
+            return None
+
     @property
     def session_start_date(self):
         return self.cur_state[START_TIME_KEY] if START_TIME_KEY in self.cur_state else None
@@ -201,8 +249,9 @@ def connect(self):
         # build and start picocom command
         flow_cmd = "h" if self.flow_control else "n"
         escape_cmd = "-e {}".format(self.escape_char) if self.escape_char else ""
-        cmd = "picocom {} -b {} -f {} {}{}".format(escape_cmd, self.baud, flow_cmd,
-                                                   SysInfoProvider.DEVICE_PREFIX, self.line_num)
+        cmd = "picocom {} -b {} -f {} {}{}{}".format(
+            escape_cmd, self.baud, flow_cmd,
+            SysInfoProvider.DEVICE_PREFIX, self.line_num, PTY_SYMLINK_SUFFIX)
 
         # start connection
         try:
@@ -312,7 +361,7 @@ def list_console_ttys():
         cmd = ["bash", "-c", "ls " + SysInfoProvider.DEVICE_PREFIX + "*"]
         output, _ = SysInfoProvider.run_command(cmd, abort=False)
         ttys = output.split('\n')
-        ttys = list([dev for dev in ttys if re.match(SysInfoProvider.DEVICE_PREFIX + r"\d+", dev) != None])
+        ttys = list([dev for dev in ttys if re.match(SysInfoProvider.DEVICE_PREFIX + r"\d+$", dev)])
         return ttys
 
     @staticmethod
@@ -345,8 +394,8 @@ def _parse_processes_info(output):
         regex_date = r"([A-Z][a-z]{2} [A-Z][a-z]{2} [\d ]\d \d{2}:\d{2}:\d{2} \d{4})"
         # matches any characters ending in minicom or picocom,
         # then a space and any chars followed by /dev/ttyUSB<any digits>,
-        # then a space and any chars
-        regex_cmd = r".*(?:(?:mini)|(?:pico))com .*" + SysInfoProvider.DEVICE_PREFIX + r"(\d+)(?: .*)?"
+        # then any chars
+        regex_cmd = r".*(?:(?:mini)|(?:pico))com .*" + SysInfoProvider.DEVICE_PREFIX + r"(\d+).*"
         regex_process = re.compile(r"^" + regex_pid + r" " + regex_date + r" " + regex_cmd + r"$")
 
         console_processes = {}
@@ -378,10 +427,18 @@ def update_state(self, line_num, state, pid="", date=""):
         self._state_db.set(self._state_db.STATE_DB, key, STATE_KEY, state)
         self._state_db.set(self._state_db.STATE_DB, key, PID_KEY, pid)
         self._state_db.set(self._state_db.STATE_DB, key, START_TIME_KEY, date)
+
+        # Read existing oper_state and last_state_change from STATE_DB
+        existing_data = self._state_db.get_all(self._state_db.STATE_DB, key)
+        oper_state = existing_data.get(OPER_STATE_KEY, "") if existing_data else ""
+        last_state_change = existing_data.get(LAST_STATE_CHANGE_KEY, "") if existing_data else ""
+
         return {
             STATE_KEY: state,
             PID_KEY: pid,
-            START_TIME_KEY: date
+            START_TIME_KEY: date,
+            OPER_STATE_KEY: oper_state,
+            LAST_STATE_CHANGE_KEY: last_state_change
         }
 
 class InvalidConfigurationError(Exception):

consutil/main.py

@@ -44,22 +44,27 @@ def show(db, brief):
     ports.sort(key=lambda p: int(p.line_num))
 
     # set table header style
-    header = ["Line", "Baud", "Flow Control", "PID", "Start Time", "Device"]
+    header = ["Line", "Baud", "Flow Control", "PID", "Start Time", "Device", "Oper State", "State Duration"]
     body = []
     for port in ports:
         # runtime information
         busy = "*" if port.busy else " "
         pid = port.session_pid if port.session_pid else "-"
         date = port.session_start_date if port.session_start_date else "-"
-        baud = port.baud
+        baud = port.baud if port.baud else "-"
         flow_control = "Enabled" if port.flow_control else "Disabled"
+        remote_device = port.remote_device if port.remote_device else "-"
+        oper_state = port.oper_state if port.oper_state else "-"
+        state_duration = port.state_duration if port.state_duration else "-"
         body.append([
             busy+port.line_num,
             baud if baud else "-",
             flow_control,
             pid if pid else "-",
             date if date else "-",
-            port.remote_device,
+            remote_device,
+            oper_state,
+            state_duration,
         ])
     click.echo(tabulate(body, header, stralign='right'))