Addressing last review comments
[ccsdk/cds.git] / components / scripts / python / ccsdk_restconf / restconf_client.py
index 43e885a..92069c5 100644 (file)
@@ -22,53 +22,61 @@ from time import sleep
 
 class RestconfClient:
 
+    __base_odl_url = "restconf/config/network-topology:network-topology/topology/topology-netconf/node/"
     __odl_status_check_limit = 10
     __odl_status_check_pause = 1
+    # Once confirmed to be reliable, the check should change to use the connection-status API
     __odl_status_check_url = "restconf/operational/network-topology:network-topology/topology/topology-netconf/node/"
-    __base_odl_url = "restconf/config/network-topology:network-topology/topology/topology-netconf/node/"
 
     def __init__(self, log, restconf_component_function):
         self.__log = log
         self.__component_function = restconf_component_function
 
-    def mount_device(self, web_client_service, pnf_id, mount_payload):
-        self.__log.debug("mounting device {}", pnf_id)
+    def mount_device(self, web_client_service, nf_id, mount_payload):
+        self.__log.debug("mounting device {}", nf_id)
         headers = {"Content-Type": "application/xml"}
-        url = self.__base_odl_url + pnf_id
+        url = self.__base_odl_url + nf_id
         self.__log.debug("sending mount request, url: {}", url)
         web_client_service.exchangeResource("PUT", url, mount_payload, headers)
-        self.__wait_for_odl_to_mount(web_client_service, pnf_id)
+        self.__wait_for_odl_to_mount(web_client_service, nf_id)
 
-    def __wait_for_odl_to_mount(self, web_client_service, pnf_id):
+    def __wait_for_odl_to_mount(self, web_client_service, nf_id):
         counter = 0
-        url = self.__odl_status_check_url + pnf_id
+        url = self.__odl_status_check_url + nf_id
         self.__log.info("url for ODL status check: {}", url)
         expected_result = '"netconf-node-topology:connection-status":"connected"'
         while counter < self.__odl_status_check_limit:
             result = web_client_service.exchangeResource("GET", url, "")
             if expected_result in result:
-                self.__log.info("PNF was mounted successfully on ODL")
+                self.__log.info("NF was mounted successfully on ODL")
                 return None
             sleep(self.__odl_status_check_pause)
             counter += 1
-        raise Exception("PNF was not mounted on ODL, aborting configuration procedure")
+        raise Exception("NF was not mounted on ODL, aborting configuration procedure")
 
-    def configure_device(self, web_client_service, pnf_id, configlet_resource_path, configlet_to_apply):
-        self.log_current_configlet(web_client_service, pnf_id, configlet_resource_path)
-        self.__log.info("configuring device: {}, Configlet: {}", pnf_id, configlet_to_apply)
+    def configure_device_json_patch(self, web_client_service, nf_id, configlet_resource_path, configlet_to_apply):
         headers = {"Content-Type": "application/yang.patch+json"}
-        url = self.__base_odl_url + pnf_id + configlet_resource_path
+        self.__configure_device(web_client_service, nf_id, configlet_resource_path, configlet_to_apply, headers)
+
+    def configure_device_xml_patch(self, web_client_service, nf_id, configlet_resource_path, configlet_to_apply):
+        headers = {"Content-Type": "application/yang.patch+xml"}
+        self.__configure_device(web_client_service, nf_id, configlet_resource_path, configlet_to_apply, headers)
+
+    def __configure_device(self, web_client_service, nf_id, configlet_resource_path, configlet_to_apply, headers):
+        self.__log.debug("headers: {}", headers)
+        self.__log.info("configuring device: {}, Configlet: {}", nf_id, configlet_to_apply)
+        url = self.__base_odl_url + nf_id + configlet_resource_path
         self.__log.debug("sending patch request,  url: {}", url)
         result = web_client_service.exchangeResource("PATCH", url, configlet_to_apply, headers)
         self.__log.info("Configuration application result: {}", result)
 
-    def log_current_configlet(self, web_client_service, pnf_id, configlet_resource_path):
-        url = self.__base_odl_url + pnf_id + configlet_resource_path
+    def retrieve_device_configuration_subtree(self, web_client_service, nf_id, configlet_resource_path):
+        url = self.__base_odl_url + nf_id + configlet_resource_path
         self.__log.debug("sending GET request,  url: {}", url)
         result = web_client_service.exchangeResource("GET", url, "")
-        self.__log.info("Current configuration: {}", result)
+        return result
 
-    def unmount_device(self, web_client_service, pnf_id):
-        url = self.__base_odl_url + str(pnf_id)
+    def unmount_device(self, web_client_service, nf_id):
+        url = self.__base_odl_url + nf_id
         self.__log.debug("sending unmount request, url: {}", url)
         web_client_service.exchangeResource("DELETE", url, "")