Merge lp:~ricardokirkner/configglue/multi-file-interpolation into lp:configglue

[Ricardo Kirkner]

allow interpolating with __noschema__ values across included files

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

Voting does not meet specified criteria. Required: Approve >= 1, Disapprove == 0, Needs Fixing == 0, Needs Information == 0, Resubmit == 0, Pending == 0. Got: 1 Pending.

[Ricardo Kirkner (ricardokirkner)]

Rubber stamping

review: Approve

=== modified file 'configglue/parser.py'
--- configglue/parser.py	2013-07-11 17:01:58 +0000
+++ configglue/parser.py	2013-07-15 18:06:23 +0000
@@ -282,7 +282,15 @@
                 fpname)
             includes = self.get('__main__', 'includes')
             filenames = [text_type.strip(x) for x in includes]
-            self.read(filenames, already_read=already_read)
+
+            # parse included files
+            sub_parser = self.__class__(self.schema)
+            sub_parser._basedir = self._basedir
+            sub_parser._location = self._location
+            sub_parser.read(filenames)
+            # update current parser with those values
+            self._sections.update(sub_parser._sections)
+
             self._basedir = old_basedir
 
             if filenames:

=== modified file 'configglue/tests/test_parser.py'
--- configglue/tests/test_parser.py	2013-07-11 17:01:58 +0000
+++ configglue/tests/test_parser.py	2013-07-15 18:06:23 +0000
@@ -109,6 +109,7 @@
         """Test parser include files using relative paths."""
         def setup_config():
             folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
 
             f = codecs.open("%s/first.cfg" % folder, 'w',
                             encoding=CONFIG_FILE_ENCODING)
@@ -150,16 +151,11 @@
         # make sure we leave the basedir clean
         self.assertEqual(parser._basedir, '')
 
-        # silently remove any created files
-        try:
-            shutil.rmtree(folder)
-        except:
-            pass
-
     def test_local_override(self):
         """Test parser override values from included files."""
         def setup_config():
             folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
 
             f = codecs.open("%s/first.cfg" % folder, 'w',
                             encoding=CONFIG_FILE_ENCODING)
@@ -190,11 +186,51 @@
         # make sure we leave the basedir clean
         self.assertEqual(parser._basedir, '')
 
-        # silently remove any created files
-        try:
-            shutil.rmtree(folder)
-        except:
-            pass
+    def test_multiple_includes(self):
+        """Test parser correctly handles multiple included files."""
+        def setup_config():
+            folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
+
+            f = codecs.open("%s/first.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__main__]\nfoo=1\nbar=1")
+            f.close()
+
+            f = codecs.open("%s/second.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__main__]\nfoo=2\nbar=2")
+            f.close()
+
+            f = codecs.open("%s/third.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__main__]\nfoo=3\nbar=3")
+            f.close()
+
+            config = textwrap.dedent("""
+                [__main__]
+                includes =
+                    {folder}/first.cfg
+                    {folder}/second.cfg
+                    {folder}/third.cfg
+                foo = 4
+                """.format(folder=folder))
+            config = BytesIO(config.encode(CONFIG_FILE_ENCODING))
+            return config, folder
+
+        class MySchema(Schema):
+            foo = IntOption()
+            bar = IntOption()
+
+        config, folder = setup_config()
+        expected_values = {'__main__': {'foo': 4, 'bar': 3}}
+        parser = SchemaConfigParser(MySchema())
+        # make sure we start on a clean basedir
+        self.assertEqual(parser._basedir, '')
+        parser.readfp(config, 'my.cfg')
+        self.assertEqual(parser.values(), expected_values)
+        # make sure we leave the basedir clean
+        self.assertEqual(parser._basedir, '')
 
 
 class TestInterpolation(unittest.TestCase):
@@ -266,6 +302,73 @@
         self.assertRaises(InterpolationMissingOptionError,
             parser.get, 'foo', 'bar')
 
+    def test_interpolate_across_includes(self):
+        """Test interpolation across included files."""
+        def setup_config():
+            folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
+
+            f = codecs.open("%s/first.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__main__]\nfoo=1\nincludes=second.cfg")
+            f.close()
+
+            f = codecs.open("%s/second.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__main__]\nbar=3")
+            f.close()
+
+            config = "[__main__]\nfoo=%%(bar)s\nincludes=%s/first.cfg" % folder
+            config = BytesIO(config.encode(CONFIG_FILE_ENCODING))
+            return config, folder
+
+        class MySchema(Schema):
+            foo = IntOption()
+            bar = IntOption()
+
+        config, folder = setup_config()
+        expected_values = {'__main__': {'foo': 3, 'bar': 3}}
+        parser = SchemaConfigParser(MySchema())
+        # make sure we start on a clean basedir
+        self.assertEqual(parser._basedir, '')
+        parser.readfp(config, 'my.cfg')
+        self.assertEqual(parser.values(), expected_values)
+        # make sure we leave the basedir clean
+        self.assertEqual(parser._basedir, '')
+
+    def test_interpolate_using_noschema(self):
+        """Test interpolation across included files."""
+        def setup_config():
+            folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
+
+            f = codecs.open("%s/first.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__noschema__]\nbar=1\n[__main__]\nincludes=second.cfg")
+            f.close()
+
+            f = codecs.open("%s/second.cfg" % folder, 'w',
+                            encoding=CONFIG_FILE_ENCODING)
+            f.write("[__noschema__]\nbar=3")
+            f.close()
+
+            config = "[__main__]\nfoo=%%(bar)s\nincludes=%s/first.cfg" % folder
+            config = BytesIO(config.encode(CONFIG_FILE_ENCODING))
+            return config, folder
+
+        class MySchema(Schema):
+            foo = IntOption()
+
+        config, folder = setup_config()
+        expected_values = {'__main__': {'foo': 1}}
+        parser = SchemaConfigParser(MySchema())
+        # make sure we start on a clean basedir
+        self.assertEqual(parser._basedir, '')
+        parser.readfp(config, 'my.cfg')
+        self.assertEqual(parser.values(), expected_values)
+        # make sure we leave the basedir clean
+        self.assertEqual(parser._basedir, '')
+
     def test_interpolate_invalid_key(self):
         """Test interpolation of invalid key."""
         class MySchema(Schema):
@@ -882,6 +985,7 @@
     def test_read_multiple_files(self):
         def setup_config():
             folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
 
             f = codecs.open("%s/first.cfg" % folder, 'w',
                             encoding=CONFIG_FILE_ENCODING)
@@ -900,12 +1004,6 @@
         self.parser.read(files)
         self.assertEqual(self.parser.values(), {'__main__': {'foo': 'bar'}})
 
-        # silently remove any created files
-        try:
-            shutil.rmtree(folder)
-        except:
-            pass
-
     def test_read_utf8_encoded_file(self):
         # create config file
         fp, filename = tempfile.mkstemp()
@@ -1053,6 +1151,7 @@
         """Test parser save config values to original files."""
         def setup_config():
             folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
 
             f = codecs.open("%s/first.cfg" % folder, 'w',
                             encoding=CONFIG_FILE_ENCODING)
@@ -1095,15 +1194,10 @@
         # new value goes into last read config file
         self.assertTrue('baz = 42' in data)
 
-        # silently remove any created files
-        try:
-            shutil.rmtree(folder)
-        except:
-            pass
-
     def test_save_config_last_location_nested_includes(self):
         def setup_config():
             folder = tempfile.mkdtemp()
+            self.addCleanup(shutil.rmtree, folder)
 
             f = codecs.open("%s/first.cfg" % folder, 'w',
                             encoding=CONFIG_FILE_ENCODING)
@@ -1151,12 +1245,6 @@
         # not in the last included config file
         self.assertTrue('baz = 42' in data)
 
-        # silently remove any created files
-        try:
-            shutil.rmtree(folder)
-        except:
-            pass
-
 
 class TestParserIsValid(unittest.TestCase):
     def setUp(self):