Add SettingsLoader.getremains() test + code refactoring in SettingsLoader

lodel/settings/settings_loader.py

@@ -9,6 +9,11 @@ from lodel.settings.utils import *
    
 ##@brief Merges and loads configuration files
 class SettingsLoader(object):
+    
+    ## To avoid the DEFAULT section whose values are found in all sections, we
+    # have to give it an unsual name
+    DEFAULT_SECTION = 'lodel2_default_passaway_tip'
+
     ##@brief Constructor
     # @param conf_path str : conf.d path
     def __init__(self,conf_path):
@@ -17,39 +22,28 @@ class SettingsLoader(object):
         self.__conf=self.__merge()
     
     ##@brief Lists and merges files in settings_loader.conf_path
-    #
-    # 
     # @return dict()
-    # 
     def __merge(self):
         conf = dict()
-        dir_conf = os.open(self.__conf_path, os.O_RDONLY)
- 
         l_dir = glob.glob(self.__conf_path+'/*.ini')  
 
         for f_ini in l_dir:  
-            #To avoid the DEFAULT section whose values are found in all sections, we have to give it an unsual name
-            config = configparser.ConfigParser(default_section = 'lodel2_default_passaway_tip',interpolation=None)
+            config = configparser.ConfigParser(default_section = self.DEFAULT_SECTION ,interpolation=None)
             config.read(f_ini)
-
-            for sect in config:
-                if sect in conf:
-                    for param in config[sect]:
-                        if param not in conf[sect]: 
-                            conf[sect][param] = config[sect][param]
-                            if sect != 'DEFAULT': self.__conf_sv[sect + ':' + param]=f_ini
-                        else:
-                            raise SettingsError("Key attribute already defined : %s " % sect + '.' + param + ' dans ' + f_ini + ' et ' + self.__conf_sv[sect + ':' + param])                        
-                else:
-                    opts={}
-                    for key in config[sect]:
-                        opts[key] = config[sect].get(key)
-                        if sect != 'lodel2_default_passaway_tip': self.__conf_sv[sect + ':' + key]=f_ini
-                    conf.update({sect: opts})
-        os.close(dir_conf)
+            for section in [ s for s in config if s != self.DEFAULT_SECTION ]:
+                if section not in conf:
+                    conf[section] = dict()
+                for param in config[section]:
+                    if param not in conf[section]: 
+                        conf[section][param] = config[section][param]
+                        self.__conf_sv[section + ':' + param]=f_ini
+                    else:
+                        raise SettingsError("Error redeclaration of key %s in section %s. Found in %s and %s" % (
+            section,
+            param,
+            f_ini,
+            self.__conf_sv[section + ':' + param]))
         return conf
-        
-        
     
     ##@brief Returns option if exists default_value else and validates
     # @param section str : name of the section
@@ -70,7 +64,6 @@ class SettingsLoader(object):
              raise SettingsError("Default value mandatory for option %s" % keyname)
         else:
              return default_value
-                              
     
     ##@brief Returns the section to be configured
     # @param section_prefix str
@@ -94,8 +87,13 @@ class SettingsLoader(object):
             
         return sections;
     
-    ##@brief Returns the sections which have not been configured
-    # @return list of missing options
+    ## @brief Returns invalid settings
+    #
+    # This method returns all the settings that was not fecthed by 
+    # getsection() method. For the Settings object it allows to know
+    # the list of invalids settings keys
+    # @return a dict with SECTION_NAME+":"+KEY_NAME as key and the filename
+    # where the settings was found as value
     def getremains(self):
-        return list(self.__conf_sv)
-        
+        return self.__conf_sv
+    

tests/settings/settings_examples/remains.conf.d/file1.ini

@@ -1,4 +1,4 @@
-[lodel2]
+[lodel2.section]
 a = a
 b = b
 c = c

tests/settings/settings_examples/remains.conf.d/file2.ini

@@ -1,3 +1,3 @@
-[lodel2]
+[lodel2.section]
 d = d
 e = e

tests/settings/test_settings_loader.py

@@ -35,7 +35,7 @@ class SettingsLoaderTestCase(unittest.TestCase):
         f=settings.getoption('lodel2.A.e','a',maFonction)
         f=settings.getoption('lodel2.A.e','titi',maFonction)
         g=settings.getremains()
-        self.assertEqual(g,[])
+        self.assertEqual(len(g),0)
         with self.assertRaises(SettingsError):
             loader = SettingsLoader('tests/settings/settings_examples/conf_raise.d')
     
@@ -118,8 +118,25 @@ class SettingsLoaderTestCase(unittest.TestCase):
         with self.assertRaises(NameError):
             sections = loader.getsection('lodel2.notexisting')
     
-    @unittest.skip("Waiting implementation")
     def test_remains(self):
         """ Testing the remains method of SettingsLoader """
         loader = SettingsLoader('tests/settings/settings_examples/remains.conf.d')
-        pass #TO BE DONE LATER
+        values = {
+            'lodel2.section': [ chr(i) for i in range(ord('a'), ord('f')) ],
+            'lodel2.othersection': [ chr(i) for i in range(ord('a'), ord('f')) ],
+        }
+        
+        expt_rem = []
+        for section in values:
+            for val in values[section]:
+                expt_rem.append('%s:%s' % (section, val))
+
+        self.assertEqual(sorted(expt_rem), sorted(loader.getremains().keys()))
+
+        for section in values:
+            for val in values[section]:
+                loader.getoption(section, val, dummy_validator)
+                expt_rem.remove('%s:%s' % (section, val))
+                self.assertEqual(   sorted(expt_rem),
+                                    sorted(loader.getremains().keys()))
+