Merge pull request #331 from krocard/add-complex-edd-test

 - Advance testing of XML generation from EDD.
 - XML generation from EDD test was not detecting failures.
 - XML generation from EDD had a bug that made impossible to use the sequence aware domain feature.
 - Fix various error message typos.

Author: krocard

parameter/ParameterMgr.cpp

@@ -2401,7 +2401,7 @@ bool CParameterMgr::addConfigurableElementToDomain(const string &strDomain,
                                                    const string &strConfigurableElementPath,
                                                    string &strError)
 {
-    LOG_CONTEXT("Adding configurable element '" + strConfigurableElementPath + "to domain '" +
+    LOG_CONTEXT("Adding configurable element '" + strConfigurableElementPath + "' to domain '" +
                 strDomain + "'");
     // Check tuning mode
     if (!checkTuningModeOn(strError)) {
@@ -2649,7 +2649,7 @@ bool CParameterMgr::exportDomainsXml(string &xmlDest, bool withSettings, bool to
                                      string &errorMsg) const
 {
     LOG_CONTEXT("Exporting domains to " +
-                (toFile ? ('"' + xmlDest + '"') : " a user-provided buffer"));
+                (toFile ? ('"' + xmlDest + '"') : "a user-provided buffer"));
 
     const CConfigurableDomains *configurableDomains = getConstConfigurableDomains();
 
@@ -2660,7 +2660,7 @@ bool CParameterMgr::exportSingleDomainXml(string &xmlDest, const string &domainN
                                           bool withSettings, bool toFile, string &errorMsg) const
 {
     LOG_CONTEXT("Exporting single domain '" + domainName + "' to " +
-                (toFile ? ('"' + xmlDest + '"') : " a user-provided buffer"));
+                (toFile ? ('"' + xmlDest + '"') : "a user-provided buffer"));
 
     // Element to be serialized
     const CConfigurableDomain *requestedDomain =

test/xml-generator/PFConfig/structure.xml

@@ -14,7 +14,7 @@
             <ParameterBlock Name="block" ArrayLength="5">
                 <FixedPointParameter Name="q2.5" Size="8" Integral="2" Fractional="5"/>
                 <IntegerParameter Name="uint8" Signed="false" Size="8"/>
-                <StringParameter Name="string" MaxLength="20"/>
+                <StringParameter Name="string" MaxLength="50"/>
             </ParameterBlock>
 
         </InstanceDefinition>

test/xml-generator/test.py

@@ -73,20 +73,16 @@ def check(self, reference=None, expectedErrors=0):
 
         if not reference:
             # The caller only wants to check the number of errors
-            return True
+            return
 
         # The generation has succeeded as expected - let's compare with the reference.
-        unified = difflib.unified_diff(reference,
-                                       actual,
-                                       fromfile="reference.xml",
-                                       tofile="-",
-                                       lineterm="")
-        diffs = list(unified)
-        if diffs:
-            for d in diffs:
-                print(d)
-            return AssertionError("The result and the reference don't match.")
-        return True
+        if reference != actual:
+            unified = difflib.unified_diff(reference,
+                                           actual,
+                                           fromfile="reference.xml",
+                                           tofile="-",
+                                           lineterm="")
+            raise AssertionError("The result and the reference don't match:" + "\n".join(unified))
 
 
 basedir = os.path.dirname(sys.argv[0])
@@ -100,20 +96,21 @@ class TestCase(unittest.TestCase):
                                 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, "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)
-        self.assertTrue(tester.check(self.nominal_reference))
+        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"))
 
         tester = Tester(self.nominal_pfconfig, vector)
-        self.assertTrue(tester.check(self.nominal_reference, expectedErrors=1))
+        tester.check(self.nominal_reference, expectedErrors=1)
 
 if __name__ == "__main__":
     unittest.main()

test/xml-generator/testVector/complex.pfw

@@ -0,0 +1,40 @@
+domain: sequenceAware sequenceAware
+
+domainGroup: Red sequenceAware
+	Colors Includes Red
+	confType: On
+		ANY
+			Switch Is On
+			# Expecting a empty tree of all (except for the last `Switch Is On` rule)
+			ALL
+				ALL
+					ALL
+				ALL
+					ANY
+						Switch Is On
+	confType: On
+		Switch Is On
+
+	domain: Black
+		Colors Includes Green
+		confGroup: green.confGroup
+			# Should add a `.` in the conf name
+			# Ie an empty confGroup in a legal name
+			confGroup:
+
+				confType: On
+					Switch Is On
+
+				# confGroups with the same name should not overwrite one another
+				confGroup: On
+					Colors Includes Green
+
+					conf: Blue.dot
+						Colors Includes Blue
+
+						component: /Test/test
+							component: block/3
+								q2.5 = 1.18750
+								string = 12 ab @ 	 <![CDATA[ < > \n \0 ✔ "'\
+							component: included
+								bool = 1

test/xml-generator/testVector/reference.xml

@@ -168,4 +168,54 @@
       </Configuration>
     </Settings>
   </ConfigurableDomain>
+  <ConfigurableDomain Name="sequenceAware" SequenceAware="true">
+    <Configurations/>
+    <ConfigurableElements/>
+    <Settings/>
+  </ConfigurableDomain>
+  <ConfigurableDomain Name="Red.Black" SequenceAware="true">
+    <Configurations>
+      <Configuration Name="green.confGroup..On.Blue.dot">
+        <CompoundRule Type="All">
+          <SelectionCriterionRule SelectionCriterion="Colors" MatchesWhen="Includes" Value="Red"/>
+          <SelectionCriterionRule SelectionCriterion="Colors" MatchesWhen="Includes" Value="Green"/>
+          <CompoundRule Type="Any">
+            <SelectionCriterionRule SelectionCriterion="Switch" MatchesWhen="Is" Value="On"/>
+            <CompoundRule Type="All">
+              <CompoundRule Type="All">
+                <CompoundRule Type="All"/>
+              </CompoundRule>
+              <CompoundRule Type="All">
+                <CompoundRule Type="Any">
+                  <SelectionCriterionRule SelectionCriterion="Switch" MatchesWhen="Is" Value="On"/>
+                </CompoundRule>
+              </CompoundRule>
+            </CompoundRule>
+          </CompoundRule>
+          <SelectionCriterionRule SelectionCriterion="Switch" MatchesWhen="Is" Value="On"/>
+          <SelectionCriterionRule SelectionCriterion="Switch" MatchesWhen="Is" Value="On"/>
+          <SelectionCriterionRule SelectionCriterion="Colors" MatchesWhen="Includes" Value="Green"/>
+          <SelectionCriterionRule SelectionCriterion="Colors" MatchesWhen="Includes" Value="Blue"/>
+        </CompoundRule>
+      </Configuration>
+    </Configurations>
+    <ConfigurableElements>
+      <ConfigurableElement Path="/Test/test/block/3/q2.5"/>
+      <ConfigurableElement Path="/Test/test/block/3/string"/>
+      <ConfigurableElement Path="/Test/test/included/bool"/>
+    </ConfigurableElements>
+    <Settings>
+      <Configuration Name="green.confGroup..On.Blue.dot">
+        <ConfigurableElement Path="/Test/test/block/3/q2.5">
+          <FixedPointParameter Name="q2.5">1.18750</FixedPointParameter>
+        </ConfigurableElement>
+        <ConfigurableElement Path="/Test/test/block/3/string">
+          <StringParameter Name="string">12 ab @ 	 &lt;![CDATA[ &lt; &gt; \n \0 ✔ "'\</StringParameter>
+        </ConfigurableElement>
+        <ConfigurableElement Path="/Test/test/included/bool">
+          <BooleanParameter Name="bool">1</BooleanParameter>
+        </ConfigurableElement>
+      </Configuration>
+    </Settings>
+  </ConfigurableDomain>
 </ConfigurableDomains>

tools/xmlGenerator/PFWScriptGenerator.py

@@ -60,7 +60,7 @@ def _doCreateConfiguration(self, name):
         self._appendCommand("createConfiguration", self._ctx_domain, name)
 
     def _doSetElementSequence(self, paths):
-        self._appendCommand("setElementSequence", self._ctx_domain, self._ctx_configuration, " ".join(paths))
+        self._appendCommand("setElementSequence", self._ctx_domain, self._ctx_configuration, *paths)
 
     def _doSetRule(self, rule):
         self._appendCommand("setRule", self._ctx_domain, self._ctx_configuration, rule)

tools/xmlGenerator/domainGenerator.py

@@ -127,12 +127,12 @@ def parseCriteria(criteriaFile):
 
     return all_criteria
 
-def parseEdd(EDDFiles, verbose):
+def parseEdd(EDDFiles):
     parsed_edds = []
 
     for edd_file in EDDFiles:
         try:
-            root = EddParser.Parser().parse(edd_file, verbose)
+            root = EddParser.Parser().parse(edd_file)
         except EddParser.MySyntaxError as ex:
             logging.critical(str(ex))
             logging.info("EXIT ON FAILURE")
@@ -184,7 +184,7 @@ def main():
     #
     # EDD files (aka ".pfw" files)
     #
-    parsed_edds = parseEdd(args.edd_files, args.verbose)
+    parsed_edds = parseEdd(args.edd_files)
 
     # We need to modify the toplevel configuration file to account for differences
     # between development setup and target (installation) setup, in particular, the

tools/xmlGenerator/domainGeneratorConnector.cpp

@@ -37,6 +37,7 @@
 #include <memory>
 #include <string>
 #include <limits>
+#include <numeric>
 #include <algorithm>
 #include <stdexcept>
 
@@ -169,9 +170,10 @@ size_t XmlGenerator::parse(std::istream &input)
             string output;
             if (not mCommandHandler->process(command, tokens, output)) {
                 errorNb++;
-                std::cerr << "Failed to executing command: "
-                          << utility::join<string>(begin(tokens), end(tokens),
-                                                   [](string l, string r) { return l + ' ' + r; })
+
+                std::cerr << accumulate(begin(tokens), end(tokens),
+                                        "Failed to executing command: `" + command + "'",
+                                        [](string l, string r) { return l + " `" + r + "'"; })
                           << std::endl
                           << output << std::endl;
             }