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 <toine.siebelink@est.tech>

2 files changed, 9 insertions, 129 deletions

diff --git a/cps-ri/src/test/groovy/org/onap/cps/spi/impl/CpsDataPersistenceQueryDataNodeSpec.groovy b/cps-ri/src/test/groovy/org/onap/cps/spi/impl/CpsDataPersistenceQueryDataNodeSpec.groovy
index f64a22c89d..b2477d47ce 100644
--- a/cps-ri/src/test/groovy/org/onap/cps/spi/impl/CpsDataPersistenceQueryDataNodeSpec.groovy
+++ b/cps-ri/src/test/groovy/org/onap/cps/spi/impl/CpsDataPersistenceQueryDataNodeSpec.groovy
@@ -129,18 +129,6 @@ class CpsDataPersistenceQueryDataNodeSpec extends CpsPersistenceSpecBase {
     }
 
     @Sql([CLEAR_DATA, SET_DATA])
-    def 'Cps Path query error scenario using descendant anywhere ends with yang list containing %scenario '() {
-        when: 'a query is executed to get a data node by the given cps path'
-            objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, OMIT_DESCENDANTS)
-        then: 'exception is thrown'
-            thrown(CpsPathException)
-        where: 'the following data is used'
-            scenario                             | cpsPath
-            'one of the leaf without value'      | '//categories[@code=1 and @name=]'
-            'more than one leaf separated by or' | '//categories[@code=1 or @name="SciFi"]'
-    }
-
-    @Sql([CLEAR_DATA, SET_DATA])
     def 'Query for attribute by cps path of type ancestor with #scenario.'() {
         when: 'the given cps path is parsed'
             def result = objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, cpsPath, INCLUDE_ALL_DESCENDANTS)
@@ -157,7 +145,15 @@ class CpsDataPersistenceQueryDataNodeSpec extends CpsPersistenceSpecBase {
             'list with index value in the xpath prefix' | '//categories[@code=1]/book/ancestor::shop[@id=1]'   || ['/shops/shop[@id=1]']
             'ancestor with parent list'                 | '//book/ancestor::shop[@id=1]/categories[@code=2]'   || ['/shops/shop[@id=1]/categories[@code=2]']
             'ancestor with parent'                      | '//phonenumbers[@type="mob"]/ancestor::info/contact' || ['/shops/shop[@id=3]/info/contact']
-            'ancestor with parent that does not exist'  | '//book/ancestor::/parentDoesNoExist/categories'     || []
+            'ancestor with parent that does not exist'  | '//book/ancestor::parentDoesNoExist/categories'      || []
             'ancestor does not exist'                   | '//book/ancestor::ancestorDoesNotExist'              || []
     }
+
+    def 'Cps Path query with syntax error throws a CPS Path Exception.'() {
+        when: 'trying to execute a query with a syntax (parsing) error'
+            objectUnderTest.queryDataNodes(DATASPACE_NAME, ANCHOR_FOR_SHOP_EXAMPLE, 'cpsPath that cannot be parsed' , OMIT_DESCENDANTS)
+        then: 'exception is thrown'
+            thrown(CpsPathException)
+    }
+
 }
diff --git a/cps-ri/src/test/groovy/org/onap/cps/spi/query/CpsPathQuerySpec.groovy b/cps-ri/src/test/groovy/org/onap/cps/spi/query/CpsPathQuerySpec.groovy
deleted file mode 100644
index ee641d1029..0000000000
--- a/cps-ri/src/test/groovy/org/onap/cps/spi/query/CpsPathQuerySpec.groovy
+++ /dev/null
@@ -1,116 +0,0 @@
-/*
- * ============LICENSE_START=======================================================
- *  Copyright (C) 2021 Nordix Foundation
- *  Modifications Copyright (C) 2020-2021 Bell Canada.
- *  ================================================================================
- *  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.query
-
-import org.onap.cps.spi.exceptions.CpsPathException
-import spock.lang.Specification
-
-class CpsPathQuerySpec extends Specification {
-
-    def objectUnderTest = new CpsPathQuery()
-
-    def 'Parse cps path with valid cps path and a filter with #scenario.'() {
-        when: 'the given cps path is parsed'
-            def result = objectUnderTest.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 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
-    }
-
-    def 'Parse cps path of type ends with a #scenario.'() {
-        when: 'the given cps path is parsed'
-            def result = objectUnderTest.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 == expectedEndsWithValue
-        where: 'the following data is used'
-            scenario         | cpsPath          || expectedEndsWithValue
-            '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 = objectUnderTest.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 #scenario.'() {
-        when: 'the given cps path is parsed'
-            objectUnderTest.createFrom(cpsPath)
-        then: 'a CpsPathException is thrown'
-            thrown(CpsPathException)
-        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"]'
-            'too many containers'                                               | '/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/27/28/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44/45/46/47/48/49/50/51/52/53/54/55/56/57/58/59/60/61/62/63/64/65/66/67/68/69/70/71/72/73/74/75/76/77/78/79/80/81/82/83/84/85/86/87/88/89/90/91/92/93/94/95/96/97/98/99/100[@a=1]'
-            '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 'Convert cps leaf value to valid type with leaf of type #scenario.'() {
-        when: 'the given leaf value is converted'
-            def result = objectUnderTest.convertLeafValueToCorrectType(leafValueInputString, 'source xPath (for error message only)')
-        then: 'the leaf value returned is of the right type'
-            result == expectedLeafOutputValue
-        where: "the following data is used"
-            scenario                         | leafValueInputString         || expectedLeafOutputValue
-            'Integer'                        | "5"                          || 5
-            'String with single quotes'      | '\'value in single quotes\'' || 'value in single quotes'
-            'String with double quotes'      | '"value in double quotes"'   || 'value in double quotes'
-            'String containing single quote' | '"value with \'"'            || 'value with \''
-            'String containing double quote' | '\'value with "\''           || 'value with "'
-    }
-
-    def 'Parse cps path using ancestor by schema node identifier.'() {
-        when: 'the given cps path is parsed'
-            def result = objectUnderTest.createFrom('//someXpath/ancestor::someAncestor')
-        then: 'the query has the right type'
-            result.cpsPathQueryType == CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE
-        and: 'the correct ancestor schema node identifier is set'
-            result.ancestorSchemaNodeIdentifier == 'someAncestor'
-        and: 'the result has ancestor axis'
-            result.hasAncestorAxis()
-    }
-}