Merge pull request #328 from dawagner/xmlgeneration-bugfix

Xml Generation bugfix

There were some coding errors in domainGenerator.py. This branch fixes them and add more tests to ensure it doesn't happen again.

Author: dawagner

test/xml-generator/test.py

@@ -1,4 +1,4 @@
-#! python2
+#! python2.7
 # Copyright (c) 2015, Intel Corporation
 # All rights reserved.
 #
@@ -31,37 +31,89 @@
 import os
 import subprocess
 import difflib
+import unittest
+import copy
+
+class PfConfig:
+    def __init__(self, toplevel, criteria, schemas):
+        self.toplevel = toplevel
+        self.criteria = criteria
+        self.schemas = schemas
+
+class TestVector:
+    def __init__(self, initialSettings=None, edds=[], domains=[]):
+        self.initialSettings = initialSettings
+        self.edds = edds
+        self.domains = domains
+
+class Tester(object):
+    def __init__(self, pfConfig, testVector):
+        self.command = [sys.executable, "domainGenerator.py",
+                        "--validate",
+                        "--verbose",
+                        "--toplevel-config", pfConfig.toplevel,
+                        "--criteria", pfConfig.criteria,
+                        "--schemas-dir", pfConfig.schemas]
+
+        if testVector.initialSettings:
+            self.command += ["--initial-settings", testVector.initialSettings]
+        if testVector.edds:
+            self.command += ["--add-edds"] + testVector.edds
+        if testVector.domains:
+            self.command += ["--add-domains"] + testVector.domains
+
+    def check(self, reference=None, expectedErrors=0):
+        process = subprocess.Popen(self.command, stdout=subprocess.PIPE)
+        actual = process.stdout.read().splitlines()
+
+        if process.wait() != expectedErrors:
+            raise AssertionError("Expected {} errors, found {}".format(
+                expectedErrors,
+                process.returncode))
+
+        if not reference:
+            # The caller only wants to check the number of errors
+            return True
+
+        # 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
+
 
 basedir = os.path.dirname(sys.argv[0])
 
-configDir = os.path.join(basedir, "PFConfig")
-vectorDir = os.path.join(basedir, "testVector")
-
-command = [sys.executable, "domainGenerator.py",
-        "--validate",
-        "--verbose",
-        "--toplevel-config", os.path.join(configDir, "configuration.xml"),
-        "--criteria", os.path.join(configDir, "criteria.txt"),
-        "--initial-settings", os.path.join(vectorDir, "initialSettings.xml"),
-        "--add-edds", os.path.join(vectorDir, "first.pfw"), os.path.join(vectorDir, "second.pfw"),
-        "--add-domains", os.path.join(vectorDir, "third.xml"), os.path.join(vectorDir, "fourth.xml"),
-        "--schemas-dir", os.path.join(basedir, "../../schemas")]
-
-reference = open(os.path.join(vectorDir, "reference.xml")).read().splitlines()
-
-process = subprocess.Popen(command, stdout=subprocess.PIPE)
-actual = process.stdout.read().splitlines()
-
-unified = difflib.unified_diff(reference,
-                               actual,
-                               fromfile="reference.xml",
-                               tofile="-",
-                               lineterm="")
-diffs = list(unified)
-if diffs:
-    for d in diffs:
-        print(d)
-    sys.exit(1)
-if process.wait() != 1:
-    print("Error: Expected 1 error, found {}".format(process.returncode))
-    sys.exit(1)
+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, "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))
+
+    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))
+
+if __name__ == "__main__":
+    unittest.main()

test/xml-generator/testVector/duplicate.pfw

@@ -0,0 +1,2 @@
+# Should trigger a non fatal error
+domain: EddGroup.First

test/xml-generator/testVector/first.pfw

@@ -31,5 +31,3 @@ domainGroup: EddGroup
 			component: /Test/test/block/1
 				q2.5 = 0
 				string = some other string
-	# Should trigger a non fatal error
-	domain: First

tools/xmlGenerator/domainGenerator.py

@@ -58,6 +58,7 @@ def parseArgs():
             help="Initial XML settings file (containing a \
         <ConfigurableDomains>  tag",
             nargs='?',
+            default=None,
             metavar="XML_SETTINGS_FILE")
     argparser.add_argument('--add-domains',
             help="List of single domain files (each containing a single \
@@ -184,7 +185,6 @@ def main():
     # EDD files (aka ".pfw" files)
     #
     parsed_edds = parseEdd(args.edd_files, args.verbose)
-    error_nb = 0
 
     # We need to modify the toplevel configuration file to account for differences
     # between development setup and target (installation) setup, in particular, the
@@ -209,7 +209,9 @@ def main():
                             args.schemas_dir],
                            stdout=sys.stdout, stdin=subprocess.PIPE, stderr=sys.stderr)
 
-    initial_settings = os.path.realpath(args.initial_settings)
+    initial_settings = None
+    if args.initial_settings:
+        initial_settings = os.path.realpath(args.initial_settings)
 
     for command in generateDomainCommands(logging, all_criteria, initial_settings,
                                        args.xml_domain_files, parsed_edds):
@@ -219,8 +221,8 @@ def main():
     # Closing the connector's input triggers the domain generation
     connector.stdin.close()
     connector.wait()
-    fake_toplevel_config.delete()
-    return connector.return_code
+    os.remove(fake_toplevel_config.name)
+    return connector.returncode
 
 # If this file is directly executed
 if __name__ == "__main__":

tools/xmlGenerator/domainGeneratorConnector.cpp

@@ -209,8 +209,8 @@ void XmlGenerator::exportDomains(std::ostream &output)
 static const char *usage =
     R"(Usage: domainGeneratorConnector <top-level config> <verbose> <validate> <path>
 
- <verbose>       '1': verbose,  else: terse
- <validate>      '1' validate, else: don't validate
+ <verbose>       'verbose': verbose, else: terse
+ <validate>      'validate': validate, else: don't validate
  <path>          path to the schemas' directory
 
 All arguments are mandatory. If no validation is required,