integration-test/src/test/groovy/org/onap/cps/integration/functional/CpsQueryServiceIntegrationSpec.groovy

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2023 TechMahindra Ltd
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the 'License');
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an 'AS IS' BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.integration.functional
  23
  24 import org.onap.cps.api.CpsQueryService
  25 import org.onap.cps.integration.base.FunctionalSpecBase
  26 import org.onap.cps.spi.FetchDescendantsOption
  27 import org.onap.cps.spi.exceptions.CpsPathException
  28 import spock.lang.Ignore
  29
  30 import static org.onap.cps.spi.FetchDescendantsOption.DIRECT_CHILDREN_ONLY
  31 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
  32 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
  33
  34 class CpsQueryServiceIntegrationSpec extends FunctionalSpecBase {
  35
  36     CpsQueryService objectUnderTest
  37
  38     def setup() { objectUnderTest = cpsQueryService }
  39
  40     def 'Query bookstore using CPS path where #scenario.'() {
  41         when: 'query data nodes for bookstore container'
  42             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, INCLUDE_ALL_DESCENDANTS)
  43         then: 'the result contains expected number of nodes'
  44             assert result.size() == expectedResultSize
  45         and: 'the result contains the expected leaf values'
  46             result.leaves.forEach( dataNodeLeaves -> {
  47                 expectedLeaves.forEach( (expectedLeafKey,expectedLeafValue) -> {
  48                     assert dataNodeLeaves[expectedLeafKey] == expectedLeafValue
  49                 })
  50             })
  51         where:
  52             scenario                                      | cpsPath                                    || expectedResultSize | expectedLeaves
  53             'the AND condition is used'                   | '//books[@lang="English" and @price=15]'   || 2                  | [lang:"English", price:15]
  54             'the AND is used where result does not exist' | '//books[@lang="English" and @price=1000]' || 0                  | []
  55     }
  56
  57     def 'Cps Path query using combinations of OR operator #scenario.'() {
  58         when: 'a query is executed to get response by the given cps path'
  59             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpspath, OMIT_DESCENDANTS)
  60         then: 'the result contains expected number of nodes'
  61             assert result.size() == expectedResultSize
  62         and: 'the cps-path of queryDataNodes has the expectedLeaves'
  63             assert result.leaves.sort() == expectedLeaves.sort()
  64         where: 'the following data is used'
  65             scenario                                | cpspath                                                    || expectedResultSize | expectedLeaves
  66             'the "OR" condition'                    | '//books[@lang="English" or @price=15]'                    || 6                  | [[lang: "English", price: 15, title: "Annihilation", authors: ["Jeff VanderMeer"], editions: [2014]],
  67                                                                                                                                           [lang: "English", price: 15, title: "The Gruffalo", authors: ["Julia Donaldson"], editions: [1999]],
  68                                                                                                                                           [lang: "English", price: 14, title: "The Light Fantastic", authors: ["Terry Pratchett"], editions: [1986]],
  69                                                                                                                                           [lang: "English", price: 13, title: "Good Omens", authors: ["Terry Pratchett", "Neil Gaiman"], editions: [2006]],
  70                                                                                                                                           [lang: "English", price: 12, title: "The Colour of Magic", authors: ["Terry Pratchett"], editions: [1983]],
  71                                                                                                                                           [lang: "English", price: 10, title: "Matilda", authors: ["Roald Dahl"], editions: [1988, 2000]]]
  72             'the "OR" condition with non-json data' | '//books[@title="xyz" or @price=15]'                       || 2                  | [[lang: "English", price: 15, title: "Annihilation", authors: ["Jeff VanderMeer"], editions: [2014]],
  73                                                                                                                                           [lang: "English", price: 15, title: "The Gruffalo", authors: ["Julia Donaldson"], editions: [1999]]]
  74             'combination of multiple AND'           | '//books[@lang="English" and @price=15 and @edition=1983]' || 0                  | []
  75             'combination of multiple OR'            | '//books[ @title="Matilda" or @price=15 or @edition=1983]' || 3                  | [[lang: "English", price: 15, title: "Annihilation", authors: ["Jeff VanderMeer"], editions: [2014]],
  76                                                                                                                                           [lang: "English", price: 10, title: "Matilda", authors: ["Roald Dahl"], editions: [1988, 2000]],
  77                                                                                                                                           [lang: "English", price: 15, title: "The Gruffalo", authors: ["Julia Donaldson"], editions: [1999]]]
  78     }
  79
  80     def 'Cps Path query for leaf value(s) with #scenario.'() {
  81         when: 'a query is executed to get a data node by the given cps path'
  82             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, fetchDescendantsOption)
  83         then: 'the correct number of parent nodes are returned'
  84             assert result.size() == expectedNumberOfParentNodes
  85         and: 'the correct total number of data nodes are returned'
  86             assert countDataNodesInTree(result) == expectedTotalNumberOfNodes
  87         where: 'the following data is used'
  88             scenario                               | cpsPath                                                    | fetchDescendantsOption         || expectedNumberOfParentNodes | expectedTotalNumberOfNodes
  89             'string and no descendants'            | '/bookstore/categories[@code="1"]/books[@title="Matilda"]' | OMIT_DESCENDANTS               || 1                           | 1
  90             'integer and descendants'              | '/bookstore/categories[@code="1"]/books[@price=15]'        | INCLUDE_ALL_DESCENDANTS        || 1                           | 1
  91             'no condition and no descendants'      | '/bookstore/categories'                                    | OMIT_DESCENDANTS               || 4                           | 4
  92             'no condition and level 1 descendants' | '/bookstore'                                               | new FetchDescendantsOption(1)  || 1                           | 6
  93             'no condition and level 2 descendants' | '/bookstore'                                               | new FetchDescendantsOption(2)  || 1                           | 17
  94     }
  95
  96     def 'Query for attribute by cps path with cps paths that return no data because of #scenario.'() {
  97         when: 'a query is executed to get data nodes for the given cps path'
  98             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, OMIT_DESCENDANTS)
  99         then: 'no data is returned'
 100             assert result.isEmpty()
 101         where: 'following cps queries are performed'
 102             scenario                         | cpsPath
 103             'cps path is incomplete'         | '/bookstore[@title="Matilda"]'
 104             'leaf value does not exist'      | '/bookstore/categories[@code="1"]/books[@title=\'does not exist\']'
 105             'incomplete end of xpath prefix' | '/bookstore/categories/books[@price=15]'
 106     }
 107
 108     def 'Cps Path query using descendant anywhere and #type (further) descendants.'() {
 109         when: 'a query is executed to get a data node by the given cps path'
 110             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, '/bookstore/categories[@code="1"]', fetchDescendantsOption)
 111         then: 'the data node has the correct number of children'
 112             assert result[0].childDataNodes.xpath.sort() == expectedChildNodes.sort()
 113         where: 'the following data is used'
 114             type      | fetchDescendantsOption   || expectedChildNodes
 115             'omit'    | OMIT_DESCENDANTS         || []
 116             'include' | INCLUDE_ALL_DESCENDANTS  || ["/bookstore/categories[@code='1']/books[@title='Matilda']",
 117                                                      "/bookstore/categories[@code='1']/books[@title='The Gruffalo']"]
 118     }
 119
 120     def 'Cps Path query for all books.'() {
 121         when: 'a query is executed to get all books'
 122             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, '//books', OMIT_DESCENDANTS)
 123         then: 'the expected number of books are returned'
 124             assert result.size() == 9
 125     }
 126
 127     def 'Cps Path query using descendant anywhere with #scenario.'() {
 128         when: 'a query is executed to get a data node by the given cps path'
 129             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, OMIT_DESCENDANTS)
 130         then: 'xpaths of the retrieved data nodes are as expected'
 131             def bookTitles = result.collect { it.getLeaves().get('title') }
 132             assert bookTitles.sort() == expectedBookTitles.sort()
 133         where: 'the following data is used'
 134             scenario                                 | cpsPath                                     || expectedBookTitles
 135             'string leaf condition'                  | '//books[@title="Matilda"]'                 || ["Matilda"]
 136             'text condition on leaf'                 | '//books/title[text()="Matilda"]'           || ["Matilda"]
 137             'text condition case mismatch'           | '//books/title[text()="matilda"]'           || []
 138             'text condition on int leaf'             | '//books/price[text()="10"]'                || ["Matilda"]
 139             'text condition on leaf-list'            | '//books/authors[text()="Terry Pratchett"]' || ["Good Omens", "The Colour of Magic", "The Light Fantastic"]
 140             'text condition partial match'           | '//books/authors[text()="Terry"]'           || []
 141             'text condition (existing) empty string' | '//books/lang[text()=""]'                   || ["A Book with No Language"]
 142             'text condition on int leaf-list'        | '//books/editions[text()="2000"]'           || ["Matilda"]
 143             'match of leaf containing /'             | '//books[@lang="N/A"]'                      || ["Logarithm tables"]
 144             'text condition on leaf containing /'    | '//books/lang[text()="N/A"]'                || ["Logarithm tables"]
 145             'match of key containing /'              | '//books[@title="Debian GNU/Linux"]'        || ["Debian GNU/Linux"]
 146             'text condition on key containing /'     | '//books/title[text()="Debian GNU/Linux"]'  || ["Debian GNU/Linux"]
 147     }
 148
 149     def 'Query for attribute by cps path using contains condition #scenario.'() {
 150         when: 'a query is executed to get response by the given cps path'
 151             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, OMIT_DESCENDANTS)
 152         then: 'the cps-path of queryDataNodes has expected number of nodes'
 153             assert result.size() == expectedResultsize
 154         and: 'xpaths of the retrieved data nodes are as expected'
 155             def bookTitles = result.collect { it.getLeaves().get('title') }
 156             assert bookTitles.sort() == expectedBookTitles.sort()
 157         where: 'the following data is used'
 158             scenario                                 | cpsPath                           | expectedResultsize || expectedBookTitles
 159             'contains condition with leaf'           | '//books[contains(@title,"Mat")]' | 1                  || ["Matilda"]
 160             'contains condition with case-sensitive' | '//books[contains(@title,"Ti")]'  | 0                  || []
 161             'contains condition with Integer Value'  | '//books[contains(@price,"15")]'  | 2                  || ["Annihilation", "The Gruffalo"]
 162             'contains condition with No-value'       | '//books[contains(@title,"")]'    | 9                  || ["A Book with No Language", "Annihilation", "Debian GNU/Linux", "Good Omens", "Logarithm tables", "Matilda", "The Colour of Magic", "The Gruffalo", "The Light Fantastic"]
 163     }
 164
 165     def 'Cps Path query using descendant anywhere with #scenario condition for a container element.'() {
 166         when: 'a query is executed to get a data node by the given cps path'
 167             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, OMIT_DESCENDANTS)
 168         then: 'book titles from the retrieved data nodes are as expected'
 169             def bookTitles = result.collect { it.getLeaves().get('title') }
 170             assert bookTitles.sort() == expectedBookTitles.sort()
 171         where: 'the following data is used'
 172             scenario                                                   | cpsPath                                                    || expectedBookTitles
 173             'one leaf'                                                 | '//books[@price=14]'                                       || ['The Light Fantastic']
 174             'one text'                                                 | '//books/authors[text()="Terry Pratchett"]'                || ['Good Omens', 'The Colour of Magic', 'The Light Fantastic']
 175             'more than one leaf'                                       | '//books[@price=12 and @lang="English"]'                   || ['The Colour of Magic']
 176             'more than one leaf has "OR" condition'                    | '//books[@lang="English" or @price=15]'                    || ['Annihilation', 'Good Omens', 'Matilda', 'The Colour of Magic', 'The Gruffalo', 'The Light Fantastic']
 177             'more than one leaf has "OR" condition with non-json data' | '//books[@title="xyz" or @price=13]'                       || ['Good Omens']
 178             'more than one leaf has multiple AND'                      | '//books[@lang="English" and @price=13 and @edition=1983]' || []
 179             'more than one leaf has multiple OR'                       | '//books[ @title="Matilda" or @price=15 or @edition=2006]' || ['Annihilation', 'Matilda', 'The Gruffalo']
 180             'leaves reversed in order'                                 | '//books[@lang="English" and @price=12]'                   || ['The Colour of Magic']
 181             'leaf and text'                                            | '//books[@price=14]/authors[text()="Terry Pratchett"]'     || ['The Light Fantastic']
 182             'leaf and contains'                                        | '//books[contains(@price,"13")]'                           || ['Good Omens']
 183     }
 184
 185     def 'Cps Path query using descendant anywhere with #scenario condition(s) for a list element.'() {
 186         when: 'a query is executed to get a data node by the given cps path'
 187             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, INCLUDE_ALL_DESCENDANTS)
 188         then: 'xpaths of the retrieved data nodes are as expected'
 189             result.xpath.toList() == ["/bookstore/premises/addresses[@house-number='2' and @street='Main Street']"]
 190         where: 'the following data is used'
 191             scenario                              | cpsPath
 192             'full composite key'                  | '//addresses[@house-number=2 and @street="Main Street"]'
 193             'one partial key leaf'                | '//addresses[@house-number=2]'
 194             'one non key leaf'                    | '//addresses[@county="Kildare"]'
 195             'mix of partial key and non key leaf' | '//addresses[@street="Main Street" and @county="Kildare"]'
 196     }
 197
 198     def 'Query for attribute by cps path of type ancestor with #scenario.'() {
 199         when: 'the given cps path is parsed'
 200             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, cpsPath, OMIT_DESCENDANTS)
 201         then: 'the xpaths of the retrieved data nodes are as expected'
 202             assert result.xpath.sort() == expectedXPaths.sort()
 203         where: 'the following data is used'
 204             scenario                                    | cpsPath                                               || expectedXPaths
 205             'multiple list-ancestors'                   | '//books/ancestor::categories'                        || ["/bookstore/categories[@code='1']", "/bookstore/categories[@code='2']", "/bookstore/categories[@code='3']", "/bookstore/categories[@code='4']"]
 206             'one ancestor with list value'              | '//books/ancestor::categories[@code="1"]'             || ["/bookstore/categories[@code='1']"]
 207             'top ancestor'                              | '//books/ancestor::bookstore'                         || ["/bookstore"]
 208             'list with index value in the xpath prefix' | '//categories[@code="1"]/books/ancestor::bookstore'   || ["/bookstore"]
 209             'ancestor with parent list'                 | '//books/ancestor::bookstore/categories'              || ["/bookstore/categories[@code='1']", "/bookstore/categories[@code='2']", "/bookstore/categories[@code='3']", "/bookstore/categories[@code='4']"]
 210             'ancestor with parent'                      | '//books/ancestor::bookstore/categories[@code="2"]'   || ["/bookstore/categories[@code='2']"]
 211             'ancestor combined with text condition'     | '//books/title[text()="Matilda"]/ancestor::bookstore' || ["/bookstore"]
 212             'ancestor with parent that does not exist'  | '//books/ancestor::parentDoesNoExist/categories'      || []
 213             'ancestor does not exist'                   | '//books/ancestor::ancestorDoesNotExist'              || []
 214             'ancestor combined with contains condition' | '//books[contains(@title,"Mat")]/ancestor::bookstore' || ["/bookstore"]
 215     }
 216
 217     def 'Query for attribute by cps path of type ancestor with #scenario descendants.'() {
 218         when: 'the given cps path is parsed'
 219             def result = objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, '//books/ancestor::bookstore', fetchDescendantsOption)
 220         then: 'the xpaths of the retrieved data nodes are as expected'
 221             assert countDataNodesInTree(result) == expectedNumberOfNodes
 222         where: 'the following data is used'
 223             scenario | fetchDescendantsOption  || expectedNumberOfNodes
 224             'no'     | OMIT_DESCENDANTS        || 1
 225             'direct' | DIRECT_CHILDREN_ONLY    || 6
 226             'all'    | INCLUDE_ALL_DESCENDANTS || 17
 227     }
 228
 229     def 'Cps Path query with syntax error throws a CPS Path Exception.'() {
 230         when: 'trying to execute a query with a syntax (parsing) error'
 231             objectUnderTest.queryDataNodes(FUNCTIONAL_TEST_DATASPACE_1, BOOKSTORE_ANCHOR_1, 'cpsPath that cannot be parsed' , OMIT_DESCENDANTS)
 232         then: 'a cps path exception is thrown'
 233             thrown(CpsPathException)
 234     }
 235
 236     @Ignore
 237     def 'Cps Path query across anchors with #scenario.'() {
 238         when: 'a query is executed to get a data nodes across anchors by the given CpsPath'
 239             def result = objectUnderTest.queryDataNodesAcrossAnchors(FUNCTIONAL_TEST_DATASPACE_1, cpsPath, OMIT_DESCENDANTS)
 240         then: 'the correct dataspace is queried'
 241             assert result.dataspace.toSet() == [FUNCTIONAL_TEST_DATASPACE_1].toSet()
 242         and: 'correct anchors are queried'
 243             assert result.anchorName.toSet() == [BOOKSTORE_ANCHOR_1, BOOKSTORE_ANCHOR_2].toSet()
 244         and: 'the correct number of nodes is returned'
 245             assert result.size() == expectedXpathsPerAnchor.size() * NUMBER_OF_ANCHORS_PER_DATASPACE_WITH_BOOKSTORE_DATA
 246         and: 'the queried nodes have expected xpaths'
 247             assert result.xpath.toSet() == expectedXpathsPerAnchor.toSet()
 248         where: 'the following data is used'
 249             scenario                                    | cpsPath                                               || expectedXpathsPerAnchor
 250             'container node'                            | '/bookstore'                                          || ["/bookstore"]
 251             'list node'                                 | '/bookstore/categories'                               || ["/bookstore/categories[@code='1']", "/bookstore/categories[@code='2']", "/bookstore/categories[@code='3']", "/bookstore/categories[@code='4']"]
 252             'string leaf-condition'                     | '/bookstore[@bookstore-name="Easons"]'                || ["/bookstore"]
 253             'integer leaf-condition'                    | '/bookstore/categories[@code="1"]/books[@price=15]'   || ["/bookstore/categories[@code='1']/books[@title='The Gruffalo']"]
 254             'multiple list-ancestors'                   | '//books/ancestor::categories'                        || ["/bookstore/categories[@code='1']", "/bookstore/categories[@code='2']", "/bookstore/categories[@code='3']", "/bookstore/categories[@code='4']"]
 255             'one ancestor with list value'              | '//books/ancestor::categories[@code="1"]'             || ["/bookstore/categories[@code='1']"]
 256             'list with index value in the xpath prefix' | '//categories[@code="1"]/books/ancestor::bookstore'   || ["/bookstore"]
 257             'ancestor with parent list'                 | '//books/ancestor::bookstore/categories'              || ["/bookstore/categories[@code='1']", "/bookstore/categories[@code='2']", "/bookstore/categories[@code='3']", "/bookstore/categories[@code='4']"]
 258             'ancestor with parent list element'         | '//books/ancestor::bookstore/categories[@code="2"]'   || ["/bookstore/categories[@code='2']"]
 259             'ancestor combined with text condition'     | '//books/title[text()="Matilda"]/ancestor::bookstore' || ["/bookstore"]
 260     }
 261
 262     @Ignore
 263     def 'Cps Path query across anchors with #scenario descendants.'() {
 264         when: 'a query is executed to get a data node by the given cps path'
 265             def result = objectUnderTest.queryDataNodesAcrossAnchors(FUNCTIONAL_TEST_DATASPACE_1, '/bookstore', fetchDescendantsOption)
 266         then: 'the correct dataspace was queried'
 267             assert result.dataspace.toSet() == [FUNCTIONAL_TEST_DATASPACE_1].toSet()
 268         and: 'correct number of datanodes are returned'
 269             assert countDataNodesInTree(result) == expectedNumberOfNodesPerAnchor * NUMBER_OF_ANCHORS_PER_DATASPACE_WITH_BOOKSTORE_DATA
 270         where: 'the following data is used'
 271             scenario | fetchDescendantsOption  || expectedNumberOfNodesPerAnchor
 272             'no'     | OMIT_DESCENDANTS        || 1
 273             'direct' | DIRECT_CHILDREN_ONLY    || 6
 274             'all'    | INCLUDE_ALL_DESCENDANTS || 17
 275     }
 276
 277     @Ignore
 278     def 'Cps Path query across anchors with ancestors and #scenario descendants.'() {
 279         when: 'a query is executed to get a data node by the given cps path'
 280             def result = objectUnderTest.queryDataNodesAcrossAnchors(FUNCTIONAL_TEST_DATASPACE_1, '//books/ancestor::bookstore', fetchDescendantsOption)
 281         then: 'the correct dataspace was queried'
 282             assert result.dataspace.toSet() == [FUNCTIONAL_TEST_DATASPACE_1].toSet()
 283         and: 'correct number of datanodes are returned'
 284             assert countDataNodesInTree(result) == expectedNumberOfNodesPerAnchor * NUMBER_OF_ANCHORS_PER_DATASPACE_WITH_BOOKSTORE_DATA
 285         where: 'the following data is used'
 286             scenario | fetchDescendantsOption  || expectedNumberOfNodesPerAnchor
 287             'no'     | OMIT_DESCENDANTS        || 1
 288             'direct' | DIRECT_CHILDREN_ONLY    || 6
 289             'all'    | INCLUDE_ALL_DESCENDANTS || 17
 290     }
 291
 292     def 'Cps Path query across anchors with syntax error throws a CPS Path Exception.'() {
 293         when: 'trying to execute a query with a syntax (parsing) error'
 294             objectUnderTest.queryDataNodesAcrossAnchors(FUNCTIONAL_TEST_DATASPACE_1, 'cpsPath that cannot be parsed' , OMIT_DESCENDANTS)
 295         then: 'a cps path exception is thrown'
 296             thrown(CpsPathException)
 297     }
 298
 299 }