Add support for XDG_CONFIG_HOME

b2sdk/account_info/sqlite_account_info.py

@@ -34,17 +34,28 @@ class SqliteAccountInfo(UrlPoolAccountInfo):
     completed.
     """
 
-    def __init__(self, file_name=None, last_upgrade_to_run=None):
+    def __init__(self, file_name=None, env=os.environ, last_upgrade_to_run=None):
         """
-        If ``file_name`` argument is empty or ``None``, path from ``B2_ACCOUNT_INFO`` environment variable is used. If that is not available, a default of ``~/.b2_account_info`` is used.
+        If ``file_name`` argument is empty or ``None``, the path from
+        ``B2_ACCOUNT_INFO`` environment variable is used.  If that is not
+        available, we check if the default ``~/.b2_account_info`` exists to
+        ensure backwards compatibility, before using ``XDG_CONFIG_HOME``. If
+        ``XDG_CONFIG_HOME`` is not set, we fall back to the default.
 
         :param str file_name: The sqlite file to use; overrides the default.
+        :param dict env: Override Environment variables. For testing only.
         :param int last_upgrade_to_run: For testing only, override the auto-update on the db.
         """
         self.thread_local = threading.local()
-        user_account_info_path = file_name or os.environ.get(
-            B2_ACCOUNT_INFO_ENV_VAR, B2_ACCOUNT_INFO_DEFAULT_FILE
-        )
+        if B2_ACCOUNT_INFO_ENV_VAR in env:
+            user_account_info_path = env[B2_ACCOUNT_INFO_ENV_VAR]
+        elif 'XDG_CONFIG_HOME' in env and not os.path.exists(
+            os.path.expanduser(B2_ACCOUNT_INFO_DEFAULT_FILE)
+        ):
+            user_account_info_path = os.path.join(env['XDG_CONFIG_HOME'], 'b2', 'account_info')
+            os.makedirs(os.path.join(env['XDG_CONFIG_HOME'], 'b2'), mode=0o755, exist_ok=True)
+        else:
+            user_account_info_path = B2_ACCOUNT_INFO_DEFAULT_FILE
         self.filename = file_name or os.path.expanduser(user_account_info_path)
         logger.debug('%s file path to use: %s', self.__class__.__name__, self.filename)
         self._validate_database()

test/v1/test_account_info.py

@@ -21,7 +21,7 @@
 
 from .test_base import TestBase
 
-from .deps import AbstractAccountInfo, InMemoryAccountInfo, UploadUrlPool, SqliteAccountInfo
+from .deps import B2_ACCOUNT_INFO_ENV_VAR, AbstractAccountInfo, InMemoryAccountInfo, UploadUrlPool, SqliteAccountInfo
 from .deps_exception import CorruptAccountInfo, MissingAccountData
 
 try:
@@ -292,11 +292,39 @@ def test_upgrade_2_default_app_key(self):
     def _make_info(self):
         return self._make_sqlite_account_info()
 
-    def _make_sqlite_account_info(self, last_upgrade_to_run=None):
+    def _make_sqlite_account_info(self, env=None, last_upgrade_to_run=None):
         """
-        Returns a new StoredAccountInfo that has just read the data from the file.
+        Returns a new SqliteAccountInfo that has just read the data from the file.
         """
-        return SqliteAccountInfo(file_name=self.db_path, last_upgrade_to_run=None)
+        return SqliteAccountInfo(
+            file_name=self.db_path if not env else None,
+            env=env or {},
+            last_upgrade_to_run=last_upgrade_to_run
+        )
 
     def test_account_info_persistence(self):
         self._test_account_info(check_persistence=True)
+
+    def test_uses_xdg_config_home(self):
+        with tempfile.TemporaryDirectory() as d:
+            account_info = self._make_sqlite_account_info(env={'XDG_CONFIG_HOME': d})
+            expected_path = os.path.abspath(os.path.join(d, 'b2', 'account_info'))
+            actual_path = os.path.abspath(account_info.filename)
+            assert expected_path == actual_path, 'Actual path %s is not equal to $XDG_CONFIG_HOME/b2/account_info'
+            assert os.path.exists(
+                os.path.join(d, 'b2')
+            ), 'Config folder $XDG_CONFIG_HOME/b2 was not created!'
+
+    def test_account_info_env_var_overrides_xdg_config_home(self):
+        with tempfile.TemporaryDirectory() as d:
+            account_info = self._make_sqlite_account_info(
+                env={
+                    'XDG_CONFIG_HOME': d,
+                    B2_ACCOUNT_INFO_ENV_VAR: os.path.join(d, 'b2_account_info')
+                }
+            )
+            expected_path = os.path.abspath(os.path.join(d, 'b2_account_info'))
+            actual_path = os.path.abspath(account_info.filename)
+            assert expected_path == actual_path, 'Actual path {path} is not equal to ${var}'.format(
+                path=actual_path, var=B2_ACCOUNT_INFO_ENV_VAR
+            )