fixup! fixup! Generate warning when node indexed like array

- fix text and steps for Expression - change error message for check - update tests - remove Subset text from error - add nested array test DAFFODIL-2773
olabusayoT · Oct 2, 2024 · 87635fe · 87635fe
1 parent df63ec7
commit 87635fe
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 39 deletions.
diff --git a/daffodil-core/src/main/scala/org/apache/daffodil/core/dpath/Expression.scala b/daffodil-core/src/main/scala/org/apache/daffodil/core/dpath/Expression.scala
@@ -773,13 +773,14 @@ case class RelativePathExpression(stepsRaw: List[StepExpression], isEvaluatedAbo
 sealed abstract class StepExpression(val step: String, val pred: Option[PredicateExpression])
   extends Expression {
 
+  final override def text: String = step + pred.map(_.text).getOrElse("")
+
   def checkIfNodeIndexedLikeArray(): Unit = {
-    if (pred.isDefined) {
-      SDE(
-        "Expression contains indexing on a node element: %s.",
-        this.wholeExpressionText
-      )
-    }
+    schemaDefinitionWhen(
+      pred.isDefined,
+      "Indexing is only allowed on arrays. Offending path step: '%s'.",
+      this.text
+    )
   }
 
   def relPathErr() = {
@@ -1028,7 +1029,6 @@ sealed abstract class SelfStepExpression(s: String, predArg: Option[PredicateExp
     checkIfNodeIndexedLikeArray()
     new CompiledDPath(SelfMove)
   }
-  override def text = "." + predArg.map(_.text).getOrElse("")
 
   protected def stepElementDefs: Seq[DPathElementCompileInfo] = {
     if (this.isFirstStep) {
@@ -1046,7 +1046,7 @@ sealed abstract class SelfStepExpression(s: String, predArg: Option[PredicateExp
   }
 }
 
-case class Self(predArg: Option[PredicateExpression]) extends SelfStepExpression(null, predArg)
+case class Self(predArg: Option[PredicateExpression]) extends SelfStepExpression(".", predArg)
 
 /**
  * Different from Self in that it verifies the qName (s) is
@@ -1065,16 +1065,14 @@ case class Self2(s: String, predArg: Option[PredicateExpression])
 sealed abstract class UpStepExpression(s: String, predArg: Option[PredicateExpression])
   extends StepExpression(s, predArg) {
 
-  override def text = ".." + predArg.map(_.text).getOrElse("")
-
   final override lazy val compiledDPath = {
     val areAllArrays = isLastStep && stepElements.forall {
       _.isArray
     } && targetType == NodeInfo.Array
     if (areAllArrays) {
       new CompiledDPath(UpMoveArray)
     } else {
-      checkIfNodeIndexedLikeArray
+      checkIfNodeIndexedLikeArray()
       new CompiledDPath(UpMove)
     }
   }
@@ -1102,7 +1100,7 @@ sealed abstract class UpStepExpression(s: String, predArg: Option[PredicateExpre
   override lazy val inherentType: NodeInfo.Kind = NodeInfo.Complex
 }
 
-case class Up(predArg: Option[PredicateExpression]) extends UpStepExpression(null, predArg)
+case class Up(predArg: Option[PredicateExpression]) extends UpStepExpression("..", predArg)
 
 /**
  * Different from Up in that it verifies the qName (s) is the
@@ -1111,8 +1109,6 @@ case class Up(predArg: Option[PredicateExpression]) extends UpStepExpression(nul
 case class Up2(s: String, predArg: Option[PredicateExpression])
   extends UpStepExpression(s, predArg) {
 
-  override def text = ".."
-
   override protected def stepElementDefs: Seq[DPathElementCompileInfo] = {
     val cis = super.stepElementDefs
     verifyQNames(cis)
@@ -1156,22 +1152,15 @@ case class NamedStep(s: String, predArg: Option[PredicateExpression])
         new DownArray(nqn)
       }
     } else {
-      // a[exp] is only supported on arrays , because Daffodil no longer treats
+      // a[exp] is only supported on arrays, because Daffodil no longer treats
       // optional elements as arrays
-      if (pred.isDefined)
-        subsetError(
-          "Indexing is only allowed on arrays. Offending path step: '%s%s'.",
-          step,
-          pred.get.text
-        )
+      checkIfNodeIndexedLikeArray()
       // the downward element step must be the same for all the possible elements, so
       // we can pick the first one arbitrarily.
       new DownElement(nqn)
     }
   }
 
-  override def text = step
-
   /*
    * The ERDs of the elements that correspond to this path step
    * (or SDE trying to find them.)

diff --git a/.../test/resources/org/apache/daffodil/section14/unordered_sequences/UnorderedSequences.tdml b/.../test/resources/org/apache/daffodil/section14/unordered_sequences/UnorderedSequences.tdml
@@ -627,7 +627,7 @@
     <tdml:document><![CDATA[a1,b2,cy99:x20:z10]]></tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Subset: Indexing is only allowed on arrays</tdml:error>
+      <tdml:error>Indexing is only allowed on arrays</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>
 

diff --git a/...l-test/src/test/resources/org/apache/daffodil/section23/dfdl_expressions/expressions.tdml b/...l-test/src/test/resources/org/apache/daffodil/section23/dfdl_expressions/expressions.tdml
@@ -4427,7 +4427,7 @@ blastoff
      Test Name: predicate_05
         Schema: predicates
           Root: e5
-       Purpose: This test demonstrates that subset indexing is only allowed on arrays.
+       Purpose: This test demonstrates that indexing is only allowed on arrays.
   -->
 
   <tdml:parserTestCase name="predicate_05" root="e5"
@@ -4436,15 +4436,15 @@ blastoff
     <tdml:document>2,one,two,three</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Subset: Indexing is only allowed on arrays.</tdml:error>
+      <tdml:error>Indexing is only allowed on arrays.</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>
 
   <!--
      Test Name: predicate_06
         Schema: predicates
           Root: e6
-       Purpose: This test demonstrates that subset indexing is not allowed on optionals
+       Purpose: This test demonstrates that indexing is not allowed on optionals
   -->
 
   <tdml:parserTestCase name="predicate_06" root="e6"
@@ -4453,7 +4453,7 @@ blastoff
     <tdml:document>2,one</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Subset: Indexing is only allowed on arrays.</tdml:error>
+      <tdml:error>Indexing is only allowed on arrays.</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>
 
@@ -7297,7 +7297,7 @@ blastoff
     <tdml:document>1,2,3</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Subset: Indexing is only allowed on arrays</tdml:error>
+      <tdml:error>Indexing is only allowed on arrays</tdml:error>
       <tdml:error>ex:a</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>

diff --git a/...-test/src/test/resources/org/apache/daffodil/section23/dfdl_expressions/expressions3.tdml b/...-test/src/test/resources/org/apache/daffodil/section23/dfdl_expressions/expressions3.tdml
@@ -536,16 +536,36 @@
         </xs:sequence>
       </xs:complexType>
     </xs:element>
+
+    <xs:element name="array1">
+      <xs:complexType>
+        <xs:sequence>
+          <xs:element name="array1_1" maxOccurs="unbounded">
+            <xs:complexType>
+              <xs:sequence dfdl:terminator="|">
+                <xs:element name="array1_1_1" type="xs:string" dfdl:lengthKind="explicit" dfdl:length="1" maxOccurs="unbounded">
+                  <xs:annotation>
+                    <xs:appinfo source="http://www.ogf.org/dfdl/">
+                      <dfdl:assert>{ fn:exists(..[1]) }</dfdl:assert>
+                    </xs:appinfo>
+                  </xs:annotation>
+                </xs:element>
+              </xs:sequence>
+            </xs:complexType>
+          </xs:element>
+        </xs:sequence>
+      </xs:complexType>
+    </xs:element>
 
  </tdml:defineSchema>
 
   <tdml:parserTestCase name="test_array_self_expr1" model="arraySchema" root="r" ignoreUnexpectedWarnings="false">
     <tdml:document>1|2|3</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Expression contains</tdml:error>
-      <tdml:error>indexing</tdml:error>
-      <tdml:error>node element</tdml:error>
+      <tdml:error>Indexing</tdml:error>
+      <tdml:error>only allowed</tdml:error>
+      <tdml:error>arrays</tdml:error>
       <tdml:error>.[1]</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>
@@ -554,9 +574,9 @@
     <tdml:document>1</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Expression contains</tdml:error>
-      <tdml:error>indexing</tdml:error>
-      <tdml:error>node element</tdml:error>
+      <tdml:error>Indexing</tdml:error>
+      <tdml:error>only allowed</tdml:error>
+      <tdml:error>arrays</tdml:error>
       <tdml:error>.[1]</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>
@@ -565,7 +585,6 @@
     <tdml:document>1</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Subset</tdml:error>
       <tdml:error>Indexing</tdml:error>
       <tdml:error>only allowed</tdml:error>
       <tdml:error>arrays</tdml:error>
@@ -577,9 +596,20 @@
     <tdml:document>1</tdml:document>
     <tdml:errors>
       <tdml:error>Schema Definition Error</tdml:error>
-      <tdml:error>Expression contains</tdml:error>
-      <tdml:error>indexing</tdml:error>
-      <tdml:error>node element</tdml:error>
+      <tdml:error>Indexing</tdml:error>
+      <tdml:error>only allowed</tdml:error>
+      <tdml:error>arrays</tdml:error>
+      <tdml:error>..[1]</tdml:error>
+    </tdml:errors>
+  </tdml:parserTestCase>
+
+  <tdml:parserTestCase name="test_array_path_expr3" model="arraySchema" root="array1" ignoreUnexpectedWarnings="false">
+    <tdml:document>123|456|789</tdml:document>
+    <tdml:errors>
+      <tdml:error>Schema Definition Error</tdml:error>
+      <tdml:error>Indexing</tdml:error>
+      <tdml:error>only allowed</tdml:error>
+      <tdml:error>arrays</tdml:error>
       <tdml:error>..[1]</tdml:error>
     </tdml:errors>
   </tdml:parserTestCase>

diff --git a/.../src/test/scala/org/apache/daffodil/section23/dfdl_expressions/TestDFDLExpressions3.scala b/.../src/test/scala/org/apache/daffodil/section23/dfdl_expressions/TestDFDLExpressions3.scala
@@ -50,6 +50,7 @@ class TestDFDLExpressions3 {
   @Test def test_array_self_expr2(): Unit = { runner.runOneTest("test_array_self_expr2") }
   @Test def test_array_path_expr1(): Unit = { runner.runOneTest("test_array_path_expr1") }
   @Test def test_array_path_expr2(): Unit = { runner.runOneTest("test_array_path_expr2") }
+  @Test def test_array_path_expr3(): Unit = { runner.runOneTest("test_array_path_expr3") }
 
   @Test def test_setVariable_neg_01(): Unit = { runner.runOneTest("setVariable_neg_01") }