Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Warn about Multiple Child Elements with Same Name #1321

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Warn about Multiple Child Elements with Same Name #1321

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97e98bc
Warn about Multiple Child Elements with Same Name
olabusayoT Sep 26, 2024
d6153d1
fixup! Warn about Multiple Child Elements with Same Name
olabusayoT Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions daffodil-core/src/main/scala/org/apache/daffodil/core/dsom/SequenceGroup.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ abstract class SequenceGroupTermBase(xml: Node, lexicalParent: SchemaComponent,

requiredEvaluationsIfActivated(checkIfValidUnorderedSequence)
requiredEvaluationsIfActivated(checkIfNonEmptyAndDiscrimsOrAsserts)
requiredEvaluationsIfActivated(checkIfMultipleChildrenWithSameName)

protected def apparentXMLChildren: Seq[Node]

Expand Down Expand Up @@ -181,7 +182,7 @@ abstract class SequenceGroupTermBase(xml: Node, lexicalParent: SchemaComponent,
if (!isOrdered) {
checkMembersAreAllElementOrElementRef
checkMembersHaveValidOccursCountKind
checkMembersHaveUniqueNamesInNamespaces
checkUnorderedSequenceMembersHaveUniqueNamesInNamespaces
}
}

Expand Down Expand Up @@ -215,20 +216,37 @@ abstract class SequenceGroupTermBase(xml: Node, lexicalParent: SchemaComponent,
}
}

private lazy val checkMembersHaveUniqueNamesInNamespaces: Unit = {
val childrenGroupedByQName = groupMembers.groupBy { gm =>
// previous checks should ensure that all group members are either local
// elements or element references
Assert.invariant(gm.isInstanceOf[ElementBase])
gm.asInstanceOf[ElementBase].namedQName
}
childrenGroupedByQName.foreach { case (qname, children) =>
if (children.length > 1) {
private lazy val checkUnorderedSequenceMembersHaveUniqueNamesInNamespaces: Unit = {
// previous checks should ensure that all group members for unordered sequences are either local
// elements or element references
groupChildrenBy(_.namedQName)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forget why we added the groupChildrenBy function, but it only replaces elementChildren.groupBy. The former isn't significantly shorter and I don't think it is any more clear. Is it worth removing groupChildrenBy?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It used to do alot more than elementChildren.groupBy, but I moved out the filter stuff, since that wasn't related to grouping

.filter(_._2.length > 1)
.values
.foreach { children =>
children.head.SDE(
"Two or more members of an unordered sequence have the same name and the same namespace"
)
}
}
}

private def groupChildrenBy[T](func: (ElementBase) => T): Map[T, Seq[ElementBase]] = {
val childrenGrouped = elementChildren.groupBy { gm => func(gm) }
childrenGrouped
}

private lazy val checkIfMultipleChildrenWithSameName: Unit = {
groupChildrenBy(_.name)
.filter(_._2.length > 1)
.values
.foreach { children =>
children.head.SDW(
WarnID.MultipleChildElementsWithSameName,
"Two or more members of the sequence have the same name. " +
"Since not all infosets support namespaces or siblings with the same name, " +
"this could cause issues. QNames are: %s",
children.map(c => c.namedQName).mkString(", ")
)
}
}

final lazy val isOrdered: Boolean = this.sequenceKind match {
Expand Down
1 change: 1 addition & 0 deletions daffodil-propgen/src/main/resources/org/apache/daffodil/xsd/dafext.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,7 @@
<xs:enumeration value="invalidAnnotationPoint" />
<xs:enumeration value="layerCompileWarning" />
<xs:enumeration value="multipleChoiceBranches" />
<xs:enumeration value="multipleChildElementsWithSameName" />
<xs:enumeration value="namespaceDifferencesOnly" />
<xs:enumeration value="noEmptyDefault" />
<xs:enumeration value="nonExpressionPropertyValueLooksLikeExpression" />
Expand Down
111 changes: 111 additions & 0 deletions ...-test/src/test/resources/org/apache/daffodil/section14/sequence_groups/SequenceGroup.tdml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1535,4 +1535,115 @@
</tdml:infoset>
</tdml:parserTestCase>

<tdml:defineSchema name="multipleElemSameName" xmlns:u="USMTF" elementFormDefault="unqualified">

<xs:include schemaLocation="/org/apache/daffodil/xsd/DFDLGeneralFormat.dfdl.xsd"/>
<xs:import namespace="USMTF" schemaLocation="/org/apache/daffodil/section14/sequence_groups/sequenceWithComplexType.dfdl.xsd"/>
<dfdl:format ref="ex:GeneralFormat" lengthKind="explicit" occursCountKind="implicit"/>

<xs:element name="multipleElemSameName" dfdl:lengthKind="implicit">
<xs:complexType>
<xs:sequence>
<xs:element name="A" type="xs:string" dfdl:length="1" />
<xs:element name="AmbigElt" type="xs:string" dfdl:length="1" />
<xs:element name="B" type="xs:string" dfdl:length="1" />
<xs:element name="AmbigElt" type="xs:string" dfdl:length="1" />
</xs:sequence>
</xs:complexType>
</xs:element>

<xs:element name="multipleElemSameNameDifferentNamespaces" dfdl:lengthKind="implicit">
<xs:complexType>
<xs:sequence>
<xs:element name="A" type="xs:string" dfdl:length="1" />
<xs:element name="e1" dfdl:terminator="/" dfdl:lengthKind="delimited">
<xs:complexType>
<xs:sequence dfdl:initiator="-" dfdl:separator=";" dfdl:separatorPosition="prefix">
<xs:element name="e2" type="u:ct1" minOccurs="1" maxOccurs="unbounded" dfdl:lengthKind="delimited" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="B" type="xs:string" dfdl:length="1" />
<xs:element ref="u:e1" dfdl:lengthKind="delimited"/>
</xs:sequence>
</xs:complexType>
</xs:element>

</tdml:defineSchema>


<tdml:parserTestCase name="multipleElemSameName"
root="multipleElemSameName"
model="multipleElemSameName"
ignoreUnexpectedWarnings="false"
description="TDML runner verifies warnings and infoset.">

<tdml:document><![CDATA[1234]]></tdml:document>

<tdml:infoset>
<tdml:dfdlInfoset>
<multipleElemSameName>
<A>1</A>
<AmbigElt>2</AmbigElt>
<B>3</B>
<AmbigElt>4</AmbigElt>
</multipleElemSameName>
</tdml:dfdlInfoset>
</tdml:infoset>

<tdml:warnings>
<tdml:warning>Schema Definition Warning</tdml:warning>
<tdml:warning>same name</tdml:warning>
<tdml:warning>AmbigElt</tdml:warning>
</tdml:warnings>
</tdml:parserTestCase>

<tdml:parserTestCase name="multipleElemSameNameDifferentNamespaces"
root="multipleElemSameNameDifferentNamespaces"
model="multipleElemSameName"
ignoreUnexpectedWarnings="false"
description="TDML runner verifies warnings and infoset.">

<tdml:document><![CDATA[1-;2;3;4/5-;6;7;8/]]></tdml:document>

<tdml:infoset>
<tdml:dfdlInfoset>
<multipleElemSameNameDifferentNamespaces>
<A>1</A>
<e1>
<e2>
<String1>2</String1>
</e2>
<e2>
<String1>3</String1>
</e2>
<e2>
<String1>4</String1>
</e2>
</e1>
<B>5</B>
<e1>
<e2>
<String1>6</String1>
</e2>
<e2>
<String1>7</String1>
</e2>
<e2>
<String1>8</String1>
</e2>
</e1>
</multipleElemSameNameDifferentNamespaces>
</tdml:dfdlInfoset>
</tdml:infoset>

<tdml:warnings>
<tdml:warning>Schema Definition Warning</tdml:warning>
<tdml:warning>same name</tdml:warning>
<tdml:warning>{}e1</tdml:warning>
<tdml:warning>u:e1</tdml:warning>
</tdml:warnings>
</tdml:parserTestCase>


</tdml:testSuite>
66 changes: 66 additions & 0 deletions daffodil-test/src/test/resources/org/apache/daffodil/section15/choice_groups/choice2736.tdml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->

<tdml:testSuite
suiteName="choice1765"
description="Tests for choice construct. Bug DFDL-1765."
xmlns:tdml="http://www.ibm.com/xmlns/dfdl/testData"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dfdl="http://www.ogf.org/dfdl/dfdl-1.0/"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:ex="http://example.com"
xmlns:fn="http://www.w3.org/2005/xpath-functions">

<tdml:defineSchema name="ambiguousChoice" elementFormDefault="unqualified">

<xs:include schemaLocation="/org/apache/daffodil/xsd/DFDLGeneralFormat.dfdl.xsd"/>
<dfdl:format ref="ex:GeneralFormat" lengthKind="explicit" occursCountKind="implicit"/>


<xs:element name="ambiguousChoice" dfdl:lengthKind="implicit">
<xs:complexType>
<xs:sequence>
<xs:element name="key" type="xs:string" dfdl:length="1"/>
<xs:choice dfdl:choiceDispatchKey="{key}">
<xs:element name="A" type="xs:string" dfdl:length="1" dfdl:choiceBranchKey="A" />
<xs:element name="AmbigElt" type="xs:string" dfdl:length="1" dfdl:choiceBranchKey="B" />
<xs:element name="B" type="xs:string" dfdl:length="1" dfdl:choiceBranchKey="C" />
<xs:element name="AmbigElt" type="xs:string" dfdl:length="1" dfdl:choiceBranchKey="D" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>


</tdml:defineSchema>

<tdml:parserTestCase name="choiceAmbiguousUPA" root="ambiguousChoice" model="ambiguousChoice"
description="verify UPA error in choice"
ignoreUnexpectedWarnings="false">

<tdml:document><![CDATA[B2]]></tdml:document>

<tdml:errors>
<tdml:error>Schema Definition Error</tdml:error>
<tdml:error>AmbigElt</tdml:error>
<tdml:error>Unique Particle Attribution</tdml:error>
</tdml:errors>
</tdml:parserTestCase>


</tdml:testSuite>
8 changes: 8 additions & 0 deletions ...est/src/test/scala/org/apache/daffodil/section14/sequence_groups/TestSequenceGroups.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,12 @@ class TestSequenceGroups {
// @Test def test_delimiterScanning_03() { runner_01.runOneTest("delimiterScanning_03") }

@Test def test_hiddenGroupIVC(): Unit = { runner_02.runOneTest("hiddenGroupIVC") }

// DAFFODIL-2736
@Test def test_multipleElemSameName() = {
runner_02.runOneTest("multipleElemSameName")
}
@Test def test_multipleElemSameNameDifferentNamespaces() = {
runner_02.runOneTest("multipleElemSameNameDifferentNamespaces")
}
}
6 changes: 6 additions & 0 deletions daffodil-test/src/test/scala/org/apache/daffodil/section15/choice_groups/TestChoice2.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ object TestChoice2 {
val runner = Runner(testDir, "choice1765.tdml")
val runner1773 = Runner(testDir, "choice1773.tdml")
val runner2162 = Runner(testDir, "choice2162.tdml")
val runner2736 = Runner(testDir, "choice2736.tdml")

@AfterClass def shutDown(): Unit = {
runner.reset
runner1773.reset
runner2162.reset
runner2736.reset
}
}

Expand Down Expand Up @@ -63,4 +65,8 @@ class TestChoice2 {
runner2162.runOneTest("choiceArrayDirectDispatch1")
}

// DAFFODIL-2736
@Test def test_choiceAmbiguousUPA() = {
runner2736.runOneTest("choiceAmbiguousUPA")
}
}
Loading