Added unittests for config.py (all tests in one case for now); fixed an error on 3rd party keys; polish and cleanup to config

svn: r13401

src/config.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-
 #
 # Gramps - a GTK+/GNOME based genealogy program
 #
@@ -43,8 +42,10 @@ try:
     from ast import literal_eval as safe_eval
 except:
     # PYTHON2.5 COMPATIBILITY: no ast present
-    # not safe, but works:
+    # not as safe as literal_eval, but works for python2.5:
-    safe_eval = eval
+    def safe_eval(exp):
+        # restrict eval to empty environment
+        return eval(exp, {})
 
 #---------------------------------------------------------------
 #
@@ -163,38 +164,40 @@ class ConfigManager(object):
                     # These might be old settings, or third-party settings
                     self.data[name] = {}
                 for opt in parser.options(sec):
-                    setting = parser.get(sec, opt).strip()
+                    raw_value = parser.get(sec, opt).strip()
+                    setting = opt.lower()
                     if oldstyle:
                     ####################### Upgrade from oldstyle < 3.2
+                    # Oldstyle didn't mark setting type, but had it 
+                    # set in preferences. New style gets it from evaling
+                    # the setting's value
+                    #######################
                         # if we know this setting, convert type
-                        key = "%s.%s" % (name, opt)
+                        key = "%s.%s" % (name, setting)
                         if self.has_default(key):
                             vtype = type(self.get_default(key))
                             if vtype == bool:
-                                value = setting in ["1", "True"]
+                                value = raw_value in ["1", "True"]
-                            elif vtype == list:
-                                print "WARNING: ignoring old key '%s'" % key
-                                continue # there were no lists in oldstyle
                             else:
-                                value = vtype(setting)
+                                value = vtype(raw_value)
                         else:
                             # else, ignore it
                             print "WARNING: ignoring old key '%s'" % key
                             continue # with next setting
                     ####################### End upgrade code
                     else:
-                        # as safe as we can be:
+                        value = safe_eval(raw_value)
-                        value = safe_eval(setting)
                     ####################### Now, let's test and set:
-                    if opt.lower() in self.default[name]:
+                    if (name in self.default and 
-                        if type(value) == type(self.default[name][opt.lower()]):
+                        setting in self.default[name]):
-                            self.data[name][opt.lower()] = value
+                        if type(value) == type(self.default[name][setting]):
+                            self.data[name][setting] = value
                         else:
                             print ("WARNING: ignoring key with wrong type "
-                                   "'%s.%s'" % (name, opt.lower()))
+                                   "'%s.%s'" % (name, setting))
                     else:
                         # this could be a third-party setting; add it:
-                        self.data[name][opt.lower()] = value
+                        self.data[name][setting] = value
 
     def save(self, filename = None):
         """
@@ -400,9 +403,7 @@ class ConfigManager(object):
             # Only call callback if the value changed!
             if (section in self.callbacks and 
                 setting in self.callbacks[section]):
-                for (cbid, func) in self.callbacks[section][setting]:
+                self.emit(key)
-                    # Call all callbacks for this key:
-                    func(self, 0, str(self.data[section][setting]), None) 
 
 #---------------------------------------------------------------
 #
@@ -672,119 +673,3 @@ if not os.path.exists(CONFIGMAN.filename):
 #
 #---------------------------------------------------------------
 CONFIGMAN.load()
-
-if __name__ == "__main__":
-    CM = ConfigManager("./temp.ini")
-    CM.register("section.setting1", 1) # int
-    CM.register("section.setting2", 3.1415) # float
-    CM.register("section.setting3", "String") # string
-    CM.register("section.setting4", False) # boolean
-
-    assert CM.get("section.setting1") == 1
-    assert CM.get("section.setting2") == 3.1415
-    assert CM.get("section.setting3") == "String"
-    assert CM.get("section.setting4") == False
-
-    CM.set("section.setting1", 2)
-    CM.set("section.setting2", 8.6)
-    CM.set("section.setting3", "Another String")
-    CM.set("section.setting4", True)
-
-    assert CM.get("section.setting1") == 2
-    assert CM.get("section.setting2") == 8.6
-    assert CM.get("section.setting3") == "Another String"
-    assert CM.get("section.setting4") == True
-
-    try:
-        CM.set("section.setting1", 2.8)
-    except AttributeError:
-        pass
-    else:
-        raise AssertionError
-
-    try:
-        CM.set("section.setting2", 2)
-    except AttributeError:
-        pass
-    else:
-        raise AssertionError
-
-    try:
-        CM.set("section.setting3", 6)
-    except AttributeError:
-        pass
-    else:
-        raise AssertionError
-
-    try:
-        CM.set("section.setting4", 1)
-    except AttributeError:
-        pass
-    else:
-        raise AssertionError
-
-    assert CM.get("section.setting1") == 2
-    assert CM.get("section.setting2") == 8.6
-    assert CM.get("section.setting3") == "Another String"
-    assert CM.get("section.setting4") == True
-
-    # Try to set one that doesn't exist:
-    try:
-        CM.set("section.setting5", 1)
-    except AttributeError:
-        pass
-    else:
-        raise AssertionError
-
-    CM.save()
-
-    CM.reset()
-
-    assert CM.get("section.setting1") == 1
-    assert CM.get("section.setting2") == 3.1415
-    assert CM.get("section.setting3") == "String"
-    assert CM.get("section.setting4") == False
-
-    x = None
-    def callback(*args):
-        # args: self, 0, str(setting), None
-        global x
-        x = args[2]
-
-    cbid = CM.connect("section.setting1", callback)
-    assert x == None
-
-    CM.set("section.setting1", 1024)
-    assert x == "1024"
-
-    CM.disconnect(cbid)
-
-    CM.set("section.setting1", -1)
-    assert x == "1024"
-
-    CM.reset("section.setting1")
-    assert CM.get("section.setting1") == 1
-
-    # No callback:
-    x = None
-    CM.set("section.setting1", 200)
-    assert x == None
-    # Now, set one:
-    cbid = CM.connect("section.setting1", callback)
-    # Now, call it:
-    CM.emit("section.setting1")
-    assert x == "200"
-
-    CM.register("section2.windows-file", r"c:\drive\path\o'malley\file.pdf")
-    CM.register("section2.list", [1, 2, 3, 4])
-    CM.register("section2.dict", {'a': "apple", "b": "banana"})
-    CM.register("section2.unicode", "Raötröme")
-
-    CM.save("./test2.ini")
-    CM.reset()
-    CM.load("./test2.ini")
-
-    assert CM.get("section2.windows-file") == r"c:\drive\path\o'malley\file.pdf"
-    assert CM.get("section2.list") == [1, 2, 3, 4]
-    assert CM.get("section2.dict") == {'a': "apple", "b": "banana"}
-    assert CM.get("section2.unicode") == "Raötröme"

src/test/config_test.py

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2009 Douglas S. Blank <doug.blank@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, 
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+
+# $Id$
+
+""" Unittest for config.py """
+
+import unittest
+from config import ConfigManager
+
+def callback(*args):
+    # args: self, 0, str(setting), None
+    # print "Calling callback with:", args
+    # self is ConfigManager
+    self = args[0]
+    self._x = args[2]
+
+class CompleteCheck(unittest.TestCase):
+    
+    def testAll(self):
+        self.CM = ConfigManager("./temp.ini")
+        self.CM.register("section.setting1", 1) # int
+        self.CM.register("section.setting2", 3.1415) # float
+        self.CM.register("section.setting3", "String") # string
+        self.CM.register("section.setting4", False) # boolean
+    
+        assert self.CM.get("section.setting1") == 1
+        assert self.CM.get("section.setting2") == 3.1415
+        assert self.CM.get("section.setting3") == "String"
+        assert self.CM.get("section.setting4") == False
+    
+        self.CM.set("section.setting1", 2)
+        self.CM.set("section.setting2", 8.6)
+        self.CM.set("section.setting3", "Another String")
+        self.CM.set("section.setting4", True)
+    
+        assert self.CM.get("section.setting1") == 2
+        assert self.CM.get("section.setting2") == 8.6
+        assert self.CM.get("section.setting3") == "Another String"
+        assert self.CM.get("section.setting4") == True
+    
+        try:
+            self.CM.set("section.setting1", 2.8)
+        except AttributeError:
+            pass
+        else:
+            raise AssertionError
+    
+        try:
+            self.CM.set("section.setting2", 2)
+        except AttributeError:
+            pass
+        else:
+            raise AssertionError
+    
+        try:
+            self.CM.set("section.setting3", 6)
+        except AttributeError:
+            pass
+        else:
+            raise AssertionError
+    
+        try:
+            self.CM.set("section.setting4", 1)
+        except AttributeError:
+            pass
+        else:
+            raise AssertionError
+    
+        assert self.CM.get("section.setting1") == 2
+        assert self.CM.get("section.setting2") == 8.6
+        assert self.CM.get("section.setting3") == "Another String"
+        assert self.CM.get("section.setting4") == True
+    
+        # Try to set one that doesn't exist:
+        try:
+            self.CM.set("section.setting5", 1)
+        except AttributeError:
+            pass
+        else:
+            raise AssertionError
+    
+        self.CM.save()
+    
+        self.CM.reset() # to defaults
+    
+        assert self.CM.get("section.setting1") == 1
+        assert self.CM.get("section.setting2") == 3.1415, self.CM.get("section.setting2")
+        assert self.CM.get("section.setting3") == "String"
+        assert self.CM.get("section.setting4") == False
+    
+        self.CM._x = None
+    
+        cbid = self.CM.connect("section.setting1", callback)
+        assert self.CM._x == None
+    
+        self.CM.set("section.setting1", 1024)
+        assert self.CM._x == "1024", "x was '%s'" % self.CM._x
+    
+        self.CM.disconnect(cbid)
+    
+        self.CM.set("section.setting1", -1)
+        assert self.CM._x == "1024"
+    
+        self.CM.reset("section.setting1")
+        assert self.CM.get("section.setting1") == 1
+    
+        # No callback:
+        self.CM._x = None
+        self.CM.set("section.setting1", 200)
+        assert self.CM._x == None
+        # Now, set one:
+        cbid = self.CM.connect("section.setting1", callback)
+        # Now, call it:
+        self.CM.emit("section.setting1")
+        assert self.CM._x == "200"
+    
+        self.CM.set("section.setting1", 2)
+        self.CM.set("section.setting2", 8.6)
+        self.CM.set("section.setting3", "Another String")
+        self.CM.set("section.setting4", True)
+
+        self.CM.register("section2.windows-file", r"c:\drive\path\o'malley\file.pdf")
+        self.CM.register("section2.list", [1, 2, 3, 4])
+        self.CM.register("section2.dict", {'a': "apple", "b": "banana"})
+        self.CM.register("section2.unicode", "Raötröme")
+
+        self.CM.save("./test2.ini")
+        self.CM.reset()
+
+        assert self.CM.get("section.setting1") == 1, self.CM.get("section.setting1")
+        assert self.CM.get("section.setting2") == 3.1415
+        assert self.CM.get("section.setting3") == "String"
+        assert self.CM.get("section.setting4") == False
+    
+        self.CM.load("./test2.ini")
+    
+        assert self.CM.get("section.setting1") == 2, self.CM.get("section.setting1")
+        assert self.CM.get("section.setting2") == 8.6
+        assert self.CM.get("section.setting3") == "Another String"
+        assert self.CM.get("section.setting4") == True
+    
+        assert self.CM.get("section2.windows-file") == r"c:\drive\path\o'malley\file.pdf"
+        assert self.CM.get("section2.list") == [1, 2, 3, 4]
+        assert self.CM.get("section2.dict") == {'a': "apple", "b": "banana"}
+        assert self.CM.get("section2.unicode") == "Raötröme"
+
+if __name__ == "__main__":
+    unittest.main()
+
+