software/ors-amarisoft: add firmware auto-upgrade over netconf

software/ors-amarisoft/lopcomm-rrh-config.jinja2.py

 #!{{ python_path }}
-import logging
 import time
-import xmltodict
-from logging.handlers import RotatingFileHandler
-from ncclient import manager
-from ncclient.operations import RPCError
-from ncclient.xml_ import *
-from ncclient.devices.default import DefaultDeviceHandler
-
-class LopcommNetconfClient:
-
-    def __init__(self):
-
-        log_file = "{{ log_file }}"
-
-        self.logger = logging.getLogger('logger')
-        self.logger.setLevel(logging.DEBUG)
-
-        handler = RotatingFileHandler(log_file, maxBytes=100000, backupCount=5)
-        self.logger.addHandler(handler)
-        formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
-        handler.setFormatter(formatter)
-
-        if {{ testing }}:
-            return
-
-    def connect(self, host, port, user, password):
-
-        if {{ testing }}:
-            return
-
-        self.address = (host, port)
-
-        self.logger.info('Connecting to %s, user %s...' % (self.address, user))
-
-        self.conn = manager.connect(host=host,
-                               port=port,
-                               username=user,
-                               password=password,
-                               timeout=1800,
-                               device_params={
-                                   'name': 'default'
-                               },
-                               hostkey_verify=False)
-
-        self.logger.info('Connection to %s successful' % (self.address,))
-
-    def edit_config(self, config_files):
-        for config_file in config_files:
-            with open(config_file) as f:
-                config_xml = f.read()
-
-            try:
-                self.logger.info('Sending edit-config RPC request...')
-                self.conn.edit_config(target='running', config=config_xml)
-                self.logger.info('Edit-config RPC request sent successfully')
-            except RPCError as e:
-                self.logger.error('Error sending edit-config RPC request: %s' % e)
-
-    def close(self):
-        # Close not compatible between ncclient and netconf server
-        #self.conn.close()
-        pass
+import sys
+sys.path.append({{ repr(buildout_directory_path) }})
+from ncclient_common import LopcommNetconfClient
 
 if __name__ == '__main__':
-    nc = LopcommNetconfClient()
-    while True:
-        try:
-            nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
-            nc.edit_config(["{{ CreateProcessingEle_template }}", "{{ cu_config_template }}"])
-            break
-        except Exception as e:
-            nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
-            nc.logger.debug(e)
-            time.sleep(10)
-        finally:
-            nc.close()
+  nc = LopcommNetconfClient(log_file="{{ log_file }}")
+  while True:
+      try:
+          nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
+          nc.edit_config(["{{ CreateProcessingEle_template }}", "{{ cu_config_template }}"])
+          break
+      except Exception as e:
+          nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
+          nc.logger.debug(e)
+          time.sleep(10)
+      finally:
+          nc.close()

software/ors-amarisoft/lopcomm-rrh-reset.jinja2.py

+#!{{ python_path }}
+import time
+import sys
+sys.path.append({{ repr(buildout_directory_path) }})
+from ncclient_common import LopcommNetconfClient
+
+if __name__ == '__main__':
+  nc = LopcommNetconfClient(log_file="{{ log_file }}")
+  while True:
+      try:
+          nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
+          nc.nc.reset_device()
+          break
+      except Exception as e:
+          nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
+          nc.logger.debug(e)
+          time.sleep(10)
+      finally:
+          nc.close()

software/ors-amarisoft/lopcomm-rrh-software.jinja2.py

+#!{{ python_path }}
+import time
+import xmltodict
+import sys
+import re
+import os
+sys.path.append({{ repr(buildout_directory_path) }})
+from ncclient_common import LopcommNetconfClient
+
+if __name__ == '__main__':
+  nc = LopcommNetconfClient(
+    log_file="{{ log_file }}",
+    software_reply_json_log_file="{{ software_reply_json_log_file }}"
+    )
+  while True:
+      try:
+          firmware_check_file= os.path.join('{{etc_path}}','is_firmware_updated')
+          nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
+          # Fetch software inventory
+
+          inventory_vars = nc.get_inventory()
+
+          nonrunning_slot_name = inventory_vars["nonrunning_slot_name"]
+          running_slot_name = inventory_vars["running_slot_name"]
+          active_nonrunning_slot_name = inventory_vars["active_nonrunning_slot_name"]
+          nonrunning_slot_name_build_version = inventory_vars["nonrunning_slot_name_build_version"]
+          running_slot_name_build_version = inventory_vars["running_slot_name_build_version"]
+
+          if running_slot_name and nonrunning_slot_name:
+              if running_slot_name:
+                  nc.logger.info("One slot is running and one is non-running. Proceeding...")
+                  if running_slot_name_build_version in "{{firmware_name}}":
+                      if not os.path.exists(firmware_check_file):
+                        open(firmware_check_file, "w").write('True')
+                      nc.logger.info("Running slot's build-version %s is already updated. Skipping install." % running_slot_name_build_version)
+                  else:
+                      if os.path.exists(firmware_check_file):
+                        os.remove(firmware_check_file)
+                      nc.logger.info("Current build version: %s" % running_slot_name_build_version)
+                      user_authorized_key ="""{{ slapparameter_dict.get('user-authorized-key', '') }}"""
+                      match = re.match(r'ssh-rsa ([^\s]+)', user_authorized_key)
+                      if match:
+                          extracted_key = match.group(1)
+                      else:
+                          nc.logger.info("No valid key found in user authorized key.")
+                      download_rpc_xml = f"""
+                          <software-download xmlns="urn:o-ran:software-management:1.0">
+                              <remote-file-path>{{remote_file_path}}</remote-file-path>
+                              <server>
+                                      <keys>
+                                      <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">1024</algorithm>
+                                      <public-key>{extracted_key}</public-key>
+                                      </keys>
+                              </server>
+                          </software-download>
+                      """
+                      download_reply_xml = nc.custom_rpc_request(download_rpc_xml)
+                      nc.logger.info("Downloading software...")
+                      time.sleep(60)
+                      if download_reply_xml:
+                          nc.logger.info("Download proceed.")
+                          download_data = xmltodict.parse(download_reply_xml)
+                          nc.software_reply_json_logger.info('', extra={'data': download_data})
+
+                      install_rpc_xml = f"""
+                          <software-install xmlns="urn:o-ran:software-management:1.0">
+                              <slot-name>{nonrunning_slot_name}</slot-name>
+                              <file-names>{{firmware_name}}</file-names>
+                          </software-install>
+                      """
+                      install_reply_xml = nc.custom_rpc_request(install_rpc_xml)
+                      nc.logger.info("Installing software...")
+                      time.sleep(60)
+                      if install_reply_xml:
+                          nc.logger.info("Installation proceed.")
+                          install_data = xmltodict.parse(install_reply_xml)
+                          nc.software_reply_json_logger.info('', extra={'data': install_data})
+
+                      if nonrunning_slot_name_build_version in "{{firmware_name}}":
+                          activate_rpc_xml = f"""
+                              <software-activate xmlns="urn:o-ran:software-management:1.0">
+                                  <slot-name>{nonrunning_slot_name}</slot-name>
+                              </software-activate>
+                          """
+                          activate_reply_xml = nc.custom_rpc_request(activate_rpc_xml)
+                          nc.logger.info("Activating software...")
+                          time.sleep(60)
+                          if activate_reply_xml:
+                              nc.logger.info("Activation proceed.")
+                              activate_data = xmltodict.parse(activate_reply_xml)
+                              nc.software_reply_json_logger.info('', extra={'data': activate_data})
+
+                      nc.get_inventory()
+                      if nonrunning_slot_name_build_version in "{{firmware_name}}" and active_nonrunning_slot_name:
+                          nc.logger.info("Active non-running slot has the updated build version. Resetting device.")
+                          nc.reset_device()
+          break
+      except Exception as e:
+          nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
+          nc.logger.debug(str(e))
+          time.sleep(10)
+      finally:
+          nc.close()

software/ors-amarisoft/lopcomm-rrh-stats.jinja2.py

 #!{{ python_path }}
-import json
-import logging
 import time
-import xmltodict
-from logging.handlers import RotatingFileHandler
-from ncclient import manager
-from ncclient.xml_ import *
-from ncclient.devices.default import DefaultDeviceHandler
-
-class LopcommNetconfClient:
-
-    def __init__(self):
-
-        log_file = "{{ log_file }}"
-        json_log_file = "{{ json_log_file }}"
-        cfg_json_log_file = "{{ cfg_json_log_file }}"
-        supervision_json_log_file = "{{ supervision_json_log_file }}"
-        ncsession_json_log_file = "{{ ncsession_json_log_file }}"
-
-        self.logger = logging.getLogger('logger')
-        self.json_logger = logging.getLogger('json_logger')
-        self.cfg_json_logger = logging.getLogger('cfg_json_logger')
-        self.supervision_json_logger = logging.getLogger('supervision_json_logger')
-        self.ncsession_json_logger = logging.getLogger('ncsession_json_logger')
-        self.logger.setLevel(logging.DEBUG)
-        self.json_logger.setLevel(logging.DEBUG)
-        self.cfg_json_logger.setLevel(logging.DEBUG)
-        self.supervision_json_logger.setLevel(logging.DEBUG)
-        self.ncsession_json_logger.setLevel(logging.DEBUG)
-
-        json_handler = RotatingFileHandler(json_log_file, maxBytes=100000, backupCount=5)
-        json_formatter = logging.Formatter('{"time": "%(asctime)s", "log_level": "%(levelname)s", "message": "%(message)s", "data": %(data)s}')
-        json_handler.setFormatter(json_formatter)
-        self.json_logger.addHandler(json_handler)
-
-        cfg_json_handler = RotatingFileHandler(cfg_json_log_file, maxBytes=100000, backupCount=5)
-        cfg_json_formatter = logging.Formatter('{"time": "%(asctime)s", "log_level": "%(levelname)s", "message": "%(message)s", "data": %(data)s}')
-        cfg_json_handler.setFormatter(cfg_json_formatter)
-        self.cfg_json_logger.addHandler(cfg_json_handler)
-
-        supervision_json_handler = RotatingFileHandler(supervision_json_log_file, maxBytes=100000, backupCount=5)
-        supervision_json_formatter = logging.Formatter('{"time": "%(asctime)s", "log_level": "%(levelname)s", "message": "%(message)s", "data": %(data)s}')
-        supervision_json_handler.setFormatter(supervision_json_formatter)
-        self.supervision_json_logger.addHandler(supervision_json_handler)
-
-        ncsession_json_handler = RotatingFileHandler(ncsession_json_log_file, maxBytes=100000, backupCount=5)
-        ncsession_json_formatter = logging.Formatter('{"time": "%(asctime)s", "log_level": "%(levelname)s", "message": "%(message)s", "data": %(data)s}')
-        ncsession_json_handler.setFormatter(ncsession_json_formatter)
-        self.ncsession_json_logger.addHandler(ncsession_json_handler)
-
-        handler = RotatingFileHandler(log_file, maxBytes=100000, backupCount=5)
-        self.logger.addHandler(handler)
-        formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
-        handler.setFormatter(formatter)
-
-        if {{ testing }}:
-            return
-
-    def connect(self, host, port, user, password):
-
-        if {{ testing }}:
-            return
-
-        self.address = (host, port)
-
-        self.logger.info('Connecting to %s, user %s...' % (self.address, user))
-
-        self.conn = manager.connect(host=host,
-                               port=port,
-                               username=user,
-                               password=password,
-                               timeout=1800,
-                               device_params={
-                                   'name': 'default'
-                               },
-                               hostkey_verify=False)
-
-        self.logger.info('Connection to %s successful' % (self.address,))
-
-    def subscribe(self):
-
-        # Filter not compatible between ncclient and netconf server
-        #result = self.conn.create_subscription(filter=('xpath', '/o-ran-fm:*'))
-        sub = self.conn.create_subscription()
-        self.logger.info('Subscription to %s successful' % (self.address,))
-
-    def get_notification(self):
-
-        result = None
-        while result == None:
-            self.logger.debug('Waiting for notification from %s...' % (self.address,))
-            result = self.conn.take_notification(block=True)
-            if result:
-              self.logger.debug('Got new notification from %s...' % (self.address,))
-              result_in_xml = result._raw
-              data_dict = xmltodict.parse(result_in_xml)
-              if 'alarm-notif' in data_dict['notification']:
-                self.json_logger.info('', extra={'data': data_dict})
-              elif 'supervision-notification' in data_dict['notification']:
-                self.supervision_json_logger.info('', extra={'data': data_dict})
-              elif 'netconf-session-start' or 'netconf-session-end' in data_dict['notification']:
-                self.ncsession_json_logger.info('', extra={'data': data_dict})
-              else:
-                self.cfg_json_logger.info('', extra={'data': data_dict})
-
-
-    def close(self):
-        # Close not compatible between ncclient and netconf server
-        #self.conn.close()
-        pass
+import sys
+sys.path.append({{ repr(buildout_directory_path) }})
+from ncclient_common import LopcommNetconfClient
 
 if __name__ == '__main__':
-
-    nc = LopcommNetconfClient()
-    while True:
-      try:
-          nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
-          nc.subscribe()
-          while True:
-            nc.get_notification()
-      except Exception as e:
-          nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
-          nc.logger.debug(e)
-          time.sleep(10)
-      finally:
-          nc.close()
+  nc = LopcommNetconfClient(
+    log_file="{{ log_file }}",
+    json_log_file="{{ json_log_file }}",
+    cfg_json_log_file="{{ cfg_json_log_file }}",
+    supervision_json_log_file="{{ supervision_json_log_file }}",
+    ncsession_json_log_file="{{ ncsession_json_log_file }}",
+    software_json_log_file="{{ software_json_log_file }}"
+    )
+  while True:
+    try:
+        nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
+        nc.subscribe()
+        while True:
+          nc.get_notification()
+    except Exception as e:
+        nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
+        nc.logger.debug(e)
+        time.sleep(10)
+    finally:
+        nc.close()

software/ors-amarisoft/lopcomm-rrh-supervision.jinja2.py

+#!{{ python_path }}
+import time
+import xmltodict
+import sys
+import re
+import os
+sys.path.append({{ repr(buildout_directory_path) }})
+from ncclient_common import LopcommNetconfClient
+
+if __name__ == '__main__':
+    nc = LopcommNetconfClient(
+        log_file="{{ log_file }}",
+        supervision_reply_json_log_file="{{ supervision_reply_json_log_file }}"
+    )
+    try:
+        netconf_check_file = os.path.join('{{etc_path}}', 'is_netconf_connected')
+        nc.connect("{{ netaddr.IPAddress(slap_configuration.get('tap-ipv6-gateway', '')) }}", 830, "oranuser", "oranpassword")
+
+        supervision_subscription_rpc_xml = """
+            <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
+                <stream>o-ran-supervision</stream>
+            </create-subscription>
+        """
+        nc.logger.info("Subscription creating...")
+        supervision_subscription_reply_xml = nc.custom_rpc_request(supervision_subscription_rpc_xml)
+
+        if supervision_subscription_reply_xml:
+            nc.logger.info("Subscription created")
+            supervision_subscription_data = xmltodict.parse(supervision_subscription_reply_xml)
+            nc.supervision_reply_json_logger.info('', extra={'data': supervision_subscription_data})
+            while True:
+              supervision_watchdog_rpc_xml = """
+                  <supervision-watchdog-reset xmlns="urn:o-ran:supervision:1.0">
+                          <supervision-notification-interval>60</supervision-notification-interval>
+                          <guard-timer-overhead>10</guard-timer-overhead>
+                  </supervision-watchdog-reset>
+              """
+              nc.logger.info("NETCONF server replying...")
+              supervision_watchdog_reply_xml = nc.custom_rpc_request(supervision_watchdog_rpc_xml)
+              if supervision_watchdog_reply_xml:
+                  if not os.path.exists(netconf_check_file):
+                      open(netconf_check_file, "w").write('True')
+                      nc.logger.info("NETCONF server replied")
+                      
+                      supervision_watchdog_data = xmltodict.parse(supervision_watchdog_reply_xml)
+                      nc.supervision_reply_json_logger.info('', extra={'data': supervision_watchdog_data})
+                      # It must be the same interval as <supervision-notification-interval>
+                      time.sleep(60)
+                  else:
+                      if os.path.exists(netconf_check_file):
+                          os.remove(netconf_check_file)
+
+        else:
+          nc.logger.debug("Subscription failed.")
+
+    except Exception as e:
+        nc.logger.debug('Got exception, waiting 10 seconds before reconnecting...')
+        nc.logger.debug(str(e))
+        time.sleep(10)
+    finally:
+        nc.close()
\ No newline at end of file

[Jérome Perrin]

here there is the same potential problem as !1447 (merged) , if nonrunning_slot_name contains characters like < or >, this would break.

It should be pretty easy to rewrite the XML generation to use https://lxml.de/apidoc/lxml.builder.html .

[Lu Xu]

For now, nonrunning_slot_name replies only slot-1 or slot-2, but it's a good idea to use XML generation instead of "hardcoded" XML. Thanks for pointing it out.