You are here

Home » API reference » Backup and Migrate 5.0.x » AdminFunctionalityTest.php

class AdminFunctionalityTest in Backup and Migrate 5.0.x

Same name and namespace in other branches
  1. 8.4 tests/src/Functional/AdminFunctionalityTest.php \Drupal\Tests\backup_migrate\Functional\AdminFunctionalityTest

Checks if admin functionality works correctly.

@group backup_migrate

Hierarchy

Expanded class hierarchy of AdminFunctionalityTest

File

tests/src/Functional/AdminFunctionalityTest.php, line 13

Namespace

Drupal\Tests\backup_migrate\Functional
View source 
class AdminFunctionalityTest extends BrowserTestBase {

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

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

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

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

    // 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 function pagesListProvider() {
    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.
    $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');

    // @todo Confirm the table only has one record.
    // 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.
    $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('Last backups');

    // @todo Confirm the table only has one record.
    // 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.
    $this
      ->drupalGet('admin/config/development/backup_migrate/settings');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);
    $session
      ->pageTextContains('Settings');
    $session
      ->pageTextContains('Profile Name');

    // @todo Confirm the table has no records.
    // 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.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdminFunctionalityTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
AdminFunctionalityTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
AdminFunctionalityTest::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. Overrides TestSetupTrait::$strictConfigSchema
AdminFunctionalityTest::pagesListProvider public function A list of paths to check and a string that should be present on that page.
AdminFunctionalityTest::setUp public function Overrides BrowserTestBase::setUp
AdminFunctionalityTest::testCron public function Run the system cron.
AdminFunctionalityTest::testDestinationsAdmin public function Make sure the 'destinations' system works correctly.
AdminFunctionalityTest::testPages public function Tests each of the admin pages loads correctly.
AdminFunctionalityTest::testProfilesAdmin public function Make sure the 'profiles' system works correctly.
AdminFunctionalityTest::testSchedulesAdmin public function Make sure the 'schedules' system works correctly.
AdminFunctionalityTest::testSourcesAdmin public function Make sure the 'sources' system works correctly.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 20
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.