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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  34 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  35 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  36 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
  37 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  38 import org.onap.cps.ncmp.api.models.YangResource;
  39 import org.onap.cps.spi.model.ModuleReference;
  40 import org.onap.cps.utils.JsonObjectMapper;
  41 import org.springframework.http.ResponseEntity;
  42 import org.springframework.stereotype.Component;
  43
  44 /**
  45  * Operations class for DMI Model.
  46  */
  47 @Component
  48 public class DmiModelOperations extends DmiOperations {
  49
  50     /**
  51      * Constructor for {@code DmiOperations}. This method also manipulates url properties.
  52      *
  53      * @param dmiRestClient {@code DmiRestClient}
  54      */
  55     public DmiModelOperations(final InventoryPersistence inventoryPersistence,
  56                               final JsonObjectMapper jsonObjectMapper,
  57                               final NcmpConfiguration.DmiProperties dmiProperties,
  58                               final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  59         super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  60     }
  61
  62     /**
  63      * Retrieves module references.
  64      *
  65      * @param yangModelCmHandle the yang model cm handle
  66      * @return module references
  67      */
  68     public List<ModuleReference> getModuleReferences(final YangModelCmHandle yangModelCmHandle) {
  69         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder().build();
  70         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  71         final ResponseEntity<Object> dmiFetchModulesResponseEntity = getResourceFromDmiWithJsonData(
  72             yangModelCmHandle.resolveDmiServiceName(MODEL),
  73                 jsonObjectMapper.asJsonString(dmiRequestBody), yangModelCmHandle.getId(), "modules");
  74         return toModuleReferences((Map) dmiFetchModulesResponseEntity.getBody());
  75     }
  76
  77     /**
  78      * Retrieve yang resources from dmi for any modules that CPS-NCMP hasn't cached before.
  79      *
  80      * @param yangModelCmHandle the yangModelCmHandle
  81      * @param newModuleReferences the unknown module references
  82      * @return yang resources as map of module name to yang(re)source
  83      */
  84     public Map<String, String> getNewYangResourcesFromDmi(final YangModelCmHandle yangModelCmHandle,
  85                                                           final Collection<ModuleReference> newModuleReferences) {
  86         final String jsonWithDataAndDmiProperties = getRequestBodyToFetchYangResources(
  87             newModuleReferences, yangModelCmHandle.getDmiProperties());
  88         final ResponseEntity<Object> responseEntity = getResourceFromDmiWithJsonData(
  89             yangModelCmHandle.resolveDmiServiceName(MODEL),
  90             jsonWithDataAndDmiProperties,
  91             yangModelCmHandle.getId(),
  92             "moduleResources");
  93         return asModuleNameToYangResourceMap(responseEntity);
  94     }
  95
  96     /**
  97      * Get resources from DMI for modules.
  98      *
  99      * @param dmiServiceName dmi service name
 100      * @param jsonRequestBody module names and revisions as JSON
 101      * @param cmHandle cmHandle
 102      * @param resourceName name of the resource(s)
 103      * @return {@code ResponseEntity} response entity
 104      */
 105     private ResponseEntity<Object> getResourceFromDmiWithJsonData(final String dmiServiceName,
 106                                                                   final String jsonRequestBody,
 107                                                                   final String cmHandle,
 108                                                                   final String resourceName) {
 109         final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
 110         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody,
 111                 OperationType.READ);
 112     }
 113
 114     private static String getRequestBodyToFetchYangResources(final Collection<ModuleReference> newModuleReferences,
 115         final List<YangModelCmHandle.Property> dmiProperties) {
 116         final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(newModuleReferences);
 117         final JsonObject data = new JsonObject();
 118         data.add("modules", moduleReferencesAsJson);
 119         final JsonObject jsonRequestObject = new JsonObject();
 120         jsonRequestObject.add("data", data);
 121         jsonRequestObject.add("cmHandleProperties", toJsonObject(dmiProperties));
 122         return jsonRequestObject.toString();
 123     }
 124
 125     private static JsonArray getModuleReferencesAsJson(final Collection<ModuleReference> unknownModuleReferences) {
 126         final JsonArray moduleReferences = new JsonArray();
 127
 128         for (final ModuleReference moduleReference : unknownModuleReferences) {
 129             final JsonObject moduleReferenceAsJson = new JsonObject();
 130             moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
 131             moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
 132             moduleReferences.add(moduleReferenceAsJson);
 133         }
 134         return moduleReferences;
 135     }
 136
 137     private static JsonObject toJsonObject(final List<YangModelCmHandle.Property>
 138                                                dmiProperties) {
 139         final JsonObject asJsonObject = new JsonObject();
 140         for (final YangModelCmHandle.Property additionalProperty : dmiProperties) {
 141             asJsonObject.addProperty(additionalProperty.getName(), additionalProperty.getValue());
 142         }
 143         return asJsonObject;
 144     }
 145
 146     private List<ModuleReference> toModuleReferences(final Map<String, Object> dmiFetchModulesResponseAsMap) {
 147         final List<ModuleReference> moduleReferences = new ArrayList<>();
 148
 149         if (dmiFetchModulesResponseAsMap != null) {
 150             final List<Object> moduleReferencesAsList = (List) dmiFetchModulesResponseAsMap.get("schemas");
 151             if (moduleReferencesAsList != null) {
 152                 moduleReferencesAsList.forEach(moduleReferenceAsMap -> {
 153                     final ModuleReference moduleReference =
 154                             jsonObjectMapper.convertToValueType(moduleReferenceAsMap, ModuleReference.class);
 155                     moduleReferences.add(moduleReference);
 156                 });
 157             }
 158         }
 159         return moduleReferences;
 160     }
 161
 162     private Map<String, String> asModuleNameToYangResourceMap(final ResponseEntity<Object> responseEntity) {
 163         final Map<String, String> yangResourcesModuleNameToContentMap = new HashMap<>();
 164         final List<Map<String, String>> yangResourcesAsList = (List) responseEntity.getBody();
 165
 166         if (yangResourcesAsList != null) {
 167             yangResourcesAsList.forEach(yangResourceAsMap -> {
 168                 final YangResource yangResource =
 169                         jsonObjectMapper.convertToValueType(yangResourceAsMap, YangResource.class);
 170                 yangResourcesModuleNameToContentMap.put(yangResource.getModuleName(),
 171                     yangResource.getYangSource());
 172             });
 173         }
 174         return yangResourcesModuleNameToContentMap;
 175     }
 176 }