Add gauge metric for NCMP "cmhandle states"

Issue-ID: CPS-2456
Change-Id: I1aebcc68dfdc9c48c230c74376742d67b05c0615
Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>

3 files changed, 152 insertions, 2 deletions

diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/cache/AdminCacheConfigSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/cache/AdminCacheConfigSpec.groovy
new file mode 100644
index 0000000000..9b9603369d
--- /dev/null
+++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/cache/AdminCacheConfigSpec.groovy
@@ -0,0 +1,57 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2025 Nordix Foundation.
+ * ================================================================================
+ * 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.cache
+
+import com.hazelcast.core.Hazelcast
+import com.hazelcast.map.IMap
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.test.context.ContextConfiguration;
+import spock.lang.Specification;
+
+@SpringBootTest
+@ContextConfiguration(classes = [AdminCacheConfig])
+class AdminCacheConfigSpec extends Specification {
+
+    @Autowired
+    IMap<String, Integer> cmHandlesByState
+
+    def cleanupSpec() {
+        Hazelcast.getHazelcastInstanceByName('cps-and-ncmp-hazelcast-instance-test-config').shutdown()
+    }
+
+    def 'Hazelcast cache for cm handle by state gauge'() {
+        expect: 'system is able to create an instance of the cm handle by state cache'
+            assert null != cmHandlesByState
+        and: 'there is at least 1 instance'
+            assert Hazelcast.allHazelcastInstances.size() > 0
+        and: 'Hazelcast cache instance for cm handle by state is present'
+            assert Hazelcast.getHazelcastInstanceByName('cps-and-ncmp-hazelcast-instance-test-config').getMap('cmHandlesByState') != null
+        and: 'the cache already contains 5 entries, an entry for each state'
+            def cmHandleByState =  Hazelcast.getHazelcastInstanceByName('cps-and-ncmp-hazelcast-instance-test-config').getMap('cmHandlesByState')
+            assert cmHandleByState.size() == 5
+            assert cmHandleByState.containsKey('advisedCmHandlesCount')
+            assert cmHandleByState.containsKey('lockedCmHandlesCount')
+            assert cmHandleByState.containsKey('readyCmHandlesCount')
+            assert cmHandleByState.containsKey('deletingCmHandlesCount')
+            assert cmHandleByState.containsKey('deletedCmHandlesCount')
+    }
+}
diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/CmHandleStateMonitorSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/CmHandleStateMonitorSpec.groovy
new file mode 100644
index 0000000000..2833ca838f
--- /dev/null
+++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/CmHandleStateMonitorSpec.groovy
@@ -0,0 +1,92 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2025 Nordix Foundation.
+ * ================================================================================
+ * 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 static org.onap.cps.ncmp.impl.inventory.models.CmHandleState.ADVISED
+import static org.onap.cps.ncmp.impl.inventory.models.CmHandleState.READY
+
+import com.hazelcast.core.Hazelcast
+import com.hazelcast.map.IMap
+import org.onap.cps.ncmp.api.inventory.models.CompositeState
+import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle
+import org.onap.cps.ncmp.impl.inventory.sync.lcm.CmHandleStateMonitor.DecreasingEntryProcessor
+import org.onap.cps.ncmp.impl.inventory.sync.lcm.CmHandleStateMonitor.IncreasingEntryProcessor
+import spock.lang.Shared
+import spock.lang.Specification;
+
+class CmHandleStateMonitorSpec extends Specification {
+
+    def cmHandlesByState = Mock(IMap)
+    def objectUnderTest = new CmHandleStateMonitor(cmHandlesByState)
+
+    @Shared
+    def entryProcessingMap =  Hazelcast.newHazelcastInstance().getMap('entryProcessingMap')
+
+    def setup() {
+        entryProcessingMap.put('zeroCmHandlesCount', 0)
+        entryProcessingMap.put('tenCmHandlesCount', 10)
+    }
+
+    def cleanupSpec() {
+        Hazelcast.shutdownAll()
+    }
+
+    def 'Update cm handle state metric'() {
+        given: 'a collection of cm handle state pair'
+            def cmHandleTransitionPair = new LcmEventsCmHandleStateHandlerImpl.CmHandleTransitionPair()
+            cmHandleTransitionPair.currentYangModelCmHandle = new YangModelCmHandle(compositeState: new CompositeState(cmHandleState: ADVISED))
+            cmHandleTransitionPair.targetYangModelCmHandle =  new YangModelCmHandle(compositeState: new CompositeState(cmHandleState: READY))
+        when: 'method to update cm handle state metrics is called'
+            objectUnderTest.updateCmHandleStateMetrics([cmHandleTransitionPair])
+        then: 'cm handle by state cache map is called once for current and target state for entry processing'
+            1 * cmHandlesByState.executeOnKey('advisedCmHandlesCount', _)
+            1 * cmHandlesByState.executeOnKey('readyCmHandlesCount', _)
+    }
+
+    def 'Updating cm handle state metric with no previous state'() {
+        given: 'a collection of cm handle state pair wherein current state is null'
+            def cmHandleTransitionPair = new LcmEventsCmHandleStateHandlerImpl.CmHandleTransitionPair()
+            cmHandleTransitionPair.currentYangModelCmHandle = new YangModelCmHandle(compositeState: null)
+            cmHandleTransitionPair.targetYangModelCmHandle =  new YangModelCmHandle(compositeState: new CompositeState(cmHandleState: ADVISED))
+        when: 'method to update cm handle state metrics is called'
+            objectUnderTest.updateCmHandleStateMetrics([cmHandleTransitionPair])
+        then: 'cm handle by state cache map is called only once'
+            1 * cmHandlesByState.executeOnKey(_, _)
+    }
+
+    def 'Applying decreasing entry processor to a key on map where #scenario'() {
+        when: 'decreasing entry processor is applied to subtract 1 to the value'
+            entryProcessingMap.executeOnKey(key, new DecreasingEntryProcessor())
+        then: 'the new value is as expected'
+            assert entryProcessingMap.get(key) == expectedValue
+        where: 'the following data is used'
+            scenario                        | key                 || expectedValue
+            'current value of count is zero'| 'zeroCmHandlesCount'|| 0
+            'current value of count is >0'  | 'tenCmHandlesCount' || 9
+    }
+
+    def 'Applying increasing entry processor to a key on map'() {
+        when: 'increasing entry processor is applied to add 1 to the value'
+            entryProcessingMap.executeOnKey('tenCmHandlesCount', new IncreasingEntryProcessor())
+        then: 'the new value is as expected'
+            assert entryProcessingMap.get('tenCmHandlesCount') == 11
+    }
+}
diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy
index 4b676e1b4c..5e614a6f88 100644
--- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy
+++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/impl/inventory/sync/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy
@@ -1,6 +1,6 @@
 /*
  * ============LICENSE_START=======================================================
- * Copyright (C) 2022-2024 Nordix Foundation
+ * Copyright (C) 2022-2025 Nordix Foundation
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,9 +56,10 @@ class LcmEventsCmHandleStateHandlerImplSpec extends Specification {
     def mockInventoryPersistence = Mock(InventoryPersistence)
     def mockLcmEventsCreator = Mock(LcmEventsCreator)
     def mockLcmEventsService = Mock(LcmEventsService)
+    def mockCmHandleStateMonitor = Mock(CmHandleStateMonitor)
 
     def lcmEventsCmHandleStateHandlerAsyncHelper = new LcmEventsCmHandleStateHandlerAsyncHelper(mockLcmEventsCreator, mockLcmEventsService)
-    def objectUnderTest = new LcmEventsCmHandleStateHandlerImpl(mockInventoryPersistence, lcmEventsCmHandleStateHandlerAsyncHelper)
+    def objectUnderTest = new LcmEventsCmHandleStateHandlerImpl(mockInventoryPersistence, lcmEventsCmHandleStateHandlerAsyncHelper, mockCmHandleStateMonitor)
 
     def cmHandleId = 'cmhandle-id-1'
     def compositeState