Improved symlink support for backup/restore

[system-cli] / tests / Commands / RestoreCommandTest.php

diff --git a/tests/Commands/RestoreCommandTest.php b/tests/Commands/RestoreCommandTest.php
index c985abd41f57bd97d58fc8c47645a9eb0a5c0962..93b27bfd6caa285194158a0dfc540a30843a9fdb 100644 (file)
--- a/tests/Commands/RestoreCommandTest.php
+++ b/tests/Commands/RestoreCommandTest.php
@@ -2,6 +2,7 @@
 
 namespace Tests\Commands;
 
+use mysqli;
 use Tests\TestCase;
 
 class RestoreCommandTest extends TestCase
@@ -9,14 +10,14 @@ class RestoreCommandTest extends TestCase
 
     public function test_restore_into_cwd_by_default_with_all_content_types()
     {
-        $mysql = new \mysqli('db', 'bookstack', 'bookstack', 'bookstack');
+        $mysql = new mysqli('db', 'bookstack', 'bookstack', 'bookstack');
         $mysql->query('CREATE TABLE xx_testing (labels varchar(255));');
 
         $result = $mysql->query('SHOW TABLES LIKE \'zz_testing\';');
         $this->assertEquals(0, mysqli_num_rows($result));
 
         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
-            $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://example.com");
+            $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://restore.example.com");
             $zip->addFromString('public/uploads/test.txt', 'hello-public-uploads');
             $zip->addFromString('storage/uploads/test.txt', 'hello-storage-uploads');
             $zip->addFromString('themes/test.txt', 'hello-themes');
@@ -28,13 +29,17 @@ class RestoreCommandTest extends TestCase
 
         $result = $this->runCommand('restore', [
             'backup-zip' => $zipFile,
-        ], [
-            'yes', '1'
-        ]);
+        ], ['yes', '1']); // This restore uses the existing (Non-backup) APP_URL
 
         $result->dumpError();
         $result->assertSuccessfulExit();
+        $result->assertStdoutContains('✔ .env Config File');
+        $result->assertStdoutContains('✔ Themes Folder');
+        $result->assertStdoutContains('✔ Public File Uploads');
+        $result->assertStdoutContains('✔ Private File Uploads');
+        $result->assertStdoutContains('✔ Database Dump');
         $result->assertStdoutContains('Restore operation complete!');
+        $result->assertStdoutContains('App URL change made, updating database with URL change');
 
         $result = $mysql->query('SELECT * FROM zz_testing where names = \'barry\';');
         $this->assertEquals(1, mysqli_num_rows($result));
@@ -45,10 +50,121 @@ class RestoreCommandTest extends TestCase
         $this->assertStringEqualsFile('/var/www/bookstack-restore/storage/uploads/test.txt', 'hello-storage-uploads');
         $this->assertStringEqualsFile('/var/www/bookstack-restore/themes/test.txt', 'hello-themes');
 
+        $env = file_get_contents('/var/www/bookstack-restore/.env');
+        $this->assertStringContainsString('APP_KEY=abc123', $env);
+        $this->assertStringNotContainsString('APP_URL=https://restore.example.com', $env);
+        $this->assertStringContainsString('APP_URL="https://example.com"', $env);
+
         $mysql->query("DROP TABLE zz_testing;");
         exec('rm -rf /var/www/bookstack-restore');
     }
 
+    public function test_restore_using_backup_env_url()
+    {
+        $zipFile = $this->buildZip(function (\ZipArchive $zip) {
+            $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://restore.example.com");
+        });
+
+        exec('cp -r /var/www/bookstack /var/www/bookstack-restore-backup-env');
+        chdir('/var/www/bookstack-restore-backup-env');
+
+        $result = $this->runCommand('restore', [
+            'backup-zip' => $zipFile,
+        ], ['yes', '0']); // This restore uses the old (Backup) APP_URL
+
+        $result->assertSuccessfulExit();
+        $result->assertStdoutContains('✔ .env Config File');
+        $result->assertStdoutContains('Restore operation complete!');
+
+        $env = file_get_contents('/var/www/bookstack-restore-backup-env/.env');
+        $this->assertStringContainsString('APP_KEY=abc123', $env);
+        $this->assertStringContainsString('APP_URL="https://restore.example.com"', $env);
+
+        exec('rm -rf /var/www/bookstack-restore-backup-env');
+    }
+
+    public function test_command_fails_on_zip_with_no_expected_contents()
+    {
+        $zipFile = $this->buildZip(function (\ZipArchive $zip) {
+            $zip->addFromString('spaghetti', "Hello world!");
+        });
+
+        chdir('/var/www/bookstack');
+
+        $result = $this->runCommand('restore', [
+            'backup-zip' => $zipFile,
+        ]);
+
+        $result->assertErrorExit();
+        $result->assertStderrContains("Provided ZIP backup [{$zipFile}] does not have any expected restorable content.");
+    }
+
+    public function test_limited_restore_using_app_directory_option()
+    {
+        $zipFile = $this->buildZip(function (\ZipArchive $zip) {
+            $zip->addFromString('db.sql', "CREATE TABLE zz_testing (names varchar(255));");
+            $zip->addFromString('themes/hello.txt', "limited restore test!");
+        });
+
+        chdir('/home');
+
+        $result = $this->runCommand('restore', [
+            'backup-zip' => $zipFile,
+            '--app-directory' => '/var/www/bookstack'
+        ], ['yes']);
+
+        $result->assertSuccessfulExit();
+        $result->assertStdoutContains('❌ .env Config File');
+        $result->assertStdoutContains('✔ Themes Folder');
+        $result->assertStdoutContains('❌ Public File Uploads');
+        $result->assertStdoutContains('❌ Private File Uploads');
+        $result->assertStdoutContains('✔ Database Dump');
+        $this->assertStringEqualsFile('/var/www/bookstack/themes/hello.txt', 'limited restore test!');
+
+        unlink('/var/www/bookstack/themes/hello.txt');
+        $mysql = new mysqli('db', 'bookstack', 'bookstack', 'bookstack');
+        $mysql->query("DROP TABLE zz_testing;");
+    }
+
+    public function test_restore_with_symlinked_content_folders()
+    {
+        $zipFile = $this->buildZip(function (\ZipArchive $zip) {
+            $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://example.com");
+            $zip->addFromString('public/uploads/test.txt', 'hello-public-uploads');
+            $zip->addFromString('storage/uploads/test.txt', 'hello-storage-uploads');
+            $zip->addFromString('themes/test.txt', 'hello-themes');
+        });
+
+        exec('cp -r /var/www/bookstack /var/www/bookstack-symlink-restore');
+        chdir('/var/www/bookstack-symlink-restore');
+        mkdir('/symlinks');
+
+        $symlinkPaths = ['public/uploads', 'storage/uploads', '.env', 'themes'];
+        foreach ($symlinkPaths as $path) {
+            $targetFile = str_replace('/', '-', $path);
+            $code = 0;
+            $output = null;
+            exec("mv /var/www/bookstack-symlink-restore/{$path} /symlinks/{$targetFile}", $output, $code);
+            exec("ln -s /symlinks/{$targetFile} /var/www/bookstack-symlink-restore/{$path}", $output, $code);
+            if ($code !== 0) {
+                $this->fail("Error when setting up symlinks");
+            }
+        }
+
+        $result = $this->runCommand('restore', [
+            'backup-zip' => $zipFile,
+        ], ['yes', '1']);
+
+        $result->assertSuccessfulExit();
+
+        $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/public/uploads/test.txt', 'hello-public-uploads');
+        $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/storage/uploads/test.txt', 'hello-storage-uploads');
+        $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/themes/test.txt', 'hello-themes');
+
+        exec('rm -rf /var/www/bookstack-symlink-restore');
+        exec('rm -rf /symlinks');
+    }
+
     protected function buildZip(callable $builder): string
     {
         $zipFile = tempnam(sys_get_temp_dir(), 'cli-test');