BookStack Code Mirror - system-cli/blob - tests/Commands/RestoreCommandTest.php

   1 <?php declare(strict_types=1);
   2
   3 namespace Tests\Commands;
   4
   5 use mysqli;
   6 use Tests\TestCase;
   7
   8 class RestoreCommandTest extends TestCase
   9 {
  10
  11     public function test_restore_into_cwd_by_default_with_all_content_types()
  12     {
  13         $mysql = new mysqli('db', 'bookstack', 'bookstack', 'bookstack');
  14         $mysql->query('CREATE TABLE xx_testing (labels varchar(255));');
  15
  16         $result = $mysql->query('SHOW TABLES LIKE \'zz_testing\';');
  17         $this->assertEquals(0, mysqli_num_rows($result));
  18
  19         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
  20             $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://restore.example.com");
  21             $zip->addFromString('public/uploads/test.txt', 'hello-public-uploads');
  22             $zip->addFromString('storage/uploads/test.txt', 'hello-storage-uploads');
  23             $zip->addFromString('themes/test.txt', 'hello-themes');
  24             $zip->addFromString('db.sql', "CREATE TABLE zz_testing (names varchar(255));\nINSERT INTO zz_testing values ('barry');");
  25         });
  26
  27         exec('cp -r /var/www/bookstack /var/www/bookstack-restore');
  28         chdir('/var/www/bookstack-restore');
  29
  30         $result = $this->runCommand('restore', [
  31             'backup-zip' => $zipFile,
  32         ], ['yes', '1']); // This restore uses the existing (Non-backup) APP_URL
  33
  34         $result->dumpError();
  35         $result->assertSuccessfulExit();
  36         $result->assertStdoutContains('✔ .env Config File');
  37         $result->assertStdoutContains('✔ Themes Folder');
  38         $result->assertStdoutContains('✔ Public File Uploads');
  39         $result->assertStdoutContains('✔ Private File Uploads');
  40         $result->assertStdoutContains('✔ Database Dump');
  41         $result->assertStdoutContains('Restore operation complete!');
  42         $result->assertStdoutContains('App URL change made, updating database with URL change');
  43
  44         $result = $mysql->query('SELECT * FROM zz_testing where names = \'barry\';');
  45         $this->assertEquals(1, mysqli_num_rows($result));
  46         $result = $mysql->query('SHOW TABLES LIKE \'xx_testing\';');
  47         $this->assertEquals(0, mysqli_num_rows($result));
  48
  49         $this->assertStringEqualsFile('/var/www/bookstack-restore/public/uploads/test.txt', 'hello-public-uploads');
  50         $this->assertStringEqualsFile('/var/www/bookstack-restore/storage/uploads/test.txt', 'hello-storage-uploads');
  51         $this->assertStringEqualsFile('/var/www/bookstack-restore/themes/test.txt', 'hello-themes');
  52
  53         $env = file_get_contents('/var/www/bookstack-restore/.env');
  54         $this->assertStringContainsString('APP_KEY=abc123', $env);
  55         $this->assertStringNotContainsString('APP_URL=https://restore.example.com', $env);
  56         $this->assertStringContainsString('APP_URL="https://example.com"', $env);
  57
  58         $mysql->query("DROP TABLE zz_testing;");
  59         exec('rm -rf /var/www/bookstack-restore');
  60     }
  61
  62     public function test_restore_using_backup_env_url()
  63     {
  64         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
  65             $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://restore.example.com");
  66         });
  67
  68         exec('cp -r /var/www/bookstack /var/www/bookstack-restore-backup-env');
  69         chdir('/var/www/bookstack-restore-backup-env');
  70
  71         $result = $this->runCommand('restore', [
  72             'backup-zip' => $zipFile,
  73         ], ['yes', '0']); // This restore uses the old (Backup) APP_URL
  74
  75         $result->assertSuccessfulExit();
  76         $result->assertStdoutContains('✔ .env Config File');
  77         $result->assertStdoutContains('Restore operation complete!');
  78
  79         $env = file_get_contents('/var/www/bookstack-restore-backup-env/.env');
  80         $this->assertStringContainsString('APP_KEY=abc123', $env);
  81         $this->assertStringContainsString('APP_URL="https://restore.example.com"', $env);
  82
  83         exec('rm -rf /var/www/bookstack-restore-backup-env');
  84     }
  85
  86     public function test_command_fails_on_zip_with_no_expected_contents()
  87     {
  88         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
  89             $zip->addFromString('spaghetti', "Hello world!");
  90         });
  91
  92         chdir('/var/www/bookstack');
  93
  94         $result = $this->runCommand('restore', [
  95             'backup-zip' => $zipFile,
  96         ]);
  97
  98         $result->assertErrorExit();
  99         $result->assertStderrContains("Provided ZIP backup [{$zipFile}] does not have any expected restorable content.");
 100     }
 101
 102     public function test_limited_restore_using_app_directory_option()
 103     {
 104         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
 105             $zip->addFromString('db.sql', "CREATE TABLE zz_testing (names varchar(255));");
 106             $zip->addFromString('themes/hello.txt', "limited restore test!");
 107         });
 108
 109         chdir('/home');
 110
 111         $result = $this->runCommand('restore', [
 112             'backup-zip' => $zipFile,
 113             '--app-directory' => '/var/www/bookstack'
 114         ], ['yes']);
 115
 116         $result->assertSuccessfulExit();
 117         $result->assertStdoutContains('❌ .env Config File');
 118         $result->assertStdoutContains('✔ Themes Folder');
 119         $result->assertStdoutContains('❌ Public File Uploads');
 120         $result->assertStdoutContains('❌ Private File Uploads');
 121         $result->assertStdoutContains('✔ Database Dump');
 122         $this->assertStringEqualsFile('/var/www/bookstack/themes/hello.txt', 'limited restore test!');
 123
 124         unlink('/var/www/bookstack/themes/hello.txt');
 125         $mysql = new mysqli('db', 'bookstack', 'bookstack', 'bookstack');
 126         $mysql->query("DROP TABLE zz_testing;");
 127     }
 128
 129     public function test_restore_with_symlinked_content_folders()
 130     {
 131         $zipFile = $this->buildZip(function (\ZipArchive $zip) {
 132             $zip->addFromString('.env', "APP_KEY=abc123\nAPP_URL=https://example.com");
 133             $zip->addFromString('public/uploads/test.txt', 'hello-public-uploads');
 134             $zip->addFromString('storage/uploads/test.txt', 'hello-storage-uploads');
 135             $zip->addFromString('themes/test.txt', 'hello-themes');
 136         });
 137
 138         exec('cp -r /var/www/bookstack /var/www/bookstack-symlink-restore');
 139         chdir('/var/www/bookstack-symlink-restore');
 140         mkdir('/symlinks');
 141
 142         $symlinkPaths = ['public/uploads', 'storage/uploads', '.env', 'themes'];
 143         foreach ($symlinkPaths as $path) {
 144             $targetFile = str_replace('/', '-', $path);
 145             $code = 0;
 146             $output = null;
 147             exec("mv /var/www/bookstack-symlink-restore/{$path} /symlinks/{$targetFile}", $output, $code);
 148             exec("ln -s /symlinks/{$targetFile} /var/www/bookstack-symlink-restore/{$path}", $output, $code);
 149             if ($code !== 0) {
 150                 $this->fail("Error when setting up symlinks");
 151             }
 152         }
 153
 154         $result = $this->runCommand('restore', [
 155             'backup-zip' => $zipFile,
 156         ], ['yes', '1']);
 157
 158         $result->assertSuccessfulExit();
 159
 160         $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/public/uploads/test.txt', 'hello-public-uploads');
 161         $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/storage/uploads/test.txt', 'hello-storage-uploads');
 162         $this->assertStringEqualsFile('/var/www/bookstack-symlink-restore/themes/test.txt', 'hello-themes');
 163
 164         exec('rm -rf /var/www/bookstack-symlink-restore');
 165         exec('rm -rf /symlinks');
 166     }
 167
 168     protected function buildZip(callable $builder): string
 169     {
 170         $zipFile = tempnam(sys_get_temp_dir(), 'cli-test');
 171         $testZip = new \ZipArchive('');
 172         $testZip->open($zipFile);
 173         $builder($testZip);
 174         $testZip->close();
 175
 176         return $zipFile;
 177     }
 178 }