mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-03 13:45:31 +00:00
Code Issues Releases Wiki Activity

point XDG_*_HOME to temp dirs for tests, fixes #1714

Browse source 
otherwise it spoils the user's nonces and cache dirs with lots of files.

also: remove all BORG_* env vars from the outer environment
This commit is contained in:
Thomas Waldmann 2016-10-13 23:59:28 +02:00
parent a2dfe68609
commit 4e4847ccce
4 changed files with 21 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
conftest.py
View file

@ -1,5 +1,7 @@
import os
import pytest
from borg.logger import setup_logging
# Ensure that the loggers exist for all tests
@ -16,6 +18,17 @@ def pytest_configure(config):
constants.PBKDF2_ITERATIONS = 1
@pytest.fixture(autouse=True)
def clean_env(tmpdir_factory, monkeypatch):
# avoid that we access / modify the user's normal .config / .cache directory:
monkeypatch.setenv('XDG_CONFIG_HOME', tmpdir_factory.mktemp('xdg-config-home'))
monkeypatch.setenv('XDG_CACHE_HOME', tmpdir_factory.mktemp('xdg-cache-home'))
# also avoid to use anything from the outside environment:
keys = [key for key in os.environ if key.startswith('BORG_')]
for key in keys:
monkeypatch.delenv(key, raising=False)
def pytest_report_header(config, startdir):
tests = {
"BSD flags": has_lchflags,

31
src/borg/testsuite/helpers.py
View file

@ -605,44 +605,29 @@ def test(self):
self.assert_equal(parse_timestamp('2015-04-19T20:25:00'), datetime(2015, 4, 19, 20, 25, 0, 0, timezone.utc))
def test_get_cache_dir():
def test_get_cache_dir(monkeypatch):
"""test that get_cache_dir respects environment"""
# reset BORG_CACHE_DIR in order to test default
old_env = None
if os.environ.get('BORG_CACHE_DIR'):
old_env = os.environ['BORG_CACHE_DIR']
del(os.environ['BORG_CACHE_DIR'])
monkeypatch.delenv('XDG_CACHE_HOME', raising=False)
assert get_cache_dir() == os.path.join(os.path.expanduser('~'), '.cache', 'borg')
os.environ['XDG_CACHE_HOME'] = '/var/tmp/.cache'
monkeypatch.setenv('XDG_CACHE_HOME', '/var/tmp/.cache')
assert get_cache_dir() == os.path.join('/var/tmp/.cache', 'borg')
os.environ['BORG_CACHE_DIR'] = '/var/tmp'
monkeypatch.setenv('BORG_CACHE_DIR', '/var/tmp')
assert get_cache_dir() == '/var/tmp'
# reset old env
if old_env is not None:
os.environ['BORG_CACHE_DIR'] = old_env
def test_get_keys_dir():
def test_get_keys_dir(monkeypatch):
"""test that get_keys_dir respects environment"""
# reset BORG_KEYS_DIR in order to test default
old_env = None
if os.environ.get('BORG_KEYS_DIR'):
old_env = os.environ['BORG_KEYS_DIR']
del(os.environ['BORG_KEYS_DIR'])
monkeypatch.delenv('XDG_CONFIG_HOME', raising=False)
assert get_keys_dir() == os.path.join(os.path.expanduser('~'), '.config', 'borg', 'keys')
os.environ['XDG_CONFIG_HOME'] = '/var/tmp/.config'
monkeypatch.setenv('XDG_CONFIG_HOME', '/var/tmp/.config')
assert get_keys_dir() == os.path.join('/var/tmp/.config', 'borg', 'keys')
os.environ['BORG_KEYS_DIR'] = '/var/tmp'
monkeypatch.setenv('BORG_KEYS_DIR', '/var/tmp')
assert get_keys_dir() == '/var/tmp'
# reset old env
if old_env is not None:
os.environ['BORG_KEYS_DIR'] = old_env
def test_get_nonces_dir(monkeypatch):
"""test that get_nonces_dir respects environment"""
monkeypatch.delenv('XDG_CONFIG_HOME', raising=False)
monkeypatch.delenv('BORG_NONCES_DIR', raising=False)
assert get_nonces_dir() == os.path.join(os.path.expanduser('~'), '.config', 'borg', 'key-nonces')
monkeypatch.setenv('XDG_CONFIG_HOME', '/var/tmp/.config')
assert get_nonces_dir() == os.path.join('/var/tmp/.config', 'borg', 'key-nonces')

11
src/borg/testsuite/key.py
View file

@ -14,17 +14,6 @@
from ..key import PlaintextKey, PassphraseKey, KeyfileKey, Passphrase, PasswordRetriesExceeded, bin_to_hex
@pytest.fixture(autouse=True)
def clean_env(monkeypatch):
# Workaround for some tests (testsuite/archiver) polluting the environment
monkeypatch.delenv('BORG_PASSPHRASE', False)
@pytest.fixture(autouse=True)
def nonce_dir(tmpdir_factory, monkeypatch):
monkeypatch.setenv('XDG_CONFIG_HOME', tmpdir_factory.mktemp('xdg-config-home'))
class TestKey:
class MockArgs:
location = Location(tempfile.mkstemp()[1])

11
src/borg/testsuite/nonces.py
View file

@ -10,17 +10,6 @@
from .. import nonces # for monkey patching NONCE_SPACE_RESERVATION
@pytest.fixture(autouse=True)
def clean_env(monkeypatch):
# Workaround for some tests (testsuite/archiver) polluting the environment
monkeypatch.delenv('BORG_PASSPHRASE', False)
@pytest.fixture(autouse=True)
def nonce_dir(tmpdir_factory, monkeypatch):
monkeypatch.setenv('XDG_CONFIG_HOME', tmpdir_factory.mktemp('xdg-config-home'))
class TestNonceManager:
class MockRepository: