cps-ri/src/test/groovy/org/onap/cps/spi/impl/CpsDataPersistenceQueryDataNodeSpec.groovy

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23 package org.onap.cps.spi.impl
  24
  25 import org.onap.cps.spi.CpsDataPersistenceService
  26 import org.onap.cps.spi.exceptions.CpsPathException
  27 import org.springframework.beans.factory.annotation.Autowired
  28 import org.springframework.test.context.jdbc.Sql
  29
  30 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
  31 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
  32
  33 class CpsDataPersistenceQueryDataNodeSpec extends CpsPersistenceSpecBase {
  34
  35     @Autowired
  36     CpsDataPersistenceService objectUnderTest
  37
  38     static final String SET_DATA = '/data/cps-path-query.sql'
  39
  40     @Sql([CLEAR_DATA, SET_DATA])
  41     def 'Cps Path query using descendant anywhere with #scenario '() {
  42         when: 'a query is executed to get a data node by the given cps path'
  43             def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
  44         then: 'the correct number of data nodes are retrieved'
  45             result.size() == expectedXPaths.size()
  46         and: 'xpaths of the retrieved data nodes are as expected'
  47             for (int i = 0; i < result.size(); i++) {
  48                 assert result[i].getXpath() == expectedXPaths[i]
  49             }
  50         where: 'the following data is used'
  51             scenario                                                 | cpsPath                                                || expectedXPaths
  52             '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']"]
  53             'descendant name match end of other node'                | '//book'                                               || ["/shops/shop[@id='1']/categories[@code='1']/book", "/shops/shop[@id='1']/categories[@code='2']/book"]
  54             'descendant with text condition on leaf'                 | '//book/title[text()="Chapters"]'                      || ["/shops/shop[@id='1']/categories[@code='2']/book"]
  55             'descendant with text condition case mismatch'           | '//book/title[text()="chapters"]'                      || []
  56             'descendant with text condition on int leaf'             | '//book/price[text()="5"]'                             || ["/shops/shop[@id='1']/categories[@code='1']/book"]
  57             'descendant with text condition on leaf-list'            | '//book/labels[text()="special offer"]'                || ["/shops/shop[@id='1']/categories[@code='1']/book"]
  58             'descendant with text condition partial match'           | '//book/labels[text()="special"]'                      || []
  59             'descendant with text condition (existing) empty string' | '//book/labels[text()=""]'                             || ["/shops/shop[@id='1']/categories[@code='1']/book"]
  60             'descendant with text condition on int leaf-list'        | '//book/editions[text()="2000"]'                       || ["/shops/shop[@id='1']/categories[@code='2']/book"]
  61             'descendant name match of leaf containing /'             | '//categories/type[text()="text/with/slash"]'          || ["/shops/shop[@id='1']/categories[@code='string/with/slash/']"]
  62             'descendant with text condition on leaf containing /'    | '//categories[@code=\'string/with/slash\']'            || ["/shops/shop[@id='1']/categories[@code='string/with/slash/']"]
  63             'descendant with text condition on leaf containing ['    | '//book/author[@Address="String[with]square[bracket]"]'|| []
  64     }
  65
  66     @Sql([CLEAR_DATA, SET_DATA])
  67     def 'Cps Path query using descendant anywhere with #scenario condition(s) for a container element.'() {
  68         when: 'a query is executed to get a data node by the given cps path'
  69             def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
  70         then: 'the correct number of data nodes are retrieved'
  71             result.size() == expectedXPaths.size()
  72         and: 'xpaths of the retrieved data nodes are as expected'
  73             for (int i = 0; i < result.size(); i++) {
  74                 assert result[i].getXpath() == expectedXPaths[i]
  75             }
  76         where: 'the following data is used'
  77             scenario                   | cpsPath                                               || expectedXPaths
  78             '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']"]
  79             'more than one leaf'       | '//author[@FirstName="Joe" and @Surname="Bloggs"]'    || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
  80             'leaves reversed in order' | '//author[@Surname="Bloggs" and @FirstName="Joe"]'    || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
  81             'leaf and text condition'  | '//author[@FirstName="Joe"]/Surname[text()="Bloggs"]' || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
  82     }
  83
  84     @Sql([CLEAR_DATA, SET_DATA])
  85     def 'Cps Path query using descendant anywhere with #scenario condition(s) for a list element.'() {
  86         when: 'a query is executed to get a data node by the given cps path'
  87             def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
  88         then: 'the correct number of data nodes are retrieved'
  89             result.size() == expectedXPaths.size()
  90         and: 'xpaths of the retrieved data nodes are as expected'
  91             for (int i = 0; i < result.size(); i++) {
  92                 assert result[i].getXpath() == expectedXPaths[i]
  93             }
  94         where: 'the following data is used'
  95             scenario                              | cpsPath                                        || expectedXPaths
  96             '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']"]
  97             'one non key leaf'                    | '//author[@title="Dune"]'                      || ["/shops/shop[@id='1']/categories[@code='1']/book/author[@FirstName='Joe' and @Surname='Bloggs']"]
  98             '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']"]
  99     }
 100
 101     @Sql([CLEAR_DATA, SET_DATA])
 102     def 'Cps Path query across anchors for leaf value(s) with : #scenario.'() {
 103         when: 'a query is executed to get a data node by the given cps path'
 104             def result = objectUnderTest.queryDataNodesAcrossAnchors(DATASPACE_NAME, cpsPath, includeDescendantsOption)
 105         then: 'the correct number of queried nodes are returned'
 106             assert result.size() == expectedNumberOfQueriedNodes
 107         and : 'correct anchors are queried'
 108             assert result.anchorName.containsAll(expectedAnchors)
 109         where: 'the following data is used'
 110             scenario                                    | cpsPath                                                      | includeDescendantsOption || expectedNumberOfQueriedNodes || expectedAnchors
 111             'String and no descendants'                 | '/shops/shop[@id=1]/categories[@code=1]/book[@title="Dune"]' | OMIT_DESCENDANTS         || 2                            || ['ANCHOR-004', 'ANCHOR-005']
 112             'Integer and descendants'                   | '/shops/shop[@id=1]/categories[@code=1]/book[@price=5]'      | INCLUDE_ALL_DESCENDANTS  || 3                            || ['ANCHOR-004', 'ANCHOR-005']
 113             'No condition no descendants'               | '/shops/shop[@id=1]/categories'                              | OMIT_DESCENDANTS         || 6                            || ['ANCHOR-004', 'ANCHOR-005']
 114             'multiple list-ancestors'                   | '//book/ancestor::categories'                                | INCLUDE_ALL_DESCENDANTS  || 4                            || ['ANCHOR-004', 'ANCHOR-005']
 115             'one ancestor with list value'              | '//book/ancestor::categories[@code=1]'                       | INCLUDE_ALL_DESCENDANTS  || 2                            || ['ANCHOR-004', 'ANCHOR-005']
 116             'list with index value in the xpath prefix' | '//categories[@code=1]/book/ancestor::shop[@id=1]'           | INCLUDE_ALL_DESCENDANTS  || 2                            || ['ANCHOR-004', 'ANCHOR-005']
 117             'ancestor with parent list'                 | '//book/ancestor::shop[@id=1]/categories[@code=2]'           | INCLUDE_ALL_DESCENDANTS  || 2                            || ['ANCHOR-004', 'ANCHOR-005']
 118             'ancestor with parent'                      | '//phonenumbers[@type="mob"]/ancestor::info/contact'         | INCLUDE_ALL_DESCENDANTS  || 5                            || ['ANCHOR-004', 'ANCHOR-005']
 119             'ancestor combined with text condition'     | '//book/title[text()="Dune"]/ancestor::shop'                 | INCLUDE_ALL_DESCENDANTS  || 10                           || ['ANCHOR-004', 'ANCHOR-005']
 120             'ancestor with parent that does not exist'  | '//book/ancestor::parentDoesNoExist/categories'              | INCLUDE_ALL_DESCENDANTS  || 0                            || []
 121             'ancestor does not exist'                   | '//book/ancestor::ancestorDoesNotExist'                      | INCLUDE_ALL_DESCENDANTS  || 0                            || []
 122     }
 123
 124     def 'Cps Path query across anchors with syntax error throws a CPS Path Exception.'() {
 125         when: 'trying to execute a query with a syntax (parsing) error'
 126             objectUnderTest.queryDataNodesAcrossAnchors(DATASPACE_NAME, 'cpsPath that cannot be parsed' , OMIT_DESCENDANTS)
 127         then: 'a cps path exception is thrown'
 128             thrown(CpsPathException)
 129     }
 130 }