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()
  71                 .moduleSetTag(yangModelCmHandle.getModuleSetTag()).build();
  72         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  73         final ResponseEntity<Object> dmiFetchModulesResponseEntity = getResourceFromDmiWithJsonData(
  74             yangModelCmHandle.resolveDmiServiceName(MODEL),
  75                 jsonObjectMapper.asJsonString(dmiRequestBody), yangModelCmHandle.getId(), "modules");
  76         return toModuleReferences((Map) dmiFetchModulesResponseEntity.getBody());
  77     }
  78
  79     /**
  80      * Retrieve yang resources from dmi for any modules that CPS-NCMP hasn't cached before.
  81      *
  82      * @param yangModelCmHandle the yangModelCmHandle
  83      * @param newModuleReferences the unknown module references
  84      * @return yang resources as map of module name to yang(re)source
  85      */
  86     public Map<String, String> getNewYangResourcesFromDmi(final YangModelCmHandle yangModelCmHandle,
  87                                                           final Collection<ModuleReference> newModuleReferences) {
  88         if (newModuleReferences.isEmpty()) {
  89             return Collections.emptyMap();
  90         }
  91         final String jsonWithDataAndDmiProperties = getRequestBodyToFetchYangResources(
  92             newModuleReferences, yangModelCmHandle.getDmiProperties());
  93         final ResponseEntity<Object> responseEntity = getResourceFromDmiWithJsonData(
  94             yangModelCmHandle.resolveDmiServiceName(MODEL),
  95             jsonWithDataAndDmiProperties,
  96             yangModelCmHandle.getId(),
  97             "moduleResources");
  98         return asModuleNameToYangResourceMap(responseEntity);
  99     }
 100
 101     /**
 102      * Get resources from DMI for modules.
 103      *
 104      * @param dmiServiceName dmi service name
 105      * @param jsonRequestBody module names and revisions as JSON
 106      * @param cmHandle cmHandle
 107      * @param resourceName name of the resource(s)
 108      * @return {@code ResponseEntity} response entity
 109      */
 110     private ResponseEntity<Object> getResourceFromDmiWithJsonData(final String dmiServiceName,
 111                                                                   final String jsonRequestBody,
 112                                                                   final String cmHandle,
 113                                                                   final String resourceName) {
 114         final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
 115         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody,
 116                 OperationType.READ, null);
 117     }
 118
 119     private static String getRequestBodyToFetchYangResources(final Collection<ModuleReference> newModuleReferences,
 120         final List<YangModelCmHandle.Property> dmiProperties) {
 121         final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(newModuleReferences);
 122         final JsonObject data = new JsonObject();
 123         data.add("modules", moduleReferencesAsJson);
 124         final JsonObject jsonRequestObject = new JsonObject();
 125         jsonRequestObject.add("data", data);
 126         jsonRequestObject.add("cmHandleProperties", toJsonObject(dmiProperties));
 127         return jsonRequestObject.toString();
 128     }
 129
 130     private static JsonArray getModuleReferencesAsJson(final Collection<ModuleReference> unknownModuleReferences) {
 131         final JsonArray moduleReferences = new JsonArray();
 132
 133         for (final ModuleReference moduleReference : unknownModuleReferences) {
 134             final JsonObject moduleReferenceAsJson = new JsonObject();
 135             moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
 136             moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
 137             moduleReferences.add(moduleReferenceAsJson);
 138         }
 139         return moduleReferences;
 140     }
 141
 142     private static JsonObject toJsonObject(final List<YangModelCmHandle.Property>
 143                                                dmiProperties) {
 144         final JsonObject asJsonObject = new JsonObject();
 145         for (final YangModelCmHandle.Property additionalProperty : dmiProperties) {
 146             asJsonObject.addProperty(additionalProperty.getName(), additionalProperty.getValue());
 147         }
 148         return asJsonObject;
 149     }
 150
 151     private List<ModuleReference> toModuleReferences(final Map<String, Object> dmiFetchModulesResponseAsMap) {
 152         final List<ModuleReference> moduleReferences = new ArrayList<>();
 153
 154         if (dmiFetchModulesResponseAsMap != null) {
 155             final List<Object> moduleReferencesAsList = (List) dmiFetchModulesResponseAsMap.get("schemas");
 156             if (moduleReferencesAsList != null) {
 157                 moduleReferencesAsList.forEach(moduleReferenceAsMap -> {
 158                     final ModuleReference moduleReference =
 159                             jsonObjectMapper.convertToValueType(moduleReferenceAsMap, ModuleReference.class);
 160                     moduleReferences.add(moduleReference);
 161                 });
 162             }
 163         }
 164         return moduleReferences;
 165     }
 166
 167     private Map<String, String> asModuleNameToYangResourceMap(final ResponseEntity<Object> responseEntity) {
 168         final Map<String, String> yangResourcesModuleNameToContentMap = new HashMap<>();
 169         final List<Map<String, String>> yangResourcesAsList = (List) responseEntity.getBody();
 170
 171         if (yangResourcesAsList != null) {
 172             yangResourcesAsList.forEach(yangResourceAsMap -> {
 173                 final YangResource yangResource =
 174                         jsonObjectMapper.convertToValueType(yangResourceAsMap, YangResource.class);
 175                 yangResourcesModuleNameToContentMap.put(yangResource.getModuleName(),
 176                     yangResource.getYangSource());
 177             });
 178         }
 179         return yangResourcesModuleNameToContentMap;
 180     }
 181 }