Merge lp:~jelmer/brz/config-win32 into lp:brz/3.2

[Jelmer Vernooij]

Require that AppData is known on Windows. (Aleksandr Smyshliaev, Jelmer Vernooij)

Require that AppData is known on Windows.

Derived from lp:~a1s/brz/3.2 (and with appropriate author).

[Aleksandr Smyshliaev (a1s)]

review: Approve

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'breezy/bedding.py'
--- breezy/bedding.py	2020-06-01 19:35:12 +0000
+++ breezy/bedding.py	2022-01-14 14:42:31 +0000
@@ -96,7 +96,13 @@
         if base is None:
             base = win32utils.get_appdata_location()
         if base is None:
-            base = win32utils.get_home_location()
+            # Assume that AppData location is ALWAYS DEFINED,
+            # and don't look for %HOME%, as we aren't sure about
+            # where the files should be stored in %HOME%:
+            # on other platforms the directory is ~/.config/,
+            # but that would be incompatible with older Bazaar versions.
+            raise RuntimeError('Unable to determine AppData location')
+
     if base is None:
         base = os.environ.get('XDG_CONFIG_HOME')
         if base is None:

=== modified file 'breezy/tests/test_bedding.py'
--- breezy/tests/test_bedding.py	2020-06-01 19:35:12 +0000
+++ breezy/tests/test_bedding.py	2022-01-14 14:42:31 +0000
@@ -26,6 +26,8 @@
     tests,
     )
 
+if sys.platform == "win32":
+    from .. import win32utils
 
 def override_whoami(test):
     test.overrideEnv('EMAIL', None)
@@ -96,6 +98,62 @@
                          self.bzr_home + '/authentication.conf')
 
 
+class TestConfigPathFallbackWindows(tests.TestCaseInTempDir):
+
+    def mock_special_folder_path(self, csidl):
+        if csidl == win32utils.CSIDL_APPDATA:
+            return self.appdata
+        elif csidl == win32utils.CSIDL_PERSONAL:
+            return self.test_dir
+        return None
+
+    def setUp(self):
+        if sys.platform != 'win32':
+            raise tests.TestNotApplicable(
+                'This test is specific to Windows platform')
+        super(TestConfigPathFallbackWindows, self).setUp()
+        # Note: No HOME fallback on Windows.  The configs MUST be in AppData,
+        # and we only fall back from breezy to bazaar configuration files.
+        self.appdata = os.path.join(self.test_dir, 'appdata')
+        self.appdata_bzr = os.path.join(self.appdata, 'bazaar', '2.0')
+        os.makedirs(self.appdata_bzr)
+        self.overrideAttr(
+            win32utils, "_get_sh_special_folder_path",
+            self.mock_special_folder_path)
+        # The safety net made by super() has set BZR_HOME and BRZ_HOME
+        # to the temporary directory.  As they take precedence, we need
+        # to erase the variables in order to check Windows special folders.
+        self.overrideEnv('BRZ_HOME', None)
+        self.overrideEnv('BZR_HOME', None)
+
+    def test_config_dir(self):
+        self.assertIsSameRealPath(bedding.config_dir(), self.appdata_bzr)
+
+    def test_config_dir_is_unicode(self):
+        self.assertIsInstance(bedding.config_dir(), str)
+
+    def test_config_path(self):
+        self.assertIsSameRealPath(
+            bedding.config_path(),
+            self.appdata_bzr + '/bazaar.conf')
+        self.overrideAttr(win32utils, "get_appdata_location", lambda: None)
+        self.assertRaises(RuntimeError, bedding.config_path)
+
+    def test_locations_config_path(self):
+        self.assertIsSameRealPath(
+            bedding.locations_config_path(),
+            self.appdata_bzr + '/locations.conf')
+        self.overrideAttr(win32utils, "get_appdata_location", lambda: None)
+        self.assertRaises(RuntimeError, bedding.locations_config_path)
+
+    def test_authentication_config_path(self):
+        self.assertIsSameRealPath(
+            bedding.authentication_config_path(),
+            self.appdata_bzr + '/authentication.conf')
+        self.overrideAttr(win32utils, "get_appdata_location", lambda: None)
+        self.assertRaises(RuntimeError, bedding.authentication_config_path)
+
+
 class TestXDGConfigDir(tests.TestCaseInTempDir):
     # must be in temp dir because config tests for the existence of the bazaar
     # subdirectory of $XDG_CONFIG_HOME