Fix Id-searches endpoint performance degradation

- create more flexible control over fetch descendants
- add a new FETCH_DIRECT_CHILDREN_ONLY option to fetch descendants
options
- enabel create custom fetch descendants option

Reviewer: Toine, Joe, Priyank
Issue-ID: CPS-1216
Change-Id: I900b32e813367aa9566c1dec986b20f009d27203
Signed-off-by: kissand <andras.zoltan.kiss@est.tech>

3 files changed, 78 insertions, 3 deletions

diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy
index 3f28f0ac8..a53706a06 100644
--- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy
+++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy
@@ -188,7 +188,7 @@ class CpsDataServiceImplSpec extends Specification {
         expect: 'service returns same data if uses same parameters'
             objectUnderTest.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption) == dataNode
         where: 'all fetch options are supported'
-            fetchDescendantsOption << FetchDescendantsOption.values()
+            fetchDescendantsOption << [FetchDescendantsOption.OMIT_DESCENDANTS, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS]
     }
 
     def 'Get data node with option invalid #scenario.'() {
diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsQueryServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsQueryServiceImplSpec.groovy
index 55a252c27..b7fec8511 100644
--- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsQueryServiceImplSpec.groovy
+++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsQueryServiceImplSpec.groovy
@@ -1,6 +1,6 @@
 /*
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2021 Nordix Foundation
+ *  Copyright (C) 2021-2022 Nordix Foundation
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -44,7 +44,7 @@ class CpsQueryServiceImplSpec extends Specification {
         then: 'the persistence service is called once with the correct parameters'
             1 * mockCpsDataPersistenceService.queryDataNodes(dataspaceName, anchorName, cpsPath, fetchDescendantsOption)
         where: 'all fetch descendants options are supported'
-            fetchDescendantsOption << FetchDescendantsOption.values()
+            fetchDescendantsOption << [FetchDescendantsOption.OMIT_DESCENDANTS, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS]
     }
 
     def 'Query data nodes by cps path with invalid #scenario.'() {
diff --git a/cps-service/src/test/groovy/org/onap/cps/spi/FetchDescendantsOptionSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/spi/FetchDescendantsOptionSpec.groovy
new file mode 100644
index 000000000..627383561
--- /dev/null
+++ b/cps-service/src/test/groovy/org/onap/cps/spi/FetchDescendantsOptionSpec.groovy
@@ -0,0 +1,75 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 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.spi
+
+
+import spock.lang.Specification
+
+class FetchDescendantsOptionSpec extends Specification {
+    def 'Check has next descendant for fetch descendant option: #scenario'() {
+        when: 'fetch descendant option with #depth depth'
+            def fetchDescendantsOption = new FetchDescendantsOption(depth)
+        then: 'next level descendants available: #expectedHasNext'
+            fetchDescendantsOption.hasNext() == expectedHasNext
+        where: 'following parameters are used'
+            scenario                  | depth || expectedHasNext
+            'omit descendants'        | 0     || false
+            'first child'             | 1     || true
+            'second child'            | 2     || true
+            'include all descendants' | -1    || true
+    }
+
+    def 'Check has next descendant for fetch descendant option: invalid depth'() {
+        given: 'fetch descendant option with -2 depth'
+            def fetchDescendantsOption = new FetchDescendantsOption(-2)
+        when: 'next level descendants not available'
+            fetchDescendantsOption.hasNext()
+        then: 'exception thrown'
+            thrown IllegalArgumentException
+    }
+
+    def 'Get next descendant for fetch descendant option: #scenario'() {
+        when: 'fetch descendant option with #depth depth'
+            def fetchDescendantsOption = new FetchDescendantsOption(depth)
+        then: 'the next level of depth is as expected'
+            fetchDescendantsOption.next().depth == depth - 1
+        where: 'following parameters are used'
+            scenario                  | depth
+            'first child'             | 1
+            'second child'            | 2
+    }
+
+    def 'Get next descendant for fetch descendant option: include all descendants'() {
+        when: 'fetch descendant option with -1 depth'
+            def fetchDescendantsOption = new FetchDescendantsOption(-1)
+        then: 'the next level of depth is as expected'
+            fetchDescendantsOption.next().depth == -1
+    }
+
+    def 'Get next descendant for fetch descendant option: omit descendants'() {
+        given: 'fetch descendant option with 0 depth'
+            def fetchDescendantsOption = new FetchDescendantsOption(0)
+        when: 'the next level of depth is not allowed'
+            fetchDescendantsOption.next()
+        then: 'exception thrown'
+            thrown IllegalArgumentException
+    }
+}