diff options
author | 2020-02-04 03:53:15 +0000 | |
---|---|---|
committer | 2020-03-06 01:21:14 +0000 | |
commit | fdfeef7ae2f543553e2f7a7cf322b6d075599e20 (patch) | |
tree | 9bb5488db6a724c7a70bcf182df8f609456b4ff6 /ms/blueprintsprocessor/functions/restful-executor/src/main | |
parent | c2c379246a6d231e9424308c398a15fcb6618fc3 (diff) |
Add the executor and the component function to support 5G NRM CM
The executor and the component function are designed to invoke the 5G NRM CM opertions: createMOI getMOIAttributes modifyMOIAttributes and deleteMOI
Issue-ID: CCSDK-2003
Signed-off-by: Huang Cheng <duke.huangcheng@huawei.com>
Change-Id: I20d3e97c01f6499e73ab0ec77abbc24775f428b7
Diffstat (limited to 'ms/blueprintsprocessor/functions/restful-executor/src/main')
4 files changed, 348 insertions, 0 deletions
diff --git a/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/internal/scripts/TestRestfulConfigure.kt b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/internal/scripts/TestRestfulConfigure.kt new file mode 100644 index 000000000..5f867b93f --- /dev/null +++ b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/internal/scripts/TestRestfulConfigure.kt @@ -0,0 +1,42 @@ +/* + * Copyright © 2020 Huawei. + * + * 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. + */ +@file:Suppress("unused") + +package internal.scripts + +import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput +import org.onap.ccsdk.cds.blueprintsprocessor.functions.restful.executor.RestfulCMComponentFunction +import org.slf4j.LoggerFactory + +/** + * This is for used for Testing only + */ +open class TestRestfulConfigure : RestfulCMComponentFunction() { + + val log = LoggerFactory.getLogger(TestRestfulConfigure::class.java)!! + + override fun getName(): String { + return "TestRestfulConfigure" + } + + override suspend fun processNB(executionRequest: ExecutionServiceInput) { + log.info("processing request..") + } + + override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) { + log.info("recovering..") + } +} diff --git a/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/ComponentRestfulExecutor.kt b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/ComponentRestfulExecutor.kt new file mode 100644 index 000000000..e1643b576 --- /dev/null +++ b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/ComponentRestfulExecutor.kt @@ -0,0 +1,69 @@ +/* + * Copyright © 2020 Huawei Intellectual Property. + * + * 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. + */ +package org.onap.ccsdk.cds.blueprintsprocessor.functions.restful.executor + +import com.fasterxml.jackson.databind.node.ArrayNode +import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput +import org.onap.ccsdk.cds.blueprintsprocessor.rest.RestLibConstants +import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractComponentFunction +import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.ComponentFunctionScriptingService +import org.onap.ccsdk.cds.controllerblueprints.core.getAsString +import org.springframework.beans.factory.config.ConfigurableBeanFactory +import org.springframework.context.annotation.Scope +import org.springframework.stereotype.Component + +@Component("component-restful-executor") +@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE) +open class ComponentRestfulExecutor(private var componentFunctionScriptingService: ComponentFunctionScriptingService) : AbstractComponentFunction() { + + lateinit var scriptComponent: RestfulCMComponentFunction + + companion object { + const val SCRIPT_TYPE = "script-type" + const val SCRIPT_CLASS_REFERENCE = "script-class-reference" + const val INSTANCE_DEPENDENCIES = "instance-dependencies" + } + + override suspend fun processNB(executionRequest: ExecutionServiceInput) { + + val scriptType = operationInputs.getAsString(SCRIPT_TYPE) + val scriptClassReference = operationInputs.getAsString(SCRIPT_CLASS_REFERENCE) + val instanceDependenciesNode = operationInputs.get(INSTANCE_DEPENDENCIES) as? ArrayNode + + val scriptDependencies: MutableList<String> = arrayListOf() + scriptDependencies.add(RestLibConstants.SERVICE_BLUEPRINT_REST_LIB_PROPERTY) + + instanceDependenciesNode?.forEach { instanceName -> + scriptDependencies.add(instanceName.textValue()) + } + /** + * Populate the Script Instance based on the Type + */ + scriptComponent = componentFunctionScriptingService + .scriptInstance<RestfulCMComponentFunction>(this, scriptType, + scriptClassReference, scriptDependencies) + + checkNotNull(scriptComponent) { "failed to get restfulCM script component" } + + // Handles both script processing and error handling + scriptComponent.executeScript(executionServiceInput) + } + + override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) { + bluePrintRuntimeService.getBluePrintError() + .addError("Failed in ComponentRestfulExecutor : ${runtimeException.message}") + } +} diff --git a/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/RestfulCMComponentFunction.kt b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/RestfulCMComponentFunction.kt new file mode 100644 index 000000000..46fec3126 --- /dev/null +++ b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/RestfulCMComponentFunction.kt @@ -0,0 +1,126 @@ +/* + * Copyright © 2020 Huawei. + * + * 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. + */ +package org.onap.ccsdk.cds.blueprintsprocessor.functions.restful.executor + +import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput +import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractScriptComponentFunction +import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException +import com.fasterxml.jackson.databind.JsonNode +import com.fasterxml.jackson.databind.ObjectMapper +import com.fasterxml.jackson.databind.node.ObjectNode +import com.fasterxml.jackson.databind.node.ArrayNode +import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils +import org.onap.ccsdk.cds.blueprintsprocessor.rest.RestLibConstants +import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BluePrintRestLibPropertyService +import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService +import org.onap.ccsdk.cds.blueprintsprocessor.functions.restful.executor.nrmfunction.RestfulNRMServiceClient +import org.slf4j.LoggerFactory + +abstract class RestfulCMComponentFunction : AbstractScriptComponentFunction() { + + private val log = LoggerFactory.getLogger(RestfulCMComponentFunction::class.java) + override suspend fun processNB(executionRequest: ExecutionServiceInput) { + throw BluePrintException("Not Implemented required") + } + + override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) { + throw BluePrintException("Not Implemented required") + } + + open fun bluePrintRestLibPropertyService(): BluePrintRestLibPropertyService = + functionDependencyInstanceAsType(RestLibConstants.SERVICE_BLUEPRINT_REST_LIB_PROPERTY) + + fun restClientService(clientInfo: JsonNode): BlueprintWebClientService { + return bluePrintRestLibPropertyService().blueprintWebClientService(clientInfo) + } + + fun processNRM(executionRequest: ExecutionServiceInput, input_params: ArrayNode): String { + // process the managed object instances + log.info("Processing NRM Object") + operationInputs = executionServiceInput.stepData!!.properties + val dynamic_properties = operationInputs.get("dynamic-properties") + // instantiate one restClientService instance + val hostname = dynamic_properties?.get("hostname").toString().replace("\"", "") + val port = dynamic_properties?.get("port").toString().replace("\"", "") + val username = dynamic_properties?.get("username").toString().replace("\"", "") + val password = dynamic_properties?.get("password").toString().replace("\"", "") + val url = "http://" + hostname + ":" + port + val RestInfo: String = "{\n" + + " \"type\" : \"basic-auth\",\n" + + " \"url\" : \"" + url + "\",\n" + + " \"username\" : \"" + username + "\",\n" + + " \"password\" : \"" + password + "\"\n" + + "}" + val mapper = ObjectMapper() + val jsonRestInfo: JsonNode = mapper.readTree(RestInfo) + val web_client_service = restClientService(jsonRestInfo) + val managed_object_instances = input_params + var response = JacksonUtils.jsonNode("{}") as ObjectNode + // Invoke the corresponding function according to the workflowname + when (this.workflowName) { + "config-deploy" -> { + for (managed_object_instance in managed_object_instances) { + // invoke createMOI for each managed-object-instance + log.info("invoke createMOI for each managed-object-instance") + var NRM_Restful_client = RestfulNRMServiceClient() + val MOI_id = NRM_Restful_client.generateMOIid() + var httpresponse = NRM_Restful_client.createMOI(web_client_service, MOI_id, managed_object_instance) + var MOIname = managed_object_instance.get("className").toString().replace("\"", "") + response.put("/$MOIname/$MOI_id", httpresponse) + } + } + "config-get" -> { + for (managed_object_instance in managed_object_instances) { + // invoke getMOIAttributes for each managed-object-instance + log.info("invoke getMOIAttributes for each managed-object-instance") + var NRM_Restful_client = RestfulNRMServiceClient() + val MOI_id = managed_object_instance.get("id").toString().replace("\"", "") + var httpresponse = NRM_Restful_client.getMOIAttributes(web_client_service, MOI_id, managed_object_instance) + var MOIname = managed_object_instance.get("className").toString().replace("\"", "") + response.put("/$MOIname/$MOI_id", httpresponse) + } + } + "config-modify" -> { + for (managed_object_instance in managed_object_instances) { + // invoke modifyMOIAttributes for each managed-object-instance + log.info("invoke modifyMOIAttributes for each managed-object-instance") + var NRM_Restful_client = RestfulNRMServiceClient() + val MOI_id = managed_object_instance.get("id").toString().replace("\"", "") + var httpresponse = NRM_Restful_client.modifyMOIAttributes(web_client_service, MOI_id, managed_object_instance) + var MOIname = managed_object_instance.get("className").toString().replace("\"", "") + response.put("/$MOIname/$MOI_id", httpresponse) + } + } + "config-delete" -> { + for (managed_object_instance in managed_object_instances) { + // invoke deleteMOI for each managed-object-instance + log.info("invoke deleteMOI for each managed-object-instance") + var NRM_Restful_client = RestfulNRMServiceClient() + val MOI_id = managed_object_instance.get("id").toString().replace("\"", "") + var httpresponse = NRM_Restful_client.deleteMOI(web_client_service, MOI_id, managed_object_instance) + var MOIname = managed_object_instance.get("className").toString().replace("\"", "") + response.put("/$MOIname/$MOI_id", httpresponse) + } + } + else -> { + print("not Implemented") + response.put(this.workflowName, "Not Implemented") + } + } + val strresponse = "$response" + return strresponse + } +} diff --git a/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/nrmfunction/RestfulNRMServiceClient.kt b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/nrmfunction/RestfulNRMServiceClient.kt new file mode 100644 index 000000000..31ad377c9 --- /dev/null +++ b/ms/blueprintsprocessor/functions/restful-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/restful/executor/nrmfunction/RestfulNRMServiceClient.kt @@ -0,0 +1,111 @@ +/* + * Copyright © 2019 Huawei. + * + * 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. + */ + +package org.onap.ccsdk.cds.blueprintsprocessor.functions.restful.executor.nrmfunction + +import com.fasterxml.jackson.databind.JsonNode +import com.fasterxml.jackson.databind.ObjectMapper +import com.fasterxml.jackson.databind.node.ObjectNode +import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils +import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService +import org.springframework.http.HttpMethod +import org.onap.ccsdk.cds.controllerblueprints.core.logger +import java.util.UUID +import org.springframework.web.util.UriComponentsBuilder + +class RestfulNRMServiceClient() { + + private val log = logger(RestfulNRMServiceClient::class.java) + + fun createMOI(web_client_service: BlueprintWebClientService, idStr: String, managed_object_instance: JsonNode): ObjectNode { + val classNameStr = managed_object_instance.get("className").toString().replace("\"", "") + val pathStr = "/ProvisioningMnS/v1500/$classNameStr/$idStr" + log.info("MOI Path: " + pathStr) + var request_object_value = JacksonUtils.jsonNode("{}") as ObjectNode + request_object_value.put("attributes", managed_object_instance.get("data")) + request_object_value.put("href", "/" + classNameStr + "/" + idStr) + request_object_value.put("class", classNameStr) + request_object_value.put("id", idStr) + var request_object = JacksonUtils.jsonNode("{}") as ObjectNode + request_object.put("data", request_object_value) + val requestBodystr = request_object.toString() + log.info("MOI request body: " + requestBodystr) + val response = web_client_service.exchangeResource(HttpMethod.PUT.name, pathStr, requestBodystr) + var response_object = generateResponse(response.status, response.body) + log.info("MOI response status: " + response.status) + return response_object + } + + fun getMOIAttributes(web_client_service: BlueprintWebClientService, idStr: String, managed_object_instance: JsonNode): ObjectNode { + val classNameStr = managed_object_instance.get("className").toString().replace("\"", "") + var pathStr = "/ProvisioningMnS/v1500/$classNameStr/$idStr" + pathStr = addQueryParameters(pathStr, "scope", managed_object_instance.get("scope").toString().replace("\"", "")) + pathStr = addQueryParameters(pathStr, "filter", managed_object_instance.get("filter").toString().replace("\"", "")) + for (attribute_value in managed_object_instance.get("fields")) { + pathStr = addQueryParameters(pathStr, "fields", attribute_value.toString().replace("\"", "")) + } + log.info("MOI Path: " + pathStr) + val response = web_client_service.exchangeResource(HttpMethod.GET.name, pathStr, "") + log.info("MOI response status: " + response.status) + var response_object = generateResponse(response.status, response.body) + return response_object + } + + fun modifyMOIAttributes(web_client_service: BlueprintWebClientService, idStr: String, managed_object_instance: JsonNode): ObjectNode { + val classNameStr = managed_object_instance.get("className").toString().replace("\"", "") + var pathStr = "/ProvisioningMnS/v1500/$classNameStr/$idStr" + pathStr = addQueryParameters(pathStr, "scope", managed_object_instance.get("scope").toString().replace("\"", "")) + pathStr = addQueryParameters(pathStr, "filter", managed_object_instance.get("filter").toString().replace("\"", "")) + log.info("MOI Path: " + pathStr) + var request_object = JacksonUtils.jsonNode("{}") as ObjectNode + request_object.put("data", managed_object_instance.get("data")) + val requestBodystr = request_object.toString() + log.info("MOI request body: " + requestBodystr) + val response = web_client_service.exchangeResource(HttpMethod.PATCH.name, pathStr, requestBodystr) + log.info("MOI response status: " + response.status) + var response_object = generateResponse(response.status, response.body) + return response_object + } + + fun deleteMOI(web_client_service: BlueprintWebClientService, idStr: String, managed_object_instance: JsonNode): ObjectNode { + val classNameStr = managed_object_instance.get("className").toString().replace("\"", "") + var pathStr = "/ProvisioningMnS/v1500/$classNameStr/$idStr" + pathStr = addQueryParameters(pathStr, "scope", managed_object_instance.get("scope").toString().replace("\"", "")) + pathStr = addQueryParameters(pathStr, "filter", managed_object_instance.get("filter").toString().replace("\"", "")) + log.info("MOI Path: " + pathStr) + val response = web_client_service.exchangeResource(HttpMethod.DELETE.name, pathStr, "") + log.info("MOI response status: " + response.status) + var response_object = generateResponse(response.status, response.body) + return response_object + } + + fun generateResponse(status: Int, body: String): ObjectNode { + var response_object = JacksonUtils.jsonNode("{}") as ObjectNode + response_object.put("status", status) + val mapper = ObjectMapper() + val response_body: JsonNode = mapper.readTree(body) + response_object.put("body", response_body) + return response_object + } + + fun generateMOIid(): String { + return UUID.randomUUID().toString() + } + + fun addQueryParameters(old_uri: String, key: String, value: String): String { + return UriComponentsBuilder.fromUriString(old_uri).queryParam(key, value).build().toString() + } +} |