[debug dump util] Route Module added by vivekrnv · Pull Request #16 · vivekrnv/sonic-utilities

vivekrnv · 2021-08-04T21:50:52Z

Signed-off-by: Vivek Reddy Karri vkarri@nvidia.com

What I did

HLD for Dump Utility: HLD.

Added the Route Module to the Debug Dump Utility
Added the Corresponding UT's

How I did it

How to verify it

tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_all_args PASSED                                                                                                                                                    [ 11%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_caching_redis_keys PASSED                                                                                                                                          [ 22%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_directly_connected_route PASSED                                                                                                                                    [ 33%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_ip2me_route PASSED                                                                                                                                                 [ 44%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_no_next_hop_id PASSED                                                                                                                                              [ 55%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_no_route_entry PASSED                                                                                                                                              [ 66%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_route_with_next_hop PASSED                                                                                                                                         [ 77%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_route_with_next_hop_group PASSED                                                                                                                                   [ 88%]
tests/dump_tests/module_tests/route_test.py::TestRouteModule::test_static_route PASSED

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

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

admin@r-tigon-11:~$ dump state route 200.0.1.0/26
{
    "200.0.1.0/26": {
        "APPL_DB": {
            "keys": [
                {
                    "ROUTE_TABLE:200.0.1.0/26": {
                        "ifname": "PortChannel0004,PortChannel0007",
                        "nexthop": "10.0.0.37,10.0.0.41"
                    }
                }
            ],
            "tables_not_found": []
        },
        "ASIC_DB": {
            "keys": [
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_ROUTE_ENTRY:{\"dest\":\"200.0.1.0/26\",\"switch_id\":\"oid:0x21000000000000\",\"vr\":\"oid:0x3000000000002\"}": {
                        "SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID": "oid:0x5000000000c92"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_VIRTUAL_ROUTER:oid:0x3000000000002": {
                        "NULL": "NULL"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP:oid:0x5000000000c92": {
                        "SAI_NEXT_HOP_GROUP_ATTR_TYPE": "SAI_NEXT_HOP_GROUP_TYPE_DYNAMIC_UNORDERED_ECMP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP:oid:0x5000000000c72": {
                        "SAI_NEXT_HOP_GROUP_ATTR_TYPE": "SAI_NEXT_HOP_GROUP_TYPE_DYNAMIC_UNORDERED_ECMP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP:oid:0x5000000000c4f": {
                        "SAI_NEXT_HOP_GROUP_ATTR_TYPE": "SAI_NEXT_HOP_GROUP_TYPE_DYNAMIC_UNORDERED_ECMP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP:oid:0x5000000000c57": {
                        "SAI_NEXT_HOP_GROUP_ATTR_TYPE": "SAI_NEXT_HOP_GROUP_TYPE_DYNAMIC_UNORDERED_ECMP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP_MEMBER:oid:0x2d000000000c94": {
                        "SAI_NEXT_HOP_GROUP_MEMBER_ATTR_NEXT_HOP_GROUP_ID": "oid:0x5000000000c92",
                        "SAI_NEXT_HOP_GROUP_MEMBER_ATTR_NEXT_HOP_ID": "oid:0x4000000000c49"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP_GROUP_MEMBER:oid:0x2d000000000c93": {
                        "SAI_NEXT_HOP_GROUP_MEMBER_ATTR_NEXT_HOP_GROUP_ID": "oid:0x5000000000c92",
                        "SAI_NEXT_HOP_GROUP_MEMBER_ATTR_NEXT_HOP_ID": "oid:0x4000000000c1c"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP:oid:0x4000000000c49": {
                        "SAI_NEXT_HOP_ATTR_IP": "10.0.0.41",
                        "SAI_NEXT_HOP_ATTR_ROUTER_INTERFACE_ID": "oid:0x6000000000b47",
                        "SAI_NEXT_HOP_ATTR_TYPE": "SAI_NEXT_HOP_TYPE_IP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_NEXT_HOP:oid:0x4000000000c1c": {
                        "SAI_NEXT_HOP_ATTR_IP": "10.0.0.37",
                        "SAI_NEXT_HOP_ATTR_ROUTER_INTERFACE_ID": "oid:0x6000000000b44",
                        "SAI_NEXT_HOP_ATTR_TYPE": "SAI_NEXT_HOP_TYPE_IP"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_ROUTER_INTERFACE:oid:0x6000000000b47": {
                        "SAI_ROUTER_INTERFACE_ATTR_MTU": "9100",
                        "SAI_ROUTER_INTERFACE_ATTR_PORT_ID": "oid:0x2000000000b1f",
                        "SAI_ROUTER_INTERFACE_ATTR_SRC_MAC_ADDRESS": "1C:34:DA:1D:EA:00",
                        "SAI_ROUTER_INTERFACE_ATTR_TYPE": "SAI_ROUTER_INTERFACE_TYPE_PORT",
                        "SAI_ROUTER_INTERFACE_ATTR_VIRTUAL_ROUTER_ID": "oid:0x3000000000002"
                    }
                },
                {
                    "ASIC_STATE:SAI_OBJECT_TYPE_ROUTER_INTERFACE:oid:0x6000000000b44": {
                        "SAI_ROUTER_INTERFACE_ATTR_MTU": "9100",
                        "SAI_ROUTER_INTERFACE_ATTR_PORT_ID": "oid:0x2000000000b1c",
                        "SAI_ROUTER_INTERFACE_ATTR_SRC_MAC_ADDRESS": "1C:34:DA:1D:EA:00",
                        "SAI_ROUTER_INTERFACE_ATTR_TYPE": "SAI_ROUTER_INTERFACE_TYPE_PORT",
                        "SAI_ROUTER_INTERFACE_ATTR_VIRTUAL_ROUTER_ID": "oid:0x3000000000002"
                    }
                }
            ],
            "tables_not_found": [],
            "vidtorid": {
                "oid:0x3000000000002": "oid:0x3",
                "oid:0x5000000000c92": "oid:0x3900000005",
                "oid:0x5000000000c72": "oid:0x3800000005",
                "oid:0x5000000000c4f": "oid:0x3300000005",
                "oid:0x5000000000c57": "oid:0x3500000005",
                "oid:0x2d000000000c94": "oid:0x3000390000002d",
                "oid:0x2d000000000c93": "oid:0x500390000002d",
                "oid:0x4000000000c49": "oid:0x3000000004",
                "oid:0x4000000000c1c": "oid:0x500000004",
                "oid:0x6000000000b47": "oid:0x1c100000006",
                "oid:0x6000000000b44": "oid:0x10100000006"
            }
        }
    }
}

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

dump/plugins/route.py

dgsudharsan · 2021-09-11T02:34:36Z

tests/dump_input/route/config_db.json

+	"distance": "0", 
+	"ifname": ",", 
+	"nexthop": "1.1.1.2", 
+        "nexthop-vrf": ","


Correct indentation.

dgsudharsan · 2021-09-11T02:34:55Z

tests/dump_input/route/appl_db.json

+    "ifname": "PortChannel0001,PortChannel0002,PortChannel0003,PortChannel0004", 
+    "nexthop": "fc00::72,fc00::76,fc00::7a,fc00::7e"
+   }
+}


Missing newline.

dgsudharsan · 2021-09-11T02:48:00Z

tests/dump_tests/module_tests/route_test.py

+        ddiff = DeepDiff(returned, expect, ignore_order=True)
+        assert not ddiff, ddiff
+
+    def test_caching_redis_keys(self, match_engine):


Is there a way to test whether return comes from cache or redis call?

Added that check

dgsudharsan · 2021-09-11T02:48:36Z

tests/dump_input/route/asic_db.json

+      "SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID":"oid:0x60000000002cd"
+   },
+   "ASIC_STATE:SAI_OBJECT_TYPE_ROUTER_INTERFACE:oid:0x60000000002cd": {
+    "SAI_ROUTER_INTERFACE_ATTR_MTU": "9100", 


Have uniform indentation.

dgsudharsan · 2021-09-11T02:48:53Z

tests/dump_input/route/appl_db.json

+      "nexthop":"::"
+   },
+   "ROUTE_TABLE:20c0:e6e0:0:80::/64": {
+    "ifname": "PortChannel0001,PortChannel0002,PortChannel0003,PortChannel0004", 


Correct indentation here and below

…o dump_module_route

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

volodymyrsamotiy · 2021-10-01T10:27:49Z

dump/plugins/route.py

+
+class NextHopGroupMatchOptimizer():
+    """
+    A Stateful Wrapper which optimizes the the queries by caching the redis keys.


Just a type: double the.

Done!, Thanks

volodymyrsamotiy · 2021-10-01T11:04:44Z

dump/plugins/route.py

+    """
+
+    def __init__(self, m_engine):
+        self.key_cache = dict()


Suggest to use one way to initialize dictionary.
In some places it is dict() and in some {}, e.g. line 27.
(BTW, {} is a bit faster comparing to dict())

Done!, Thanks

volodymyrsamotiy · 2021-10-01T11:33:11Z

dump/plugins/route.py

+    def __init__(self, route_obj):
+        self.rt = route_obj
+
+    def collect(self):


Looks like it is abstract method which is required to be overridden by derived classes.
At least I as I see all derived classes always implement it so it looks likes it is must.
If it is the case then there is recommended exception to raise in base class in such abstract methods: NotImplementedError

This is invoked from here:

def init_asic_nh(self): self.nh_type = self.get_nh_type() nh_ex = NHExtractor.initialize(self) # This will call the actual derived class of NHExtractor nh_ex.collect()

@staticmethod def initialize(route_obj): if route_obj.nh_type == NH: return SingleNextHop(route_obj) elif route_obj.nh_type == NH_GRP: return MultipleNextHop(route_obj) elif route_obj.nh_type == RIF: return DirecAttachedRt(route_obj) elif route_obj.nh_type == CPU_PORT: return CPUPort(route_obj) return NHExtractor(route_obj)

When a nh_type apart from NH, NH_GRP, RIF or CPU_PORT is provided, the base class itself is initialized, so a NotImplemented exception will cause the dump module to not exit gracefully.

…o dump_module_route

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

vivekrnv added 3 commits August 4, 2021 21:44

Route Module files added

e68cef4

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

Changed the UT to use default mock

62528c2

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

Ran Code beautifier

2b7dd3d

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

dgsudharsan requested changes Sep 11, 2021

View reviewed changes

dump/plugins/route.py Outdated Show resolved Hide resolved

dump/plugins/route.py Show resolved Hide resolved

dgsudharsan requested changes Sep 11, 2021

View reviewed changes

vivekrnv added 2 commits September 11, 2021 06:14

Merge branch 'master' of https://github.com/Azure/sonic-utilities int…

3d36d61

…o dump_module_route

comments addressed

8219002

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

volodymyrsamotiy reviewed Oct 1, 2021

View reviewed changes

vivekrnv added 2 commits October 11, 2021 16:12

Merge branch 'master' of https://github.com/Azure/sonic-utilities int…

7335c30

…o dump_module_route

Minor Comments Handled

8b9228b

Signed-off-by: Vivek Reddy Karri <vkarri@nvidia.com>

volodymyrsamotiy approved these changes Nov 3, 2021

View reviewed changes

dgsudharsan approved these changes Nov 5, 2021

View reviewed changes

vivekrnv closed this Nov 6, 2021

Conversation

vivekrnv commented Aug 4, 2021

What I did

How I did it

How to verify it

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

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

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants