Fix metadata files not being cleaned (#659)

Archmonger · web-flow · commit 3db2c4f82784 · 2026-01-13T09:27:35.000-08:00
Fixes #658
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,9 @@ Don't forget to remove deprecated code on each major release!
 
 ## [Unreleased]
 
-- Nothing (yet)!
+### Fixed
+
+-   Fixed a bug where metadata files were not being removed during clean-up.
 
 ## [5.1.1] - 2026-01-07
 
diff --git a/dbbackup/storage.py b/dbbackup/storage.py
@@ -281,6 +281,10 @@ def clean_old_backups(
                 continue
             self.delete_file(filename)
 
+            metadata_filename = f"{filename}.metadata"
+            if self.storage.exists(metadata_filename):
+                self.delete_file(metadata_filename)
+
 
 def get_storage_class(path=None):
     """
diff --git a/docs/src/commands.md b/docs/src/commands.md
@@ -19,7 +19,7 @@ Backup size: 3.3 KiB
 Writing file to tmp-zuluvm-2016-07-29-100954.dump
 ```
 
-For detailed help information, run:
+For parameters and more information, run:
 
 ```bash
 python manage.py dbbackup --help
@@ -37,7 +37,7 @@ Restoring: tmp-zuluvm-2016-07-29-100954.dump
 Restore tempfile created: 3.3 KiB
 ```
 
-For detailed help information, run:
+For parameters and more information, run:
 
 ```bash
 python manage.py dbrestore --help
@@ -54,7 +54,7 @@ Backup size: 10.0 KiB
 Writing file to zuluvm-2016-07-04-081612.tar
 ```
 
-For detailed help information, run:
+For parameters and more information, run:
 
 ```bash
 python manage.py mediabackup --help
@@ -75,7 +75,7 @@ Are you sure you want to continue? [Y/n]
 2 file(s) restored
 ```
 
-For detailed help information, run:
+For parameters and more information, run:
 
 ```bash
 python manage.py mediarestore --help
@@ -85,7 +85,7 @@ python manage.py mediarestore --help
 
 This command lists backups filtered by type (`'media'` or `'db'`), compression, or encryption.
 
-For detailed help information, run:
+For parameters and more information, run:
 
 ```bash
 python manage.py listbackups --help
diff --git a/docs/src/configuration.md b/docs/src/configuration.md
@@ -142,8 +142,9 @@ when using `--encrypt` and for automatic decryption with `--decrypt`.
 
 ### DBBACKUP_CONNECTORS
 
-Optional per database override mapping similar to `DATABASES`. Lets you define
-different credentials / hosts exclusively for backup / restore operations
+Allows for overriding the connector used for specific Django database(s).
+This mapping is similar to `DATABASES`. Lets you define different
+credentials / hosts exclusively for backup / restore operations
 (e.g. read from a replica). Keys correspond to database aliases.
 
 See the [Databases](databases.md) section for details on how to configure
@@ -154,9 +155,9 @@ Default: `{}`
 ### DBBACKUP_CONNECTOR_MAPPING
 
 Map custom database engine names (e.g. from wrappers like `transaction_hooks`
-or third party observability packages) to an existing DBBackup connector class path.
-Useful when a third party backend subclasses a supported Django backend but
-uses a different engine string.
+or third party observability packages) to a DBBackup connector class.
+Useful when you are using a third party backend that subclasses a supported
+Django database backend.
 
 See the [Databases](databases.md) section for details on how to configure the
 connector mapping.
diff --git a/docs/src/databases.md b/docs/src/databases.md
@@ -34,11 +34,11 @@ below.
 
 All connectors have the following parameters:
 
-| Setting   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Default                     |
-| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
-| CONNECTOR | Absolute path to connector class. Defaults by engine: `dbbackup.db.sqlite.SqliteBackupConnector` (sqlite3), `dbbackup.db.mysql.MysqlDumpConnector` (mysql), `dbbackup.db.postgresql.PgDumpConnector` (postgresql), `dbbackup.db.postgresql.PgDumpGisConnector` (postgis), `dbbackup.db.mongodb.MongoDumpConnector` (django_mongodb_engine), `dbbackup.db.django.DjangoConnector` (fallback / any unmapped). Prometheus wrappers are also supported mapping to the same connectors. | Auto-detected from `ENGINE` |
-| EXCLUDE   | List of table names to exclude from dump (may be unsupported for raw file copy snapshot approaches). Example below.                                                                                                                                                                                                                                                                                                                                                                | None                        |
-| EXTENSION | File extension used for the generated dump archive.                                                                                                                                                                                                                                                                                                                                                                                                                                | `dump`                      |
+| Setting   | Description                                                                                                                                                 | Default                     |
+| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| CONNECTOR | Absolute path to connector class. For example: `dbbackup.db.django.DjangoConnector`. Prometheus wrappers are also supported mapping to the same connectors. | Auto-detected from `ENGINE` |
+| EXCLUDE   | List of table names to exclude from dump (may be unsupported for raw file copy snapshot approaches). Example below.                                         | None                        |
+| EXTENSION | File extension used for the generated dump archive.                                                                                                         | `dump`                      |
 
 Example for `EXCLUDE` usage:
 
@@ -95,7 +95,7 @@ This connector can be used to restore a backup to an existing (dirty) database d
 
 The `dbbackup.db.sqlite.SqliteCPConnector` connector can be used to make a simple raw copy of your database file, like a snapshot.
 
-In-memory databases are **not** dumpable with it. Since it works by copying the database file directly, it is not suitable for databases that are have active connections.
+In-memory databases are **not** dumpable with it. Since it works by copying the database file directly, it is not suitable for databases that have ongoing connections.
 
 ### MySQL
 
@@ -214,7 +214,7 @@ The Django connector is ideal for:
 ### Limitations
 
 -   **Performance**: Slower than native database tools for large datasets
--   **Database structure**: Only backs up data, not database schema, indices, or procedures
+-   **Database structure**: Only provides backups of data; not database schema, indices, or procedures
 
 ### File Extension
 
diff --git a/tests/test_storage.py b/tests/test_storage.py
@@ -220,6 +220,27 @@ def test_keep_filter(self):
         self.storage.clean_old_backups(keep_number=1)
         assert HANDLED_FILES["deleted_files"] == ["2015-02-07-042810.bak"]
 
+    def test_clean_includes_metadata(self):
+        for f in [
+            "2015-02-06-042810.bak.metadata",
+            "2015-02-07-042810.bak.metadata",
+            "2015-02-08-042810.bak.metadata",
+        ]:
+            HANDLED_FILES["written_files"].append((f, None))
+
+        self.storage.clean_old_backups(keep_number=1)
+
+        deleted_files = sorted(HANDLED_FILES["deleted_files"])
+        expected_deleted = sorted(
+            [
+                "2015-02-06-042810.bak",
+                "2015-02-06-042810.bak.metadata",
+                "2015-02-07-042810.bak",
+                "2015-02-07-042810.bak.metadata",
+            ]
+        )
+        self.assertEqual(deleted_files, expected_deleted)
+
 
 class StorageEdgeCasesTest(TestCase):
     @patch("dbbackup.settings.STORAGE", "")
diff --git a/tests/utils.py b/tests/utils.py
@@ -64,7 +64,7 @@ class FakeStorage(Storage):
     name = "FakeStorage"
 
     def exists(self, name):
-        return name in HANDLED_FILES["written_files"]
+        return any(f[0] == name for f in HANDLED_FILES["written_files"])
 
     def get_available_name(self, name, max_length=None):
         return name[:max_length]
