From c37678a3eb62685d32a1581729e2a4e26002bffc Mon Sep 17 00:00:00 2001 From: ToineSiebelink Date: Thu, 20 May 2021 16:44:21 +0100 Subject: Introducing Antlr4 for cpsPath parsing -created new module for cpPathParser -added antlr rule for cpsPathWithSingleLeafCondition -added antlr rule for cpsPathWithDescendant (and with leaf conditions) -added antlr rule for ancestor axis -added unit test (copied from existing CpsPathQuerySpec) -udpated cps-ri to use new cpPathQuery from parser module -'imported' lexer rules from publix xPath grammar -Re-used existing CpsPathException but conversion happens in cps-ri to prevent additional dependency in cps-path-parser module Issue-ID: CPS-376 Change-Id: I2c5df98969402cbf69f6573c52705879450ce606 Signed-off-by: ToineSiebelink --- .../cps/cpspath/parser/CpsPathQuerySpec.groovy | 124 +++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 cps-path-parser/src/test/groovy/org/onap/cps/cpspath/parser/CpsPathQuerySpec.groovy (limited to 'cps-path-parser/src/test/groovy') diff --git a/cps-path-parser/src/test/groovy/org/onap/cps/cpspath/parser/CpsPathQuerySpec.groovy b/cps-path-parser/src/test/groovy/org/onap/cps/cpspath/parser/CpsPathQuerySpec.groovy new file mode 100644 index 0000000000..0e7fc35cf4 --- /dev/null +++ b/cps-path-parser/src/test/groovy/org/onap/cps/cpspath/parser/CpsPathQuerySpec.groovy @@ -0,0 +1,124 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.cpspath.parser + +import spock.lang.Specification + +class CpsPathQuerySpec extends Specification { + + def 'Parse cps path with valid cps path and a filter with #scenario.'() { + when: 'the given cps path is parsed' + def result = CpsPathQuery.createFrom(cpsPath) + then: 'the query has the right type' + result.cpsPathQueryType == CpsPathQueryType.XPATH_LEAF_VALUE + and: 'the right query parameters are set' + result.xpathPrefix == expectedXpathPrefix + result.leafName == expectedLeafName + result.leafValue == expectedLeafValue + where: 'the following data is used' + scenario | cpsPath || expectedXpathPrefix | expectedLeafName | expectedLeafValue + 'leaf of type String' | '/parent/child[@common-leaf-name="common-leaf-value"]' || '/parent/child' | 'common-leaf-name' | 'common-leaf-value' + 'leaf of type String' | '/parent/child[@common-leaf-name=\'common-leaf-value\']' || '/parent/child' | 'common-leaf-name' | 'common-leaf-value' + 'leaf of type Integer' | '/parent/child[@common-leaf-name-int=5]' || '/parent/child' | 'common-leaf-name-int' | 5 + 'spaces around =' | '/parent/child[@common-leaf-name-int = 5]' || '/parent/child' | 'common-leaf-name-int' | 5 + 'key in top container' | '/parent[@common-leaf-name-int=5]' || '/parent' | 'common-leaf-name-int' | 5 + 'parent list' | '/shops/shop[@id=1]/categories[@id=1]/book[@title="Dune"]' || '/shops/shop[@id=1]/categories[@id=1]/book' | 'title' | 'Dune' + } + + def 'Parse cps path of type ends with a #scenario.'() { + when: 'the given cps path is parsed' + def result = CpsPathQuery.createFrom(cpsPath) + then: 'the query has the right type' + result.cpsPathQueryType == CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE + and: 'the right ends with parameters are set' + result.descendantName == expectedDescendantName + where: 'the following data is used' + scenario | cpsPath || expectedDescendantName + 'yang container' | '//cps-path' || 'cps-path' + 'parent & child' | '//parent/child' || 'parent/child' + } + + def 'Parse cps path that ends with a yang list containing #scenario.'() { + when: 'the given cps path is parsed' + def result = CpsPathQuery.createFrom(cpsPath) + then: 'the query has the right type' + result.cpsPathQueryType == CpsPathQueryType.XPATH_HAS_DESCENDANT_WITH_LEAF_VALUES + and: 'the right ends with parameters are set' + result.descendantName == "child" + result.leavesData.size() == expectedNumberOfLeaves + where: 'the following data is used' + scenario | cpsPath || expectedNumberOfLeaves + 'one attribute' | '//child[@common-leaf-name-int=5]' || 1 + 'more than one attribute' | '//child[@int-leaf=5 and @leaf-name="leaf value"]' || 2 + } + + def 'Parse cps path with error: #scenario.'() { + when: 'the given cps path is parsed' + CpsPathQuery.createFrom(cpsPath) + then: 'a CpsPathException is thrown' + thrown(IllegalStateException) + where: 'the following data is used' + scenario | cpsPath + 'no / at the start' | 'invalid-cps-path/child' + 'additional / after descendant option' | '///cps-path' + 'float value' | '/parent/child[@someFloat=5.0]' + 'unmatched quotes, double quote first ' | '/parent/child[@someString="value with unmatched quotes\']' + 'unmatched quotes, single quote first' | '/parent/child[@someString=\'value with unmatched quotes"]' + 'end with descendant and more than one attribute separated by "or"' | '//child[@int-leaf=5 or @leaf-name="leaf value"]' + 'missing attribute value' | '//child[@int-leaf=5 and @name]' + 'incomplete ancestor value' | '//books/ancestor::' + } + + def 'Parse cps path using ancestor by schema node identifier with a #scenario.'() { + when: 'the given cps path is parsed' + def result = CpsPathQuery.createFrom('//descendant/ancestor::' + ancestorPath) + then: 'the query has the right type' + result.cpsPathQueryType == CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE + and: 'the result has ancestor axis' + result.hasAncestorAxis() + and: 'the correct ancestor schema node identifier is set' + result.ancestorSchemaNodeIdentifier == ancestorPath + where: + scenario | ancestorPath + 'basic container' | 'someContainer' + 'container with parent' | 'parent/child' + 'ancestor that is a list' | 'categories[@code=1]' + 'parent that is a list' | 'parent[@id=1]/child' + } + + def 'Combinations #scenario.'() { + when: 'the given cps path is parsed' + def result = CpsPathQuery.createFrom(cpsPath + '/ancestor::someAncestor') + then: 'the query has the right type' + result.cpsPathQueryType == expectedCpsPathQueryType + and: 'the result has ancestor axis' + result.hasAncestorAxis() + and: 'the correct ancestor schema node identifier is set' + result.ancestorSchemaNodeIdentifier == 'someAncestor' + result.descendantName == expectedDescendantName + where: + scenario | cpsPath || expectedDescendantName | expectedCpsPathQueryType + 'basic container' | '//someContainer' || 'someContainer' | CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE + 'container with parent' | '//parent/child' || 'parent/child' | CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE + 'container with list-parent' | '//parent[@id=1]/child' || 'parent[@id=1]/child' | CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE + 'container with list-parent' | '//parent[@id=1]/child[@name="test"]' || 'parent[@id=1]/child' | CpsPathQueryType.XPATH_HAS_DESCENDANT_WITH_LEAF_VALUES + } + +} -- cgit 1.2.3-korg