CPS-475 - fix sonar smells
[cps.git] / cps-ri / src / main / java / org / onap / cps / spi / impl / CpsDataPersistenceServiceImpl.java
index d8f3df1..2397d31 100644 (file)
@@ -1,13 +1,15 @@
 /*
- * ============LICENSE_START=======================================================
+ *  ============LICENSE_START=======================================================
  *  Copyright (C) 2021 Nordix Foundation
  *  Modifications Copyright (C) 2021 Pantheon.tech
+ *  Modifications Copyright (C) 2020-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.
  *  You may obtain a copy of the License at
  *
  *        http://www.apache.org/licenses/LICENSE-2.0
+ *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -22,51 +24,109 @@ package org.onap.cps.spi.impl;
 
 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet.Builder;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+import javax.transaction.Transactional;
+import lombok.extern.slf4j.Slf4j;
+import org.hibernate.StaleStateException;
+import org.onap.cps.cpspath.parser.CpsPathQuery;
 import org.onap.cps.spi.CpsDataPersistenceService;
 import org.onap.cps.spi.FetchDescendantsOption;
 import org.onap.cps.spi.entities.AnchorEntity;
 import org.onap.cps.spi.entities.DataspaceEntity;
 import org.onap.cps.spi.entities.FragmentEntity;
+import org.onap.cps.spi.exceptions.AlreadyDefinedException;
+import org.onap.cps.spi.exceptions.ConcurrencyException;
+import org.onap.cps.spi.exceptions.CpsPathException;
+import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
+import org.onap.cps.spi.exceptions.DataValidationException;
 import org.onap.cps.spi.model.DataNode;
 import org.onap.cps.spi.model.DataNodeBuilder;
 import org.onap.cps.spi.repository.AnchorRepository;
 import org.onap.cps.spi.repository.DataspaceRepository;
 import org.onap.cps.spi.repository.FragmentRepository;
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.stereotype.Service;
 
 @Service
+@Slf4j
 public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService {
 
-    @Autowired
     private DataspaceRepository dataspaceRepository;
 
-    @Autowired
     private AnchorRepository anchorRepository;
 
-    @Autowired
     private FragmentRepository fragmentRepository;
 
+    private final ObjectMapper objectMapper;
+
+    /**
+     * Constructor.
+     *
+     * @param dataspaceRepository dataspaceRepository
+     * @param anchorRepository    anchorRepository
+     * @param fragmentRepository  fragmentRepository
+     */
+    public CpsDataPersistenceServiceImpl(final DataspaceRepository dataspaceRepository,
+        final AnchorRepository anchorRepository, final FragmentRepository fragmentRepository) {
+        this.dataspaceRepository = dataspaceRepository;
+        this.anchorRepository = anchorRepository;
+        this.fragmentRepository = fragmentRepository;
+        objectMapper = new ObjectMapper();
+    }
+
     private static final Gson GSON = new GsonBuilder().create();
+    private static final String REG_EX_FOR_OPTIONAL_LIST_INDEX = "(\\[@[\\s\\S]+?]){0,1})";
+    private static final String REG_EX_FOR_LIST_NODE_KEY = "\\[(\\@([^/]*?)){0,99}( and)*\\]$";
 
     @Override
     public void addChildDataNode(final String dataspaceName, final String anchorName, final String parentXpath,
         final DataNode dataNode) {
-        final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
-        final AnchorEntity anchorEntity = anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
-        final FragmentEntity parentFragment =
-            fragmentRepository.getByDataspaceAndAnchorAndXpath(dataspaceEntity, anchorEntity, parentXpath);
-        final FragmentEntity childFragment = toFragmentEntity(dataspaceEntity, anchorEntity, dataNode);
-        parentFragment.getChildFragments().add(childFragment);
-        fragmentRepository.save(parentFragment);
+        final FragmentEntity parentFragment = getFragmentByXpath(dataspaceName, anchorName, parentXpath);
+        final FragmentEntity fragmentEntity =
+            toFragmentEntity(parentFragment.getDataspace(), parentFragment.getAnchor(), dataNode);
+        parentFragment.getChildFragments().add(fragmentEntity);
+        try {
+            fragmentRepository.save(parentFragment);
+        } catch (final DataIntegrityViolationException exception) {
+            throw AlreadyDefinedException.forDataNode(dataNode.getXpath(), anchorName, exception);
+        }
+    }
+
+    @Override
+    public void addListDataNodes(final String dataspaceName, final String anchorName, final String parentNodeXpath,
+        final Collection<DataNode> dataNodes) {
+        final FragmentEntity parentFragment = getFragmentByXpath(dataspaceName, anchorName, parentNodeXpath);
+        final List<FragmentEntity> newFragmentEntities =
+            dataNodes.stream().map(
+                dataNode -> toFragmentEntity(parentFragment.getDataspace(), parentFragment.getAnchor(), dataNode)
+            ).collect(Collectors.toUnmodifiableList());
+        parentFragment.getChildFragments().addAll(newFragmentEntities);
+        try {
+            fragmentRepository.save(parentFragment);
+            dataNodes.forEach(
+                dataNode -> getChildFragments(dataspaceName, anchorName, dataNode)
+            );
+        } catch (final DataIntegrityViolationException exception) {
+            final List<String> conflictXpaths = dataNodes.stream()
+                .map(DataNode::getXpath)
+                .collect(Collectors.toList());
+            throw AlreadyDefinedException.forDataNodes(conflictXpaths, anchorName, exception);
+        }
     }
 
     @Override
@@ -75,7 +135,11 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService
         final AnchorEntity anchorEntity = anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
         final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(dataspaceEntity, anchorEntity,
             dataNode);
-        fragmentRepository.save(fragmentEntity);
+        try {
+            fragmentRepository.save(fragmentEntity);
+        } catch (final DataIntegrityViolationException exception) {
+            throw AlreadyDefinedException.forDataNode(dataNode.getXpath(), anchorName, exception);
+        }
     }
 
     /**
@@ -101,6 +165,17 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService
         return parentFragment;
     }
 
+    private void getChildFragments(final String dataspaceName, final String anchorName, final DataNode dataNode) {
+        for (final DataNode childDataNode: dataNode.getChildDataNodes()) {
+            final FragmentEntity getChildsParentFragmentByXPath =
+                getFragmentByXpath(dataspaceName, anchorName, dataNode.getXpath());
+            final FragmentEntity childFragmentEntity = toFragmentEntity(getChildsParentFragmentByXPath.getDataspace(),
+                getChildsParentFragmentByXPath.getAnchor(), childDataNode);
+            getChildsParentFragmentByXPath.getChildFragments().add(childFragmentEntity);
+            fragmentRepository.save(getChildsParentFragmentByXPath);
+        }
+    }
+
     private static FragmentEntity toFragmentEntity(final DataspaceEntity dataspaceEntity,
         final AnchorEntity anchorEntity, final DataNode dataNode) {
         return FragmentEntity.builder()
@@ -113,25 +188,82 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService
 
     @Override
     public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath,
+        final FetchDescendantsOption fetchDescendantsOption) {
+        final FragmentEntity fragmentEntity = getFragmentByXpath(dataspaceName, anchorName, xpath);
+        return toDataNode(fragmentEntity, fetchDescendantsOption);
+    }
+
+    private FragmentEntity getFragmentByXpath(final String dataspaceName, final String anchorName,
+        final String xpath) {
+        final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
+        final AnchorEntity anchorEntity = anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
+        if (isRootXpath(xpath)) {
+            return fragmentRepository.findFirstRootByDataspaceAndAnchor(dataspaceEntity, anchorEntity);
+        } else {
+            return fragmentRepository.getByDataspaceAndAnchorAndXpath(dataspaceEntity, anchorEntity,
+                xpath);
+        }
+    }
+
+    @Override
+    public List<DataNode> queryDataNodes(final String dataspaceName, final String anchorName, final String cpsPath,
         final FetchDescendantsOption fetchDescendantsOption) {
         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
         final AnchorEntity anchorEntity = anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
-        final FragmentEntity fragmentEntity =
-            fragmentRepository.getByDataspaceAndAnchorAndXpath(dataspaceEntity, anchorEntity, xpath);
-        return toDataNode(fragmentEntity, fetchDescendantsOption);
+        final CpsPathQuery cpsPathQuery;
+        try {
+            cpsPathQuery = CpsPathQuery.createFrom(cpsPath);
+        } catch (final IllegalStateException e) {
+            throw new CpsPathException(e.getMessage());
+        }
+        List<FragmentEntity> fragmentEntities =
+            fragmentRepository.findByAnchorAndCpsPath(anchorEntity.getId(), cpsPathQuery);
+        if (cpsPathQuery.hasAncestorAxis()) {
+            final Set<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
+            fragmentEntities = ancestorXpaths.isEmpty()
+                ? Collections.emptyList() : fragmentRepository.findAllByAnchorAndXpathIn(anchorEntity, ancestorXpaths);
+        }
+        return fragmentEntities.stream()
+            .map(fragmentEntity -> toDataNode(fragmentEntity, fetchDescendantsOption))
+            .collect(Collectors.toUnmodifiableList());
+    }
+
+    private static Set<String> processAncestorXpath(final List<FragmentEntity> fragmentEntities,
+        final CpsPathQuery cpsPathQuery) {
+        final Set<String> ancestorXpath = new HashSet<>();
+        final Pattern pattern =
+            Pattern.compile("([\\s\\S]*\\/" + Pattern.quote(cpsPathQuery.getAncestorSchemaNodeIdentifier())
+                + REG_EX_FOR_OPTIONAL_LIST_INDEX + "\\/[\\s\\S]*");
+        for (final FragmentEntity fragmentEntity : fragmentEntities) {
+            final Matcher matcher = pattern.matcher(fragmentEntity.getXpath());
+            if (matcher.matches()) {
+                ancestorXpath.add(matcher.group(1));
+            }
+        }
+        return ancestorXpath;
     }
 
-    private static DataNode toDataNode(final FragmentEntity fragmentEntity,
+    private DataNode toDataNode(final FragmentEntity fragmentEntity,
         final FetchDescendantsOption fetchDescendantsOption) {
-        final Map<String, Object> leaves = GSON.fromJson(fragmentEntity.getAttributes(), Map.class);
         final List<DataNode> childDataNodes = getChildDataNodes(fragmentEntity, fetchDescendantsOption);
+        Map<String, Object> leaves = new HashMap<>();
+        if (fragmentEntity.getAttributes() != null) {
+            try {
+                leaves = objectMapper.readValue(fragmentEntity.getAttributes(), Map.class);
+            } catch (final JsonProcessingException jsonProcessingException) {
+                final String message = "Parsing error occurred while processing fragmentEntity attributes.";
+                log.error(message);
+                throw new DataValidationException(message,
+                    jsonProcessingException.getMessage(), jsonProcessingException);
+            }
+        }
         return new DataNodeBuilder()
             .withXpath(fragmentEntity.getXpath())
             .withLeaves(leaves)
             .withChildDataNodes(childDataNodes).build();
     }
 
-    private static List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
+    private List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
         final FetchDescendantsOption fetchDescendantsOption) {
         if (fetchDescendantsOption == INCLUDE_ALL_DESCENDANTS) {
             return fragmentEntity.getChildFragments().stream()
@@ -140,4 +272,156 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService
         }
         return Collections.emptyList();
     }
+
+    @Override
+    public void updateDataLeaves(final String dataspaceName, final String anchorName, final String xpath,
+        final Map<String, Object> leaves) {
+        final FragmentEntity fragmentEntity = getFragmentByXpath(dataspaceName, anchorName, xpath);
+        fragmentEntity.setAttributes(GSON.toJson(leaves));
+        fragmentRepository.save(fragmentEntity);
+    }
+
+    @Override
+    public void replaceDataNodeTree(final String dataspaceName, final String anchorName, final DataNode dataNode) {
+        final FragmentEntity fragmentEntity = getFragmentByXpath(dataspaceName, anchorName, dataNode.getXpath());
+        replaceDataNodeTree(fragmentEntity, dataNode);
+        try {
+            fragmentRepository.save(fragmentEntity);
+        } catch (final StaleStateException staleStateException) {
+            throw new ConcurrencyException("Concurrent Transactions",
+                String.format("dataspace :'%s', Anchor : '%s' and xpath: '%s' is updated by another transaction.",
+                    dataspaceName, anchorName, dataNode.getXpath()),
+                staleStateException);
+        }
+    }
+
+    private static void replaceDataNodeTree(final FragmentEntity existingFragmentEntity,
+                                            final DataNode submittedDataNode) {
+
+        existingFragmentEntity.setAttributes(GSON.toJson(submittedDataNode.getLeaves()));
+
+        final Map<String, FragmentEntity> existingChildrenByXpath = existingFragmentEntity.getChildFragments()
+            .stream().collect(Collectors.toMap(FragmentEntity::getXpath, childFragmentEntity -> childFragmentEntity));
+
+        final Collection<FragmentEntity> updatedChildFragments = new HashSet<>();
+
+        for (final DataNode submittedChildDataNode : submittedDataNode.getChildDataNodes()) {
+            final FragmentEntity childFragment;
+            if (isNewDataNode(submittedChildDataNode, existingChildrenByXpath)) {
+                childFragment = convertToFragmentWithAllDescendants(
+                    existingFragmentEntity.getDataspace(), existingFragmentEntity.getAnchor(), submittedChildDataNode);
+            } else {
+                childFragment = existingChildrenByXpath.get(submittedChildDataNode.getXpath());
+                replaceDataNodeTree(childFragment, submittedChildDataNode);
+            }
+            updatedChildFragments.add(childFragment);
+        }
+        existingFragmentEntity.getChildFragments().clear();
+        existingFragmentEntity.getChildFragments().addAll(updatedChildFragments);
+    }
+
+    @Override
+    @Transactional
+    public void replaceListDataNodes(final String dataspaceName, final String anchorName, final String parentNodeXpath,
+                                     final Collection<DataNode> replacementDataNodes) {
+        final FragmentEntity parentEntity = getFragmentByXpath(dataspaceName, anchorName, parentNodeXpath);
+        final String listNodeXpathPrefix = getListNodeXpathPrefix(replacementDataNodes);
+        final Map<String, FragmentEntity> existingListElementFragmentEntitiesByXPath =
+            extractListElementFragmentEntitiesByXPath(parentEntity.getChildFragments(), listNodeXpathPrefix);
+        removeExistingListElements(parentEntity.getChildFragments(), existingListElementFragmentEntitiesByXPath);
+        final Set<FragmentEntity> updatedChildFragmentEntities = new HashSet<>();
+        for (final DataNode replacementDataNode : replacementDataNodes) {
+            final FragmentEntity existingListNodeElementEntity =
+                existingListElementFragmentEntitiesByXPath.get(replacementDataNode.getXpath());
+            final FragmentEntity entityToBeAdded = getFragmentForReplacement(parentEntity, replacementDataNode,
+                existingListNodeElementEntity);
+
+            updatedChildFragmentEntities.add(entityToBeAdded);
+        }
+        parentEntity.getChildFragments().addAll(updatedChildFragmentEntities);
+        fragmentRepository.save(parentEntity);
+    }
+
+    private static void removeExistingListElements(
+        final Collection<FragmentEntity> fragmentEntities,
+        final Map<String, FragmentEntity> existingListElementFragmentEntitiesByXPath) {
+        fragmentEntities.removeAll(existingListElementFragmentEntitiesByXPath.values());
+    }
+
+    private static String getListNodeXpathPrefix(final Collection<DataNode> replacementDataNodes) {
+        final String firstChildNodeXpath = replacementDataNodes.iterator().next().getXpath();
+        return firstChildNodeXpath.substring(0, firstChildNodeXpath.lastIndexOf("[") + 1);
+    }
+
+    private static FragmentEntity getFragmentForReplacement(final FragmentEntity parentEntity,
+                                                            final DataNode replacementDataNode,
+                                                            final FragmentEntity existingListNodeElementEntity) {
+        if (existingListNodeElementEntity == null) {
+            return convertToFragmentWithAllDescendants(
+                parentEntity.getDataspace(), parentEntity.getAnchor(), replacementDataNode);
+        }
+        if (replacementDataNode.getChildDataNodes().isEmpty()) {
+            copyAttributesFromReplacementDataNode(existingListNodeElementEntity, replacementDataNode);
+            existingListNodeElementEntity.getChildFragments().clear();
+        } else {
+            replaceDataNodeTree(existingListNodeElementEntity, replacementDataNode);
+        }
+        return existingListNodeElementEntity;
+    }
+
+    private static boolean isNewDataNode(final DataNode replacementDataNode,
+                                         final Map<String, FragmentEntity> existingListNodeElementsByXpath) {
+        return !existingListNodeElementsByXpath.containsKey(replacementDataNode.getXpath());
+    }
+
+    private static void copyAttributesFromReplacementDataNode(final FragmentEntity existingListNodeElementEntity,
+                                                              final DataNode replacementDataNode) {
+        final FragmentEntity replacementFragmentEntity =
+            FragmentEntity.builder().attributes(GSON.toJson(replacementDataNode.getLeaves())).build();
+        existingListNodeElementEntity.setAttributes(replacementFragmentEntity.getAttributes());
+    }
+
+    private static Map<String, FragmentEntity> extractListElementFragmentEntitiesByXPath(
+        final Set<FragmentEntity> childEntities, final String listNodeXpathPrefix) {
+        return childEntities.stream()
+            .filter(fragmentEntity -> fragmentEntity.getXpath().startsWith(listNodeXpathPrefix))
+            .collect(Collectors.toMap(FragmentEntity::getXpath, fragmentEntity -> fragmentEntity));
+    }
+
+    @Override
+    @Transactional
+    public void deleteListDataNodes(final String dataspaceName, final String anchorName, final String listNodeXpath) {
+        final String parentNodeXpath = listNodeXpath.substring(0, listNodeXpath.lastIndexOf('/'));
+        final FragmentEntity parentEntity = getFragmentByXpath(dataspaceName, anchorName, parentNodeXpath);
+        final String descendantNode = listNodeXpath.substring(listNodeXpath.lastIndexOf('/'));
+        final Matcher descendantNodeHasListNodeKey = Pattern.compile(REG_EX_FOR_LIST_NODE_KEY).matcher(descendantNode);
+
+        final boolean xpathPointsToAValidChildNodeWithKey = parentEntity.getChildFragments().stream().anyMatch(
+            fragment -> fragment.getXpath().equals(listNodeXpath));
+
+        final boolean xpathPointsToAValidChildNodeWithoutKey = parentEntity.getChildFragments().stream().anyMatch(
+            fragment -> fragment.getXpath().replaceAll(REG_EX_FOR_LIST_NODE_KEY, "").equals(listNodeXpath));
+
+        if ((descendantNodeHasListNodeKey.find() && xpathPointsToAValidChildNodeWithKey)
+            ||
+            (!descendantNodeHasListNodeKey.find() && xpathPointsToAValidChildNodeWithoutKey)) {
+            removeListNodeDescendants(parentEntity, listNodeXpath);
+        } else {
+            throw new DataNodeNotFoundException(parentEntity.getDataspace().getName(),
+                parentEntity.getAnchor().getName(), listNodeXpath);
+        }
+    }
+
+    private void removeListNodeDescendants(final FragmentEntity parentFragmentEntity, final String listNodeXpath) {
+        final Matcher descendantNodeHasListNodeKey = Pattern.compile(REG_EX_FOR_LIST_NODE_KEY).matcher(listNodeXpath);
+        final String listNodeXpathPrefix = listNodeXpath + (descendantNodeHasListNodeKey.find() ? "" : "[");
+        if (parentFragmentEntity.getChildFragments()
+            .removeIf(fragment -> fragment.getXpath().startsWith(listNodeXpathPrefix))) {
+            fragmentRepository.save(parentFragmentEntity);
+        }
+    }
+
+    private static boolean isRootXpath(final String xpath) {
+        return "/".equals(xpath) || "".equals(xpath);
+    }
 }