2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 Nordix Foundation
4 * Modifications Copyright (C) 2021 Pantheon.tech
5 * Modifications Copyright (C) 2021 Bell Canada.
6 * Modifications Copyright (C) 2023 TechMahindra Ltd.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
23 package org.onap.cps.spi.impl
25 import org.onap.cps.spi.CpsDataPersistenceService
26 import org.onap.cps.spi.FetchDescendantsOption
27 import org.onap.cps.spi.exceptions.CpsPathException
28 import org.springframework.beans.factory.annotation.Autowired
29 import org.springframework.test.context.jdbc.Sql
31 import java.util.stream.Collectors
33 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
34 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
36 class CpsDataPersistenceQueryDataNodeSpec extends CpsPersistenceSpecBase {
39 CpsDataPersistenceService objectUnderTest
41 static final String SET_DATA = '/data/cps-path-query.sql'
43 @Sql([CLEAR_DATA, SET_DATA])
44 def 'Cps Path query for leaf value(s) with : #scenario.'() {
45 when: 'a query is executed to get a data node by the given cps path'
46 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, fetchDescendantsOption)
47 then: 'the correct number of parent nodes are returned'
48 result.size() == expectedNumberOfParentNodes
49 then: 'the correct data is returned'
51 assert it.getChildDataNodes().size() == expectedNumberOfChildNodes
53 where: 'the following data is used'
54 scenario | cpsPath | fetchDescendantsOption || expectedNumberOfParentNodes | expectedNumberOfChildNodes
55 'String and no descendants' | '/shops/shop[@id=1]/categories[@code=1]/book[@title="Dune"]' | OMIT_DESCENDANTS || 1 | 0
56 'Integer and descendants' | '/shops/shop[@id=1]/categories[@code=1]/book[@price=5]' | INCLUDE_ALL_DESCENDANTS || 1 | 1
57 'No condition no descendants' | '/shops/shop[@id=1]/categories' | OMIT_DESCENDANTS || 3 | 0
58 'Integer and level 1 descendants' | '/shops' | new FetchDescendantsOption(1) || 1 | 5
59 'Integer and level 2 descendants' | '/shops/shop[@id=1]' | new FetchDescendantsOption(2) || 1 | 3
62 @Sql([CLEAR_DATA, SET_DATA])
63 def 'Query for attribute by cps path with cps paths that return no data because of #scenario.'() {
64 when: 'a query is executed to get data nodes for the given cps path'
65 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
66 then: 'no data is returned'
68 where: 'following cps queries are performed'
70 'cps path is incomplete' | '/shops[@title="Dune"]'
71 'leaf value does not exist' | '/shops/shop[@id=1]/categories[@code=1]/book[@title=\'does not exist\']'
72 'incomplete end of xpath prefix' | '/shops/shop[@id=1]/categories/book[@price=15]'
75 @Sql([CLEAR_DATA, SET_DATA])
76 def 'Cps Path query using descendant anywhere and #type (further) descendants.'() {
77 when: 'a query is executed to get a data node by the given cps path'
78 def cpsPath = '//categories[@code=1]'
79 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, includeDescendantsOption)
80 then: 'the data node has the correct number of children'
81 def dataNode = result.stream().findFirst().get()
82 dataNode.getChildDataNodes().size() == expectedNumberOfChildNodes
83 where: 'the following data is used'
84 type | includeDescendantsOption || expectedNumberOfChildNodes
85 'omit' | OMIT_DESCENDANTS || 0
86 'include' | INCLUDE_ALL_DESCENDANTS || 1
89 @Sql([CLEAR_DATA, SET_DATA])
90 def 'Cps Path query using descendant anywhere with #scenario '() {
91 when: 'a query is executed to get a data node by the given cps path'
92 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
93 then: 'the correct number of data nodes are retrieved'
94 result.size() == expectedXPaths.size()
95 and: 'xpaths of the retrieved data nodes are as expected'
96 for (int i = 0; i < result.size(); i++) {
97 assert result[i].getXpath() == expectedXPaths[i]
99 where: 'the following data is used'
100 scenario | cpsPath || expectedXPaths
101 'fully unique descendant name' | '//categories[@code=2]' || ["/shops/shop[@id='1']/categories[@code='2']", "/shops/shop[@id='2']/categories[@code='1']", "/shops/shop[@id='2']/categories[@code='2']"]
102 'descendant name match end of other node' | '//book' || ["/shops/shop[@id='1']/categories[@code='1']/book", "/shops/shop[@id='1']/categories[@code='2']/book"]
103 'descendant with text condition on leaf' | '//book/title[text()="Chapters"]' || ["/shops/shop[@id='1']/categories[@code='2']/book"]
104 'descendant with text condition case mismatch' | '//book/title[text()="chapters"]' || []
105 'descendant with text condition on int leaf' | '//book/price[text()="5"]' || ["/shops/shop[@id='1']/categories[@code='1']/book"]
106 'descendant with text condition on leaf-list' | '//book/labels[text()="special offer"]' || ["/shops/shop[@id='1']/categories[@code='1']/book"]
107 'descendant with text condition partial match' | '//book/labels[text()="special"]' || []
108 'descendant with text condition (existing) empty string' | '//book/labels[text()=""]' || ["/shops/shop[@id='1']/categories[@code='1']/book"]
109 'descendant with text condition on int leaf-list' | '//book/editions[text()="2000"]' || ["/shops/shop[@id='1']/categories[@code='2']/book"]
110 'descendant name match of leaf containing /' | '//categories/type[text()="text/with/slash"]' || ["/shops/shop[@id='1']/categories[@code='string/with/slash/']"]
111 'descendant with text condition on leaf containing /' | '//categories[@code=\'string/with/slash\']' || ["/shops/shop[@id='1']/categories[@code='string/with/slash/']"]
112 'descendant with text condition on leaf containing [' | '//book/author[@Address="String[with]square[bracket]"]'|| []
115 @Sql([CLEAR_DATA, SET_DATA])
116 def 'Cps Path query using descendant anywhere with #scenario condition(s) for a container element.'() {
117 when: 'a query is executed to get a data node by the given cps path'
118 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
119 then: 'the correct number of data nodes are retrieved'
120 result.size() == expectedXPaths.size()
121 and: 'xpaths of the retrieved data nodes are as expected'
122 for (int i = 0; i < result.size(); i++) {
123 assert result[i].getXpath() == expectedXPaths[i]
125 where: 'the following data is used'
126 scenario | cpsPath || expectedXPaths
127 'one leaf' | '//author[@FirstName="Joe"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']", "/shops/shop[@id='1']/categories[@code='2']/book/author[@FirstName='Joe' and @Surname='Smith']"]
128 'more than one leaf' | '//author[@FirstName="Joe" and @Surname="Bloggs"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
129 'leaves reversed in order' | '//author[@Surname="Bloggs" and @FirstName="Joe"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
130 'leaf and text condition' | '//author[@FirstName="Joe"]/Surname[text()="Bloggs"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
133 @Sql([CLEAR_DATA, SET_DATA])
134 def 'Cps Path query using descendant anywhere with #scenario condition(s) for a list element.'() {
135 when: 'a query is executed to get a data node by the given cps path'
136 def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
137 then: 'the correct number of data nodes are retrieved'
138 result.size() == expectedXPaths.size()
139 and: 'xpaths of the retrieved data nodes are as expected'
140 for (int i = 0; i < result.size(); i++) {
141 assert result[i].getXpath() == expectedXPaths[i]
143 where: 'the following data is used'
144 scenario | cpsPath || expectedXPaths
145 'one partial key leaf' | '//author[@FirstName="Joe"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']", "/shops/shop[@id='1']/categories[@code='2']/book/author[@FirstName='Joe' and @Surname='Smith']"]
146 'one non key leaf' | '//author[@title="Dune"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
147 'mix of partial key and non key leaf' | '//author[@FirstName="Joe" and @title="Dune"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
150 @Sql([CLEAR_DATA, SET_DATA])
151 def 'Cps Path query across anchors for leaf value(s) with : #scenario.'() {
152 when: 'a query is executed to get a data node by the given cps path'
153 def result = objectUnderTest.queryDataNodesAcrossAnchors(DATASPACE_NAME, cpsPath, includeDescendantsOption)
154 then: 'the correct number of queried nodes are returned'
155 assert result.size() == expectedNumberOfQueriedNodes
156 and : 'correct anchors are queried'
157 assert result.anchorName.containsAll(expectedAnchors)
158 where: 'the following data is used'
159 scenario | cpsPath | includeDescendantsOption || expectedNumberOfQueriedNodes || expectedAnchors
160 'String and no descendants' | '/shops/shop[@id=1]/categories[@code=1]/book[@title="Dune"]' | OMIT_DESCENDANTS || 2 || ['ANCHOR-004', 'ANCHOR-005']
161 'Integer and descendants' | '/shops/shop[@id=1]/categories[@code=1]/book[@price=5]' | INCLUDE_ALL_DESCENDANTS || 3 || ['ANCHOR-004', 'ANCHOR-005']
162 'No condition no descendants' | '/shops/shop[@id=1]/categories' | OMIT_DESCENDANTS || 6 || ['ANCHOR-004', 'ANCHOR-005']
163 'multiple list-ancestors' | '//book/ancestor::categories' | INCLUDE_ALL_DESCENDANTS || 4 || ['ANCHOR-004', 'ANCHOR-005']
164 'one ancestor with list value' | '//book/ancestor::categories[@code=1]' | INCLUDE_ALL_DESCENDANTS || 2 || ['ANCHOR-004', 'ANCHOR-005']
165 'list with index value in the xpath prefix' | '//categories[@code=1]/book/ancestor::shop[@id=1]' | INCLUDE_ALL_DESCENDANTS || 2 || ['ANCHOR-004', 'ANCHOR-005']
166 'ancestor with parent list' | '//book/ancestor::shop[@id=1]/categories[@code=2]' | INCLUDE_ALL_DESCENDANTS || 2 || ['ANCHOR-004', 'ANCHOR-005']
167 'ancestor with parent' | '//phonenumbers[@type="mob"]/ancestor::info/contact' | INCLUDE_ALL_DESCENDANTS || 5 || ['ANCHOR-004', 'ANCHOR-005']
168 'ancestor combined with text condition' | '//book/title[text()="Dune"]/ancestor::shop' | INCLUDE_ALL_DESCENDANTS || 10 || ['ANCHOR-004', 'ANCHOR-005']
169 'ancestor with parent that does not exist' | '//book/ancestor::parentDoesNoExist/categories' | INCLUDE_ALL_DESCENDANTS || 0 || []
170 'ancestor does not exist' | '//book/ancestor::ancestorDoesNotExist' | INCLUDE_ALL_DESCENDANTS || 0 || []
173 def 'Cps Path query across anchors with syntax error throws a CPS Path Exception.'() {
174 when: 'trying to execute a query with a syntax (parsing) error'
175 objectUnderTest.queryDataNodesAcrossAnchors(DATASPACE_NAME, 'cpsPath that cannot be parsed' , OMIT_DESCENDANTS)
176 then: 'a cps path exception is thrown'
177 thrown(CpsPathException)