Merge lp:~jelmer/brz/cachedir into lp:brz

[Jelmer Vernooij]

Add osutils.cache_dir function and use it where we create Breezy-specific caches.

Add osutils.cache_dir function and use it where we create Breezy-specific caches.

[Martin Packman (gz)]

Okay. We need to do a bit more tidying up here, can tackle later.

review: Approve

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/241/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/246/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/249/

[Martin Packman (gz)]

Attempting land again to see what the failures were.

[The Breezy Bot (the-breezy-bot)]

Merging failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/349/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/351/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/353/

=== modified file 'breezy/config.py'
--- breezy/config.py	2019-05-11 18:38:21 +0000
+++ breezy/config.py	2019-06-15 15:54:32 +0000
@@ -1560,16 +1560,6 @@
         return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
 
 
-def xdg_cache_dir():
-    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
-    # Possibly this should be different on Windows?
-    e = os.environ.get('XDG_CACHE_HOME', None)
-    if e:
-        return e
-    else:
-        return os.path.expanduser('~/.cache')
-
-
 def _get_default_mail_domain(mailname_file='/etc/mailname'):
     """If possible, return the assumed default email domain.
 

=== modified file 'breezy/git/cache.py'
--- breezy/git/cache.py	2019-02-24 03:46:16 +0000
+++ breezy/git/cache.py	2019-06-15 15:54:32 +0000
@@ -51,13 +51,7 @@
 
 
 def get_cache_dir():
-    try:
-        from xdg.BaseDirectory import xdg_cache_home
-    except ImportError:
-        from ..config import config_dir
-        ret = os.path.join(config_dir(), "git")
-    else:
-        ret = os.path.join(xdg_cache_home, "breezy", "git")
+    ret = os.path.join(osutils.cache_dir(), "git")
     if not os.path.isdir(ret):
         os.makedirs(ret)
     return ret

=== modified file 'breezy/osutils.py'
--- breezy/osutils.py	2019-06-03 21:25:01 +0000
+++ breezy/osutils.py	2019-06-15 15:54:32 +0000
@@ -2634,6 +2634,39 @@
     return False
 
 
+def cache_dir():
+    """Return the cache directory to use."""
+    if sys.platform in ("nt", "win32"):
+        from bzrlib.win32utils import get_local_appdata_location
+        s = get_local_appdata_location()
+        # This can return a unicode string or a plain string in
+        # user encoding
+        if isinstance(s, bytes):
+            s = s.decode(bzrlib.user_encoding)
+        cache_dir = s.encode(_fs_enc)
+    else:
+        try:
+            from xdg import BaseDirectory
+        except ImportError:
+            xdg_cache_dir = os.environ.get('XDG_CACHE_HOME', None)
+        else:
+            xdg_cache_dir = BaseDirectory.xdg_cache_home
+        if xdg_cache_dir is not None:
+            cache_dir = os.path.join(xdg_cache_dir, "breezy")
+        else:
+            cache_dir = None
+        if cache_dir is not None and not isinstance(cache_dir, text_type):
+            cache_dir = cache_dir.encode(_fs_enc)
+
+    if cache_dir is None:
+        cache_dir = os.path.expanduser('~/.cache/breezy')
+
+    if not os.path.exists(cache_dir):
+        os.makedirs(cache_dir)
+
+    return cache_dir
+
+
 def get_fs_type(path):
     """Return the filesystem type for the partition a path is in.
 

=== modified file 'breezy/plugins/launchpad/lp_api.py'
--- breezy/plugins/launchpad/lp_api.py	2019-05-29 09:48:08 +0000
+++ breezy/plugins/launchpad/lp_api.py	2019-06-15 15:54:32 +0000
@@ -88,7 +88,7 @@
 
 def get_cache_directory():
     """Return the directory to cache launchpadlib objects in."""
-    return osutils.pathjoin(config.config_dir(), 'launchpad')
+    return osutils.pathjoin(osutils.cache_dir(), 'launchpad')
 
 
 def parse_launchpadlib_version(version_number):

=== modified file 'breezy/plugins/launchpad/test_lp_api.py'
--- breezy/plugins/launchpad/test_lp_api.py	2018-12-19 01:29:48 +0000
+++ breezy/plugins/launchpad/test_lp_api.py	2019-06-15 15:54:32 +0000
@@ -77,7 +77,7 @@
 
     def test_get_cache_directory(self):
         # get_cache_directory returns the path to a directory inside the
-        # Bazaar configuration directory.
+        # Breezy cache directory.
         from . import lp_api
-        expected_path = osutils.pathjoin(config.config_dir(), 'launchpad')
+        expected_path = osutils.pathjoin(osutils.cache_dir(), 'launchpad')
         self.assertEqual(expected_path, lp_api.get_cache_directory())

=== modified file 'breezy/tests/test_config.py'
--- breezy/tests/test_config.py	2018-11-17 16:53:10 +0000
+++ breezy/tests/test_config.py	2019-06-15 15:54:32 +0000
@@ -550,10 +550,6 @@
         self.assertEqual(config.authentication_config_filename(),
                          self.brz_home + '/authentication.conf')
 
-    def test_xdg_cache_dir(self):
-        self.assertEqual(config.xdg_cache_dir(),
-                         '/home/bogus/.cache')
-
 
 class TestConfigPathFallback(tests.TestCaseInTempDir):
 
@@ -582,10 +578,6 @@
         self.assertEqual(config.authentication_config_filename(),
                          self.bzr_home + '/authentication.conf')
 
-    def test_xdg_cache_dir(self):
-        self.assertEqual(config.xdg_cache_dir(),
-                         os.path.join(self.test_dir, '.cache'))
-
 
 class TestXDGConfigDir(tests.TestCaseInTempDir):
     # must be in temp dir because config tests for the existence of the bazaar

=== modified file 'breezy/tests/test_osutils.py'
--- breezy/tests/test_osutils.py	2019-03-04 00:16:27 +0000
+++ breezy/tests/test_osutils.py	2019-06-15 15:54:32 +0000
@@ -2344,6 +2344,49 @@
             pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))
 
 
+class TestXDGCacheDir(tests.TestCaseInTempDir):
+    # must be in temp dir because tests for the existence of the breezy
+    # subdirectory of $XDG_CACHE_HOME
+
+    def setUp(self):
+        super(TestXDGCacheDir, self).setUp()
+        if sys.platform in ('darwin', 'win32'):
+            raise tests.TestNotApplicable(
+                'XDG cache dir not used on this platform')
+        self.overrideEnv('HOME', self.test_home_dir)
+        # BZR_HOME overrides everything we want to test so unset it.
+        self.overrideEnv('BZR_HOME', None)
+
+    def test_xdg_cache_dir_exists(self):
+        """When ~/.cache/breezy exists, use it as the cache dir."""
+        cachedir = osutils.pathjoin(self.test_home_dir, '.cache')
+        newdir = osutils.pathjoin(cachedir, 'breezy')
+        try:
+            from xdg import BaseDirectory
+        except ImportError:
+            pass
+        else:
+            self.overrideAttr(BaseDirectory, "xdg_cache_home", cachedir)
+        os.makedirs(newdir)
+        self.assertEqual(osutils.cache_dir(), newdir)
+
+    def test_xdg_cache_home_unix(self):
+        """When XDG_CACHE_HOME is set, use it."""
+        if sys.platform in ('nt', 'win32'):
+            raise tests.TestNotApplicable(
+                'XDG cache dir not used on this platform')
+        xdgcachedir = osutils.pathjoin(self.test_home_dir, 'xdgcache')
+        self.overrideEnv('XDG_CACHE_HOME', xdgcachedir)
+        try:
+            from xdg import BaseDirectory
+        except ImportError:
+            pass
+        else:
+            self.overrideAttr(BaseDirectory, "xdg_cache_home", xdgcachedir)
+        newdir = osutils.pathjoin(xdgcachedir, 'breezy')
+        os.makedirs(newdir)
+        self.assertEqual(osutils.cache_dir(), newdir)
+
 class SupportsExecutableTests(tests.TestCaseInTempDir):
 
     def test_returns_bool(self):