backup_migrate-5.0.0-rc2/tests/src/Functional/AdminFunctionalityTest.php

<?php

namespace Drupal\Tests\backup_migrate\Functional;

use Drupal\Core\File\FileSystemInterface;
use Drupal\Tests\BrowserTestBase;

/**
 * Checks if admin functionality works correctly.
 *
 * @group backup_migrate
 */
class AdminFunctionalityTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = ['backup_migrate', 'test_page_test'];

  /**
   * {@inheritdoc}
   */
  protected $strictConfigSchema = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  public function setUp(): void {
    parent::setUp();
    $this->container->get('router.builder')->rebuild();

    // Set test-page as front page:
    $this->config('system.site')->set('page.front', '/test-page')->save();

    // Ensure backup_migrate folder exists, the
    // `admin/config/development/backup_migrate/backups` path will fail without
    // this.
    $path = 'private://backup_migrate/';
    \Drupal::service('file_system')->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);

    // Log in an admin user.
    $account = $this->drupalCreateUser([
      'access backup files',
      'administer backup and migrate',
      'perform backup',
      'restore from backup',
      // Used to access the system cron page.
      'administer site configuration',
    ]);
    $this->drupalLogin($account);
  }

  /**
   * Tests each of the admin pages loads correctly.
   *
   * This is to be used until all of the admin functionality has separate.
   *
   * @param string $path
   *   The path to check.
   * @param string $string_on_page
   *   A string to look for on the page above..
   *
   * @dataProvider pagesListProvider
   */
  public function testPages($path, $string_on_page) {
    $this->drupalGet($path);
    $this->assertSession()->statusCodeEquals(200);
    $this->assertSession()->pageTextContains($string_on_page);
  }

  /**
   * A list of paths to check and a string that should be present on that page.
   *
   * @return array
   *   A list of paths with a string that should be present on that page.
   */
  public static function pagesListProvider(): array {
    return [
      ['admin/config/development/backup_migrate', 'Quick Backup'],
      ['admin/config/development/backup_migrate/advanced', 'Advanced Backup'],
      ['admin/config/development/backup_migrate/restore', 'Restore'],
      ['admin/config/development/backup_migrate/backups', 'Backups'],
      ['admin/config/development/backup_migrate/schedule', 'Schedule'],
      ['admin/config/development/backup_migrate/schedule/add', 'Add schedule'],
      ['admin/config/development/backup_migrate/settings', 'Settings'],
      [
        'admin/config/development/backup_migrate/settings/add',
        'Add settings profile',
      ],
      [
        'admin/config/development/backup_migrate/settings/destination',
        'Backup Destination',
      ],
      [
        'admin/config/development/backup_migrate/settings/destination/add',
        'Add destination',
      ],
      [
        'admin/config/development/backup_migrate/settings/source',
        'Backup sources',
      ],
      [
        'admin/config/development/backup_migrate/settings/source/add',
        'Add Backup Source',
      ],
    ];
  }

  /**
   * Make sure the 'destinations' system works correctly.
   */
  public function testDestinationsAdmin() {
    // Load the destination page.
    // @todo Confirm the table only has one record.
    $this->drupalGet('admin/config/development/backup_migrate/settings/destination');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Backup Destination');
    $session->pageTextContains('Private Files Directory');
    $session->pageTextContains('private_files');
    $session->pageTextContains('Server File Directory');

    // Load the destination-add form.
    $this->drupalGet('admin/config/development/backup_migrate/settings/destination/add');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Add destination');
    $session->fieldExists('label');
    $session->fieldExists('id');
    $session->fieldExists('type');
    $session->buttonExists('Save and edit');

    // Create a new destination.
    $edit = [
      'label' => 'Test destination',
      'id' => 'test_destination',
      'type' => 'Directory',
    ];
    $this->submitForm($edit, 'Save and edit');

    // This should load a new version of the form with the directory filled in.
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/destination/edit/test_destination');
    $session->pageTextContains('Created Test destination.');
    $session->fieldExists('label');
    $session->fieldExists('config[directory]');
    $session->buttonExists('Save');
    $session->linkExists('Delete');

    // Fill in a path.
    $edit = [
      'config[directory]' => 'test_path',
    ];
    $this->submitForm($edit, 'Save');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/destination');
    $session->pageTextContains('Saved Test destination.');
    $session->pageTextContains('Private Files Directory');
    $session->pageTextContains('private_files');
    $session->pageTextContains('Test destination');
    $session->pageTextContains('test_destination');
  }

  /**
   * Make sure the 'sources' system works correctly.
   */
  public function testSourcesAdmin() {
    // Load the source page.
    $this->drupalGet('admin/config/development/backup_migrate/settings/source');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Backup Source');
    $session->pageTextContains('Default Drupal Database');
    $session->pageTextContains('default_db');
    $session->pageTextContains('Default Database');

    $session->pageTextContains('entire_site');
    $session->pageTextContains('Entire Site');

    $session->pageTextContains('Private Files Directory');
    $session->pageTextContains('private_files');
    $session->pageTextContains('Public Files');

    // @todo Confirm the table has four records.
    // Load the add source form.
    $this->drupalGet('admin/config/development/backup_migrate/settings/source/add');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Add Backup Source');
    $session->fieldExists('label');
    $session->fieldExists('type');
    $session->buttonExists('Save and edit');

    // Create a new source of type File Directory.
    $edit = [
      'label' => 'Test FileDirectory source',
      'id' => 'test_filedirectory_source',
      'type' => 'FileDirectory',
    ];
    $this->submitForm($edit, 'Save and edit');

    // This should load a new version of the form with the directory filled in.
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/source/edit/test_filedirectory_source');
    $session->pageTextContains('Created Test FileDirectory source.');
    $session->fieldExists('label');
    $session->fieldExists('config[directory]');
    $session->buttonExists('Save');
    $session->linkExists('Delete');

    // Fill in a path.
    $edit = [
      'config[directory]' => 'test_path',
    ];
    $this->submitForm($edit, 'Save');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/source');
    $session->pageTextContains('Saved Test FileDirectory source.');
    $session->pageTextContains('Default Drupal Database');
    $session->pageTextContains('default_db');
    $session->pageTextContains('Entire Site');
    $session->pageTextContains('entire_site');
    $session->pageTextContains('Private Files Directory');
    $session->pageTextContains('private_files');
    $session->pageTextContains('Test FileDirectory source');
    $session->pageTextContains('test_filedirectory_source');
    $session->pageTextContains('File Directory');

    // Load the add source form.
    $this->drupalGet('admin/config/development/backup_migrate/settings/source/add');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Add Backup Source');
    $session->fieldExists('label');
    $session->fieldExists('type');
    $session->buttonExists('Save and edit');

    // Create a new source of type MySQL Database.
    $edit = [
      'label' => 'Test MySQL source',
      'id' => 'test_mysql_source',
      'type' => 'MySQL',
    ];
    $this->submitForm($edit, 'Save and edit');

    // This should load a new version of the form with the directory filled in.
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/source/edit/test_mysql_source');
    $session->pageTextContains('Created Test MySQL source.');
    $session->fieldExists('label');
    $session->fieldExists('config[host]');
    $session->fieldExists('config[database]');
    $session->fieldExists('config[username]');
    $session->fieldExists('config[password]');
    $session->fieldExists('config[port]');
    $session->buttonExists('Save');
    $session->linkExists('Delete');

    // Fill in fields with test values.
    $edit = [
      'config[host]' => 'test_host',
      'config[database]' => 'test_dbname',
      'config[username]' => 'test_user',
      'config[password]' => 'test_pw',
      'config[port]' => '12345',
    ];
    $this->submitForm($edit, 'Save');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings/source');
    $session->pageTextContains('Saved Test MySQL source.');
    $session->pageTextContains('Default Drupal Database');
    $session->pageTextContains('default_db');
    $session->pageTextContains('Entire Site');
    $session->pageTextContains('entire_site');
    $session->pageTextContains('Private Files Directory');
    $session->pageTextContains('private_files');
    $session->pageTextContains('Test MySQL source');
    $session->pageTextContains('test_mysql_source');
    $session->pageTextContains('MySQL Database');
  }

  /**
   * Make sure the 'schedules' system works correctly.
   */
  public function testSchedulesAdmin() {
    // Load the schedule page.
    // @todo Confirm the table only has one record.
    $this->drupalGet('admin/config/development/backup_migrate/schedule');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Schedule Name');
    $session->pageTextContains('Enabled');
    $session->pageTextContains('Frequency');
    $session->pageTextContains('Last Run');
    $session->pageTextContains('Next Run');
    $session->pageTextContains('Keep');
    $session->pageTextContains('Daily Schedule');
    $session->pageTextContains('No');
    $session->pageTextContains('Every 0 weeks');
    $session->pageTextContains('Never');
    $session->pageTextContains('Disabled');
    $session->pageTextContains('All backups');

    // Edit an existing schedule - turn on the default schedule.
    $this->drupalGet('admin/config/development/backup_migrate/schedule/edit/daily_schedule');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->fieldExists('Schedule enabled');
    $edit = [
      'enabled' => TRUE,
      'period_number' => 1,
      'period_type' => 'days',
    ];
    $this->submitForm($edit, 'Save');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Saved the Daily Schedule Schedule.');
    $session->pageTextContains('Yes');
    $session->pageTextContains('Daily');
    $session->pageTextContains('Never');
    $session->pageTextContains('Next cron run');
    $session->pageTextNotContains('Disabled');

    // Load the schedule-add form.
    $this->drupalGet('admin/config/development/backup_migrate/schedule/add');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Add schedule');
    $session->fieldExists('label');
    $session->fieldExists('id');
    $session->fieldExists('enabled');
    $session->fieldExists('source_id');
    $session->fieldExists('destination_id');
    $session->fieldExists('period_number');
    $session->fieldExists('period_type');
    $session->fieldExists('keep');
    $session->buttonExists('Save');

    // Create a new schedule.
    $edit = [
      'label' => 'Test schedule',
      'id' => 'test_schedule',
      'enabled' => TRUE,
      'source_id' => 'default_db',
      'destination_id' => 'private_files',
      'period_number' => 14400,
      'period_type' => 'minutes',
      'keep' => 1000,
    ];
    $this->submitForm($edit, 'Save');

    // Make sure the form saved correctly.
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/schedule');
    $session->pageTextContains('Created the Test schedule Schedule.');
    $session->pageTextContains('Every 10 days');
    $session->pageTextContains('Last 1000 backups');
    $session->pageTextContains('Yes');
  }

  /**
   * Make sure the 'profiles' system works correctly.
   */
  public function testProfilesAdmin() {
    // Load the profiles page.
    // @todo Confirm the table has no records.
    $this->drupalGet('admin/config/development/backup_migrate/settings');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Settings');
    $session->pageTextContains('Profile Name');

    // Load the profile-add form.
    $this->drupalGet('admin/config/development/backup_migrate/settings/add');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Add settings profile');
    $session->fieldExists('label');
    $session->fieldExists('id');
    $session->fieldExists('config[namer][filename]');
    $session->fieldExists('config[namer][timestamp]');
    $session->fieldExists('config[namer][timestamp_format]');
    $session->fieldExists('config[compressor][compression]');
    $session->fieldExists('config[utils][site_offline]');
    $session->fieldExists('config[metadata][description]');
    $session->fieldExists('config[db_exclude][exclude_tables][]');
    $session->fieldExists('config[db_exclude][nodata_tables][]');
    $session->fieldExists('config[private_files_exclude][exclude_filepaths]');
    $session->fieldExists('config[public_files_exclude][exclude_filepaths]');
    $session->buttonExists('Save');

    // Create a new profile.
    $edit = [
      'label' => 'Test profile',
      'id' => 'test_profile',
      'config[namer][filename]' => 'test_backup',
      'config[namer][timestamp]' => 'Y-m-d\TH-i-s',
      'config[compressor][compression]' => 'none',
      'config[utils][site_offline]' => 1,
      'config[metadata][description]' => 'Test description text.',
      'config[db_exclude][exclude_tables][]' => [],
      'config[db_exclude][nodata_tables][]' => [],
      'config[private_files_exclude][exclude_filepaths]' => 'test_private_exclude',
      'config[public_files_exclude][exclude_filepaths]' => 'test_public_exclude',
    ];
    $this->submitForm($edit, 'Save');

    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/config/development/backup_migrate/settings');
    $session->pageTextContains('Created the Test profile Settings Profile.');
    $session->pageTextContains('Profile Name');
    $session->pageTextContains('Machine name');
    $session->pageTextContains('Compression');
    $session->pageTextContains('Take site offline');
    $session->pageTextContains('Description');
    $session->pageTextContains('Test profile');
    $session->pageTextContains('test_profile');
    $session->pageTextContains('none');
    $session->pageTextContains('1');
    $session->pageTextContains('Test description text.');
  }

  /**
   * Run the system cron.
   */
  public function testCron() {
    // Turn on the default schedule.
    $this->drupalGet('admin/config/development/backup_migrate/schedule/edit/daily_schedule');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->fieldExists('Schedule enabled');
    $edit = [
      'enabled' => TRUE,
      'period_number' => 1,
      'period_type' => 'days',
    ];
    $this->submitForm($edit, 'Save');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('Saved the Daily Schedule Schedule.');
    $session->pageTextContains('Never');
    $session->pageTextContains('Next cron run');

    // Confirm the backup destination is empty.
    $this->drupalGet('admin/config/development/backup_migrate/settings/destination/backups/private_files');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextContains('There are no backups in this destination.');

    // Trigger cron.
    $this->drupalGet('admin/reports/status');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->linkExists('Run cron');
    $this->clickLink('Run cron');

    // Make sure that cron ran correctly.
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->addressEquals('admin/reports/status');
    $session->pageTextContains('Cron ran successfully.');

    // Check that the schedule is enabled.
    $this->drupalGet('admin/config/development/backup_migrate/schedule/edit/daily_schedule');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);

    // Confirm a backup was created.
    $this->drupalGet('admin/config/development/backup_migrate/settings/destination/backups/private_files');
    $session = $this->assertSession();
    $session->statusCodeEquals(200);
    $session->pageTextNotContains('There are no backups in this destination.');
  }

  /**
   * Tests the advanced backup.
   *
   * Tests the advanced backup using the "Take site offline" setting and
   * setting the Backup Destination to "Download".
   */
  public function testAdvancedBackupWithMaintenanceModeEnabledDestinationDownload() {
    $session = $this->assertSession();
    $page = $this->getSession()->getPage();
    // Got to the advance backup site and create a backup with taking the site
    // offline:
    $this->drupalGet('/admin/config/development/backup_migrate/advanced');
    $session->statusCodeEquals(200);
    $page->checkField('edit-utils-site-offline');
    $page->selectFieldOption('edit-destination-id', 'download');
    $page->pressButton('edit-submit');
    // Setting both the site offline and the destination to download should
    // not be allowed:
    $session->statusCodeEquals(200);
    $session->pageTextContains('The Backup Destination "Download" does not support taking the site offline during backup.');
    // Uncheck taking the site offline:
    $page->uncheckField('edit-utils-site-offline');
    $page->pressButton('edit-submit');
    // Check if the backup is downloaded now:
    $session->statusCodeEquals(200);
    $session->responseHeaderContains('Content-Disposition', 'attachment');
    // Check if the front page is still reachable after the backup:
    $this->drupalGet('<front>');
    $session->statusCodeEquals(200);
  }

  /**
   * Tests the advanced backup.
   *
   * Tests the advanced backup using the "Take site offline" setting and
   * setting the Backup Destination to "Private Files Directory".
   */
  public function testAdvancedBackupWithMaintenanceModeEnabledDestinationPrivate() {
    $session = $this->assertSession();
    $page = $this->getSession()->getPage();
    // Check if maintenance mode is currently disabled, note that as we have not
    // changed it yet, it will be NULL as it is uninitialized:
    $this->assertEmpty(\Drupal::state()->get('system.maintenance_mode'));
    // Got to the advance backup site and create a backup with taking the site
    // offline:
    $this->drupalGet('/admin/config/development/backup_migrate/advanced');
    $session->statusCodeEquals(200);
    $page->checkField('edit-utils-site-offline');
    $page->selectFieldOption('edit-destination-id', 'private_files');
    $page->pressButton('edit-submit');
    // Check if the backup was completed:
    $session->statusCodeEquals(200);
    $session->pageTextContains('Backup Complete.');
    // Maintenance mode should be disabled now, check the front page:
    $this->drupalGet('<front>');
    $session->statusCodeEquals(200);
    // It should be FALSE now, as it was enabled and then disabled:
    $this->assertFalse(\Drupal::state()->get('system.maintenance_mode'));
  }

}