Creating a reusable Restconf client

[ccsdk/cds.git] / components / scripts / python / ccsdk_restconf / restconf_client.py

diff --git a/components/scripts/python/ccsdk_restconf/restconf_client.py b/components/scripts/python/ccsdk_restconf/restconf_client.py
new file mode 100644 (file)
index 0000000..43e885a
--- /dev/null
+++ b/components/scripts/python/ccsdk_restconf/restconf_client.py
@@ -0,0 +1,74 @@
+#
+# ============LICENSE_START=======================================================
+#  Copyright (C) 2019 Nordix Foundation.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+#
+from time import sleep
+
+
+class RestconfClient:
+
+    __odl_status_check_limit = 10
+    __odl_status_check_pause = 1
+    __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)
+        headers = {"Content-Type": "application/xml"}
+        url = self.__base_odl_url + pnf_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)
+
+    def __wait_for_odl_to_mount(self, web_client_service, pnf_id):
+        counter = 0
+        url = self.__odl_status_check_url + pnf_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")
+                return None
+            sleep(self.__odl_status_check_pause)
+            counter += 1
+        raise Exception("PNF 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)
+        headers = {"Content-Type": "application/yang.patch+json"}
+        url = self.__base_odl_url + pnf_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
+        self.__log.debug("sending GET request,  url: {}", url)
+        result = web_client_service.exchangeResource("GET", url, "")
+        self.__log.info("Current configuration: {}", result)
+
+    def unmount_device(self, web_client_service, pnf_id):
+        url = self.__base_odl_url + str(pnf_id)
+        self.__log.debug("sending unmount request, url: {}", url)
+        web_client_service.exchangeResource("DELETE", url, "")