Add CLEAN and EXTRA_MYSQL/EXTRA_POSTGRESQL options

README.md

@@ -33,6 +33,14 @@ Files are backed up uncompressed by default, on the assumption a snapshotting or
 - `bz2`
 - `plain` (no compression - the default)
 
+### Clean dumps
+
+`DROP` statements can be automatically added with `$CLEAN=true`.
+
+### Extra parameters !
+
+Fine manage of your dump policies using extra parameters respectively `$EXTRA_MYSQL` & `$EXTRA_POSTGRESQL`.
+
 ### Example `docker-compose.yml`
 
 ```yml
@@ -48,6 +56,7 @@ services:
     environment:
       - SUCCESS_HOOK_URL=https://hc-ping.com/1234
       - INCLUDE_LOGS=true
+      - EXTRA_MYSQL=--comments --dump-date --lock-all-tables 
 ```
 
 ### Oneshot

db-auto-backup.py

@@ -97,11 +97,17 @@ def get_success_hook_url() -> Optional[str]:
 def backup_psql(container: Container) -> str:
     env = get_container_env(container)
     user = env.get("POSTGRES_USER", "postgres")
-    return f"pg_dumpall -U {user}"
+    extra = os.environ.get("EXTRA_POSTGRESQL", "")
+    if bool(os.environ.get("CLEAN")):
+        print("CLEAN is set, using --clean --if-exists")
+        extra += " --clean --if-exists"
+    print(f"Using {extra} for backup")
+    return f"pg_dumpall -U {user} {extra}"
 
 
 def backup_mysql(container: Container) -> str:
     env = get_container_env(container)
+    extra = os.environ.get("EXTRA_MYSQL", "")
 
     # The mariadb container supports both
     if "MARIADB_ROOT_PASSWORD" in env:
@@ -116,14 +122,18 @@ def backup_mysql(container: Container) -> str:
     else:
         backup_binary = "mysqldump"
 
-    return f"bash -c '{backup_binary} {auth} --all-databases'"
+    if bool(os.environ.get("CLEAN")):
+        extra += " --add-drop-database --add-drop-table --add-drop-trigger"
+
+    return f"bash -c '{backup_binary} {auth} --all-databases {extra}'"
 
 
 def backup_redis(container: Container) -> str:
     """
     Note: `SAVE` command locks the database, which isn't ideal.
     Hopefully the commit is fast enough!
     """
+
     return "sh -c 'redis-cli SAVE > /dev/null && cat /data/dump.rdb'"
 
 
@@ -159,6 +169,9 @@ def backup_redis(container: Container) -> str:
 SHOW_PROGRESS = sys.stdout.isatty()
 COMPRESSION = os.environ.get("COMPRESSION", "plain")
 INCLUDE_LOGS = bool(os.environ.get("INCLUDE_LOGS"))
+CLEAN = bool(os.environ.get("CLEAN", False))
+EXTRA_PSQL = os.environ.get("EXTRA_POSTGRESQL", "")
+EXTRA_MYSQL = os.environ.get("EXTRA_MYSQL", "")
 
 
 def get_backup_provider(container_names: Iterable[str]) -> Optional[BackupProvider]:

tests/tests.py

@@ -4,6 +4,7 @@
 from typing import Any, Callable
 from unittest.mock import MagicMock
 
+import docker
 import pytest
 
 BACKUP_DIR = Path.cwd() / "backups"
@@ -128,3 +129,32 @@ def test_get_backup_provider(container_name: str, name: str) -> None:
 
     assert provider is not None
     assert provider.name == name
+
+
+# Have to be run with root privileges to avoid permission issues
+def test_backup_runs_clean(run_backup: Callable) -> None:
+    exit_code, out = run_backup({"CLEAN": "true"})
+    assert exit_code == 0, out
+    assert BACKUP_DIR.is_dir()
+    assert sorted(normalize_container_name(f.name) for f in BACKUP_DIR.iterdir()) == [
+        "docker-db-auto-backup-mariadb-1.sql",
+        "docker-db-auto-backup-mysql-1.sql",
+        "docker-db-auto-backup-psql-1.sql",
+        "docker-db-auto-backup-redis-1.rdb",
+    ]
+    # Hack for having right on files
+    docker_client = docker.from_env()
+    backup_container = docker_client.containers.get("docker-db-auto-backup")
+
+    for backup_file in BACKUP_DIR.iterdir():
+        backup_container.exec_run(["chmod", "o+r", f"/var/backups/{backup_file.name}"])
+        if "sql" in backup_file.name:
+            with open(backup_file, "r") as f:
+                content = f.read()
+                if "psql" in backup_file.name:
+                    assert content.find("\nDROP DATABASE") > 0
+                    assert content.find("\nCREATE DATABASE") > 0
+                if "mysql" in backup_file.name or "mariadb" in backup_file.name:
+                    assert content.find("/*!40000 DROP DATABASE IF EXISTS") > 0
+                    assert content.find("CREATE DATABASE /*!32312 IF NOT EXISTS*/ ") > 0
+                    assert content.find("CREATE TABLE IF NOT EXISTS ") > 0