Common functions for show CLI support on multi ASIC #999

arlakshm · 2020-07-20T21:41:52Z

Common functions for show CLI support on multi ASIC
Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan arlakshm@microsoft.com

Depends on this PR
sonic-net/sonic-buildimage#4973

- What I did
Add a set of common function will be used to support SONiC CLIs for multi ASIC
- How I did it

- How to verify it

- Previous command output (if the output of a command-line utility has changed)
NA
- New command output (if the output of a command-line utility has changed)
NA

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

lgtm-com · 2020-07-20T21:48:17Z

This pull request introduces 3 alerts when merging 768ab07 into 82dfe50 - view on LGTM.com

new alerts:

3 for Unused import

jleveque · 2020-07-20T22:29:02Z

utilities_common/multi_asic.py

+        swsssdk.SonicDBConfig.load_sonic_global_db_config()
+        self.current_namespace = None
+
+    def connect_dbs_for_ns(self,namespace=DEFAULT_NAMESPACE):


I recently opened a PR to add a "sonic-py-common" library in sonic-buildimage to house common Python functions (sonic-net/sonic-buildimage#5003). It will replace sonic_device_util. I think some of these functions like this one (which are not CLI-specific) can eventually be moved there, in a multi_asic.py file. That way they can be shared by more than just sonic-utilities. This file should hold multi-ASIC functions that are specific to the CLI.

@jleveque I agree. I will move the common functions 'sonic-py-common' once the PRs are merged.

Great! I have created an issue here to track it: #1000

jleveque · 2020-07-20T22:39:32Z

Retest this please

smaheshm · 2020-07-21T18:20:18Z

utilities_common/multi_asic.py

+import subprocess
+import json
+import click
+import functools


alphabetical order?

Fixed in the latest commit

smaheshm · 2020-07-21T18:21:30Z

utilities_common/multi_asic.py

+import swsssdk
+from swsssdk import ConfigDBConnector
+import argparse


Also, follow PEP8 import ordering convention:

Imports should be grouped in the following order:

Standard library imports.
Related third party imports.
Local application/library specific imports.
You should put a blank line between each group of imports.

https://www.python.org/dev/peps/pep-0008/#imports

Fixed in the latest commit.

smaheshm · 2020-07-21T18:23:03Z

utilities_common/multi_asic.py

+DEFAULT_NAMESPACE = ''
+DISPLAY_ALL = 'all'
+DISPLAY_EXTERNAL = 'frontend'
+PORT_CHANNEL_OBJ = 'PORT_CHANNEL'
+PORT_OBJ = 'PORT'
+BGP_NEIGH_OBJ = 'BGP_NEIGH'


wondering if some of these constants can potentially be used in other files. If that's the case lets create utilities_common/consts.py. It's cleaner and more readable if all constants are in one place.

add a new file constants.py with all the constants in it

smaheshm · 2020-07-21T18:28:41Z

utilities_common/multi_asic.py

+        In case of multi ASIC, the default namespace in the database instance running the on the host
+        In case of single ASIC, the namespace has to DEFAULT_NAMESPACE


"is the database instance"
"has to be .."

Fixed in the latest commit

smaheshm · 2020-07-21T18:29:56Z

utilities_common/multi_asic.py

+        '''
+        The function connects to the config DB for a given namespace and
+        returns the handle
+        If no namespace is provide, it will connect to the db in the


"...provided.."

Fixed in the latest commit

smaheshm · 2020-07-21T18:31:05Z

utilities_common/multi_asic.py

+        In case of multi ASIC, the default namespace in the database instance running the on the host
+        In case of single ASIC, the namespace has to DEFAULT_NAMESPACE


same as above.. "copy - pasta :)"

Fixed in the latest commit

smaheshm · 2020-07-21T18:32:41Z

utilities_common/multi_asic.py

+        The function check if a CLI object is internal and returns true or false.
+        For single asic, this function is not applicable


can you also add the definition of "internal".

added in the latest commit

smaheshm · 2020-07-21T18:36:48Z

utilities_common/multi_asic.py

+        returns false, if the cli option is all or if it the platform is single ASIC.
+
+        '''
+        if not is_multi_npu():


perhaps this can be added in the constuctor.

self.is_multi_npu = is_multi_npu()

smaheshm · 2020-07-21T18:40:26Z

utilities_common/multi_asic.py

+            else:
+                ns_list = [self.namespace_option]


We should validate namespace here. With this class we don't expect CLIs to get namespace list and validate the namespace.

added validation in the latest commit

smaheshm

Minor changes.

smaheshm · 2020-07-21T20:29:51Z

utilities_common/multi_asic.py

+PORT_OBJ = 'PORT'
+BGP_NEIGH_OBJ = 'BGP_NEIGH'
+
+class MultiAsic(object):


This sounds like the class is for 'MultiAsic' only where as, If I understand correctly, all CLIs will use it on both single ASIC and multi ASIC platforms. Wondering if we should rename to something like 'SwitchAsic'. Either way is fine, lets hear others opinion.

I agree the name is a bit misleading, but I'm not sure if SwitchAsic is better. I feel like it needs a more generic name, but I can't think of anything at the moment. Maybe as more functionality is added to it we'll have a better idea of what to call it. I'm OK with saving a renaming for a future PR.

smaheshm · 2020-07-21T21:11:54Z

utilities_common/multi_asic.py

+
+    '''
+    @functools.wraps(func)
+    def wrapped_run_on_all_asics(self, *args, **kwargs):


This is accessing class instance inside the decorator. Either decorator should be inside the CLI class, or we should come up with another way to run command in multiple namespaces.

The decorator is for a function in the CLI class.

Would prefer not changing the object state outside its domain. How about adding an API inside class, and call it from here.

def connect_dbs(ns): self.multi_asic.current_namespace = ns self.db = connect_to_all_dbs_for_ns(ns) self.config_db = connect_config_db_for_ns(ns)

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

utilities_common/multi_asic.py

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

lgtm-com · 2020-07-24T07:31:52Z

This pull request introduces 4 alerts when merging 15dbd2f into aa1b072 - view on LGTM.com

new alerts:

3 for Unused import
1 for 'import *' may pollute namespace

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

arlakshm · 2020-08-06T17:07:55Z

retest this please

arlakshm · 2020-08-06T19:58:44Z

retest this please

arlakshm · 2020-08-10T20:00:12Z

retest this please

arlakshm · 2020-08-11T13:18:14Z

retest this please

arlakshm · 2020-08-12T17:31:11Z

retest this please

arlakshm · 2020-08-12T17:36:26Z

@jleveque, @lguohan, @smaheshm All review comments are addressed. Please approve if there are no other comments

smaheshm

looks good.

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

judyjoseph · 2020-08-14T18:25:06Z

utilities_common/multi_asic.py

+        return ns_list
+
+
+def multi_asic_ns_choices():


This API may not be required as multi_asic.get_namespace_list() already gives the namespacelist correctly. But, it is ok for now - could remove later as well.

Common changes will be used to support SONiC CLIs for multi ASIC - New MultiAsic class to support not displaying of internal object - Common CLI options which needed for multi ASIC platforms - a new decorator to execute a function on all namespaces Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

Common functions for show CLI support on multi ASIC (sonic-net#999)

Common functions for show CLI support on multi ASIC

768ab07

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

arlakshm requested review from jleveque, lguohan and smaheshm July 20, 2020 21:43

jleveque reviewed Jul 20, 2020

View reviewed changes

jleveque added Enhancement utilities-common labels Jul 20, 2020

smaheshm reviewed Jul 21, 2020

View reviewed changes

smaheshm suggested changes Jul 21, 2020

View reviewed changes

smaheshm reviewed Jul 21, 2020

View reviewed changes

address review comments

7f3a0b4

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

This comment has been minimized.

Sign in to view

jleveque suggested changes Jul 21, 2020

View reviewed changes

utilities_common/multi_asic.py Outdated Show resolved Hide resolved

Address review comments

15dbd2f

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

This was referenced Jul 24, 2020

show interface portchannel support for Multi ASIC #1005

Merged

support show interface commands for multi ASIC platforms #1006

Merged

arlakshm added 2 commits July 27, 2020 22:39

change to new lib

209ef33

Merge remote-tracking branch 'arlakshm/master' into masic_cli

c5d79a0

arlakshm added 3 commits August 5, 2020 15:11

Address review comments

895ec3e

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

remove changes to portstat from this PR

e657d4d

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

fix lgtm warnings

a3d18d6

arlakshm mentioned this pull request Aug 12, 2020

Support "show cli" for Multi Npu platforms. #889

Closed

lguohan previously approved these changes Aug 12, 2020

View reviewed changes

arlakshm requested review from jleveque and smaheshm August 13, 2020 20:33

smaheshm previously approved these changes Aug 13, 2020

View reviewed changes

address review comments

a47ad2f

Signed-off-by: Arvindsrinivasan Lakshmi Narasimhan <arlakshm@microsoft.com>

arlakshm dismissed stale reviews from smaheshm and lguohan via a47ad2f August 14, 2020 14:27

arlakshm requested a review from smaheshm August 14, 2020 14:28

jleveque approved these changes Aug 14, 2020

View reviewed changes

judyjoseph reviewed Aug 14, 2020

View reviewed changes

arlakshm added Multi-ASIC 🔢 Request for 201911 Branch labels Aug 14, 2020

arlakshm merged commit a15b6bf into sonic-net:master Aug 14, 2020

abdosi added the Included in 201911 Branch label Aug 16, 2020

gechiang mentioned this pull request Aug 21, 2020

Multi-ASIC support for show ip route #1060

Closed

gechiang mentioned this pull request Sep 2, 2020

Multi-ASIC support for show ip route #1089

Closed

stepanblyschak pushed a commit to stepanblyschak/sonic-utilities that referenced this pull request Apr 28, 2022

[submodule update] sonic-utilities

87fa880

Common functions for show CLI support on multi ASIC (sonic-net#999)

		In case of multi ASIC, the default namespace in the database instance running the on the host
		In case of single ASIC, the namespace has to DEFAULT_NAMESPACE

		The function check if a CLI object is internal and returns true or false.
		For single asic, this function is not applicable

Common functions for show CLI support on multi ASIC #999

Common functions for show CLI support on multi ASIC #999

Conversation

arlakshm commented Jul 20, 2020 • edited Loading

lgtm-com bot commented Jul 20, 2020

jleveque Jul 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jleveque commented Jul 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smaheshm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smaheshm Jul 31, 2020 • edited Loading

Choose a reason for hiding this comment

This comment has been minimized.

lgtm-com bot commented Jul 24, 2020

arlakshm commented Aug 6, 2020

arlakshm commented Aug 6, 2020

arlakshm commented Aug 10, 2020

arlakshm commented Aug 11, 2020

arlakshm commented Aug 12, 2020

arlakshm commented Aug 12, 2020

smaheshm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arlakshm commented Jul 20, 2020 •

edited

Loading

jleveque Jul 20, 2020 •

edited

Loading

smaheshm Jul 31, 2020 •

edited

Loading