Merge "Add integration test for extending API: Get Module Definitions"
[cps.git] / integration-test / src / test / groovy / org / onap / cps / integration / performance / base / CpsPerfTestBase.groovy
index 3b5f69c..68dfb4a 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2023 Nordix Foundation
+ *  Copyright (C) 2023-2024 Nordix Foundation
  *  ================================================================================
  *  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.integration.performance.base
 
-import org.onap.cps.spi.FetchDescendantsOption
-
-import java.time.OffsetDateTime
-import org.onap.cps.integration.base.CpsIntegrationSpecBase
+import org.onap.cps.integration.ResourceMeter
 import org.onap.cps.rest.utils.MultipartFileUtil
+import org.onap.cps.spi.FetchDescendantsOption
 import org.springframework.web.multipart.MultipartFile
 
 class CpsPerfTestBase extends PerfTestBase {
 
-    static def CPS_PERFORMANCE_TEST_DATASPACE = 'cpsPerformanceDataspace'
+    static final def CPS_PERFORMANCE_TEST_DATASPACE = 'cpsPerformanceDataspace'
+    static final def OPENROADM_ANCHORS = 3
+    static final def OPENROADM_DEVICES_PER_ANCHOR = 1000
+    static final def OPENROADM_DATANODES_PER_DEVICE = 86
+
+    ResourceMeter resourceMeter = new ResourceMeter()
 
     def printTitle() {
-        println('##        C P S   P E R F O R M A N C E   T E S T   R E S U L T S          ##')
+        println('##                   C P S   P E R F O R M A N C E   T E S T   R E S U L T S                    ##')
     }
 
     def isInitialised() {
@@ -40,76 +43,50 @@ class CpsPerfTestBase extends PerfTestBase {
     }
 
     def setupPerformanceInfraStructure() {
-        cpsAdminService.createDataspace(CPS_PERFORMANCE_TEST_DATASPACE)
-        def modelAsString = CpsIntegrationSpecBase.readResourceDataFile('bookstore/bookstore.yang')
-        cpsModuleService.createSchemaSet(CPS_PERFORMANCE_TEST_DATASPACE, CpsIntegrationSpecBase.BOOKSTORE_SCHEMA_SET, [bookstore: modelAsString])
+        cpsDataspaceService.createDataspace(CPS_PERFORMANCE_TEST_DATASPACE)
+        createStandardBookStoreSchemaSet(CPS_PERFORMANCE_TEST_DATASPACE)
     }
 
     def createInitialData() {
-        createWarmupData()
-        createLargeBookstoresData()
         addOpenRoadModel()
         addOpenRoadData()
     }
 
-    def createWarmupData() {
-        def data = "{\"bookstore\":{}}"
-        stopWatch.start()
-        addAnchorsWithData(1, CpsIntegrationSpecBase.BOOKSTORE_SCHEMA_SET, 'warmup', data)
-        stopWatch.stop()
-        def durationInMillis = stopWatch.getTotalTimeMillis()
-        recordAndAssertPerformance('Creating warmup anchor with tiny data tree', 500, durationInMillis)
-    }
-
-    def createLargeBookstoresData() {
-        def data = CpsIntegrationSpecBase.readResourceDataFile('bookstore/largeModelData.json')
-        stopWatch.start()
-        addAnchorsWithData(5, CpsIntegrationSpecBase.BOOKSTORE_SCHEMA_SET, 'bookstore', data)
-        stopWatch.stop()
-        def durationInMillis = stopWatch.getTotalTimeMillis()
-        recordAndAssertPerformance('Creating bookstore anchors with large data tree', 3_000, durationInMillis)
-    }
-
     def addOpenRoadModel() {
         def file = new File('src/test/resources/data/openroadm/correctedModel.zip')
         def multipartFile = Mock(MultipartFile)
         multipartFile.getOriginalFilename() >> file.getName()
         multipartFile.getInputStream() >> new FileInputStream(file)
-        cpsModuleService.createSchemaSet(CPS_PERFORMANCE_TEST_DATASPACE, PerfTestBase.LARGE_SCHEMA_SET, MultipartFileUtil.extractYangResourcesMap(multipartFile))
+        cpsModuleService.createSchemaSet(CPS_PERFORMANCE_TEST_DATASPACE, LARGE_SCHEMA_SET, MultipartFileUtil.extractYangResourcesMap(multipartFile))
     }
 
     def addOpenRoadData() {
-        def data = generateOpenRoadData(50)
-        stopWatch.start()
-        addAnchorsWithData(5, PerfTestBase.LARGE_SCHEMA_SET, 'openroadm', data)
-        stopWatch.stop()
-        def durationInMillis = stopWatch.getTotalTimeMillis()
-        recordAndAssertPerformance('Creating openroadm anchors with large data tree', 25_000, durationInMillis)
+        def data = generateOpenRoadData(OPENROADM_DEVICES_PER_ANCHOR)
+        resourceMeter.start()
+        addAnchorsWithData(OPENROADM_ANCHORS, CPS_PERFORMANCE_TEST_DATASPACE, LARGE_SCHEMA_SET, 'openroadm', data)
+        resourceMeter.stop()
+        def durationInSeconds = resourceMeter.getTotalTimeInSeconds()
+        recordAndAssertResourceUsage('Creating openroadm anchors with large data tree', 100, durationInSeconds, 600, resourceMeter.getTotalMemoryUsageInMB())
     }
 
     def generateOpenRoadData(numberOfNodes) {
-        def innerNode = CpsIntegrationSpecBase.readResourceDataFile('openroadm/innerNode.json')
+        def innerNode = readResourceDataFile('openroadm/innerNode.json')
         return '{ "openroadm-devices": { "openroadm-device": [' +
             (1..numberOfNodes).collect { innerNode.replace('NODE_ID_HERE', it.toString()) }.join(',') +
             ']}}'
     }
 
-    def addAnchorsWithData(numberOfAnchors, schemaSetName, anchorNamePrefix, data) {
-        (1..numberOfAnchors).each {
-            cpsAdminService.createAnchor(CPS_PERFORMANCE_TEST_DATASPACE, schemaSetName, anchorNamePrefix + it)
-            cpsDataService.saveData(CPS_PERFORMANCE_TEST_DATASPACE, anchorNamePrefix + it, data, OffsetDateTime.now())
-        }
-    }
-
     def 'Warm the database'() {
-        when: 'get data nodes for warmup anchor'
-            stopWatch.start()
-            def result = cpsDataService.getDataNodes(CPS_PERFORMANCE_TEST_DATASPACE, 'warmup1', '/', FetchDescendantsOption.OMIT_DESCENDANTS)
+        when: 'dummy get data nodes runs so that populating the DB does not get included in other test timings'
+            resourceMeter.start()
+            def result = cpsDataService.getDataNodes(CPS_PERFORMANCE_TEST_DATASPACE, 'openroadm1', '/', FetchDescendantsOption.OMIT_DESCENDANTS)
             assert countDataNodesInTree(result) == 1
-            stopWatch.stop()
-            def durationInMillis = stopWatch.getTotalTimeMillis()
-        then: 'all data is read within 25 seconds (warm up not critical)'
-            recordAndAssertPerformance("Warming database", 25_000, durationInMillis)
+            resourceMeter.stop()
+            def durationInSeconds = resourceMeter.getTotalTimeInSeconds()
+        then: 'memory used is within #peakMemoryUsage'
+            assert resourceMeter.getTotalMemoryUsageInMB() <= 30
+        and: 'all data is read within expected time'
+            recordAndAssertResourceUsage("Warming database", 100, durationInSeconds, 600, resourceMeter.getTotalMemoryUsageInMB())
     }
 
 }