Merge "Filling Code Coverage gaps in CPS-NCMP-Service"

Author: leeanjellamacabuhay

cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyRestExceptionHandlerSpec.groovy

@@ -156,21 +156,20 @@ class NetworkCmProxyRestExceptionHandlerSpec extends Specification {
         then: 'an HTTP response is returned with correct message and details'
             assertTestResponse(response, expectedErrorCode, expectedErrorMessage, expectedErrorDetails)
         where:
-            scenario                | exception                                                                      || expectedErrorCode     | expectedErrorMessage                 | expectedErrorDetails
-            'CPS'                   | new CpsException(sampleErrorMessage, sampleErrorDetails)                       || INTERNAL_SERVER_ERROR | sampleErrorMessage                   | sampleErrorDetails
-            'NCMP-server'           | new ServerNcmpException(sampleErrorMessage, sampleErrorDetails)                || INTERNAL_SERVER_ERROR | sampleErrorMessage                   | null
-            'DMI Request'           | new DmiRequestException(sampleErrorMessage, sampleErrorDetails)                || BAD_REQUEST           | sampleErrorMessage                   | null
-            'Invalid Operation'     | new InvalidOperationException('some reason')                                   || BAD_REQUEST           | 'some reason'                        | null
-            'Unsupported Operation' | new OperationNotSupportedException('not yet')                                  || BAD_REQUEST           | 'not yet'                            | null
-            'DataNode Validation'   | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName')               || NOT_FOUND             | 'DataNode not found'                 | null
-            'other'                 | new IllegalStateException(sampleErrorMessage)                                  || INTERNAL_SERVER_ERROR | sampleErrorMessage                   | null
-            'Data Node Not Found'   | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName')               || NOT_FOUND             | 'DataNode not found'                 | 'DataNode not found'
-            'Existing entry'        | new AlreadyDefinedException('name',null)                                       || CONFLICT              | 'Already defined exception'          | 'name already exists'
-            'Existing entries'      | AlreadyDefinedException.forDataNodes(['A', 'B'], 'myAnchorName')               || CONFLICT              | 'Already defined exception'          | '2 data node(s) already exist'
-            'Operation too large'   | new PayloadTooLargeException(sampleErrorMessage)                               || PAYLOAD_TOO_LARGE     | sampleErrorMessage                   | 'Check logs'
-            'Policy Executor'       | new PolicyExecutorException(sampleErrorMessage, sampleErrorDetails, null)      || CONFLICT              | sampleErrorMessage                   | sampleErrorDetails
-            'Invalid Path'          | new ProvMnSException('not a valid path' ,'some invalid path not a valid path') || UNPROCESSABLE_ENTITY  | 'not a valid path'                   | 'some invalid path not a valid path'
-            'Invalid Path'          | new ProvMnSException('some invalid path not a valid path')                     || UNPROCESSABLE_ENTITY  | 'some invalid path not a valid path' | null
+            scenario                | exception                                                                 || expectedErrorCode     | expectedErrorMessage        | expectedErrorDetails
+            'CPS'                   | new CpsException(sampleErrorMessage, sampleErrorDetails)                  || INTERNAL_SERVER_ERROR | sampleErrorMessage          | sampleErrorDetails
+            'NCMP-server'           | new ServerNcmpException(sampleErrorMessage, sampleErrorDetails)           || INTERNAL_SERVER_ERROR | sampleErrorMessage          | null
+            'DMI Request'           | new DmiRequestException(sampleErrorMessage, sampleErrorDetails)           || BAD_REQUEST           | sampleErrorMessage          | null
+            'Invalid Operation'     | new InvalidOperationException('some reason')                              || BAD_REQUEST           | 'some reason'               | null
+            'Unsupported Operation' | new OperationNotSupportedException('not yet')                             || BAD_REQUEST           | 'not yet'                   | null
+            'DataNode Validation'   | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName')          || NOT_FOUND             | 'DataNode not found'        | null
+            'other'                 | new IllegalStateException(sampleErrorMessage)                             || INTERNAL_SERVER_ERROR | sampleErrorMessage          | null
+            'Data Node Not Found'   | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName')          || NOT_FOUND             | 'DataNode not found'        | 'DataNode not found'
+            'Existing entry'        | new AlreadyDefinedException('name',null)                                  || CONFLICT              | 'Already defined exception' | 'name already exists'
+            'Existing entries'      | AlreadyDefinedException.forDataNodes(['A', 'B'], 'myAnchorName')          || CONFLICT              | 'Already defined exception' | '2 data node(s) already exist'
+            'Operation too large'   | new PayloadTooLargeException(sampleErrorMessage)                          || PAYLOAD_TOO_LARGE     | sampleErrorMessage          | 'Check logs'
+            'Policy Executor'       | new PolicyExecutorException(sampleErrorMessage, sampleErrorDetails, null) || CONFLICT              | sampleErrorMessage          | sampleErrorDetails
+            'Invalid Path'          | new ProvMnSException('not a valid path' ,'some details')                  || UNPROCESSABLE_ENTITY  | 'not a valid path'          | 'some details'
     }
 
     def 'Post request with exception returns correct HTTP Status.'() {

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/exceptions/ProvMnSException.java

@@ -32,13 +32,4 @@ public ProvMnSException(final String message, final String details) {
         super(message, details);
     }
 
-    /**
-     * Constructor.
-     *
-     * @param message exception message
-     */
-    public ProvMnSException(final String message) {
-        super(message, null);
-    }
-
 }

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/models/CompositeStateBuilder.java

@@ -1,7 +1,7 @@
 /*
  * ============LICENSE_START=======================================================
  * Copyright (C) 2022 Bell Canada
- * Modifications Copyright (C) 2022-2023 Nordix Foundation.
+ * Modifications Copyright (C) 2022-2025 OpenInfra Foundation Europe.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -123,13 +123,13 @@ public CompositeStateBuilder fromDataNode(final DataNode dataNode) {
         }
         for (final DataNode stateChildNode : dataNode.getChildDataNodes()) {
             if (stateChildNode.getXpath().endsWith("/lock-reason")) {
-                this.lockReason = getLockReason(stateChildNode);
+                this.lockReason = toLockReason(stateChildNode);
             }
             if (stateChildNode.getXpath().endsWith("/datastores")) {
                 for (final DataNode dataStoreNodes : stateChildNode.getChildDataNodes()) {
                     Operational operationalDataStore = null;
                     if (dataStoreNodes.getXpath().contains("/operational")) {
-                        operationalDataStore = getOperationalDataStore(dataStoreNodes);
+                        operationalDataStore = toOperationalDataStore(dataStoreNodes);
                     }
                     this.datastores = DataStores.builder().operationalDataStore(operationalDataStore).build();
                 }
@@ -138,14 +138,14 @@ public CompositeStateBuilder fromDataNode(final DataNode dataNode) {
         return this;
     }
 
-    private Operational getOperationalDataStore(final DataNode dataStoreNodes) {
+    private Operational toOperationalDataStore(final DataNode dataStoreNodes) {
         return Operational.builder()
                 .dataStoreSyncState(DataStoreSyncState.valueOf((String) dataStoreNodes.getLeaves().get("sync-state")))
                 .lastSyncTime((String) dataStoreNodes.getLeaves().get("last-sync-time"))
                 .build();
     }
 
-    private LockReason getLockReason(final DataNode stateChildNode) {
+    private LockReason toLockReason(final DataNode stateChildNode) {
         final boolean isLockReasonExists = stateChildNode.getLeaves().containsKey("reason");
         return new LockReason(isLockReasonExists
                 ? LockReasonCategory.valueOf((String) stateChildNode.getLeaves().get("reason"))

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/NetworkCmProxyInventoryFacadeImpl.java

@@ -98,6 +98,8 @@ public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleReference(fina
         }
     }
 
+
+
     @Override
     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleAndModule(final String cmHandleReference,
                                                                                 final String moduleName,

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/CmHandleRegistrationServicePropertyHandler.java

@@ -55,6 +55,7 @@
 import org.onap.cps.ncmp.api.inventory.models.CmHandleRegistrationResponse;
 import org.onap.cps.ncmp.api.inventory.models.NcmpServiceCmHandle;
 import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
+import org.onap.cps.ncmp.impl.inventory.sync.lcm.CmHandleTransitionPair;
 import org.onap.cps.ncmp.impl.inventory.sync.lcm.LcmEventsHelper;
 import org.onap.cps.ncmp.impl.utils.YangDataConverter;
 import org.onap.cps.utils.ContentType;
@@ -142,7 +143,7 @@ private void updateAlternateId(final NcmpServiceCmHandle ncmpServiceCmHandle) {
     }
 
     private void updateDataProducerIdentifier(final DataNode cmHandleDataNode,
-            final NcmpServiceCmHandle ncmpServiceCmHandle) {
+                                              final NcmpServiceCmHandle ncmpServiceCmHandle) {
         final String targetDataProducerIdentifier = ncmpServiceCmHandle.getDataProducerIdentifier();
         final String cmHandleId = ncmpServiceCmHandle.getCmHandleId();
 
@@ -151,31 +152,26 @@ private void updateDataProducerIdentifier(final DataNode cmHandleDataNode,
             return;
         }
 
-        final YangModelCmHandle existingYangModelCmHandle = YangDataConverter.toYangModelCmHandle(cmHandleDataNode);
-        final String existingDataProducerIdentifier = existingYangModelCmHandle.getDataProducerIdentifier();
+        final YangModelCmHandle currentYangModelCmHandle = YangDataConverter.toYangModelCmHandle(cmHandleDataNode);
+        final String currentDataProducerIdentifier = currentYangModelCmHandle.getDataProducerIdentifier();
 
-        if (existingDataProducerIdentifier.equals(targetDataProducerIdentifier)) {
+        if (currentDataProducerIdentifier.equals(targetDataProducerIdentifier)) {
             log.debug("Ignoring update as dataProducerIdentifier for cmHandle {} is already set to {}.", cmHandleId,
                     targetDataProducerIdentifier);
             return;
         }
-
         setAndUpdateCmHandleField(cmHandleId, "data-producer-identifier", targetDataProducerIdentifier);
         log.debug("dataProducerIdentifier for cmHandle {} updated from {} to {}", cmHandleId,
-                existingDataProducerIdentifier, targetDataProducerIdentifier);
-        sendLcmEventForDataProducerIdentifier(cmHandleId, existingYangModelCmHandle);
+                currentDataProducerIdentifier, targetDataProducerIdentifier);
+        sendLcmEventForDataProducerIdentifier(cmHandleId, currentYangModelCmHandle);
     }
 
     private void sendLcmEventForDataProducerIdentifier(final String cmHandleId,
-            final YangModelCmHandle existingYangModelCmHandle) {
+                                                       final YangModelCmHandle currentYangModelCmHandle) {
         final YangModelCmHandle updatedYangModelCmHandle = inventoryPersistence.getYangModelCmHandle(cmHandleId);
-        final NcmpServiceCmHandle existingNcmpServiceCmHandle =
-                YangDataConverter.toNcmpServiceCmHandle(existingYangModelCmHandle);
-        final NcmpServiceCmHandle updatedNcmpServiceCmHandle =
-                YangDataConverter.toNcmpServiceCmHandle(updatedYangModelCmHandle);
-
-        lcmEventsHelper.sendLcmEventAsynchronously(updatedNcmpServiceCmHandle,
-                existingNcmpServiceCmHandle);
+        final CmHandleTransitionPair cmHandleTransitionPair =
+            new CmHandleTransitionPair(currentYangModelCmHandle, updatedYangModelCmHandle);
+        lcmEventsHelper.sendLcmEventBatchAsynchronously(List.of(cmHandleTransitionPair));
     }
 
     private void updateProperties(final DataNode existingCmHandleDataNode, final PropertyType propertyType,

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/lcm/CmHandleStateMonitor.java

@@ -29,7 +29,6 @@
 import org.onap.cps.ncmp.api.inventory.models.CmHandleState;
 import org.onap.cps.ncmp.api.inventory.models.CompositeState;
 import org.onap.cps.ncmp.impl.inventory.CmHandleQueryService;
-import org.onap.cps.ncmp.impl.inventory.sync.lcm.LcmEventsCmHandleStateHandlerImpl.CmHandleTransitionPair;
 import org.onap.cps.ncmp.utils.events.NcmpInventoryModelOnboardingFinishedEvent;
 import org.springframework.context.annotation.DependsOn;
 import org.springframework.context.event.EventListener;
@@ -76,12 +75,12 @@ public void updateCmHandleStateMetrics(final Collection<CmHandleTransitionPair>
     }
 
     private void updateMetricWithStateChange(final CmHandleTransitionPair cmHandleTransitionPair) {
-        final CmHandleState targetCmHandleState = cmHandleTransitionPair.getTargetYangModelCmHandle()
+        final CmHandleState targetCmHandleState = cmHandleTransitionPair.targetYangModelCmHandle()
                 .getCompositeState().getCmHandleState();
-        if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState())) {
+        if (isNew(cmHandleTransitionPair.currentYangModelCmHandle().getCompositeState())) {
             updateTargetStateCount(targetCmHandleState);
         } else {
-            final CmHandleState previousCmHandleState = cmHandleTransitionPair.getCurrentYangModelCmHandle()
+            final CmHandleState previousCmHandleState = cmHandleTransitionPair.currentYangModelCmHandle()
                     .getCompositeState().getCmHandleState();
             updatePreviousStateCount(previousCmHandleState);
             updateTargetStateCount(targetCmHandleState);
@@ -98,8 +97,8 @@ private void updateTargetStateCount(final CmHandleState targetCmHandleState) {
         cmHandlesByState.executeOnKey(keyName, new IncreasingEntryProcessor());
     }
 
-    private boolean isNew(final CompositeState existingCompositeState) {
-        return (existingCompositeState == null);
+    private boolean isNew(final CompositeState currentCompositeState) {
+        return (currentCompositeState == null);
     }
 
     static class DecreasingEntryProcessor implements EntryProcessor<String, Integer, Void> {

cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/lcm/CmHandleTransitionPair.java

@@ -0,0 +1,27 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2025 OpenInfra Foundation Europe. All rights reserved.
+ * ================================================================================
+ * 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.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.impl.inventory.sync.lcm;
+
+import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
+
+public record CmHandleTransitionPair(YangModelCmHandle currentYangModelCmHandle,
+                                     YangModelCmHandle targetYangModelCmHandle
+) {}