Merge branch 'main' into sodn_yang_connector_protofiles

Author: sodn

connector/docs/changelog/2024/november.rst

@@ -0,0 +1,25 @@
+November 2024
+==========
+
+November 26 - Yang v24.11
+------------------------
+
+
+
+.. csv-table:: New Module Versions
+    :header: "Modules", "Version"
+
+    ``yang.connector``, v24.11
+    ``yang.ncdiff``, v24.11
+
+
+
+
+Changelogs
+^^^^^^^^^^
+
+yang.connector
+""""""""""""""
+
+yang.ncdiff
+"""""""""""

connector/docs/changelog/index.rst

@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2024/november
    2024/october
    2024/September
    2024/august

connector/docs/changelog/undistributed/changelog_add_grcp.rst

@@ -0,0 +1,5 @@
+--------------------------------------------------------------------------------
+                                New
+--------------------------------------------------------------------------------
+* yang.connector
+    * Added support for GRPC_MAX_RECEIVE_MESSAGE_LENGTH and GRPC_MAX_SEND_MESSAGE_LENGTH attributes to pick up from testbed settings.

connector/src/yang/connector/__init__.py

@@ -7,7 +7,7 @@
 """
 
 # metadata
-__version__ = '24.10'
+__version__ = '24.11'
 __author__ = (
     'Jonathan Yang <[email protected]>',
     'Siming Yuan <[email protected]',

connector/src/yang/connector/gnmi.py

@@ -31,6 +31,7 @@ def banner(string):
     def to_plaintext(string):
         return string
 
+from .settings import Settings
 
 # create a logger for this module
 log = logging.getLogger(__name__)
@@ -239,6 +240,9 @@ def __init__(self, *args, **kwargs):
         self.results = deque()
         self.metadata = None
 
+        # connection_info is set by BaseConnection class
+        self.settings = self.connection_info.pop('settings', Settings())
+
     @property
     def connected(self):
         """Return True if session is connected."""
@@ -304,7 +308,12 @@ def connect(self):
             port = str(dev_args.get('port'))
         target = '{0}:{1}'.format(host, port)
 
-        options = [('grpc.max_receive_message_length', 1000000000)]
+        max_receive_message_length = self.settings.get('GRPC_MAX_RECEIVE_MESSAGE_LENGTH')
+        max_send_message_length = self.settings.get('GRPC_MAX_SEND_MESSAGE_LENGTH')
+        
+        options = [('grpc.max_receive_message_length', max_receive_message_length),
+                   ('grpc.max_send_message_length', max_send_message_length)]
+
         # Gather certificate settings
         root = dev_args.get('root_certificate')
         if not root:
@@ -351,6 +360,7 @@ def connect(self):
             )
         else:
             self.channel = grpc.insecure_channel(target)
+            self.channel = grpc.insecure_channel(target, options)
             self.metadata = [
                 ("username", username),
                 ("password", password),

connector/src/yang/connector/settings.py

@@ -8,3 +8,7 @@ def __init__(self, *args, **kwargs):
         self.NETCONF_SCREEN_LOGGING_MAX_LINES = 40
         # Enable XML formatting by default
         self.NETCONF_LOGGING_FORMAT_XML = True
+        # Default receive message length
+        self.GRPC_MAX_RECEIVE_MESSAGE_LENGTH = 1000000000
+        # Default send message length
+        self.GRPC_MAX_SEND_MESSAGE_LENGTH = 1000000000

connector/src/yang/connector/tests/test_gnmi.py

@@ -25,13 +25,13 @@ def test_connect(self):
             '                ip : "1.2.3.4"\n' \
             '                port: 830\n' \
             '                username: admin\n' \
-            '                password: admin\n'
+            '                password: admin\n' \
 
         testbed = loader.load(yaml)
         device = testbed.devices['dummy']
         with patch('yang.connector.gnmi.grpc.insecure_channel') as mock_grpc:
             device.connect(alias='gnmi', via='Gnmi')
-            mock_grpc.assert_called_with('1.2.3.4:830')
+            mock_grpc.assert_called_with('1.2.3.4:830', [('grpc.max_receive_message_length', 1000000000), ('grpc.max_send_message_length', 1000000000)])
 
     def test_re_connect(self):
 
@@ -46,16 +46,16 @@ def test_re_connect(self):
             '                ip : "1.2.3.4"\n' \
             '                port: 830\n' \
             '                username: admin\n' \
-            '                password: admin\n'
+            '                password: admin\n' \
 
         testbed = loader.load(yaml)
         device = testbed.devices['dummy']
         with patch('yang.connector.gnmi.grpc.insecure_channel') as mock_grpc:
             device.connect()
-            mock_grpc.assert_called_with('1.2.3.4:830')
+            mock_grpc.assert_called_with('1.2.3.4:830', [('grpc.max_receive_message_length', 1000000000), ('grpc.max_send_message_length', 1000000000)])
             device.disconnect()
             device.connect(alias='gnmi', via='Gnmi')
-            mock_grpc.assert_called_with('1.2.3.4:830')
+            mock_grpc.assert_called_with('1.2.3.4:830', [('grpc.max_receive_message_length', 1000000000), ('grpc.max_send_message_length', 1000000000)])
 
     def test_connect_proxy(self):
         yaml = \
@@ -91,7 +91,7 @@ def test_connect_proxy(self):
                 mock_tunnel.side_effect = ['830']
                 device.connections['Gnmi'].sshtunnel = AttrDict({'tunnel_ip': '4.3.2.1'})
                 device.connect(alias='gnmi', via='Gnmi')
-                mock_grpc.assert_called_with('4.3.2.1:830')
+                mock_grpc.assert_called_with('4.3.2.1:830', [('grpc.max_receive_message_length', 1000000000), ('grpc.max_send_message_length', 1000000000)])
     request = {
         "namespace": {"oc-acl": "http://openconfig.net/yang/acl"},
         "nodes": [
@@ -159,6 +159,29 @@ def test_get_prefix(self):
         path = xpath_util.get_prefix('rfc7951')
         self.assertIsInstance(path, proto.gnmi_pb2.Path)
 
+    def test_connect_grcp_length(self):
+        yaml = \
+            'devices:\n' \
+            '    dummy:\n' \
+            '        type: dummy_device\n' \
+            '        connections:\n' \
+            '            Gnmi:\n' \
+            '                class:  yang.connector.Gnmi\n' \
+            '                protocol: gnmi\n' \
+            '                ip : "1.2.3.4"\n' \
+            '                port: 830\n' \
+            '                username: admin\n' \
+            '                password: admin\n' \
+            '                settings:\n' \
+            '                  GRPC_MAX_RECEIVE_MESSAGE_LENGTH: 100\n' \
+            '                  GRPC_MAX_SEND_MESSAGE_LENGTH: 100\n' \
+
+        testbed = loader.load(yaml)
+        device = testbed.devices['dummy']
+        with patch('yang.connector.gnmi.grpc.insecure_channel') as mock_grpc:
+            device.connect(alias='gnmi', via='Gnmi')
+            mock_grpc.assert_called_with('1.2.3.4:830', [('grpc.max_receive_message_length', 100), ('grpc.max_send_message_length', 100)])
+
 
 if __name__ == '__main__':
     unittest.main()

ncdiff/docs/usage_gnmi_set.rst

@@ -27,6 +27,8 @@ YAML topology file:
                 enable: admin
                 line: admin
             connections:
+                defaults:
+                    class: unicon.Unicon
                 a:
                     protocol: telnet
                     ip: "1.2.3.4"
@@ -35,7 +37,8 @@ YAML topology file:
                     protocol : telnet
                     ip : "2.3.4.5"
                 gnmi:
-                    class: yang.connector.gNMI
+                    class: yang.connector.Gnmi
+                    protocol: gnmi
                     ip : "2.3.4.5"
                     port: 50052
                     timeout: 10

ncdiff/src/yang/ncdiff/__init__.py

@@ -4,7 +4,7 @@
 edit-config message."""
 
 # metadata
-__version__ = '24.10'
+__version__ = '24.11'
 __author__ = 'Jonathan Yang <[email protected]>'
 __contact__ = '[email protected]'
 __copyright__ = 'Cisco Systems, Inc.'