xml generation: check for conflicting elements in user-provided input

Conflicting elements are elements belonging to more than one domain. The
behaviour in such a case is unspecified.

In the context of XML generation from user input, this denotes a mistake from
the user. We now warn him and fail the generation. This commit includes
testing.

Signed-off-by: David Wagner <[email protected]>

Author: dawagner

test/xml-generator/PFConfig/structure.xml

@@ -10,6 +10,9 @@
         <InstanceDefinition>
 
             <Component Name="included" Type="Included"/>
+            <ParameterBlock Name="inline">
+                <BooleanParameter Name="bool"/>
+            </ParameterBlock>
 
             <ParameterBlock Name="block" ArrayLength="5">
                 <FixedPointParameter Name="q2.5" Size="8" Integral="2" Fractional="5"/>

test/xml-generator/test.py

@@ -90,27 +90,33 @@ def check(self, reference=None, expectedErrors=0):
 config_dir = os.path.join(basedir, "PFConfig")
 vector_dir = os.path.join(basedir, "testVector")
 class TestCase(unittest.TestCase):
-    nominal_reference = open(os.path.join(vector_dir, "reference.xml")).read().splitlines()
-    nominal_pfconfig = PfConfig(os.path.join(config_dir, "configuration.xml"),
-                                os.path.join(config_dir, "criteria.txt"),
-                                os.path.join(basedir, "../../schemas"))
-    nominal_vector = TestVector(os.path.join(vector_dir, "initialSettings.xml"),
-                                [os.path.join(vector_dir, "first.pfw"),
-                                 os.path.join(vector_dir, "second.pfw"),
-                                 os.path.join(vector_dir, "complex.pfw")],
-                                [os.path.join(vector_dir, "third.xml"),
-                                 os.path.join(vector_dir, "fourth.xml")])
+    def setUp(self):
+        self.nominal_reference = open(os.path.join(vector_dir, "reference.xml")).read().splitlines()
+        self.nominal_pfconfig = PfConfig(os.path.join(config_dir, "configuration.xml"),
+                                         os.path.join(config_dir, "criteria.txt"),
+                                         os.path.join(basedir, "../../schemas"))
+        self.nominal_vector = TestVector(os.path.join(vector_dir, "initialSettings.xml"),
+                                         [os.path.join(vector_dir, "first.pfw"),
+                                          os.path.join(vector_dir, "second.pfw"),
+                                          os.path.join(vector_dir, "complex.pfw")],
+                                         [os.path.join(vector_dir, "third.xml"),
+                                          os.path.join(vector_dir, "fourth.xml")])
 
     def test_nominal(self):
         tester = Tester(self.nominal_pfconfig, self.nominal_vector)
         tester.check(self.nominal_reference)
 
     def test_nonfatalError(self):
-        vector = copy.copy(self.nominal_vector)
-        vector.edds.append(os.path.join(vector_dir, "duplicate.pfw"))
+        self.nominal_vector.edds.append(os.path.join(vector_dir, "duplicate.pfw"))
 
-        tester = Tester(self.nominal_pfconfig, vector)
+        tester = Tester(self.nominal_pfconfig, self.nominal_vector)
         tester.check(self.nominal_reference, expectedErrors=1)
 
+    def test_conflicting(self):
+        vector = TestVector(edds=[os.path.join(vector_dir, "conflicting.pfw")])
+
+        tester = Tester(self.nominal_pfconfig, vector)
+        tester.check(expectedErrors=1)
+
 if __name__ == "__main__":
     unittest.main()

test/xml-generator/testVector/complex.pfw

@@ -33,8 +33,8 @@ domainGroup: Red sequenceAware
 						Colors Includes Blue
 
 						component: /Test/test
-							component: block/3
+							component: block/0
 								q2.5 = 1.18750
 								string = 12 ab @ 	 <![CDATA[ < > \n \0 ✔ "'\
-							component: included
+							component: inline
 								bool = 1

test/xml-generator/testVector/conflicting.pfw

@@ -0,0 +1,7 @@
+# Causes a conflicting-element error
+domain: First
+	conf: Default
+		/Test/test/included/bool = 1
+domain: Second
+	conf: Default
+		/Test/test/included/bool = 0

test/xml-generator/testVector/reference.xml

@@ -200,19 +200,19 @@
       </Configuration>
     </Configurations>
     <ConfigurableElements>
-      <ConfigurableElement Path="/Test/test/block/3/q2.5"/>
-      <ConfigurableElement Path="/Test/test/block/3/string"/>
-      <ConfigurableElement Path="/Test/test/included/bool"/>
+      <ConfigurableElement Path="/Test/test/block/0/q2.5"/>
+      <ConfigurableElement Path="/Test/test/block/0/string"/>
+      <ConfigurableElement Path="/Test/test/inline/bool"/>
     </ConfigurableElements>
     <Settings>
       <Configuration Name="green.confGroup..On.Blue.dot">
-        <ConfigurableElement Path="/Test/test/block/3/q2.5">
+        <ConfigurableElement Path="/Test/test/block/0/q2.5">
           <FixedPointParameter Name="q2.5">1.18750</FixedPointParameter>
         </ConfigurableElement>
-        <ConfigurableElement Path="/Test/test/block/3/string">
+        <ConfigurableElement Path="/Test/test/block/0/string">
           <StringParameter Name="string">12 ab @ 	 &lt;![CDATA[ &lt; &gt; \n \0 ✔ "'\</StringParameter>
         </ConfigurableElement>
-        <ConfigurableElement Path="/Test/test/included/bool">
+        <ConfigurableElement Path="/Test/test/inline/bool">
           <BooleanParameter Name="bool">1</BooleanParameter>
         </ConfigurableElement>
       </Configuration>

tools/xmlGenerator/domainGeneratorConnector.cpp

@@ -92,6 +92,14 @@ class XmlGenerator
      */
     size_t parse(std::istream &input);
 
+    /** Check for elements belonging to several domains
+     *
+     * Prints conflicting elements, if any, on the error output.
+     *
+     * @returns true if there are conflicting elements, false otherwise
+     */
+    bool conflictingElements();
+
     /** Prints the Parameter Framework's instance configuration
      *
      * @param[out] output The stream to which output the configuration
@@ -182,6 +190,22 @@ size_t XmlGenerator::parse(std::istream &input)
     return errorNb;
 }
 
+bool XmlGenerator::conflictingElements()
+{
+    string conflicting;
+    if (not mCommandHandler->process("listConflictingElements", {}, conflicting)) {
+        // Should not happen
+        throw Exception("Failed to list conflicting elements");
+    }
+
+    if (not conflicting.empty()) {
+        std::cerr << "There are conflicting elements:" << std::endl << conflicting;
+        return true;
+    }
+
+    return false;
+}
+
 void XmlGenerator::start()
 {
     string error;
@@ -257,7 +281,9 @@ int main(int argc, char *argv[])
     try {
         XmlGenerator xmlGenerator(toplevelConfig, validate, verbose, schemasDir);
         auto errorNb = xmlGenerator.parse(std::cin);
-        // TODO: add a check for conflicting elements
+        if (xmlGenerator.conflictingElements()) {
+            errorNb++;
+        }
         xmlGenerator.exportDomains(std::cout);
 
         return normalizeExitCode(errorNb);