cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/operations/DmiModelOperations.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2024 Nordix Foundation
   4  *  Modifications Copyright (C) 2022 Bell Canada
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.impl.operations;
  23
  24 import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.MODEL;
  25
  26 import com.google.gson.JsonArray;
  27 import com.google.gson.JsonObject;
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.Collections;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  35 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  36 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  37 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
  38 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  39 import org.onap.cps.ncmp.api.models.YangResource;
  40 import org.onap.cps.spi.model.ModuleReference;
  41 import org.onap.cps.utils.JsonObjectMapper;
  42 import org.springframework.http.ResponseEntity;
  43 import org.springframework.stereotype.Component;
  44
  45 /**
  46  * Operations class for DMI Model.
  47  */
  48 @Component
  49 public class DmiModelOperations extends DmiOperations {
  50
  51     /**
  52      * Constructor for {@code DmiOperations}. This method also manipulates url properties.
  53      *
  54      * @param dmiRestClient {@code DmiRestClient}
  55      */
  56     public DmiModelOperations(final InventoryPersistence inventoryPersistence,
  57                               final JsonObjectMapper jsonObjectMapper,
  58                               final NcmpConfiguration.DmiProperties dmiProperties,
  59                               final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  60         super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  61     }
  62
  63     /**
  64      * Retrieves module references.
  65      *
  66      * @param yangModelCmHandle the yang model cm handle
  67      * @return module references
  68      */
  69     public List<ModuleReference> getModuleReferences(final YangModelCmHandle yangModelCmHandle) {
  70         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder().build();
  71         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  72         final ResponseEntity<Object> dmiFetchModulesResponseEntity = getResourceFromDmiWithJsonData(
  73             yangModelCmHandle.resolveDmiServiceName(MODEL),
  74                 jsonObjectMapper.asJsonString(dmiRequestBody), yangModelCmHandle.getId(), "modules");
  75         return toModuleReferences((Map) dmiFetchModulesResponseEntity.getBody());
  76     }
  77
  78     /**
  79      * Retrieve yang resources from dmi for any modules that CPS-NCMP hasn't cached before.
  80      *
  81      * @param yangModelCmHandle the yangModelCmHandle
  82      * @param newModuleReferences the unknown module references
  83      * @return yang resources as map of module name to yang(re)source
  84      */
  85     public Map<String, String> getNewYangResourcesFromDmi(final YangModelCmHandle yangModelCmHandle,
  86                                                           final Collection<ModuleReference> newModuleReferences) {
  87         if (newModuleReferences.isEmpty()) {
  88             return Collections.emptyMap();
  89         }
  90         final String jsonWithDataAndDmiProperties = getRequestBodyToFetchYangResources(
  91             newModuleReferences, yangModelCmHandle.getDmiProperties());
  92         final ResponseEntity<Object> responseEntity = getResourceFromDmiWithJsonData(
  93             yangModelCmHandle.resolveDmiServiceName(MODEL),
  94             jsonWithDataAndDmiProperties,
  95             yangModelCmHandle.getId(),
  96             "moduleResources");
  97         return asModuleNameToYangResourceMap(responseEntity);
  98     }
  99
 100     /**
 101      * Get resources from DMI for modules.
 102      *
 103      * @param dmiServiceName dmi service name
 104      * @param jsonRequestBody module names and revisions as JSON
 105      * @param cmHandle cmHandle
 106      * @param resourceName name of the resource(s)
 107      * @return {@code ResponseEntity} response entity
 108      */
 109     private ResponseEntity<Object> getResourceFromDmiWithJsonData(final String dmiServiceName,
 110                                                                   final String jsonRequestBody,
 111                                                                   final String cmHandle,
 112                                                                   final String resourceName) {
 113         final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
 114         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody,
 115                 OperationType.READ, null);
 116     }
 117
 118     private static String getRequestBodyToFetchYangResources(final Collection<ModuleReference> newModuleReferences,
 119         final List<YangModelCmHandle.Property> dmiProperties) {
 120         final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(newModuleReferences);
 121         final JsonObject data = new JsonObject();
 122         data.add("modules", moduleReferencesAsJson);
 123         final JsonObject jsonRequestObject = new JsonObject();
 124         jsonRequestObject.add("data", data);
 125         jsonRequestObject.add("cmHandleProperties", toJsonObject(dmiProperties));
 126         return jsonRequestObject.toString();
 127     }
 128
 129     private static JsonArray getModuleReferencesAsJson(final Collection<ModuleReference> unknownModuleReferences) {
 130         final JsonArray moduleReferences = new JsonArray();
 131
 132         for (final ModuleReference moduleReference : unknownModuleReferences) {
 133             final JsonObject moduleReferenceAsJson = new JsonObject();
 134             moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
 135             moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
 136             moduleReferences.add(moduleReferenceAsJson);
 137         }
 138         return moduleReferences;
 139     }
 140
 141     private static JsonObject toJsonObject(final List<YangModelCmHandle.Property>
 142                                                dmiProperties) {
 143         final JsonObject asJsonObject = new JsonObject();
 144         for (final YangModelCmHandle.Property additionalProperty : dmiProperties) {
 145             asJsonObject.addProperty(additionalProperty.getName(), additionalProperty.getValue());
 146         }
 147         return asJsonObject;
 148     }
 149
 150     private List<ModuleReference> toModuleReferences(final Map<String, Object> dmiFetchModulesResponseAsMap) {
 151         final List<ModuleReference> moduleReferences = new ArrayList<>();
 152
 153         if (dmiFetchModulesResponseAsMap != null) {
 154             final List<Object> moduleReferencesAsList = (List) dmiFetchModulesResponseAsMap.get("schemas");
 155             if (moduleReferencesAsList != null) {
 156                 moduleReferencesAsList.forEach(moduleReferenceAsMap -> {
 157                     final ModuleReference moduleReference =
 158                             jsonObjectMapper.convertToValueType(moduleReferenceAsMap, ModuleReference.class);
 159                     moduleReferences.add(moduleReference);
 160                 });
 161             }
 162         }
 163         return moduleReferences;
 164     }
 165
 166     private Map<String, String> asModuleNameToYangResourceMap(final ResponseEntity<Object> responseEntity) {
 167         final Map<String, String> yangResourcesModuleNameToContentMap = new HashMap<>();
 168         final List<Map<String, String>> yangResourcesAsList = (List) responseEntity.getBody();
 169
 170         if (yangResourcesAsList != null) {
 171             yangResourcesAsList.forEach(yangResourceAsMap -> {
 172                 final YangResource yangResource =
 173                         jsonObjectMapper.convertToValueType(yangResourceAsMap, YangResource.class);
 174                 yangResourcesModuleNameToContentMap.put(yangResource.getModuleName(),
 175                     yangResource.getYangSource());
 176             });
 177         }
 178         return yangResourcesModuleNameToContentMap;
 179     }
 180 }