show commands for system ready and application extension package app ready support

Author: sg893052

scripts/sysreadyshow

@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+
+"""
+    Script to show system ready status.
+"""
+
+import os
+import sys
+import argparse
+from tabulate import tabulate
+from natsort import natsorted
+
+# mock the redis for unit test purposes #
+try:
+    if os.environ["UTILITIES_UNIT_TESTING"] == "1":
+        modules_path = os.path.join(os.path.dirname(__file__), "..")
+        test_path = os.path.join(modules_path, "tests")
+        sys.path.insert(0, modules_path)
+        sys.path.insert(0, test_path)
+        import mock_tables.dbconnector
+except KeyError:
+    pass
+
+from swsscommon.swsscommon import SonicV2Connector
+
+header = ['Service-Name', 'Service-Status', 'App-Ready-Status', 'Down-Reason']
+header_detail = ['Service-Name', 'Service-Status', 'App-Ready-Status', 'Down-Reason', 'AppStatus-UpdateTime']
+
+ALL_TABLE_NAME = 'ALL_SERVICE_STATUS'
+SERVICE_STATUS = 'service_status'
+APP_READY_STATUS = 'app_ready_status'
+FAIL_REASON = 'fail_reason'
+UPDATE_TIME = 'update_time'
+
+class SysreadyShow(object):
+    def __init__(self):
+        self.db = SonicV2Connector(host="127.0.0.1")
+        self.db.connect(self.db.STATE_DB)
+
+    def show(self,type):
+        TABLE_NAME = ALL_TABLE_NAME
+        SYSREADY_TABLE = "SYSTEM_READY|SYSTEM_STATE"
+        
+        keys = self.db.keys(self.db.STATE_DB, TABLE_NAME + '*')
+        if not keys:
+            print('No info\n')
+            return
+
+        table = []
+        for key in natsorted(keys):
+            key_list = key.split('|')
+            if len(key_list) != 2: # error data in DB, log it and ignore
+                print('Warn: Invalid key in table {}: {}'.format(TABLE_NAME, key))
+                continue
+
+            name = key_list[1]
+            data_dict = self.db.get_all(self.db.STATE_DB, key)
+            try:
+                service_status = data_dict[SERVICE_STATUS]
+                app_ready_status = data_dict[APP_READY_STATUS]
+                fail_reason = data_dict[FAIL_REASON]
+                update_time = data_dict[UPDATE_TIME]
+            except ValueError as e:
+                print('Error in data_dict')
+
+            if type == "alldetail":
+                table.append((name, data_dict[SERVICE_STATUS], data_dict[APP_READY_STATUS], data_dict[FAIL_REASON], 
+                            data_dict[UPDATE_TIME]))
+                header_info = header_detail
+            else:
+                table.append((name, data_dict[SERVICE_STATUS], data_dict[APP_READY_STATUS], data_dict[FAIL_REASON]))
+                header_info = header
+        
+        sysready_state = self.db.get(self.db.STATE_DB, SYSREADY_TABLE, "Status")
+        if sysready_state == "UP":
+            print("System is ready\n")
+        else:
+            print("System is not ready - one or more services are not up\n")
+        
+
+        if type == "allbrief":
+            return
+
+
+        if table:
+            print(tabulate(table, header_info, tablefmt='simple', stralign='left'))
+        else:
+            print('No sysready status data available\n')
+    
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Display the System Ready status',
+                                     formatter_class=argparse.RawTextHelpFormatter,
+                                     epilog="""
+                                      Examples:
+                                      sysreadyshow --all
+                                      sysreadyshow --allbrief
+                                      sysreadyshow --alldetail
+                                      """)
+
+    parser.add_argument('-a', '--all', action='store_true', help='all service status', default=True)
+    parser.add_argument('-b', '--allbrief', action='store_true', help='all service status brief', default=False)
+    parser.add_argument('-d', '--alldetail', action='store_true', help='all service status detail', default=False)
+    args = parser.parse_args()
+
+    try:
+        sysready = SysreadyShow()
+        if args.alldetail:
+            sysready.show("alldetail")
+        elif args.allbrief:
+            sysready.show("allbrief")
+        else:
+            sysready.show("all")
+    except Exception as e:
+        print(str(e), file=sys.stderr)
+        sys.exit(1)
+        
+
+if __name__ == "__main__":
+    main()

setup.py

@@ -146,7 +146,8 @@
         'scripts/null_route_helper',
         'scripts/coredump_gen_handler.py',
         'scripts/techsupport_cleanup.py',
-        'scripts/check_db_integrity.py'
+        'scripts/check_db_integrity.py',
+        'scripts/sysreadyshow'
     ],
     entry_points={
         'console_scripts': [

show/system_health.py

@@ -4,7 +4,7 @@
 import click
 from tabulate import tabulate
 import utilities_common.cli as clicommon
-
+import subprocess
 #
 # 'system-health' command ("show system-health")
 #
@@ -198,3 +198,64 @@ def monitor_list():
             entry.append(element[1]['type'])
             table.append(entry)
     click.echo(tabulate(table, header))
+
+
+
+def run_command(command, display_cmd=False, return_cmd=False):
+    if display_cmd:
+        click.echo(click.style("Command: ", fg='cyan') + click.style(command, fg='green'))
+
+    # No conversion needed for intfutil commands as it already displays
+    # both SONiC interface name and alias name for all interfaces.
+    if clicommon.get_interface_naming_mode() == "alias" and not command.startswith("intfutil"):
+        clicommon.run_command_in_alias_mode(command)
+        raise sys.exit(0)
+
+    proc = subprocess.Popen(command, shell=True, text=True, stdout=subprocess.PIPE)
+
+    while True:
+        if return_cmd:
+            output = proc.communicate()[0]
+            return output
+        output = proc.stdout.readline()
+        if output == "" and proc.poll() is not None:
+            break
+        if output:
+            click.echo(output.rstrip('\n'))
+
+    rc = proc.poll()
+    if rc != 0:
+        sys.exit(rc)
+
+
+@system_health.group('sysready-status',invoke_without_command=True)
+#@system_health.command()
+@click.pass_context
+def sysready_status(ctx):
+    """Show system-health system ready status"""
+
+    if ctx.invoked_subcommand is None:
+        try:
+            cmd = "sudo sysreadyshow --all"
+            run_command(cmd, display_cmd=False)
+
+        except Exception as e:
+            click.echo("Exception: {}".format(str(e)))
+
+
+@sysready_status.command('brief')
+def sysready_status_brief():
+    try:
+        cmd = "sudo sysreadyshow --allbrief"
+        run_command(cmd, display_cmd=False)
+    except Exception as e:
+        click.echo("Exception: {}".format(str(e)))
+
+
+@sysready_status.command('detail')
+def sysready_status_detail():
+    try:
+        cmd = "sudo sysreadyshow --alldetail"
+        run_command(cmd, display_cmd=False)
+    except Exception as e:
+        click.echo("Exception: {}".format(str(e)))

sonic_package_manager/manifest.py

@@ -177,6 +177,7 @@ def unmarshal(self, value):
             ManifestField('asic-service', DefaultMarshaller(bool), False),
             ManifestField('host-service', DefaultMarshaller(bool), True),
             ManifestField('delayed', DefaultMarshaller(bool), False),
+            ManifestField('check_up_status', DefaultMarshaller(bool), False),
             ManifestRoot('warm-shutdown', [
                 ManifestArray('after', DefaultMarshaller(str)),
                 ManifestArray('before', DefaultMarshaller(str)),

sonic_package_manager/service_creator/feature.py

@@ -143,4 +143,5 @@ def get_non_configurable_feature_entries(manifest) -> Dict[str, str]:
             'has_per_asic_scope': str(manifest['service']['asic-service']),
             'has_global_scope': str(manifest['service']['host-service']),
             'has_timer': str(manifest['service']['delayed']),
+            'check_up_status': str(manifest['service']['check_up_status']),
         }

tests/sonic_package_manager/test_service_creator.py

@@ -215,6 +215,7 @@ def test_feature_registration(mock_sonic_db, manifest):
         'has_per_asic_scope': 'False',
         'has_global_scope': 'True',
         'has_timer': 'False',
+        'check_up_status': 'False',
     })
 
 
@@ -227,6 +228,7 @@ def test_feature_update(mock_sonic_db, manifest):
         'has_per_asic_scope': 'False',
         'has_global_scope': 'True',
         'has_timer': 'False',
+        'check_up_status': 'False',
     }
     mock_connector = Mock()
     mock_connector.get_entry = Mock(return_value=curr_feature_config)
@@ -249,6 +251,7 @@ def test_feature_update(mock_sonic_db, manifest):
             'has_per_asic_scope': 'False',
             'has_global_scope': 'True',
             'has_timer': 'True',
+            'check_up_status': 'False',
         }),
     ], any_order=True)
 
@@ -268,6 +271,7 @@ def test_feature_registration_with_timer(mock_sonic_db, manifest):
         'has_per_asic_scope': 'False',
         'has_global_scope': 'True',
         'has_timer': 'True',
+        'check_up_status': 'False',
     })
 
 
@@ -285,4 +289,5 @@ def test_feature_registration_with_non_default_owner(mock_sonic_db, manifest):
         'has_per_asic_scope': 'False',
         'has_global_scope': 'True',
         'has_timer': 'False',
+        'check_up_status': 'False',
     })