Core logic to update,add or remove cmHandle properties
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / impl / NetworkCmProxyDataServiceImpl.java
index fd85195..38f8e17 100755 (executable)
@@ -1,8 +1,9 @@
 /*
  *  ============LICENSE_START=======================================================
  *  Copyright (C) 2021 highstreet technologies GmbH
- *  Modifications Copyright (C) 2021 Nordix Foundation
+ *  Modifications Copyright (C) 2021-2022 Nordix Foundation
  *  Modifications Copyright (C) 2021 Pantheon.tech
+ *  Modifications Copyright (C) 2021 Bell Canada
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 
 package org.onap.cps.ncmp.api.impl;
 
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
+import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
+import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.api.CpsAdminService;
 import org.onap.cps.api.CpsDataService;
-import org.onap.cps.api.CpsQueryService;
+import org.onap.cps.api.CpsModuleService;
 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
-import org.onap.cps.spi.FetchDescendantsOption;
-import org.onap.cps.spi.model.DataNode;
-import org.springframework.beans.factory.annotation.Autowired;
+import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException;
+import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
+import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
+import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
+import org.onap.cps.ncmp.api.models.CmHandle;
+import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
+import org.onap.cps.ncmp.api.models.PersistenceCmHandle;
+import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList;
+import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
+import org.onap.cps.spi.exceptions.DataValidationException;
+import org.onap.cps.spi.model.ModuleReference;
+import org.onap.cps.utils.JsonObjectMapper;
+import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Service;
-import org.springframework.util.StringUtils;
 
+@Slf4j
 @Service
+@RequiredArgsConstructor
 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
 
-    private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational";
+    private final CpsDataService cpsDataService;
 
-    @Autowired
-    private CpsDataService cpsDataService;
+    private final JsonObjectMapper jsonObjectMapper;
 
-    @Autowired
-    private CpsQueryService cpsQueryService;
+    private final DmiDataOperations dmiDataOperations;
 
-    private String getDataspaceName() {
-        return NF_PROXY_DATASPACE_NAME;
-    }
+    private final DmiModelOperations dmiModelOperations;
+
+    private final CpsModuleService cpsModuleService;
+
+    private final CpsAdminService cpsAdminService;
+
+    private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
 
     @Override
-    public DataNode getDataNode(final String cmHandle, final String xpath,
-        final FetchDescendantsOption fetchDescendantsOption) {
-        return cpsDataService.getDataNode(getDataspaceName(), cmHandle, xpath, fetchDescendantsOption);
+    public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
+        dmiPluginRegistration.validateDmiPluginRegistration();
+        try {
+            if (dmiPluginRegistration.getCreatedCmHandles() != null) {
+                parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration);
+            }
+            if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
+                parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
+            }
+            if (dmiPluginRegistration.getRemovedCmHandles() != null) {
+                parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
+            }
+        } catch (final JsonProcessingException | DataNodeNotFoundException e) {
+            final String errorMessage = String.format(
+                    "Error occurred while processing the CM-handle registration request [%s] ,caused by : [%s]",
+                    dmiPluginRegistration, e.getMessage());
+            throw new DataValidationException(errorMessage, e.getMessage(), e);
+        }
     }
 
     @Override
-    public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath,
-        final FetchDescendantsOption fetchDescendantsOption) {
-        return cpsQueryService.queryDataNodes(getDataspaceName(), cmHandle, cpsPath, fetchDescendantsOption);
+    public Object getResourceDataOperationalForCmHandle(final String cmHandle,
+                                                        final String resourceIdentifier,
+                                                        final String acceptParamInHeader,
+                                                        final String optionsParamInQuery) {
+        return handleResponse(dmiDataOperations.getResourceDataFromDmi(
+            cmHandle,
+            resourceIdentifier,
+            optionsParamInQuery,
+            acceptParamInHeader,
+            DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL), "Not able to get resource data.");
     }
 
     @Override
-    public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) {
-        if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) {
-            cpsDataService.saveData(getDataspaceName(), cmHandle, jsonData);
-        } else {
-            cpsDataService.saveData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
-        }
+    public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandle,
+                                                               final String resourceIdentifier,
+                                                               final String acceptParamInHeader,
+                                                               final String optionsParamInQuery) {
+        return handleResponse(dmiDataOperations.getResourceDataFromDmi(
+            cmHandle,
+            resourceIdentifier,
+            optionsParamInQuery,
+            acceptParamInHeader,
+            DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING), "Not able to get resource data.");
     }
 
     @Override
-    public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) {
-        cpsDataService.saveListNodeData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
+    public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandle,
+                                                               final String resourceIdentifier,
+                                                               final OperationEnum operation,
+                                                               final String requestData,
+                                                               final String dataType) {
+        return handleResponse(
+            dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(
+                cmHandle, resourceIdentifier, operation, requestData, dataType),
+            "Not able to " + operation + " resource data.");
     }
 
+
     @Override
-    public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
-        cpsDataService.updateNodeLeaves(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
+    public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandle) {
+        return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandle);
     }
 
+    /**
+     * Retrieve cm handle identifiers for the given list of module names.
+     *
+     * @param moduleNames module names.
+     * @return a collection of anchor identifiers
+     */
     @Override
-    public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
-        cpsDataService.replaceNodeTree(getDataspaceName(), cmHandle, parentNodeXpath, jsonData);
+    public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
+        return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
+    }
+
+    /**
+     * THis method registers a cm handle and intiates modules sync.
+     *
+     * @param dmiPluginRegistration dmi plugin registration information.
+     * @throws JsonProcessingException thrown if json is malformed or missing.
+     */
+    public void parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
+        final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
+        final PersistenceCmHandlesList createdPersistenceCmHandlesList =
+            getUpdatedPersistenceCmHandlesList(dmiPluginRegistration, dmiPluginRegistration.getCreatedCmHandles());
+        registerAndSyncNewCmHandles(createdPersistenceCmHandlesList);
+    }
+
+    private static Object handleResponse(final ResponseEntity<?> responseEntity,
+                                         final String exceptionMessage) {
+        if (responseEntity.getStatusCode().is2xxSuccessful()) {
+            return responseEntity.getBody();
+        } else {
+            throw new ServerNcmpException(exceptionMessage,
+                    "DMI status code: " + responseEntity.getStatusCodeValue()
+                            + ", DMI response body: " + responseEntity.getBody());
+        }
+    }
+
+    private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
+        networkCmProxyDataServicePropertyHandler.updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles());
+    }
+
+    private PersistenceCmHandlesList getUpdatedPersistenceCmHandlesList(
+        final DmiPluginRegistration dmiPluginRegistration,
+        final List<CmHandle> updatedCmHandles) {
+        return PersistenceCmHandlesList.toPersistenceCmHandlesList(
+            dmiPluginRegistration.getDmiPlugin(),
+            dmiPluginRegistration.getDmiDataPlugin(),
+            dmiPluginRegistration.getDmiModelPlugin(),
+            updatedCmHandles);
+    }
+
+    private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList) {
+        final String cmHandleJsonData = jsonObjectMapper.asJsonString(persistenceCmHandlesList);
+        cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
+                cmHandleJsonData, NO_TIMESTAMP);
+
+        for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) {
+            syncModulesAndCreateAnchor(persistenceCmHandle);
+        }
+    }
+
+    protected void syncModulesAndCreateAnchor(final PersistenceCmHandle persistenceCmHandle) {
+        syncAndCreateSchemaSet(persistenceCmHandle);
+        createAnchor(persistenceCmHandle);
+    }
+
+    private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
+        for (final String cmHandle : dmiPluginRegistration.getRemovedCmHandles()) {
+            try {
+                attemptToDeleteSchemaSetWithCascade(cmHandle);
+                cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
+                    "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
+            } catch (final DataNodeNotFoundException e) {
+                log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage());
+            }
+        }
+    }
+
+    private void attemptToDeleteSchemaSetWithCascade(final String schemaSetName) {
+        try {
+            cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
+                CASCADE_DELETE_ALLOWED);
+        } catch (final Exception e) {
+            log.warn("Schema set {} delete failed, reason {}", schemaSetName, e.getMessage());
+        }
+    }
+
+    private void syncAndCreateSchemaSet(final PersistenceCmHandle persistenceCmHandle) {
+        final List<ModuleReference> moduleReferencesFromCmHandle =
+            dmiModelOperations.getModuleReferences(persistenceCmHandle);
+        final List<ModuleReference> existingModuleReferences = new ArrayList<>();
+        final List<ModuleReference> unknownModuleReferences = new ArrayList<>();
+        prepareModuleSubsets(moduleReferencesFromCmHandle, existingModuleReferences, unknownModuleReferences);
+
+        final Map<String, String> newYangResourcesModuleNameToContentMap;
+        if (unknownModuleReferences.isEmpty()) {
+            newYangResourcesModuleNameToContentMap = new HashMap<>();
+        } else {
+            newYangResourcesModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(persistenceCmHandle,
+                unknownModuleReferences);
+        }
+        cpsModuleService
+            .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, persistenceCmHandle.getId(),
+                newYangResourcesModuleNameToContentMap, existingModuleReferences);
+    }
+
+    private void prepareModuleSubsets(final List<ModuleReference> moduleReferencesFromCmHandle,
+                                      final List<ModuleReference> existingModuleReferences,
+                                      final List<ModuleReference> unknownModuleReferences) {
+
+        final Collection<ModuleReference> knownModuleReferencesInCps =
+            cpsModuleService.getYangResourceModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME);
+
+        for (final ModuleReference moduleReferenceFromDmiForCmHandle : moduleReferencesFromCmHandle) {
+            if (knownModuleReferencesInCps.contains(moduleReferenceFromDmiForCmHandle)) {
+                existingModuleReferences.add(moduleReferenceFromDmiForCmHandle);
+            } else {
+                unknownModuleReferences.add(moduleReferenceFromDmiForCmHandle);
+            }
+        }
+    }
+
+    private void createAnchor(final PersistenceCmHandle persistenceCmHandle) {
+        cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, persistenceCmHandle.getId(),
+            persistenceCmHandle.getId());
     }
 }