Fix Absolute Path to list with Integer/String key

 - Introduced normalizedXpath to normalize the xpath and cpspath
 - Introduced normalizedAncestorpath to normalize the ancestor path in xpath and cpspath
 - Added new condition in the ANTLR Grammar to capture the invalid path in the xpath
 - Introduced PathParsingException to replace the IllegalStateException

Issue-ID: CPS-961
Change-Id: Ie10f5c6cfc466387e79eec184b933297d1d79587
Signed-off-by: Lathish <lathishbabu.ganesan@est.tech>

1 files changed, 57 insertions, 23 deletions

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
index bfec574eb..b837a64fe 100644
--- 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
@@ -1,6 +1,6 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2021 Nordix Foundation
+ *  Copyright (C) 2021-2022 Nordix Foundation
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -34,17 +34,17 @@ class CpsPathQuerySpec extends Specification {
             result.cpsPathPrefixType == ABSOLUTE
         and: 'the right query parameters are set'
             result.xpathPrefix == expectedXpathPrefix
-            result.hasLeafConditions() == true
-            result.leavesData.containsKey(expectedLeafName) == true
+            result.hasLeafConditions()
+            result.leavesData.containsKey(expectedLeafName)
             result.leavesData.get(expectedLeafName) == 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'
+            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.'() {
@@ -60,6 +60,38 @@ class CpsPathQuerySpec extends Specification {
             'parent & child' | '//parent/child' || 'parent/child'
     }
 
+    def 'Parse cps path to form the Normalized cps path containing #scenario.'() {
+        when: 'the given cps path is parsed'
+            def result = CpsPathUtil.getCpsPathQuery(cpsPath)
+        then: 'the query has the right normalized xpath type'
+            assert result.normalizedXpath == expectedNormalizedXPath
+        where: 'the following data is used'
+            scenario                                              | cpsPath                                         || expectedNormalizedXPath
+            'yang container'                                      | '/cps-path'                                     || '/cps-path'
+            'descendant anywhere'                                 | '//cps-path'                                    || '//cps-path'
+            'descendant with leaf condition'                      | '//cps-path[@key=1]'                            || "//cps-path[@key='1']"
+            'descendant with leaf value and ancestor'             | '//cps-path[@key=1]/ancestor:parent[@key=1]'    || "//cps-path[@key='1']/ancestor:parent[@key='1']"
+            'parent & child'                                      | '/parent/child'                                 || '/parent/child'
+            'parent leaf of type Integer & child'                 | '/parent/child[@code=1]/child2'                 || "/parent/child[@code='1']/child2"
+            'parent leaf with double quotes'                      | '/parent/child[@code="1"]/child2'               || "/parent/child[@code='1']/child2"
+            'parent leaf with double quotes inside single quotes' | '/parent/child[@code=\'"1"\']/child2'           || "/parent/child[@code='\"1\"']/child2"
+            'parent leaf with single quotes inside double quotes' | '/parent/child[@code="\'1\'"]/child2'           || "/parent/child[@code='\\\'1\\\'']/child2"
+            'leaf with single quotes inside double quotes'        | '/parent/child[@code="\'1\'"]'                  || "/parent/child[@code='\\\'1\\\'']"
+            'leaf with more than one attribute'                   | '/parent/child[@key1=1 and @key2="abc"]'        || "/parent/child[@key1='1' and @key2='abc']"
+            'parent & child with more than one attribute'         | '/parent/child[@key1=1 and @key2="abc"]/child2' || "/parent/child[@key1='1' and @key2='abc']/child2"
+    }
+
+    def 'Parse xpath to form the Normalized xpath containing #scenario.'() {
+        when: 'the given xpath is parsed'
+            def result = CpsPathUtil.getNormalizedXpath(xPath)
+        then: 'the query has the right normalized xpath type'
+            assert result == expectedNormalizedXPath
+        where: 'the following data is used'
+            scenario               | xPath      || expectedNormalizedXPath
+            'yang container'       | '/xpath'   || '/xpath'
+            'descendant anywhere'  | '//xpath'  || '//xpath'
+    }
+
     def 'Parse cps path that ends with a yang list containing #scenario.'() {
         when: 'the given cps path is parsed'
             def result = CpsPathQuery.createFrom(cpsPath)
@@ -99,7 +131,7 @@ class CpsPathQuerySpec extends Specification {
         when: 'the given cps path is parsed'
             CpsPathQuery.createFrom(cpsPath)
         then: 'a CpsPathException is thrown'
-            thrown(IllegalStateException)
+            thrown(PathParsingException)
         where: 'the following data is used'
             scenario                                                            | cpsPath
             'no / at the start'                                                 | 'invalid-cps-path/child'
@@ -110,7 +142,9 @@ class CpsPathQuerySpec extends Specification {
             '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::'
-//  DISCUSS WITH TEAM :           'unsupported postfix after value condition (JIRA CPS-450)'          | '/parent/child[@id=1]/somePostFix'
+            'invalid list element with missing ['                               | '/parent-206/child-206/grand-child-206@key="A"]'
+            'invalid list element with incorrect ]'                             | '/parent-206/child-206/grand-child-206]@key="A"]'
+            'invalid list element with incorrect ::'                            | '/parent-206/child-206/grand-child-206::@key"A"]'
     }
 
     def 'Parse cps path using ancestor by schema node identifier with a #scenario.'() {
@@ -125,11 +159,12 @@ class CpsPathQuerySpec extends Specification {
         and: 'there are no leaves conditions'
             result.hasLeafConditions() == false
         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'
+            scenario                                    | ancestorPath
+            'basic container'                           | 'someContainer'
+            'container with parent'                     | 'parent/child'
+            'ancestor that is a list'                   | "categories[@code='1']"
+            'ancestor that is a list with compound key' | "categories[@key1='1' and @key2='2']"
+            'parent that is a list'                     | "parent[@id='1']/child"
     }
 
     def 'Combinations #scenario.'() {
@@ -145,11 +180,10 @@ class CpsPathQuerySpec extends Specification {
             result.ancestorSchemaNodeIdentifier == 'someAncestor'
             result.descendantName == expectedDescendantName
         where:
-            scenario                     | cpsPath                               || expectedDescendantName | expectLeafConditions
-            'basic container'            | '//someContainer'                     || 'someContainer'        | false
-            'container with parent'      | '//parent/child'                      || 'parent/child'         | false
-            'container with list-parent' | '//parent[@id=1]/child'               || 'parent[@id=1]/child'  | false
-            'container with list-parent' | '//parent[@id=1]/child[@name="test"]' || 'parent[@id=1]/child'  | true
+            scenario                     | cpsPath                               || expectedDescendantName   | expectLeafConditions
+            'basic container'            | '//someContainer'                     || 'someContainer'          | false
+            'container with parent'      | '//parent/child'                      || 'parent/child'           | false
+            'container with list-parent' | '//parent[@id=1]/child'               || "parent[@id='1']/child"  | false
+            'container with list-parent' | '//parent[@id=1]/child[@name="test"]' || "parent[@id='1']/child"  | true
     }
-
 }