Add support for compression in BackupExport and update test cases accordingly

Author: mirko-pagliai

src/Utility/BackupExport.php

@@ -106,7 +106,7 @@ public function __construct(ConnectionInterface|string $Connection = '')
     public function export(): string|false
     {
         if (empty($this->filename)) {
-            $this->filename = 'backup_{$DATABASE}_{$DATETIME}.sql';
+            $this->filename = 'backup_{$DATABASE}_{$DATETIME}.' . $this->compression->value;
         }
 
         //Dispatches the `Backup.beforeExport` event implemented by the `Executor` class

tests/TestCase/Utility/BackupExportTest.php

@@ -59,6 +59,7 @@ public function setUp(): void
     #[Test]
     #[TestWith([Compression::None, Compression::None])]
     #[TestWith([Compression::Gzip, Compression::Gzip])]
+    #[TestWith([Compression::Bzip2, Compression::Bzip2])]
     #[TestWith([Compression::Gzip, 'Gzip'])]
     #[TestWith([Compression::Gzip, 'gzip'])]
     #[TestWith([Compression::None, null])]
@@ -192,12 +193,57 @@ public function runProcess(string $filename, int $timeout = 60): Process
         };
         $this->BackupExport->Executor->getEventManager()->setEventList(new EventList());
 
+        $result = $this->BackupExport->export();
+
+        $this->assertStringStartsWith(Configure::read('DatabaseBackup.target'), $result);
+        $this->assertMatchesRegularExpression('/backup_my_database_\d{14}\.sql$/', $result);
+        $this->assertEventFired('Backup.beforeExport', $this->BackupExport->Executor->getEventManager());
+        $this->assertEventFired('Backup.afterExport', $this->BackupExport->Executor->getEventManager());
+    }
+
+    /**
+     * @link \DatabaseBackup\Utility\BackupExport::export()
+     */
+    #[Test]
+    public function testExportWithCompression(): void
+    {
+        $this->BackupExport->Executor = new class extends FakeExecutor {
+            public function runProcess(string $filename, int $timeout = 60): Process
+            {
+                return new ReflectionClass(Process::class)->newInstanceWithoutConstructor();
+            }
+        };
+        $this->BackupExport->Executor->getEventManager()->setEventList(new EventList());
+
         $result = $this->BackupExport
-            ->filename(TMP . 'backup.sql')
-            ->timeout(120)
+            ->compression(Compression::Bzip2)
+            ->export();
+
+        $this->assertStringStartsWith(Configure::read('DatabaseBackup.target'), $result);
+        $this->assertMatchesRegularExpression('/backup_my_database_\d{14}\.sql\.bz2$/', $result);
+        $this->assertEventFired('Backup.beforeExport', $this->BackupExport->Executor->getEventManager());
+        $this->assertEventFired('Backup.afterExport', $this->BackupExport->Executor->getEventManager());
+    }
+
+    /**
+     * @link \DatabaseBackup\Utility\BackupExport::export()
+     */
+    #[Test]
+    public function testExportWithFilename(): void
+    {
+        $this->BackupExport->Executor = new class extends FakeExecutor {
+            public function runProcess(string $filename, int $timeout = 60): Process
+            {
+                return new ReflectionClass(Process::class)->newInstanceWithoutConstructor();
+            }
+        };
+        $this->BackupExport->Executor->getEventManager()->setEventList(new EventList());
+
+        $result = $this->BackupExport
+            ->filename(TMP . 'backup.sql.gz')
             ->export();
 
-        $this->assertSame(TMP . 'backup.sql', $result);
+        $this->assertSame(TMP . 'backup.sql.gz', $result);
         $this->assertEventFired('Backup.beforeExport', $this->BackupExport->Executor->getEventManager());
         $this->assertEventFired('Backup.afterExport', $this->BackupExport->Executor->getEventManager());
     }