Test Mount API

.travis.yml

@@ -42,7 +42,7 @@ before_install:
   - sudo apt-get -qq update
   # install screen, and util-linux (provides flock) for test_sshtools
   - sudo apt-get install -y sshfs screen util-linux libdbus-1-dev
-  - sudo apt-get install -y ruby rubygems asciidoctor
+  - sudo apt-get install -y ruby rubygems asciidoctor encfs
   - sudo gem install asciidoctor
 
 jobs:

common/config.py

@@ -41,6 +41,7 @@
 import bitbase
 import tools
 import configfile
+import encode
 import logger
 import sshtools
 import encfstools
@@ -121,7 +122,7 @@ class Config(configfile.ConfigFileWithProfiles):
     DEFAULT_REDIRECT_STDERR_IN_CRON = False
     DEFAULT_OFFSET = 0
 
-    ENCODE = encfstools.Bounce()
+    ENCODE = encode.Bounce()
     PLUGIN_MANAGER = pluginmanager.PluginManager()
 
     def __init__(self, config_path=None, data_path=None):

common/encfstools.py

@@ -14,6 +14,7 @@
 from datetime import datetime
 from packaging.version import Version
 import config
+import encode
 import password
 import password_ipc
 import tools
@@ -27,6 +28,15 @@ class EncFS_mount(MountControl):
     """Mount encrypted paths with encfs."""
 
     def __init__(self, *args, **kwargs):
+        # TODO: Remove these debug calls as they are just to help me
+        # setup testing!
+        logger.debug("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
+        logger.debug("REMOVE THESE TEMPORARY DEBUG LINES!")
+        logger.debug("EncFS_mount args:")
+        logger.debug(str(args))
+        logger.debug("EncFS_mount kwargs:")
+        logger.debug(str(kwargs))
+        logger.debug("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
         # init MountControl
         super(EncFS_mount, self).__init__(*args, **kwargs)
 
@@ -36,6 +46,7 @@ def __init__(self, *args, **kwargs):
         self.config_path = None
 
         self.setattrKwargs('path', self.config.localEncfsPath(self.profile_id), **kwargs)
+        print(f"{self.path=}")
         self.setattrKwargs('reverse', False, **kwargs)
         self.setattrKwargs('config_path', None, **kwargs)
         self.setattrKwargs('password', None, store = False, **kwargs)
@@ -77,10 +88,12 @@ def _mount(self):
             self.backupConfig()
             if proc.returncode:
                 raise MountException(
-                    '{}:\n\n{}'.format(
+                    '{}:\n\n{}\n\n{}'.format(
                         _("Unable to mount '{command}'")
                         .format(command=' '.join(encfs)),
-                        output))
+                        output,
+                        f"Return code: {proc.returncode}",
+                    ))
 
     def preMountCheck(self, first_run=False):
         """Check what ever conditions must be given for the mount.
@@ -208,6 +221,7 @@ def backupConfig(self):
                      %(cfg, new_backup), self)
         shutil.copy2(cfg, new_backup)
 
+
 class EncFS_SSH(EncFS_mount):
     """
     Mount encrypted remote path with sshfs and encfs.
@@ -273,7 +287,7 @@ def umount(self, *args, **kwargs):
         call umount for encfs, encfs --reverse and sshfs
         """
         self.config.ENCODE.close()
-        self.config.ENCODE = Bounce()
+        self.config.ENCODE = encode.Bounce()
         logger.debug('Unmount encfs', self)
         super(EncFS_SSH, self).umount(*args, **kwargs)
         logger.debug('Unmount local filesystem root mount encfs --reverse', self)
@@ -340,11 +354,13 @@ def splitKwargs(self, mode):
                 d['hash_id'] = d['hash_id_1']
             return d
 
+
 class Encode:
     """
     encode path with encfsctl.
     ENCFS_SSH will replace config.ENCODE with this
     """
+
     def __init__(self, encfs):
         self.encfs = encfs
         self.password = self.encfs.password
@@ -410,8 +426,10 @@ def exclude(self, path):
 
         enc = ''
         m = self.re_asterisk.search(path)
+
         if not m is None:
             path_ = path[:]
+
             while True:
                 #search for foo/*, foo/*/bar, */bar or **/bar
                 #but not foo* or foo/*bar
@@ -462,34 +480,13 @@ def close(self):
             logger.debug('stop \'encfsctl encode\' process', self)
             self.p.communicate()
 
-class Bounce:
-    """
-    Dummy class that will simply return all input.
-    This is the standard for config.ENCODE
-    """
-    def __init__(self):
-        self.chroot = os.sep
-
-    def path(self, path):
-        return path
-
-    def exclude(self, path):
-        return path
-
-    def include(self, path):
-        return path
-
-    def remote(self, path):
-        return path
-
-    def close(self):
-        pass
 
 class Decode:
     """
     decode path with encfsctl.
     """
-    def __init__(self, cfg, string = True):
+
+    def __init__(self, cfg, string=True):
         self.config = cfg
         self.mode = cfg.snapshotsMode()
 

common/encode.py

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: © 2012-2022 Germar Reitze
+# SPDX-FileCopyrightText: © 2012-2022 Taylor Raack
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# This file is part of the program "Back In Time" which is released under GNU
+# General Public License v2 (GPLv2). See LICENSES directory or go to
+# <https://spdx.org/licenses/GPL-2.0-or-later.html>.
+#
+# Split from common/encfstools.py.
+
+"""Module related to encrypted backup profiles.
+"""
+import os
+
+
+class Bounce:
+    """Dummy class that will simply return all input.
+
+    This is the standard for config.ENCODE.
+    """
+
+    def __init__(self):
+        self.chroot = os.sep
+
+    def path(self, path: str) -> str:
+        """The path."""
+        return path
+
+    def exclude(self, path: str) -> str:
+        """Exclude entry."""
+        return path
+
+    def include(self, path: str) -> str:
+        """Include entry."""
+        return path
+
+    def remote(self, path: str) -> str:
+        """Remote path."""
+        return path
+
+    def close(self) -> None:
+        """Nothing."""

common/mount.py

@@ -170,8 +170,6 @@ def __init__(self,
                         f'Failed to {action} pw-cache: {proc.returncode}',
                         self)
 
-                    pass
-
     def mount(self, mode=None, check=True, **kwargs):
         """High-level `mount`. Check if the selected ``mode`` need to be mounted,
         select the low-level backend and mount it.
@@ -310,7 +308,7 @@ def preMountCheck(self, mode=None, first_run=False, **kwargs):
 
         return backend.preMountCheck(first_run)
 
-    def remount(self, new_profile_id, mode = None, hash_id = None, **kwargs):
+    def remount(self, new_profile_id, mode=None, hash_id=None, **kwargs):
         """
         High-level `remount`. Unmount the old profile presented by ``hash_id``
         and mount new profile ``new_profile_id`` with mode ``mode``. If old and
@@ -463,6 +461,7 @@ def setDefaultArgs(self):
         # mount.
         args = list(self.all_kwargs.keys())
         self.destination = '%s:' % self.all_kwargs['mode']
+        logger.debug(f"{self.destination=}")
 
         args.remove('mode')
         args.sort()
@@ -475,6 +474,7 @@ def setDefaultArgs(self):
         # the same mountpoint.
         if self.hash_id is None:
             self.hash_id = self.hash(self.destination)
+            logger.debug(f"{self.hash_id=}")
 
         # e.g. ~/.local/share/backintime/mnt
         self.mount_root = self.config._LOCAL_MOUNT_ROOT

common/snapshots.py

@@ -31,6 +31,7 @@
 import logger
 import tools
 import encfstools
+import encode
 import mount
 import progress
 import snapshotlog
@@ -1260,7 +1261,7 @@ def backupPermissions(self, sid):
         if self.config.snapshotsMode() == 'ssh_encfs':
             decode = encfstools.Decode(self.config, False)
         else:
-            decode = encfstools.Bounce()
+            decode = encode.Bounce()
 
         # backup permissions of /
         # bugfix for https://github.com/bit-team/backintime/issues/708

common/test/config

@@ -1,4 +1,8 @@
 config.version=6
+profiles.version=1
+profiles=1:2:3:4:5
+
+profile1.snapshots.mode=local
 profile1.snapshots.include.1.type=0
 profile1.snapshots.include.1.value=/tmp/test
 profile1.snapshots.include.size=1
@@ -15,4 +19,79 @@ profile1.snapshots.remove_old_snapshots.unit=80
 profile1.snapshots.remove_old_snapshots.value=10
 profile1.snapshots.rsync_options.enabled=false
 profile1.snapshots.rsync_options.value=
-profiles.version=1
+
+profile2.name=test-ssh-mount
+profile2.snapshots.mode=ssh
+profile2.snapshots.include.1.type=0
+profile2.snapshots.include.1.value=/tmp/test
+profile2.snapshots.include.size=1
+profile2.snapshots.no_on_battery=false
+profile2.snapshots.notify.enabled=true
+profile2.snapshots.path=/tmp/snapshots
+profile2.snapshots.path.host=test-host
+profile2.snapshots.path.profile=1
+profile2.snapshots.path.user=test-user
+profile2.snapshots.preserve_acl=false
+profile2.snapshots.preserve_xattr=false
+profile2.snapshots.remove_old_snapshots.enabled=true
+profile2.snapshots.remove_old_snapshots.unit=80
+profile2.snapshots.remove_old_snapshots.value=10
+profile2.snapshots.rsync_options.enabled=false
+profile2.snapshots.rsync_options.value=
+
+profile3.name=test-local_encfs-mount
+profile3.snapshots.mode=local_encfs
+profile3.snapshots.include.1.type=0
+profile3.snapshots.include.1.value=/tmp/test
+profile3.snapshots.include.size=1
+profile3.snapshots.no_on_battery=false
+profile3.snapshots.notify.enabled=true
+profile3.snapshots.path=/tmp/snapshots
+profile3.snapshots.path.host=test-host
+profile3.snapshots.path.profile=1
+profile3.snapshots.path.user=test-user
+profile3.snapshots.preserve_acl=false
+profile3.snapshots.preserve_xattr=false
+profile3.snapshots.remove_old_snapshots.enabled=true
+profile3.snapshots.remove_old_snapshots.unit=80
+profile3.snapshots.remove_old_snapshots.value=10
+profile3.snapshots.rsync_options.enabled=false
+profile3.snapshots.rsync_options.value=
+
+profile4.name=test-local_encfs-mount-2
+profile4.snapshots.mode=local_encfs
+profile4.snapshots.include.1.type=0
+profile4.snapshots.include.1.value=/tmp/test
+profile4.snapshots.include.size=1
+profile4.snapshots.no_on_battery=false
+profile4.snapshots.notify.enabled=true
+profile4.snapshots.path=/tmp/snapshots
+profile4.snapshots.path.host=test-host
+profile4.snapshots.path.profile=1
+profile4.snapshots.path.user=test-user
+profile4.snapshots.preserve_acl=false
+profile4.snapshots.preserve_xattr=false
+profile4.snapshots.remove_old_snapshots.enabled=true
+profile4.snapshots.remove_old_snapshots.unit=80
+profile4.snapshots.remove_old_snapshots.value=10
+profile4.snapshots.rsync_options.enabled=false
+profile4.snapshots.rsync_options.value=
+
+profile5.name=test-ssh_encfs-mount
+profile5.snapshots.mode=ssh_encfs
+profile5.snapshots.include.1.type=0
+profile5.snapshots.include.1.value=/tmp/test
+profile5.snapshots.include.size=1
+profile5.snapshots.no_on_battery=false
+profile5.snapshots.notify.enabled=true
+profile5.snapshots.path=/tmp/snapshots
+profile5.snapshots.path.host=test-host
+profile5.snapshots.path.profile=1
+profile5.snapshots.path.user=test-user
+profile5.snapshots.preserve_acl=false
+profile5.snapshots.preserve_xattr=false
+profile5.snapshots.remove_old_snapshots.enabled=true
+profile5.snapshots.remove_old_snapshots.unit=80
+profile5.snapshots.remove_old_snapshots.value=10
+profile5.snapshots.rsync_options.enabled=false
+profile5.snapshots.rsync_options.value=

common/test/test_lint.py

@@ -48,6 +48,7 @@
     # 'clicommands.py',
     'daemon.py',
     'event.py',
+    'encode.py',
     'languages.py',
     'inhibitsuspend.py',
     'schedule.py',