Warn if "include directories" do not exist (#132)

* Warn if "include directories" do not exist

Instead of raising a RunTime errror on a missing include
directory, print a warning to the screen.

* Fix key string and add test for desired case.

Remove the "_" in the include directories string and add a test case to
capture the print and ensure the proper messages are found.

* Switch to using "warnings"

Use the warning module for both the printing of the missing directory
message and capturing the output during the test.

* Additional warnings cleanup

Use an asssertWarns instead of trying to capture the warning separately.
Clean some outdated code.

* Add warning type to warn

Add a RunTimeWarning type to the warn command for ease of filtering and
capturing later on.

Update the test to capture the new warning type.

Co-authored-by: Michka Popoff <[email protected]>

Author: josephsnyder

pygccxml/parser/config.py

@@ -12,6 +12,7 @@
 import copy
 import platform
 import subprocess
+import warnings
 # In py3, ConfigParser was renamed to the more-standard configparser.
 # But there's a py3 backport that installs "configparser" in py2, and I don't
 # want it because it has annoying deprecation warnings. So try the real py2
@@ -200,8 +201,12 @@ def __ensure_dir_exists(self, dir_path, meaning):
         if os.path.isdir(dir_path):
             return
         if os.path.exists(self.working_directory):
-            raise RuntimeError(
-                '%s("%s") does not exist!' % (meaning, dir_path))
+            msg = '%s("%s") does not exist.' % (meaning, dir_path)
+            if meaning == 'include directory':
+                # Warn instead of failing.
+                warnings.warn(msg, RuntimeWarning)
+            else:
+                raise RuntimeError(msg)
         else:
             raise RuntimeError(
                 '%s("%s") should be "directory", not a file.' %

unittests/test_all.py

@@ -84,6 +84,7 @@
 from . import test_hash
 from . import test_null_comparison
 from . import test_comments
+from . import test_warn_missing_include_dirs
 from . import test_overrides
 
 testers = [
@@ -160,6 +161,7 @@
     test_hash,
     test_null_comparison,
     test_comments,
+    test_warn_missing_include_dirs,
     test_overrides,
 ]
 

unittests/test_warn_missing_include_dirs.py

@@ -0,0 +1,52 @@
+# Copyright 2014-2017 Insight Software Consortium.
+# Copyright 2004-2009 Roman Yakovenko.
+# Distributed under the Boost Software License, Version 1.0.
+# See http://www.boost.org/LICENSE_1_0.txt
+
+import io
+import sys
+import os
+import unittest
+import warnings
+
+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 that a missing include directory is printing a warning,
+            not raising an error
+        """
+
+        # 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()
+
+        # Path given as include director doesn't exist
+        config = parser.xml_generator_configuration_t(
+            xml_generator_path=generator_path,
+            xml_generator=name,
+            include_paths=["doesnt/exist", os.getcwd()])
+        self.assertWarns(RuntimeWarning, 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()