Merge lp:~mblayman/entertainer/new-old-config into lp:~rockstar/entertainer/new-indexer-that-doesnt-suck

[Matt Layman]

Configuration now has simpler behavior.

[Matt Layman (mblayman)]

Paul, here you go. A fresh new version of config that makes the indexer pass its tests.

=== modified file 'entertainerlib/configuration.py'
--- entertainerlib/configuration.py	2009-06-30 04:16:45 +0000
+++ entertainerlib/configuration.py	2009-07-02 20:58:37 +0000
@@ -32,33 +32,19 @@
     """
 
     CFG_DIR = os.path.expanduser("~/.config/entertainer")
-    TEST_DIR = None
-
-    # This dictionary keeps track of data values that are written to config
-    # files but need to be returned to a known state while testing.
-    _tainted = {}
-
-    # This dictionary keeps track of data values that are tainted in memory
-    # instead of a config file
-    _tainted_in_memory = {}
 
     _shared_state = {}
 
     def __init__(self, test_dir=None):
-        """
-        Read configuration files and setup this object.
-        """
         self.__dict__ = self._shared_state
         MessageHandler.__init__(self)
 
-        if not self._shared_state:
-            self.TEST_DIR = test_dir
-
+        if not self._shared_state or test_dir is not None:
             # Set in a production mode or a test mode
-            if self.TEST_DIR is None:
+            if test_dir is None:
                 self.cfg_dir = self.CFG_DIR
             else:
-                self.cfg_dir = self.TEST_DIR
+                self.cfg_dir = test_dir
 
             if not os.path.exists(os.path.expanduser(self.cfg_dir)):
                 self.create_cfg_dir()
@@ -160,11 +146,8 @@
         except IOError:
             raise IOError("Couldn't read config file.")
 
-    def write_content_value(self, section, option, value, sanitize=False):
+    def write_content_value(self, section, option, value):
         """Write a new value to the content configuration file."""
-        if self.TEST_DIR and not sanitize:
-            self.taint('content', section, option)
-
         try:
             self.content_config.set(section, option, value)
             cfg_file = file(self.content_conf, 'w')
@@ -174,11 +157,8 @@
         except NoOptionError:
             raise Exception("No Option to set in content.conf file")
 
-    def write_preference_value(self, section, option, value, sanitize=False):
+    def write_preference_value(self, section, option, value):
         """Write a new value to the preferences configuration file."""
-        if self.TEST_DIR and not sanitize:
-            self.taint('preferences', section, option)
-
         try:
             self.preferences.set(section, option, value)
             cfg_file = file(self.preferences_conf, 'w')
@@ -200,14 +180,8 @@
 
         return self.stage_width
 
-    def set_stage_width(self, new_width, sanitize=False):
+    def set_stage_width(self, new_width):
         '''Set the stage width for the in memory instance'''
-        # Taint data if in test mode
-        if self.TEST_DIR and not sanitize:
-            kwargs = {'new_width' : self.get_stage_width(),
-                'sanitize' : True}
-            self.taint_in_memory(self.set_stage_width, kwargs)
-
         self.stage_width = new_width
 
     def get_stage_height(self):
@@ -223,14 +197,8 @@
 
         return self.stage_height
 
-    def set_stage_height(self, new_height, sanitize=False):
+    def set_stage_height(self, new_height):
         '''Set the stage height for the in memory instance'''
-        # Taint data if in test mode
-        if self.TEST_DIR and not sanitize:
-            kwargs = {'new_height' : self.get_stage_height(),
-                'sanitize' : True}
-            self.taint_in_memory(self.set_stage_height, kwargs)
-
         self.stage_height = new_height
 
     def get_theme_path(self):
@@ -503,53 +471,6 @@
         """
         return self.cfg_dir
 
-    def taint(self, kind, section, option):
-        '''Taint any data that is written to config files so that it can be
-        returned to a known state later'''
-        if kind == 'content':
-            value = self.content_config.get(section, option)
-        elif kind == 'preferences':
-            value = self.preferences.get(section, option)
-        else:
-            raise Exception(
-                "Taint type must be either 'content' or 'preferences'")
-
-        key = "%s %s %s" % (kind, section, option)
-        self._tainted[key] = value
-
-    def taint_in_memory(self, callback, kwargs):
-        '''Taint any data that is stored in memory. Callback is used as the
-        key to a tainted_in_memory dictionary whose stored value is a
-        dictionary of arguments (kwargs) needed to restore the original
-        value'''
-        self._tainted_in_memory[callback] = kwargs
-
-    def sanitize(self):
-        '''Restore all tainted values to their original state and clear the
-        tainted dictionary'''
-        # Sanitize values in config files
-        for key in self._tainted.keys():
-            # tokens will contain type, section, and option
-            tokens = key.split()
-            if tokens[0] == 'content':
-                # Write in the sanitize mode so taint checking will be skipped
-                self.write_content_value(tokens[1], tokens[2],
-                    self._tainted[key], sanitize=True)
-            elif tokens[0] == 'preferences':
-                # Write in the sanitize mode so taint checking will be skipped
-                self.write_preference_value(tokens[1], tokens[2],
-                    self._tainted[key], sanitize=True)
-
-        self.update_configuration()
-        self._tainted = {}
-
-        # Sanitize values in memory
-        for callback in self._tainted_in_memory.keys():
-            kwargs = self._tainted_in_memory[callback]
-            callback(**kwargs)
-
-        self._tainted_in_memory = {}
-
     def _is_valid_media_folder(self, folder_list):
         """Return a folder list where eventual cache folders are removed"""
         cache_dir = os.path.join(self.get_cfg_dir(), 'cache')

=== modified file 'entertainerlib/tests/__init__.py'
--- entertainerlib/tests/__init__.py	2009-05-10 17:36:49 +0000
+++ entertainerlib/tests/__init__.py	2009-07-02 20:58:37 +0000
@@ -20,7 +20,7 @@
         '''Set up the basic file I/O requirements.'''
         self.test_dir = self.get_temp_file()
         os.mkdir(self.test_dir)
-        self.test_cfg_dir = '/tmp/cfg_dir'
+        self.test_cfg_dir = self.get_temp_file()
         self.config = Configuration(self.test_cfg_dir)
         self.data_dir = os.path.dirname(__file__) + '/data'
 
@@ -40,10 +40,6 @@
             filename = create_new_filename()
         return filename
 
-    def tearDown(self):
-        '''Sanitize any data that will be reused'''
-        self.config.sanitize()
-
 
 class EntertainerTestWithDatabase(EntertainerTest):
     '''Test that requires a database'''

=== modified file 'entertainerlib/tests/test_configuration.py'
--- entertainerlib/tests/test_configuration.py	2009-06-30 01:06:01 +0000
+++ entertainerlib/tests/test_configuration.py	2009-07-02 20:58:37 +0000
@@ -40,12 +40,6 @@
         self.configuration.set_stage_width(new_width)
         self.assertEqual(self.configuration.get_stage_width(), new_width)
 
-        # Test that the value is properly tainted
-        self.assertEqual(
-            self.configuration._tainted_in_memory[
-                self.configuration.set_stage_width],
-            {'new_width' : 1366, 'sanitize' : True})
-
     def testGetStageHeight(self):
         '''Test getting the stage height'''
         self.assertEqual(self.configuration.get_stage_height(), 768)
@@ -56,15 +50,9 @@
         self.configuration.set_stage_height(new_height)
         self.assertEqual(self.configuration.get_stage_height(), new_height)
 
-        # Test that the value is properly tainted
-        self.assertEqual(
-            self.configuration._tainted_in_memory[
-                self.configuration.set_stage_height],
-            {'new_height' : 768, 'sanitize' : True})
-
     def testGetCfgDir(self):
         """Test getting the cfg dir"""
-        self.assertEqual(self.configuration.get_cfg_dir(), self.config.TEST_DIR)
+        self.assertEqual(self.configuration.get_cfg_dir(), self.test_cfg_dir)
 
     def testTrayIconEnabled(self):
         """Test getting the display_icon boolean"""
@@ -77,11 +65,6 @@
         self.configuration.update_configuration()
         self.assertEqual(self.configuration.get_weather_location(), new_value)
 
-        # Test that the value is properly tainted
-        self.assertEqual(
-            self.configuration._tainted['content Weather location'],
-            'Bath,England')
-
     def test_write_preference_value(self):
         """Test writing a value to the preference configuration file"""
         new_value = True
@@ -90,11 +73,6 @@
         self.configuration.update_configuration()
         self.assertEqual(self.configuration.tray_icon_enabled(), new_value)
 
-        # Test that the value is properly tainted
-        self.assertEqual(
-            self.configuration._tainted['preferences General display_icon'],
-            'False')
-
     def testGetThemeName(self):
         """Test getting the current theme name"""
         current_name = "Default"
@@ -113,53 +91,3 @@
         self.assertEqual(self.configuration.display_hidden_files_folders(),
             False)
 
-    def test_taint(self):
-        '''Test tainting configuration data'''
-        # Test tainting preferences data
-        kind = 'preferences'
-        section = 'General'
-        option = 'history_size'
-        self.configuration.taint(kind, section, option)
-        key = "%s %s %s" % (kind, section, option)
-        self.assertEqual(self.configuration._tainted[key], '8')
-
-        # Test tainting content data
-        kind = 'content'
-        section = 'Videos'
-        option = 'download_metadata'
-        self.configuration.taint(kind, section, option)
-        key = "%s %s %s" % (kind, section, option)
-        self.assertEqual(self.configuration._tainted[key], 'True')
-
-        # Test the bad branch
-        kind = 'bogus'
-        self.assertRaises(Exception, self.configuration.taint, kind, section,
-            option)
-
-    def test_taint_in_memory(self):
-        '''Test tainting data already in memory'''
-        value = 'test'
-
-        def set_value(value):
-            '''Dummy method used as a key'''
-
-        kwargs = {'value' : value}
-        self.configuration.taint_in_memory(set_value, kwargs)
-        self.assertEqual(self.configuration._tainted_in_memory[set_value],
-            kwargs)
-
-    def test_sanitize(self):
-        '''Test sanitizing configuration data'''
-        # Test sanitizing for config file data
-        new_value = 15
-        self.configuration.write_preference_value(
-            "General", "history_size", new_value)
-        self.configuration.update_configuration()
-        self.configuration.sanitize()
-        self.assertEqual(self.configuration.history_size(), 8)
-
-        # Test sanitizing in memory data
-        self.configuration.set_stage_height(400)
-        self.configuration.sanitize()
-        self.assertEqual(self.configuration.get_stage_height(), 768)
-

=== modified file 'entertainerlib/tests/test_indexer.py'
--- entertainerlib/tests/test_indexer.py	2009-06-30 05:37:55 +0000
+++ entertainerlib/tests/test_indexer.py	2009-07-02 21:10:03 +0000
@@ -3,14 +3,14 @@
 
 from entertainerlib.configuration import Configuration
 from entertainerlib.indexing.handlers import AviHandler
-#from entertainerlib.indexing.indexer import Indexer
+from entertainerlib.indexing.indexer import Indexer
 from entertainerlib.tests import EntertainerTest
 
 
 class IndexerTest(EntertainerTest):
     '''Tests for `entertainerlib.indexing.indexer`.'''
 
-    def DISABLEDtest_constructor(self):
+    def test_constructor(self):
         '''Test the Indexer constructor.'''
         indexer = Indexer()
         self.assertTrue(isinstance(indexer, Indexer))
@@ -18,7 +18,7 @@
         self.assertTrue(isinstance(indexer.logger, Logger))
         self.assertTrue(isinstance(indexer.configuration, Configuration))
 
-    def DISABLEDtest_supported_filetypes(self):
+    def test_supported_filetypes(self):
         '''Test Indexer.supported_filetypes.'''
         indexer = Indexer()
         self.assertEquals(len(indexer.supported_filetypes), 14)
@@ -26,24 +26,24 @@
             ['avi', 'jpeg', 'jpg', 'm4v', 'mkv', 'mov', 'mp3', 'mp4', 'mpeg',
                 'mpg', 'ogg', 'ogm', 'png', 'wmv'])
 
-    def DISABLEDtest_valid_get_filetype_handler(self):
+    def test_valid_get_filetype_handler(self):
         '''Test Indexer.get_filetype_handler with a valid filetype.'''
         indexer = Indexer()
         self.assertTrue(type(indexer.get_filetype_handler('avi')),
             AviHandler)
 
-    def DISABLEDtest_invalid_get_filetype_handler(self):
+    def test_invalid_get_filetype_handler(self):
         '''Test Indexer.get_filetype_handler with an invalid filetype.'''
         indexer = Indexer()
         self.assertEquals(indexer.get_filetype_handler('aeiou'), None)
 
-    def DISABLEDtest_is_supported_filetype(self):
+    def test_is_supported_filetype(self):
         '''Test Indexer.is_supported_filetype with a supported filetype.'''
         indexer = Indexer()
         self.assertTrue(indexer.is_supported_filetype('foo.avi'))
         self.assertTrue(indexer.is_supported_filetype('baz.bar.mp3'))
 
-    def DISABLEDtest_is_not_supported_filetype(self):
+    def test_is_not_supported_filetype(self):
         '''Test Indexer.is_supported_filetype with an unsupported filetype.'''
         indexer = Indexer()
         self.assertFalse(indexer.is_supported_filetype('not.aeiou'))