nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-05-27 10:44:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

backups: Minor refactoring

Browse Source 
- Mark some methods private.

- Fix some flake8 warnings.

- Remove unused exception.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Sunil Mohan Adapa 2019-01-30 12:24:49 -08:00 committed by James Valleroy
parent de22c79665
commit eb2b3bd86e
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
2 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
actions/backups
View File

@ -32,10 +32,6 @@ from plinth.modules.backups import MANIFESTS_FOLDER
TIMEOUT = 5 TIMEOUT = 5
class AlreadyMountedError(Exception):
pass
def parse_arguments(): def parse_arguments():
"""Return parsed command line arguments as dictionary.""" """Return parsed command line arguments as dictionary."""
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
@ -103,7 +99,7 @@ def subcommand_setup(arguments):
"""Create repository if it does not already exist.""" """Create repository if it does not already exist."""
try: try:
run(['borg', 'info', arguments.path], arguments=arguments, check=True) run(['borg', 'info', arguments.path], arguments=arguments, check=True)
except: except subprocess.CalledProcessError:
path = os.path.dirname(arguments.path) path = os.path.dirname(arguments.path)
if not os.path.exists(path): if not os.path.exists(path):
os.makedirs(path) os.makedirs(path)

34
plinth/modules/backups/repository.py
View File

@ -83,13 +83,13 @@ class BorgRepository():
self.credentials = credentials self.credentials = credentials
@staticmethod @staticmethod
def _append_encryption_passphrase(arguments, credentials): def _get_encryption_arguments(credentials):
"""Append '--encryption-passphrase' argument to backups call""" """Return '--encryption-passphrase' argument to backups call."""
passphrase = credentials.get('encryption_passphrase', None) passphrase = credentials.get('encryption_passphrase', None)
if passphrase: if passphrase:
arguments += ['--encryption-passphrase', passphrase] return ['--encryption-passphrase', passphrase]
return arguments return []
@property @property
def repo_path(self): def repo_path(self):
@ -125,7 +125,7 @@ class BorgRepository():
return repository return repository
def delete_archive(self, archive_name): def delete_archive(self, archive_name):
archive_path = self.get_archive_path(archive_name) archive_path = self._get_archive_path(archive_name)
self.run(['delete-archive', '--path', archive_path]) self.run(['delete-archive', '--path', archive_path])
def remove_repository(self): def remove_repository(self):
@ -133,7 +133,7 @@ class BorgRepository():
raise NotImplementedError raise NotImplementedError
def create_archive(self, archive_name, app_names): def create_archive(self, archive_name, app_names):
archive_path = self.get_archive_path(archive_name) archive_path = self._get_archive_path(archive_name)
passphrase = self.credentials.get('encryption_passphrase', None) passphrase = self.credentials.get('encryption_passphrase', None)
api.backup_apps(_backup_handler, path=archive_path, api.backup_apps(_backup_handler, path=archive_path,
app_names=app_names, encryption_passphrase=passphrase) app_names=app_names, encryption_passphrase=passphrase)
@ -142,9 +142,8 @@ class BorgRepository():
self.run(['init', '--path', self.repo_path, '--encryption', 'none']) self.run(['init', '--path', self.repo_path, '--encryption', 'none'])
def get_zipstream(self, archive_name): def get_zipstream(self, archive_name):
archive_path = self.get_archive_path(archive_name) args = ['export-tar', '--path', self._get_archive_path(archive_name)]
args = ['export-tar', '--path', archive_path] args += self._get_encryption_arguments(self.credentials)
args = self._append_encryption_passphrase(args, self.credentials)
proc = self._run('backups', args, run_in_background=True) proc = self._run('backups', args, run_in_background=True)
return zipstream.ZipStream(proc.stdout, 'readline') return zipstream.ZipStream(proc.stdout, 'readline')
@ -156,19 +155,20 @@ class BorgRepository():
def get_archive_apps(self, archive_name): def get_archive_apps(self, archive_name):
"""Get list of apps included in an archive.""" """Get list of apps included in an archive."""
archive_path = self.get_archive_path(archive_name) archive_path = self._get_archive_path(archive_name)
output = self.run(['get-archive-apps', '--path', archive_path]) output = self.run(['get-archive-apps', '--path', archive_path])
return output.splitlines() return output.splitlines()
def restore_archive(self, archive_name, apps=None): def restore_archive(self, archive_name, apps=None):
archive_path = self.get_archive_path(archive_name) archive_path = self._get_archive_path(archive_name)
passphrase = self.credentials.get('encryption_passphrase', None) passphrase = self.credentials.get('encryption_passphrase', None)
api.restore_apps(restore_archive_handler, app_names=apps, api.restore_apps(restore_archive_handler, app_names=apps,
create_subvolume=False, backup_file=archive_path, create_subvolume=False, backup_file=archive_path,
encryption_passphrase=passphrase) encryption_passphrase=passphrase)
def get_archive_path(self, archive_name): def _get_archive_path(self, archive_name):
return "::".join([self.repo_path, archive_name]) """Return full borg path for an archive."""
return '::'.join([self.repo_path, archive_name])
def _run(self, cmd, arguments, superuser=True, **kwargs): def _run(self, cmd, arguments, superuser=True, **kwargs):
"""Run a backups or sshfs action script command.""" """Run a backups or sshfs action script command."""
@ -252,8 +252,9 @@ class SshBorgRepository(BorgRepository):
['is-mounted', '--mountpoint', self.mountpoint]) ['is-mounted', '--mountpoint', self.mountpoint])
return json.loads(output) return json.loads(output)
def get_archive_path(self, archive_name): def _get_archive_path(self, archive_name):
return "::".join([self.mountpoint, archive_name]) """Return full borg path for an SSH archive."""
return '::'.join([self.mountpoint, archive_name])
def _load_from_kvstore(self): def _load_from_kvstore(self):
storage = network_storage.get(self.uuid) storage = network_storage.get(self.uuid)
@ -339,8 +340,7 @@ class SshBorgRepository(BorgRepository):
if key not in self.KNOWN_CREDENTIALS: if key not in self.KNOWN_CREDENTIALS:
raise ValueError('Unknown credentials entry: %s' % key) raise ValueError('Unknown credentials entry: %s' % key)
arguments = self._append_encryption_passphrase(arguments, arguments += self._get_encryption_arguments(self.credentials)
self.credentials)
return self._run('backups', arguments, superuser=superuser) return self._run('backups', arguments, superuser=superuser)