CDS Library Developer User guide

PROPERTY_BLUEPRINT_PROCESS_ID= "blueprint-process-id"
PROPERTY_BLUEPRINT_BASE_PATH= "blueprint-basePath"
PROPERTY_BLUEPRINT_RUNTIME= "blueprint-runtime"
PROPERTY_BLUEPRINT_INPUTS_DATA= "blueprint-inputs-data"
PROPERTY_BLUEPRINT_CONTEXT= "blueprint-context"
PROPERTY_BLUEPRINT_NAME= "template_name"
PROPERTY_BLUEPRINT_VERSION= "template_version"
PROPERTY_BLUEPRINT_USER_SYSTEM= "System"
PROPERTY_BLUEPRINT_STATUS_SUCCESS= "success"
PROPERTY_BLUEPRINT_STATUS_FAILURE= "failure"

METADATA_USER_GROUPS = "user-groups"
METADATA_TEMPLATE_NAME = "template_name"
METADATA_TEMPLATE_VERSION = "template_version"
METADATA_TEMPLATE_AUTHOR = "template_author"
METADATA_TEMPLATE_TAGS = "template_tags"
METADATA_WORKFLOW_NAME = "workflow_name"

PAYLOAD_DATA = "payload-data"
PROPERTY_CURRENT_STEP = "current-step"
PROPERTY_CURRENT_NODE_TEMPLATE = "current-node-template"
PROPERTY_CURRENT_INTERFACE = "current-interface"
PROPERTY_CURRENT_OPERATION = "current-operation"
PROPERTY_CURRENT_IMPLEMENTATION = "current-implementation"
PROPERTY_EXECUTION_REQUEST = "execution-request"

from org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor import \
    ResourceAssignmentProcessor
from org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils import \
    ResourceAssignmentUtils
from org.onap.ccsdk.cds.controllerblueprints.core import \
    BluePrintProcessorException


class AbstractRAProcessor(ResourceAssignmentProcessor):

    def process(self, resource_assignment):
        print "Processing.."
        return None

    def recover(self, runtime_exception, resource_assignment):
        print "Recovering.."
        return None

    def set_resource_data_value(self, resource_assignment, value):
        try:
            if value is not None:
                ResourceAssignmentUtils.Companion.setResourceDataValue(
                    resource_assignment, self.raRuntimeService, value)
            else:
                ResourceAssignmentUtils.Companion.setFailedResourceDataValue(
                    resource_assignment, "Fail to resolve value")
        except BluePrintProcessorException, err:
            raise BluePrintProcessorException(
                "Error on resource assignment. Message = " + err.message)

class BluePrintRuntimeService:

    def __init__(self, bps):
        self.bps = bps

    def resolveNodeTemplateArtifact(self, node_template_name, artifact_name):
        return self.bps.resolveNodeTemplateArtifact(node_template_name, artifact_name)

    def setNodeTemplateAttributeValue(self, nodeTemplateName, attributeName, value):
        return self.bps.setNodeTemplateAttributeValue(nodeTemplateName, attributeName, value)

    def setNodeTemplatePropertyValue(self, nodeTemplateName, propertyName, value):
        return self.bps.setNodeTemplatePropertyValue(nodeTemplateName, propertyName, value)

    def get_node_template_attribute_value(self, node_template_name, attribute_name, value):
        return self.bps.getNodeTemplateAttributeValue(node_template_name, attribute_name, value)

    def get_node_template_property_value(self, node_template_name, property_name, value):
        return self.bps.getNodeTemplatePropertyValue(node_template_name, property_name, value)

############## the following functions are not available not. Should be added ####################
    def put_resolution_store(self, ra_name, value):
        self.bps.putResolutionStore(ra_name, value)
        return None

    def put_dictionary_store(self, ra_dictionary_name, value):
        self.bps.putResolutionStore(ra_dictionary_name, value)
        return None

    def get_json_node_from_resolution_store(self, key):
        return self.bps.getJsonNodeFromResolutionStore(key)

    def get_string_from_resolution_store(self, key):
        return self.bps.getStringFromResolutionStore(key)

    def get_boolean_from_resolution_store(self, key):
        return self.bps.getBooleanFromResolutionStore(key)

    def get_int_from_resolution_store(self, key):
        return self.bps.getIntFromResolutionStore(key)

    def get_double_from_resolution_store(self, key):
        return self.bps.getDoubleFromResolutionStore(key)

    def get_json_node_from_dictionary_store(self, key):
        return self.bps.getJsonNodeFromDictionaryStore(key)

    def get_string_from_dictionary_store(self, key):
        return self.bps.getStringFromDictionaryStore(key)

    def get_boolean_from_dictionary_store(self, key):
        return self.bps.getBooleanFromDictionaryStore(key)

    def get_int_from_dictionary_store(self, key):
        return self.bps.getIntFromDictionaryStore(key)

    def get_double_from_dictionary_store(self, key):
        return self.bps.getDoubleFromDictionaryStore(key)

    def check_resolution_store(self, key):
        return self.bps.checkResolutionStore(key)

    def check_dictionary_store(self, key):
        return self.bps.checkDictionaryStore(key)

#  Copyright (c) 2019 IBM, Bell Canada.
#
#  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.
from java.lang import Exception as JavaException
from abstract_ra_processor import AbstractRAProcessor
from blueprint_constants import *
from blueprint_runtime_service import BluePrintRuntimeService

class ResolvProperties(AbstractRAProcessor):

    def process(self, resource_assignment):
        result = ""
        ATTRIBUTE_RESPONSE_DATA = "response-data"
        
        try:
            blueprint_runtime = BluePrintRuntimeService(self.raRuntimeService)
            #get response of another node_template in the same workflow
            result = blueprint_runtime.get_node_template_attribute_value("my_node_template_name", ATTRIBUTE_RESPONSE_DATA)

            print(result) # result is a JsonNode
            if resource_assignment.name == "minlink":
            	attribute = "minlink"
            if resource_assignment.name == "configlink":
            	attribute = "config_link"

            # get a resource resolution value from the current workflow
            resolution_key = blueprint_runtime.get_string_from_resolution_store("resolution-key")
            vnf_id = blueprint_runtime.get_string_from_resolution_store("vnf-id")
            port = blueprint_runtime.get_int_from_resolution_store("port")
			
            # set value for resource getting currently resolved
            self.set_resource_data_value(resource_assignment, result.get(attribute))
        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        log.error("Exception in the script {}", runtime_exception)
        print self.addError(runtime_exception.cause.message)
        return None

SERVICE_LOG = "log"
SERVICE_NETCONF = "netconfService"
SERVICE_MESSAGE = "messageService"

PARAM_REQUEST_ID = "requestId"
PARAM_ACTION = "action"

STATUS_SUCCESS = "success"
STATUS_FAILURE = "failure"

ATTRIBUTE_RESPONSE_DATA = "response-data"

CONFIG_TARGET_RUNNING = "running"
CONFIG_TARGET_CANDIDATE = "candidate"
CONFIG_DEFAULT_OPERATION_MERGE = "merge"
CONFIG_DEFAULT_OPERATION_REPLACE = "replace"
CONFIG_DEFAULT_OPERATION_NONE = "none"

#  Copyright (c) 2019 IBM, Bell Canada.
#
#  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.
########################################################################
# Add customs libraries needed for the script
from java.lang import Exception as JavaException

# CDS runtime scripts library
from blueprint_constants import *
from common import ResolutionHelper
from netconfclient import NetconfClient

#### Your artifact could use one or many other component executors. Import the corresponding extensions class ####
# resource resolution extension provides to your artifact what you need from resource resolution in CDS. e.g.: get a resolved template
from org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution import ResourceResolutionExtensionsKt

# Netconf executor extension provides to your artifact what you need from Netconf component in CDS. e.g.: Connect to Netconf device
from org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor import NetconfExecutorExtensionsKt

from org.onap.ccsdk.cds.blueprintsprocessor.services.execution import AbstractScriptComponentFunction 

class ShowCommand(AbstractScriptComponentFunction):

    def process(self, resource_assignment):        
        try:
            ######################### Netconf Sample ########################
            log = globals()[netconf_constant.SERVICE_LOG]
            netconf_device_info = NetconfExecutorExtensionsKt.netconfDevice("netconf-connection")
            netconf_client = NetconfClient(log, self, "netconf-connection")
            resource_resolution = ResolutionHelper(self)

            payload = resource_resolution .resolve_and_generate_message_from_template_prefix("hostname")

            netconf_client.connect()
            response = netconf_client.lock()
            if not response.isSuccess():
                log.error(response.errorMessage)

            netconf_client.edit_config(message_content=payload, edit_default_peration="none")
            netconf_client.validate()
            netconf_client.commit()
            netconf_client.unlock()
            netconf_client.disconnect()
            ########################### End ##########################
			
        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        log.error("Exception in the script {}", runtime_exception)
        print self.addError(runtime_exception.cause.message)
        return None

ATTRIBUTE_RESPONSE_DATA = "response-data"

#  Copyright (c) 2019 IBM, Bell Canada.
#
#  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.
########################################################################
# Add customs libraries needed for the script
from java.lang import Exception as JavaException

# CDS runtime scripts library
from blueprint_constants import *
from common import ResolutionHelper
from restconfclient import RestconfClient

#### Your artifact could use one or many other component executors. Import the corresponding extensions class ####
# resource resolution extension provides to your artifact what you need from resource resolution in CDS. e.g.: get a resolved template
from org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution import ResourceResolutionExtensionsKt

# Provides to your artifact what you need from Restconf component in CDS. e.g.: Apply config in Restconf device
from org.onap.ccsdk.cds.blueprintsprocessor.functions.restconf.executor import RestconfExecutorExtensionsKt

from org.onap.ccsdk.cds.blueprintsprocessor.services.execution import AbstractScriptComponentFunction 

class RestconfExecutor(AbstractScriptComponentFunction):

    def process(self, resource_assignment):        
        try:
			######################### Restconf Sample ########################
			log = globals()[netconf_constant.SERVICE_LOG]
			resource_resolution = ResolutionHelper(self)
				
			try:
			    restconf_client = RestconfClient(log, self, "restconf-selector")
                restconf_client_service = RestconfExecutorExtensionsKt.restconfClientService("restconf-selector")
				
				resolution_key = self.getDynamicProperties("resolution-key").asText()
				template_to_apply = self.getDynamicProperties("template-name").asText()
				payload = resource_resolution.retrieve_resolved_template_from_database(resolution_key, template_to_apply)
				
				device_id = self.getDynamicProperties("device-id").asText()
                RestconfExecutorExtensionsKt.restconfMountDevice(restconf_client_service, device_id, payload)
				
				# Place the response in the current node template attribute
                resource_resolution.set_execution_attribute_response_data(ATTRIBUTE_RESPONSE_DATA, response)
            except Exception, err:
                log.error("Python Exception in the script {}", err)
            ########################### End ##########################
			
        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        log.error("Exception in the script {}", runtime_exception)
        print self.addError(runtime_exception.cause.message)
        return None

#  Copyright (c) 2019 IBM, Bell Canada.
#
#  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.
########################################################################
# Add customs libraries needed for the script
from java.lang import Exception as JavaException

# CDS runtime scripts library
from blueprint_constants import *
from common import ResolutionHelper

#### Your artifact could use one or many other component executors. Import the corresponding extensions class ####
# resource resolution extension provides to your artifact what you need from resource resolution in CDS. e.g.: get a resolved template
from org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution import ResourceResolutionExtensionsKt

# Cli executor extension provides to your artifact what you need from CLI component in CDS. e.g.: SSH to a device
from org.onap.ccsdk.cds.blueprintsprocessor.functions.cli.executor import CliExecutorExtensionsKt

from org.onap.ccsdk.cds.blueprintsprocessor.services.execution import AbstractScriptComponentFunction 

class CliExecutor(AbstractScriptComponentFunction):

    def process(self, resource_assignment):        
        try:
            ######################### CLI Sample ########################
            # Get a cli device info from DSL definition (See an example of DSL definition bellow)
            val device_information = CliExecutorExtensionsKt.cliDeviceInfo("device-properties")
            # Get the Client Service
            sshClientService = CliExecutorExtensionsKt.getSshClientService(device_information )
            CliExecutorExtensionsKt.sshClientService.startSessionNB()
            # Read Commands
            commands = CliExecutorExtensionsKt.readLinesFromArtifact("command-template")
            # Execute multiple Commands
            responseLog = CliExecutorExtensionsKt.sshClientService.executeCommandsNB(commands, 5000)
            # Close Session
            CliExecutorExtensionsKt.sshClientService.closeSessionNB()
            ########################### End ##########################
			
        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        log.error("Exception in the script {}", runtime_exception)
        print self.addError(runtime_exception.cause.message)
        return None