Fixes 0.3.1 (#27)

* Fix: backups can fail if the backupPath has any symbolic link in the path

* Fix S3 creating weird folders

* Fix FTP/FTPS/SFTP several failures related to create_folder and list_directory

* Fix uploading backup was creating bad folders

* Version 0.3.1

* Refactor load_secrets code into a function

(cherry picked from commit 4f05319)
Signed-off-by: melchor629 <melchor9000@gmail.com>

* Fix upload only does not get storages from secret backends

(cherry picked from commit a115b22)
Signed-off-by: melchor629 <melchor9000@gmail.com>

Author: melchor629

mdbackup/__main__.py

@@ -36,7 +36,7 @@
 from .storage import create_storage_instance
 
 
-def main_do_backup(logger: logging.Logger, config: Config) -> Path:
+def main_load_secrets(logger: logging.Logger, config: Config):
     # Prepare secret backends (if any) and its env getters (aka functions that gets the right value from the backend)
     try:
         secret_backends = [(get_secret_backend_implementation(secret.type, secret.config), secret)
@@ -71,6 +71,10 @@ def main_do_backup(logger: logging.Logger, config: Config) -> Path:
         for secret_backend, _ in secret_backends:
             del secret_backend
 
+    return secret_env
+
+
+def main_do_backup(logger: logging.Logger, config: Config, secret_env) -> Path:
     # Do backups
     try:
         cypher_items = config.cypher_params.items() if config.cypher_params is not None else []
@@ -147,7 +151,7 @@ def main_upload_backup(logger: logging.Logger, config: Config, backup: Path):
                 # Create folder for this backup
                 try:
                     logger.info(f'Creating folder {backup_folder_name} in {prov_config.backups_path}')
-                    backup_cloud_folder = storage.create_folder(backup_folder_name, prov_config.backups_path)
+                    backup_cloud_folder = storage.create_folder(backup_folder_name)
                 except Exception as e:
                     # If we cannot create it, will continue to the next configured provider
                     run_hook('upload:error', prov_config.type, str(backup), str(e))
@@ -262,14 +266,17 @@ def main():
 
     try:
         if args.backup_only:
-            backup = main_do_backup(logger, config)
+            secret_env = main_load_secrets(logger, config)
+            backup = main_do_backup(logger, config, secret_env)
             logger.info(f'Backup done: {backup.absolute()}')
         elif args.upload_current_only:
+            main_load_secrets(logger, config)
             main_upload_backup(logger, config, (config.backups_path / 'current').resolve())
         elif args.cleanup_only:
             main_clean_up(logger, config)
         else:
-            backup = main_do_backup(logger, config)
+            secret_env = main_load_secrets(logger, config)
+            backup = main_do_backup(logger, config, secret_env)
             main_upload_backup(logger, config, backup)
             main_clean_up(logger, config)
     except Exception as e:

mdbackup/backup.py

@@ -35,7 +35,7 @@ def generate_backup_path(backups_folder: Path) -> Path:
     """
     now = datetime.utcnow()
     isostring = now.isoformat(timespec='minutes')
-    return Path(backups_folder, isostring)
+    return Path(backups_folder, isostring).resolve()
 
 
 def get_steps_scripts() -> List[Path]:

mdbackup/storage/ftp.py

@@ -46,19 +46,19 @@ def _create_connection(self, params: StorageConfig):
 
     def list_directory(self, path: Union[str, Path]) -> List[str]:
         self.__log.debug(f'Retrieving contents of directory {path}')
-        return [str(filename) for (filename, _) in self.__conn.mlsd(self.__dir / path)][2:]
+        return [str(filename) for (filename, _) in self.__conn.mlsd(str(self.__dir / path))][2:]
 
-    def create_folder(self, name: str, parent: Union[Path, str] = None) -> str:
+    def create_folder(self, name: str, parent: Union[Path, str] = '.') -> str:
         path = self.__dir / parent
         self.__conn.cwd(str(path))
         if name not in self.list_directory(parent):
             self.__log.info(f'Creating folder "{path / name}"')
             self.__conn.mkd(name)
         else:
             self.__log.debug(f'Folder "{path / name}"" already exists')
-        return str(path / name)
+        return str((path / name).relative_to(self.__dir))
 
-    def upload(self, path: Path, parent: Union[Path, str] = None):
+    def upload(self, path: Path, parent: Union[Path, str] = '.'):
         dir_path = self.__dir / parent
         self.__conn.cwd(str(dir_path))
         with open(str(path), 'rb') as file_to_upload:

mdbackup/storage/s3.py

@@ -63,6 +63,7 @@ def list_directory(self, path: Union[str, Path]) -> List[str]:
 
     def create_folder(self, name: str, parent: Union[Path, str, str] = None) -> str:
         parent = parent if parent is not None else ''
+        parent = parent[:-1] if parent.endswith('/') else parent
         key = f'{parent}/{name}/'
         if key.startswith('/'):
             key = key[1:]

mdbackup/storage/sftp.py

@@ -74,20 +74,21 @@ def _create_connection(self, params: StorageConfig) -> SFTPClient:
         return self.__ssh.open_sftp()
 
     def list_directory(self, path: Union[str, Path]) -> List[str]:
+        path = self.__dir / path
         self.__log.debug(f'Retrieving contents of directory {path}')
-        return self.__conn.listdir(path)
+        return self.__conn.listdir(str(path))
 
-    def create_folder(self, name: str, parent: Union[Path, str] = None) -> str:
+    def create_folder(self, name: str, parent: Union[Path, str] = '.') -> str:
         path = self.__dir / parent
         self.__conn.chdir(str(path))
         if name not in self.list_directory(parent):
             self.__log.info(f'Creating folder "{path / name}"')
             self.__conn.mkdir(name)
         else:
             self.__log.debug(f'Folder "{path / name}"" already exists')
-        return str(path / name)
+        return str((path / name).relative_to(self.__dir))
 
-    def upload(self, path: Path, parent: Union[Path, str] = None):
+    def upload(self, path: Path, parent: Union[Path, str] = '.'):
         dir_path = self.__dir / parent
         self.__conn.chdir(str(dir_path))
         self.__log.info(f'Uploading file {path} to {parent}')

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="mdbackup",
-    version="0.3.0",
+    version="0.3.1",
     author="majorcadevs (melchor9000 & amgxv)",
     author_email="melchor9000@gmail.com",
     description="Small but customizable utility to create backups and store them in cloud storage providers",