Added helpers for dumping files

Author: Toflar

src/Action/Dump.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Terminal42\Restic\Action;
+
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Terminal42\Restic\Action\Result\DumpResult;
+
+class Dump extends AbstractAction
+{
+    private DumpResult $result;
+
+    public function __construct(
+        private readonly string $snapshotId,
+        private readonly string $targetFileName,
+        private readonly string $pathOrFile,
+    ) {
+    }
+
+    public function getResult(): DumpResult
+    {
+        return $this->result;
+    }
+
+    protected function doGetArguments(): array
+    {
+        $arguments = [
+            'dump',
+        ];
+
+        // Always use zip as archive mode for paths
+        $arguments[] = '-a';
+        $arguments[] = 'zip';
+
+        $arguments[] = '--target';
+        $arguments[] = $this->targetFileName;
+
+        $arguments[] = $this->snapshotId;
+        $arguments[] = $this->pathOrFile;
+
+        return $arguments;
+    }
+
+    protected function updateResult(string $output, ProcessFailedException|null $exception = null): void
+    {
+        $this->result = new DumpResult($output, $exception);
+    }
+}

src/Action/Result/DumpResult.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Terminal42\Restic\Action\Result;
+
+class DumpResult extends AbstractActionResult
+{
+}

src/Toolkit.php

@@ -6,6 +6,7 @@
 
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Terminal42\Restic\Action\CreateBackup;
+use Terminal42\Restic\Action\Dump;
 use Terminal42\Restic\Action\ForgetOldSnapshots;
 use Terminal42\Restic\Action\ListFiles;
 use Terminal42\Restic\Action\ListSnapshots;
@@ -94,4 +95,14 @@ public function restoreBackup(string $snapshotId, string $restorePath, array $pa
 
         return $action->getResult();
     }
+
+    /**
+     * Dumps a file to the given target file name. In case of a path given, it will create a zip archive, so make sure your $targetFileName
+     * contains ".zip" in that case. If a file was given, it will not compress it, so make sure you use the appropriate target file name.
+     */
+    public function dumpPathOrFile(string $snapshotId, string $pathOrFile, string $targetFileName): void
+    {
+        $action = new Dump($snapshotId, $targetFileName, $pathOrFile);
+        $this->restic->runAction($action);
+    }
 }

tests/Functional/BackupTest.php

@@ -115,6 +115,35 @@ public function testForgetsSnapshotsCorrectly(): void
         );
     }
 
+    public function testDump(): void
+    {
+        $restorePath = $this->getRestorePath();
+        $toolkit = $this->createToolkit(self::getFixtureDirectory('regular-backup'));
+        $snapshotId = $toolkit->createBackup();
+
+        // Test dumping a file
+        $toolkit->dumpPathOrFile($snapshotId, 'src/Controller/LuckyController.php', $restorePath.'/LuckyController.php');
+        $this->assertFileEquals(
+            self::getFixtureDirectory('regular-backup').'/src/Controller/LuckyController.php',
+            $restorePath.'/LuckyController.php',
+        );
+
+        // Test dumping an entire path
+        $toolkit->dumpPathOrFile($snapshotId, 'src', $restorePath.'/test.zip');
+        $this->assertFileExists($restorePath.'/test.zip');
+
+        // Unarchive the path and assert the contents
+        $zip = new \ZipArchive();
+        $zip->open($restorePath.'/test.zip');
+        $zip->extractTo($restorePath.'/test');
+        $zip->close();
+
+        $this->assertFileEquals(
+            self::getFixtureDirectory('regular-backup').'/src/Controller/LuckyController.php',
+            $restorePath.'/test/src/Controller/LuckyController.php',
+        );
+    }
+
     #[DataProvider('restoreDataProvider')]
     public function testRestore(string $projectDir, array $pathsToRestore, array $expectedRestoredFiles, int $expectedNumberOfFilesRestored, int $expectedTotalBytes): void
     {