xml_generator_configuration_t should not try to look for castxml or gccxml (#65)

You can use utils.find_xml_generator to help you finding the path to the xml generator,
or set it manually. It is now mandatory to pass a valid xml_generator and
xml_generator_path to the configuration.

Author: iMichka

CHANGELOG.md

@@ -1,6 +1,16 @@
 Changes
 =======
 
+
+Version 1.8.2 (Not yet released)
+--------------------------------
+
+1. ```xml_generator_configuration_t``` will no more try to find
+  castxml or gccxml. You can use ```utils.find_xml_generator``` to help you
+  finding the path to the xml generator, or set it manually.
+  It is now mandatory to pass a valid ```xml_generator``` and
+  ```xml_generator_path``` to the configuration (#65).
+
 Version 1.8.1
 -------------
 

pygccxml/parser/config.py

@@ -45,7 +45,7 @@ def __init__(
             undefine_symbols=None,
             cflags="",
             compiler=None,
-            xml_generator="castxml",
+            xml_generator=None,
             keep_xml=False,
             compiler_path=None,
             flags=None):
@@ -187,11 +187,16 @@ def __ensure_dir_exists(self, dir_path, meaning):
                 (meaning, dir_path))
 
     def raise_on_wrong_settings(self):
-        """validates the configuration settings and raises RuntimeError on
-        error"""
+        """
+        Validates the configuration settings and raises RuntimeError on error
+        """
         self.__ensure_dir_exists(self.working_directory, 'working directory')
         for idir in self.include_paths:
             self.__ensure_dir_exists(idir, 'include directory')
+        if self.__xml_generator not in ["castxml", "gccxml"]:
+            msg = ('xml_generator("%s") should either be ' +
+                   '"castxml" or "gccxml".') % self.xml_generator
+            raise RuntimeError(msg)
 
 
 class xml_generator_configuration_t(parser_configuration_t):
@@ -215,7 +220,7 @@ def __init__(
             ignore_gccxml_output=False,
             cflags="",
             compiler=None,
-            xml_generator="castxml",
+            xml_generator=None,
             keep_xml=False,
             compiler_path=None,
             flags=None):
@@ -277,31 +282,12 @@ def ignore_gccxml_output(self, val=True):
 
     def raise_on_wrong_settings(self):
         super(xml_generator_configuration_t, self).raise_on_wrong_settings()
-        if os.path.isfile(self.xml_generator_path):
-            return
-        if os.name == 'nt':
-            gccxml_name = 'gccxml' + '.exe'
-            environment_var_delimiter = ';'
-        elif os.name == 'posix':
-            gccxml_name = 'gccxml'
-            environment_var_delimiter = ':'
-        else:
-            raise RuntimeError(
-                'unable to find out location of the xml generator')
-        may_be_gccxml = os.path.join(self.xml_generator_path, gccxml_name)
-        if os.path.isfile(may_be_gccxml):
-            self.xml_generator_path = may_be_gccxml
-        else:
-            for path in os.environ['PATH'].split(environment_var_delimiter):
-                xml_generator_path = os.path.join(path, gccxml_name)
-                if os.path.isfile(xml_generator_path):
-                    self.xml_generator_path = xml_generator_path
-                    break
-            else:
-                msg = (
-                    'xml_generator_path("%s") should exists or to be a ' +
-                    'valid file name.') % self.xml_generator_path
-                raise RuntimeError(msg)
+        if self.xml_generator_path is None or \
+                not os.path.isfile(self.xml_generator_path):
+            msg = (
+                'xml_generator_path("%s") should be set and exist.') \
+                % self.xml_generator_path
+            raise RuntimeError(msg)
 
 
 class _StringDeprecationWrapper(str):

unittests/test_all.py

@@ -75,6 +75,7 @@
 import test_pattern_parser
 import test_function_pointer
 import test_directory_cache
+import test_config
 
 testers = [
     # , demangled_tester # failing right now
@@ -142,7 +143,8 @@
     test_smart_pointer,
     test_pattern_parser,
     test_function_pointer,
-    test_directory_cache
+    test_directory_cache,
+    test_config
 ]
 
 if 'posix' in os.name:

unittests/test_config.py

@@ -0,0 +1,77 @@
+# Copyright 2014-2016 Insight Software Consortium.
+# Distributed under the Boost Software License, Version 1.0.
+# See http://www.boost.org/LICENSE_1_0.txt
+
+import sys
+import os
+import unittest
+
+sys.path.insert(1, os.path.join(os.curdir, '..'))
+sys.path.insert(1, "../pygccxml")
+
+from pygccxml import parser  # nopep8
+from pygccxml import utils  # nopep8
+
+
+class Test(unittest.TestCase):
+
+    def test_config(self):
+        """Test config setup with wrong xml generator setups."""
+
+        # Some code to parse for the example
+        code = "int a;"
+
+        # Find the location of the xml generator (castxml or gccxml)
+        generator_path, name = utils.find_xml_generator()
+
+        # No xml generator path
+        config = parser.xml_generator_configuration_t(xml_generator=name)
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+        # Invalid path
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path="wrong/path",
+            xml_generator=name)
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+        # None path
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path=None,
+            xml_generator=name)
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+        # No name
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path=generator_path)
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+        # Random name
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path=generator_path,
+            xml_generator="not_a_generator")
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+        # None name
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path=generator_path,
+            xml_generator=None)
+        self.assertRaises(
+            RuntimeError, lambda: parser.parse_string(code, config))
+
+
+def create_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(Test))
+    return suite
+
+
+def run_suite():
+    unittest.TextTestRunner(verbosity=2).run(create_suite())
+
+if __name__ == "__main__":
+    run_suite()