Refactor OverridePreferencesTestCase (#256)

* Fix test case module name

* Refactor OverridePreferencesTestCase

Author: deathaxe

tests/test_override_preferences_test_case.py

@@ -0,0 +1,47 @@
+import os
+import sublime
+
+from unittesting import OverridePreferencesTestCase
+
+
+class PreferencesTestCase(OverridePreferencesTestCase):
+    SETTINGS_FILE = "_UnitTestingTest.sublime-settings"
+    SETTINGS_PATH = os.path.join(sublime.packages_path(), "User", SETTINGS_FILE)
+
+    override_preferences = {
+        SETTINGS_FILE: {
+            "enable": True,
+            "list": ["one", "two", "three"]
+        }
+    }
+
+    @classmethod
+    def setUpClass(cls):
+        settings = sublime.load_settings(cls.SETTINGS_FILE)
+        settings.set("enable", False)
+        settings.set("list", ["foo"])
+        sublime.save_settings(cls.SETTINGS_FILE)
+        yield 500  # give ST some time to load initial settings file
+        yield from super().setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        yield from super().tearDownClass()
+        os.remove(cls.SETTINGS_PATH)
+
+    def test_backup_exists(self):
+        self.assertTrue(os.path.isfile(self.SETTINGS_PATH + ".bak"))
+
+    def test_override_exists(self):
+        self.assertTrue(os.path.isfile(self.SETTINGS_PATH))
+
+    def test_enabled(self):
+        settings = sublime.load_settings(self.SETTINGS_FILE)
+        self.assertTrue(settings.get("enable"))
+
+    def test_list_setting(self):
+        settings = sublime.load_settings(self.SETTINGS_FILE)
+        self.assertEqual(
+            self.override_preferences[self.SETTINGS_FILE]["list"],
+            settings.get("list")
+        )

unittesting/helpers/__init__.py

@@ -1,5 +1,12 @@
 # noqa: F401
-from .override_preferences_test_cast import OverridePreferencesTestCase
+from .override_preferences_test_case import OverridePreferencesTestCase
 from .temp_directory_test_case import TempDirectoryTestCase
 from .view_test_case import DeferrableViewTestCase
 from .view_test_case import ViewTestCase
+
+__all__ = [
+    "DeferrableViewTestCase",
+    "OverridePreferencesTestCase",
+    "TempDirectoryTestCase",
+    "ViewTestCase",
+]

unittesting/helpers/override_preferences_test_cast.py unittesting/helpers/override_preferences_test_case.py

@@ -1,6 +1,4 @@
 import os
-import json
-import shutil
 import sublime
 
 from ..core import DeferrableMethod
@@ -17,38 +15,43 @@ def setUpClass(cls):
             new_settings_path = settings_path + ".bak"
 
             s = sublime.load_settings(settings_file_name)
-            on_change_key = settings_file_name + "catch_on_change"
+            on_change_key = settings_file_name + ".catch_on_change"
             caught = [False]
             s.add_on_change(on_change_key, lambda: caught.__setitem__(0, True))
-
-            if os.path.exists(settings_path):
-                shutil.move(settings_path, new_settings_path)
+            try:
+                try:
+                    os.remove(new_settings_path)
+                except FileNotFoundError:
+                    pass
+                try:
+                    os.rename(settings_path, new_settings_path)
+                except FileNotFoundError:
+                    pass
                 yield lambda: caught[0]
-                yield 500
-
-            caught = [False]
-            with open(settings_path, "w") as f:
-                f.write(json.dumps(settings))
-            yield lambda: caught[0]
-            yield 500
-            s.clear_on_change(on_change_key)
+                caught = [False]
+                with open(settings_path, "w", encoding="utf-8") as f:
+                    f.write(sublime.encode_value(settings, True))
+                yield lambda: caught[0]
+            finally:
+                s.clear_on_change(on_change_key)
 
         deferred = super().setUpClass()
         if isinstance(deferred, DeferrableMethod):
             yield from deferred
 
     @classmethod
     def tearDownClass(cls):
-        for settings_file_name, settings in cls.override_preferences.items():
+        for settings_file_name in cls.override_preferences:
             settings_path = os.path.join(sublime.packages_path(), "User", settings_file_name)
             new_settings_path = settings_path + ".bak"
-            if os.path.exists(new_settings_path):
-                shutil.move(new_settings_path, settings_path)
-            else:
-                try:
-                    os.unlink(settings_path)
-                except Exception:
-                    pass
+            try:
+                os.remove(settings_path)
+            except FileNotFoundError:
+                pass
+            try:
+                os.rename(new_settings_path, settings_path)
+            except FileNotFoundError:
+                pass
 
         deferred = super().tearDownClass()
         if isinstance(deferred, DeferrableMethod):