You are here

Home » API reference » Simple XML sitemap 8.2 » SimplesitemapTest.php

class SimplesitemapTest in Simple XML sitemap 8.2

Same name and namespace in other branches
  1. 8.3 tests/src/Functional/SimplesitemapTest.php \Drupal\Tests\simple_sitemap\Functional\SimplesitemapTest
  2. 4.x tests/src/Functional/SimplesitemapTest.php \Drupal\Tests\simple_sitemap\Functional\SimplesitemapTest

Tests Simple XML sitemap functional integration.

@group simple_sitemap

Hierarchy

Expanded class hierarchy of SimplesitemapTest

File

tests/src/Functional/SimplesitemapTest.php, line 12

Namespace

Drupal\Tests\simple_sitemap\Functional
View source 
class SimplesitemapTest extends SimplesitemapTestBase {

  /**
   * Verify sitemap.xml has the link to the front page after first generation.
   */
  public function testInitialGeneration() {
    $this->generator
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('urlset');
    $this
      ->assertSession()
      ->responseContains(Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString());
    $this
      ->assertSession()
      ->responseContains('1.0');
    $this
      ->assertSession()
      ->responseContains('daily');
  }

  /**
   * Test custom link.
   */
  public function testAddCustomLink() {
    $this->generator
      ->addCustomLink('/node/' . $this->node
      ->id(), [
      'priority' => 0.2,
      'changefreq' => 'monthly',
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.2');
    $this
      ->assertSession()
      ->responseContains('monthly');
    $this
      ->drupalLogin($this->privilegedUser);
    $this
      ->drupalGet('admin/config/search/simplesitemap/custom');
    $this
      ->assertSession()
      ->pageTextContains('/node/' . $this->node
      ->id() . ' 0.2 monthly');
    $this->generator
      ->addCustomLink('/node/' . $this->node
      ->id(), [
      'changefreq' => 'yearly',
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('admin/config/search/simplesitemap/custom');
    $this
      ->assertSession()
      ->pageTextContains('/node/' . $this->node
      ->id() . ' yearly');
  }

  /**
   * Test default settings of custom links.
   */
  public function testAddCustomLinkDefaults() {
    $this->generator
      ->removeCustomLinks()
      ->addCustomLink('/node/' . $this->node
      ->id())
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('changefreq');
  }

  /**
   * Test removing custom links from the sitemap.
   */
  public function testRemoveCustomLink() {
    $this->generator
      ->addCustomLink('/node/' . $this->node
      ->id())
      ->removeCustomLink('/node/' . $this->node
      ->id())
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
  }

  /**
   * Test removing all custom paths from the sitemap settings.
   */
  public function testRemoveCustomLinks() {
    $this->generator
      ->removeCustomLinks()
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains(Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString());
  }

  /**
   * Tests setting bundle settings.
   *
   * @todo Add form tests
   */
  public function testSetBundleSettings() {
    $this
      ->assertFalse($this->generator
      ->bundleIsIndexed('node', 'page'));

    // Index new bundle.
    $this->generator
      ->removeCustomLinks()
      ->setBundleSettings('node', 'page', [
      'index' => TRUE,
      'priority' => 0.5,
      'changefreq' => 'hourly',
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseContains('hourly');
    $this
      ->assertTrue($this->generator
      ->bundleIsIndexed('node', 'page'));

    // Only change bundle priority.
    $this->generator
      ->setBundleSettings('node', 'page', [
      'priority' => 0.9,
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('0.5');
    $this
      ->assertSession()
      ->responseContains('0.9');

    // Only change bundle changefreq.
    $this->generator
      ->setBundleSettings('node', 'page', [
      'changefreq' => 'daily',
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('hourly');
    $this
      ->assertSession()
      ->responseContains('daily');

    // Remove changefreq setting.
    $this->generator
      ->setBundleSettings('node', 'page', [
      'changefreq' => '',
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('changefreq');
    $this
      ->assertSession()
      ->responseNotContains('daily');

    // Index two bundles.
    $this
      ->drupalCreateContentType([
      'type' => 'blog',
    ]);
    $node3 = $this
      ->createNode([
      'title' => 'Node3',
      'type' => 'blog',
    ]);
    $this->generator
      ->setBundleSettings('node', 'page', [
      'index' => TRUE,
    ])
      ->setBundleSettings('node', 'blog', [
      'index' => TRUE,
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('node/' . $node3
      ->id());

    // Set bundle 'index' setting to false.
    $this->generator
      ->setBundleSettings('node', 'page', [
      'index' => FALSE,
    ])
      ->setBundleSettings('node', 'blog', [
      'index' => FALSE,
    ])
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('node/' . $node3
      ->id());
  }

  /**
   * Test default settings of bundles.
   */
  public function testSetBundleSettingsDefaults() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->removeCustomLinks()
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('changefreq');
  }

  /**
   * Test the lastmod parameter in different scenarios.
   */
  public function testLastmod() {

    // Entity links should have 'lastmod'.
    $this->generator
      ->setBundleSettings('node', 'page')
      ->removeCustomLinks()
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('lastmod');

    // Entity custom links should have 'lastmod'.
    $this->generator
      ->setBundleSettings('node', 'page', [
      'index' => FALSE,
    ])
      ->addCustomLink('/node/' . $this->node
      ->id())
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('lastmod');

    // Non-entity custom links should not have 'lastmod'.
    $this->generator
      ->removeCustomLinks()
      ->addCustomLink('/')
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains('lastmod');
  }

  /**
   * Tests the duplicate setting.
   *
   * @todo On second generation too many links in XML output here?
   */
  public function testRemoveDuplicatesSetting() {
    $this->generator
      ->setBundleSettings('node', 'page', [
      'index' => TRUE,
    ])
      ->addCustomLink('/node/1')
      ->saveSetting('remove_duplicates', TRUE)
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertUniqueTextWorkaround('node/' . $this->node
      ->id());
    $this->generator
      ->saveSetting('remove_duplicates', FALSE)
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertNoUniqueTextWorkaround('node/' . $this->node
      ->id());
  }

  /**
   * Test max links setting and the sitemap index.
   */
  public function testMaxLinksSetting() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->saveSetting('max_links', 1)
      ->removeCustomLinks()
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('sitemaps/1/sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('sitemaps/2/sitemap.xml');
    $this
      ->drupalGet('sitemaps/1/sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node2
      ->id());
    $this
      ->drupalGet('sitemaps/2/sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node2
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
  }

  /**
   * Test batch process limit setting.
   */
  public function testBatchProcessLimitSetting() {

    // Create some nodes.
    for ($i = 3; $i <= 50; $i++) {
      $this
        ->createNode([
        'title' => "Node{$i}",
        'type' => 'page',
      ]);
    }

    // Test batch_process_limit setting.
    $sitemap = $this->generator
      ->setBundleSettings('node', 'page')
      ->generateSitemap('nobatch')
      ->getSitemap();
    $sitemap2 = $this->generator
      ->saveSetting('batch_process_limit', 1)
      ->generateSitemap('nobatch')
      ->getSitemap();
    $sitemap3 = $this->generator
      ->saveSetting('batch_process_limit', 10)
      ->generateSitemap('nobatch')
      ->getSitemap();
    $this
      ->assertEquals($sitemap2, $sitemap);
    $this
      ->assertEquals($sitemap3, $sitemap);

    // Test batch_process_limit setting in combination with max_links setting.
    $sitemap_index = $this->generator
      ->setBundleSettings('node', 'page')
      ->saveSetting('batch_process_limit', 1500)
      ->saveSetting('max_links', 30)
      ->generateSitemap('nobatch')
      ->getSitemap();
    $sitemap_chunk = $this->generator
      ->getSitemap(1);
    $sitemap_index2 = $this->generator
      ->saveSetting('batch_process_limit', 1)
      ->generateSitemap('nobatch')
      ->getSitemap();
    $sitemap_chunk2 = $this->generator
      ->getSitemap(1);
    $sitemap_index3 = $this->generator
      ->saveSetting('batch_process_limit', 10)
      ->generateSitemap('nobatch')
      ->getSitemap();
    $sitemap_chunk3 = $this->generator
      ->getSitemap(1);
    $this
      ->assertSame($sitemap_index2, $sitemap_index);
    $this
      ->assertSame($sitemap_chunk2, $sitemap_chunk);
    $this
      ->assertSame($sitemap_index3, $sitemap_index);
    $this
      ->assertSame($sitemap_chunk3, $sitemap_chunk);
  }

  /**
   * Test setting the base URL.
   */
  public function testBaseUrlSetting() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->saveSetting('base_url', 'http://base_url_test')
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('http://base_url_test');

    // Set base URL in the sitemap index.
    $this->generator
      ->saveSetting('max_links', 1)
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('http://base_url_test/sitemaps/1/sitemap.xml');
  }

  /**
   * @todo testSkipUntranslatedSetting
   */

  /**
   * @todo testSkipNonExistentTranslations
   */

  /**
   * Test cacheability of the response.
   */
  public function testCacheability() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->generateSitemap('nobatch');

    // Verify the cache was flushed and node is in the sitemap.
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertEquals('MISS', $this
      ->drupalGetHeader('X-Drupal-Cache'));
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());

    // Verify the sitemap is taken from cache on second call and node is in the
    // sitemap.
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertEquals('HIT', $this
      ->drupalGetHeader('X-Drupal-Cache'));
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
  }

  /**
   * Test overriding of bundle settings for a single entity.
   *
   * @todo: Use form testing instead of responseContains().
   */
  public function testSetEntityInstanceSettings() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->removeCustomLinks()
      ->setEntityInstanceSettings('node', $this->node
      ->id(), [
      'priority' => 0.1,
      'changefreq' => 'never',
    ])
      ->setEntityInstanceSettings('node', $this->node2
      ->id(), [
      'index' => FALSE,
    ])
      ->generateSitemap('nobatch');

    // Test sitemap result.
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.1');
    $this
      ->assertSession()
      ->responseContains('never');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node2
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('0.5');
    $this
      ->drupalLogin($this->privilegedUser);

    // Test UI changes.
    $this
      ->drupalGet('node/' . $this->node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->responseContains('<option value="0.1" selected="selected">0.1</option>');
    $this
      ->assertSession()
      ->responseContains('<option value="never" selected="selected">never</option>');

    // Test database changes.
    $result = $this->database
      ->select('simple_sitemap_entity_overrides', 'o')
      ->fields('o', [
      'inclusion_settings',
    ])
      ->condition('o.entity_type', 'node')
      ->condition('o.entity_id', $this->node
      ->id())
      ->execute()
      ->fetchField();
    $this
      ->assertFalse(empty($result));
    $this->generator
      ->setBundleSettings('node', 'page', [
      'priority' => 0.1,
      'changefreq' => 'never',
    ])
      ->generateSitemap('nobatch');

    // Test sitemap result.
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.1');
    $this
      ->assertSession()
      ->responseContains('never');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node2
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('0.5');

    // Test UI changes.
    $this
      ->drupalGet('node/' . $this->node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->responseContains('<option value="0.1" selected="selected">0.1 (default)</option>');
    $this
      ->assertSession()
      ->responseContains('<option value="never" selected="selected">never (default)</option>');

    // Test if entity override has been removed from database after its equal to
    // its bundle settings.
    $result = $this->database
      ->select('simple_sitemap_entity_overrides', 'o')
      ->fields('o', [
      'inclusion_settings',
    ])
      ->condition('o.entity_type', 'node')
      ->condition('o.entity_id', $this->node
      ->id())
      ->execute()
      ->fetchField();
    $this
      ->assertTrue(empty($result));
  }

  /**
   * Test indexing an atomic entity (here: a user)
   * @todo Not working
   */

  /*public function testAtomicEntityIndexation() {
      $user_id = $this->privilegedUser->id();
      $this->generator->setBundleSettings('user')
        ->generateSitemap('nobatch');

      $this->drupalGet('sitemap.xml');
      $this->assertSession()->responseNotContains('user/' . $user_id);

      user_role_grant_permissions(0, ['access user profiles']);
      $this->generator->generateSitemap('nobatch');

      $this->drupalGet('sitemap.xml');
      $this->assertSession()->responseContains('user/' . $user_id);
    }*/

  /**
   * @todo Test indexing menu.
   */

  /**
   * @todo Test deleting a bundle.
   */

  /**
   * Test disabling sitemap support for an entity type.
   */
  public function testDisableEntityType() {
    $this->generator
      ->setBundleSettings('node', 'page')
      ->disableEntityType('node');
    $this
      ->drupalLogin($this->privilegedUser);
    $this
      ->drupalGet('admin/structure/types/manage/page');
    $this
      ->assertSession()
      ->pageTextNotContains('Simple XML sitemap');
    $this->generator
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
    $this
      ->assertFalse($this->generator
      ->entityTypeIsEnabled('node'));
  }

  /**
   * Test enabling sitemap support for an entity type.
   *
   * @todo Test admin/config/search/simplesitemap/entities form.
   */
  public function testEnableEntityType() {
    $this->generator
      ->disableEntityType('node')
      ->enableEntityType('node')
      ->setBundleSettings('node', 'page');
    $this
      ->drupalLogin($this->privilegedUser);
    $this
      ->drupalGet('admin/structure/types/manage/page');
    $this
      ->assertSession()
      ->pageTextContains('Simple XML sitemap');
    $this->generator
      ->generateSitemap('nobatch');
    $this
      ->drupalGet('sitemap.xml');
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertTrue($this->generator
      ->entityTypeIsEnabled('node'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 23
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.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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.
SimplesitemapTest::testAddCustomLink public function Test custom link.
SimplesitemapTest::testAddCustomLinkDefaults public function Test default settings of custom links.
SimplesitemapTest::testBaseUrlSetting public function Test setting the base URL.
SimplesitemapTest::testBatchProcessLimitSetting public function Test batch process limit setting.
SimplesitemapTest::testCacheability public function Test cacheability of the response.
SimplesitemapTest::testDisableEntityType public function Test disabling sitemap support for an entity type.
SimplesitemapTest::testEnableEntityType public function Test enabling sitemap support for an entity type.
SimplesitemapTest::testInitialGeneration public function Verify sitemap.xml has the link to the front page after first generation.
SimplesitemapTest::testLastmod public function Test the lastmod parameter in different scenarios.
SimplesitemapTest::testMaxLinksSetting public function Test max links setting and the sitemap index.
SimplesitemapTest::testRemoveCustomLink public function Test removing custom links from the sitemap.
SimplesitemapTest::testRemoveCustomLinks public function Test removing all custom paths from the sitemap settings.
SimplesitemapTest::testRemoveDuplicatesSetting public function Tests the duplicate setting.
SimplesitemapTest::testSetBundleSettings public function Tests setting bundle settings.
SimplesitemapTest::testSetBundleSettingsDefaults public function Test default settings of bundles.
SimplesitemapTest::testSetEntityInstanceSettings public function Test overriding of bundle settings for a single entity.
SimplesitemapTestBase::$database protected property Database service.
SimplesitemapTestBase::$generator protected property Simple sitemap generator.
SimplesitemapTestBase::$modules public static property Modules to enable for this test. Overrides BrowserTestBase::$modules
SimplesitemapTestBase::$node protected property A node.
SimplesitemapTestBase::$node2 protected property A node.
SimplesitemapTestBase::$privilegedUser protected property An user with all the permissions.
SimplesitemapTestBase::assertNoUniqueTextWorkaround protected function Helper function to replace assertNoUniqueText.
SimplesitemapTestBase::assertUniqueTextWorkaround protected function Helper function to replace assertUniqueText.
SimplesitemapTestBase::setUp protected function Overrides BrowserTestBase::setUp
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.