dmi-plugin-demo-and-csit-stub/dmi-plugin-demo-and-csit-stub-service/src/main/java/org/onap/cps/ncmp/dmi/rest/stub/controller/DmiRestStubController.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023-2024 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.dmi.rest.stub.controller;
  22
  23 import static org.onap.cps.ncmp.api.NcmpResponseStatus.SUCCESS;
  24
  25 import com.fasterxml.jackson.core.JsonProcessingException;
  26 import com.fasterxml.jackson.databind.ObjectMapper;
  27 import io.cloudevents.CloudEvent;
  28 import io.cloudevents.core.builder.CloudEventBuilder;
  29 import java.net.URI;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.UUID;
  33 import lombok.RequiredArgsConstructor;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.json.simple.parser.JSONParser;
  36 import org.json.simple.parser.ParseException;
  37 import org.onap.cps.ncmp.api.impl.utils.EventDateTimeFormatter;
  38 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.CmHandle;
  39 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.DataOperationRequest;
  40 import org.onap.cps.ncmp.dmi.rest.stub.model.data.operational.DmiDataOperationRequest;
  41 import org.onap.cps.ncmp.dmi.rest.stub.utils.ResourceFileReaderUtil;
  42 import org.onap.cps.ncmp.events.async1_0_0.Data;
  43 import org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent;
  44 import org.onap.cps.ncmp.events.async1_0_0.Response;
  45 import org.springframework.beans.factory.annotation.Value;
  46 import org.springframework.context.ApplicationContext;
  47 import org.springframework.core.io.Resource;
  48 import org.springframework.core.io.ResourceLoader;
  49 import org.springframework.http.HttpStatus;
  50 import org.springframework.http.ResponseEntity;
  51 import org.springframework.kafka.core.KafkaTemplate;
  52 import org.springframework.web.bind.annotation.PathVariable;
  53 import org.springframework.web.bind.annotation.PostMapping;
  54 import org.springframework.web.bind.annotation.RequestBody;
  55 import org.springframework.web.bind.annotation.RequestMapping;
  56 import org.springframework.web.bind.annotation.RequestParam;
  57 import org.springframework.web.bind.annotation.RestController;
  58
  59 @RestController
  60 @RequestMapping("${rest.api.dmi-stub-base-path}")
  61 @RequiredArgsConstructor
  62 @Slf4j
  63 public class DmiRestStubController {
  64
  65     private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
  66     private final ObjectMapper objectMapper;
  67     private final ApplicationContext applicationContext;
  68
  69     @Value("${app.ncmp.async-m2m.topic}")
  70     private String ncmpAsyncM2mTopic;
  71
  72     @Value("${delay.module-references-delay-ms}")
  73     private long moduleReferencesDelayMs;
  74
  75     @Value("${delay.module-resources-delay-ms}")
  76     private long moduleResourcesDelayMs;
  77
  78     @Value("${delay.data-for-cm-handle-delay-ms}")
  79     private long dataForCmHandleDelayMs;
  80
  81     private String dataOperationEventType = "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent";
  82
  83     /**
  84      * Get all modules for given cm handle.
  85      *
  86      * @param cmHandleId              The identifier for a network function, network element, subnetwork,
  87      *                                or any other cm object by managed Network CM Proxy
  88      * @param moduleReferencesRequest module references request body
  89      * @return ResponseEntity response entity having module response as json string.
  90      */
  91     @PostMapping("/v1/ch/{cmHandleId}/modules")
  92     public ResponseEntity<String> getModuleReferences(@PathVariable("cmHandleId") final String cmHandleId,
  93                                                       @RequestBody final Object moduleReferencesRequest) {
  94         delay(moduleReferencesDelayMs);
  95         final String moduleResponseContent = getModuleResourceResponse(cmHandleId,
  96                 "ModuleResponse.json");
  97         log.info("cm handle: {} requested for modules", cmHandleId);
  98         return ResponseEntity.ok(moduleResponseContent);
  99     }
 100
 101     /**
 102      * Retrieves module resources for a given cmHandleId.
 103      *
 104      * @param cmHandleId                 The identifier for a network function, network element, subnetwork,
 105      *                                   or any other cm object by managed Network CM Proxy
 106      * @param moduleResourcesReadRequest module resources read request body
 107      * @return ResponseEntity response entity having module resources response as json string.
 108      */
 109     @PostMapping("/v1/ch/{cmHandleId}/moduleResources")
 110     public ResponseEntity<String> retrieveModuleResources(
 111             @PathVariable("cmHandleId") final String cmHandleId,
 112             @RequestBody final Object moduleResourcesReadRequest) {
 113         delay(moduleResourcesDelayMs);
 114         final String moduleResourcesResponseContent = getModuleResourceResponse(cmHandleId,
 115                 "ModuleResourcesResponse.json");
 116         log.info("cm handle: {} requested for modules resources", cmHandleId);
 117         return ResponseEntity.ok(moduleResourcesResponseContent);
 118     }
 119
 120     /**
 121      * This method is not implemented for ONAP DMI plugin.
 122      *
 123      * @param topic                   client given topic name
 124      * @param requestId               requestId generated by NCMP as an ack for client
 125      * @param dmiDataOperationRequest list of operation details
 126      * @return (@ code ResponseEntity) response entity
 127      */
 128     @PostMapping("/v1/data")
 129     public ResponseEntity<Void> getResourceDataForCmHandleDataOperation(@RequestParam(value = "topic")
 130                                                                             final String topic,
 131                                                                         @RequestParam(value = "requestId")
 132                                                                         final String requestId,
 133                                                                         @RequestBody final DmiDataOperationRequest
 134                                                                                     dmiDataOperationRequest) {
 135         delay(dataForCmHandleDelayMs);
 136         try {
 137             log.info("Request received from the NCMP to DMI Plugin: {}",
 138                     objectMapper.writeValueAsString(dmiDataOperationRequest));
 139         } catch (final JsonProcessingException jsonProcessingException) {
 140             log.info("Unable to process dmi data operation request to json string");
 141         }
 142         dmiDataOperationRequest.getOperations().forEach(dmiDataOperation -> {
 143             final DataOperationEvent dataOperationEvent = getDataOperationEvent(dmiDataOperation);
 144             dmiDataOperation.getCmHandles().forEach(cmHandle -> {
 145                 dataOperationEvent.getData().getResponses().get(0).setIds(List.of(cmHandle.getId()));
 146                 final CloudEvent cloudEvent = buildAndGetCloudEvent(topic, requestId, dataOperationEvent);
 147                 cloudEventKafkaTemplate.send(ncmpAsyncM2mTopic, UUID.randomUUID().toString(), cloudEvent);
 148             });
 149         });
 150         return new ResponseEntity<>(HttpStatus.ACCEPTED);
 151     }
 152
 153     private CloudEvent buildAndGetCloudEvent(final String topic, final String requestId,
 154                                              final DataOperationEvent dataOperationEvent) {
 155         CloudEvent cloudEvent = null;
 156         try {
 157             cloudEvent = CloudEventBuilder.v1()
 158                     .withId(UUID.randomUUID().toString())
 159                     .withSource(URI.create("DMI"))
 160                     .withType(dataOperationEventType)
 161                     .withDataSchema(URI.create("urn:cps:" + dataOperationEventType + ":1.0.0"))
 162                     .withTime(EventDateTimeFormatter.toIsoOffsetDateTime(
 163                             EventDateTimeFormatter.getCurrentIsoFormattedDateTime()))
 164                     .withData(objectMapper.writeValueAsBytes(dataOperationEvent))
 165                     .withExtension("destination", topic)
 166                     .withExtension("correlationid", requestId)
 167                     .build();
 168         } catch (final JsonProcessingException jsonProcessingException) {
 169             log.error("Unable to parse event into bytes. cause : {}", jsonProcessingException.getMessage());
 170         }
 171         return cloudEvent;
 172     }
 173
 174     private DataOperationEvent getDataOperationEvent(final DataOperationRequest dataOperationRequest) {
 175         final Response response = new Response();
 176         response.setOperationId(dataOperationRequest.getOperationId());
 177         response.setStatusCode(SUCCESS.getCode());
 178         response.setStatusMessage(SUCCESS.getMessage());
 179         response.setIds(dataOperationRequest.getCmHandles().stream().map(CmHandle::getId).toList());
 180         response.setResourceIdentifier(dataOperationRequest.getResourceIdentifier());
 181         response.setOptions(dataOperationRequest.getOptions());
 182         final String ietfNetworkTopologySample = ResourceFileReaderUtil
 183                 .getResourceFileContent(applicationContext.getResource(
 184                         ResourceLoader.CLASSPATH_URL_PREFIX
 185                                 + "data/operational/ietf-network-topology-sample-rfc8345.json"));
 186         final JSONParser jsonParser = new JSONParser();
 187         try {
 188             response.setResult(jsonParser.parse(ietfNetworkTopologySample));
 189         } catch (final ParseException parseException) {
 190             log.error("Unable to parse event result as json object. cause : {}", parseException.getMessage());
 191         }
 192         final List<Response> responseList = new ArrayList<>(1);
 193         responseList.add(response);
 194         final Data data = new Data();
 195         data.setResponses(responseList);
 196         final DataOperationEvent dataOperationEvent = new DataOperationEvent();
 197         dataOperationEvent.setData(data);
 198         return dataOperationEvent;
 199     }
 200
 201     private String getModuleResourceResponse(final String cmHandleId, final String moduleResponseType) {
 202         final String nodeType = cmHandleId.split("-")[0];
 203         final String moduleResponseFilePath = String.format("module/%s%s", nodeType, moduleResponseType);
 204         final Resource moduleResponseResource = applicationContext.getResource(
 205                 ResourceLoader.CLASSPATH_URL_PREFIX + moduleResponseFilePath);
 206         if (moduleResponseResource.exists()) {
 207             log.info("Using requested node type: {}", nodeType);
 208             return ResourceFileReaderUtil.getResourceFileContent(moduleResponseResource);
 209         }
 210         log.info("Using default node type: ietfYang");
 211         return ResourceFileReaderUtil.getResourceFileContent(applicationContext.getResource(
 212                 ResourceLoader.CLASSPATH_URL_PREFIX + "module/ietfYang" + moduleResponseType));
 213     }
 214
 215     private void delay(final long milliseconds) {
 216         try {
 217             Thread.sleep(milliseconds);
 218         } catch (final InterruptedException e) {
 219             log.error("Thread sleep interrupted: {}", e.getMessage());
 220             Thread.currentThread().interrupt();
 221         }
 222     }
 223 }