You are here

class SimplesitemapTest in Simple XML sitemap 4.x

Same name and namespace in other branches
  1. 8.3 tests/src/Functional/SimplesitemapTest.php \Drupal\Tests\simple_sitemap\Functional\SimplesitemapTest
  2. 8.2 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 16

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.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testInitialGeneration() {
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('urlset');
    $this
      ->assertSession()
      ->responseContains(Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString());
    $this
      ->assertSession()
      ->responseContains('1.0');
    $this
      ->assertSession()
      ->responseContains('daily');
  }

  /**
   * Test custom link.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testAddCustomLink() {
    $this->generator
      ->customLinkManager()
      ->add('/node/' . $this->node
      ->id(), [
      'priority' => 0.2,
      'changefreq' => 'monthly',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $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
      ->customLinkManager()
      ->add('/node/' . $this->node
      ->id(), [
      'changefreq' => 'yearly',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet('admin/config/search/simplesitemap/custom');
    $this
      ->assertSession()
      ->pageTextContains('/node/' . $this->node
      ->id() . ' yearly');
  }

  /**
   * Test default settings of custom links.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testAddCustomLinkDefaults() {
    $this->generator
      ->customLinkManager()
      ->remove()
      ->add('/node/' . $this->node
      ->id());
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('changefreq');
  }

  /**
   * Tests locks
   */
  public function testLocking() {
    $this->generator
      ->customLinkManager()
      ->remove()
      ->add('/node/' . $this->node
      ->id());
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalLogin($this
      ->createUser([
      'administer sitemap settings',
    ]));
    $this
      ->drupalGet('/admin/config/search/simplesitemap/settings');
    $this
      ->submitForm([
      'simple_sitemap_regenerate_now' => TRUE,
    ], 'Save configuration');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->assertSession()
      ->pageTextNotContains('Unable to acquire a lock for sitemap generation.');
    \Drupal::lock()
      ->acquire(QueueWorker::LOCK_ID);
    $this
      ->submitForm([
      'simple_sitemap_regenerate_now' => TRUE,
    ], 'Save configuration');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $this
      ->assertSession()
      ->pageTextContainsOnce('Unable to acquire a lock for sitemap generation.');
  }

  /**
   * Test removing custom paths from the sitemap settings.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testRemoveCustomLinks() {

    // Test removing one custom path from the sitemap.
    $this->generator
      ->customLinkManager()
      ->add('/node/' . $this->node
      ->id())
      ->remove('/node/' . $this->node
      ->id());
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());

    // Test removing all custom paths from the sitemap.
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseNotContains(Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString());
  }

  /**
   * Tests setting bundle settings.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   *
   * @todo Add form tests
   */
  public function testSetBundleSettings() {
    $this
      ->assertFalse($this->generator
      ->entityManager()
      ->bundleIsIndexed('node', 'page'));

    // Index new bundle.
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'index' => TRUE,
      'priority' => 0.5,
      'changefreq' => 'hourly',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseContains('hourly');
    $this
      ->assertTrue($this->generator
      ->entityManager()
      ->bundleIsIndexed('node', 'page'));

    // Only change bundle priority.
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'priority' => 0.9,
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('0.5');
    $this
      ->assertSession()
      ->responseContains('0.9');

    // Only change bundle changefreq.
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'changefreq' => 'daily',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseNotContains('hourly');
    $this
      ->assertSession()
      ->responseContains('daily');

    // Remove changefreq setting.
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'changefreq' => '',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $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
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'index' => TRUE,
    ])
      ->setBundleSettings('node', 'blog', [
      'index' => TRUE,
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('node/' . $node3
      ->id());

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

  /**
   * Test default settings of bundles.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testSetBundleSettingsDefaults() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('changefreq');
  }

  /**
   * Test link count.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function testLinkCount() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalLogin($this
      ->createUser([
      'administer sitemap settings',
    ]));
    $this
      ->drupalGet('admin/config/search/simplesitemap');
    $link_count_elements = $this
      ->xpath('//*[@id="simple-sitemap-status-form"]//table/tbody/tr/td[4]');
    $this
      ->assertSame('2', $link_count_elements[0]
      ->getText());
    $this
      ->createNode([
      'title' => 'Another node',
      'type' => 'page',
    ]);
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalLogin($this
      ->createUser([
      'administer sitemap settings',
    ]));
    $this
      ->drupalGet('admin/config/search/simplesitemap');
    $link_count_elements = $this
      ->xpath('//*[@id="simple-sitemap-status-form"]//table/tbody/tr/td[4]');
    $this
      ->assertSame('3', $link_count_elements[0]
      ->getText());
  }

  /**
   * Test the lastmod parameter in different scenarios.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testLastmod() {

    // Entity links should have 'lastmod'.
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('lastmod');

    // Entity custom links should have 'lastmod'.
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'index' => FALSE,
    ]);
    $this->generator
      ->customLinkManager()
      ->add('/node/' . $this->node
      ->id());
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('lastmod');

    // Non-entity custom links should not have 'lastmod'.
    $this->generator
      ->customLinkManager()
      ->remove()
      ->add('/');
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseNotContains('lastmod');
  }

  /**
   * Tests the duplicate setting.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testRemoveDuplicatesSetting() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->add('/node/1');
    $this->generator
      ->saveSetting('remove_duplicates', TRUE)
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertUniqueTextWorkaround('node/' . $this->node
      ->id());
    $this->generator
      ->saveSetting('remove_duplicates', FALSE)
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertNoUniqueTextWorkaround('node/' . $this->node
      ->id());
  }

  /**
   * Test max links setting and the sitemap index.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testMaxLinksSetting() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->saveSetting('max_links', 1)
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('sitemap.xml?page=1');
    $this
      ->assertSession()
      ->responseContains('sitemap.xml?page=2');
    $this
      ->drupalGet('sitemap.xml', [
      'query' => [
        'page' => 1,
      ],
    ]);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node2
      ->id());
    $this
      ->drupalGet('sitemap.xml', [
      'query' => [
        'page' => 2,
      ],
    ]);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node2
      ->id());
    $this
      ->assertSession()
      ->responseContains('0.5');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
  }

  /**
   * @todo testGenerateDurationSetting
   */

  /**
   * Test setting the base URL.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testBaseUrlSetting() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->saveSetting('base_url', 'http://base_url_test')
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('http://base_url_test');

    // Set base URL in the sitemap index.
    $this->generator
      ->saveSetting('max_links', 1)
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('http://base_url_test/sitemap.xml?page=1');
  }

  /**
   * Test overriding of bundle settings for a single entity.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   *
   * @todo: Use form testing instead of responseContains().
   */
  public function testSetEntityInstanceSettings() {
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page')
      ->setEntityInstanceSettings('node', $this->node
      ->id(), [
      'priority' => 0.1,
      'changefreq' => 'never',
    ])
      ->setEntityInstanceSettings('node', $this->node2
      ->id(), [
      'index' => FALSE,
    ]);
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);

    // Test sitemap result.
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $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.
    $this
      ->assertEquals(1, $this
      ->getOverridesCount('node', $this->node
      ->id()));
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page', [
      'priority' => 0.1,
      'changefreq' => 'never',
    ]);
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);

    // Test sitemap result.
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $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.
    $this
      ->assertEquals(0, $this
      ->getOverridesCount('node', $this->node
      ->id()));

    // Assert that creating a new content type doesn't remove the overrides.
    $this
      ->drupalGet('node/' . $this->node
      ->id() . '/edit');
    $this
      ->submitForm([
      'index_default_node_settings' => 0,
    ], 'Save');
    $this
      ->assertEquals(1, $this
      ->getOverridesCount('node', $this->node
      ->id()));

    // Create a new content type.
    $this
      ->drupalGet('admin/structure/types/add');
    $this
      ->submitForm([
      'name' => 'simple_sitemap_type',
      'type' => 'simple_sitemap_type',
      'index_default_node_settings' => 0,
    ], 'Save content type');

    // The entity override from the other content type should not be affected.
    $this
      ->assertEquals(1, $this
      ->getOverridesCount('node', $this->node
      ->id()));

    // Assert that removing the other content type doesn't remove the overrides.
    $this
      ->drupalGet('admin/structure/types/manage/simple_sitemap_type/delete');
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertEquals(1, $this
      ->getOverridesCount('node', $this->node
      ->id()));
  }

  /**
   * Returns the number of entity overrides for the given entity type/ID.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $entity_id
   *   The entity ID.
   *
   * @return int
   *   The number of overrides for the given entity type ID and entity ID.
   */
  protected function getOverridesCount($entity_type_id, $entity_id) {
    return $this->database
      ->select('simple_sitemap_entity_overrides', 'o')
      ->fields('o', [
      'inclusion_settings',
    ])
      ->condition('o.entity_type', $entity_type_id)
      ->condition('o.entity_id', $entity_id)
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * Tests that a page does not break if an entity has its id set.
   */
  public function testNewEntityWithIdSet() {
    $new_node = Node::create([
      'nid' => random_int(5, 10),
      'type' => 'page',
    ]);

    // Assert that the form does not break if an entity has an id but is not
    // saved.
    // @see https://www.drupal.org/project/simple_sitemap/issues/3079897
    \Drupal::service('entity.form_builder')
      ->getForm($new_node);
  }

  /**
   * Test indexing an atomic entity (here: a user)
   */
  public function testAtomicEntityIndexation() {
    $user_id = $this->privilegedUser
      ->id();
    $this->generator
      ->entityManager()
      ->setBundleSettings('user');
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseNotContains('user/' . $user_id);
    user_role_grant_permissions('anonymous', [
      'access user profiles',
    ]);
    drupal_flush_all_caches();

    //todo Not pretty.
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('user/' . $user_id);
  }

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

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

  /**
   * Test disabling sitemap support for an entity type.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testDisableEntityType() {
    $this->generator
      ->entityManager()
      ->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(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
    $this
      ->assertFalse($this->generator
      ->entityManager()
      ->entityTypeIsEnabled('node'));
  }

  /**
   * Test enabling sitemap support for an entity type.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Behat\Mink\Exception\ExpectationException
   *
   * @todo Test admin/config/search/simplesitemap/entities form.
   */
  public function testEnableEntityType() {
    $this->generator
      ->entityManager()
      ->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(QueueWorker::GENERATE_TYPE_BACKEND);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    $this
      ->assertTrue($this->generator
      ->entityManager()
      ->entityTypeIsEnabled('node'));
  }

  /**
   * @todo testSitemapLanguages
   */

  /**
   * Test adding and removing sitemap variants.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testSitemapVariants() {

    // Test adding a variant.
    SimpleSitemap::create([
      'id' => 'test',
      'type' => 'default_hreflang',
    ])
      ->save();
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    $variants = SimpleSitemap::loadMultiple();
    $this
      ->assertArrayHasKey('test', $variants);
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());

    // Test if generation affected the default variant only.
    $this
      ->drupalGet('test/sitemap.xml');
    $this
      ->assertSession()
      ->responseNotContains('node/' . $this->node
      ->id());
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'page');
    $this->generator
      ->setVariants('test')
      ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);

    // Test if bundle settings have been set for correct variant.
    $this
      ->drupalGet($this->defaultSitemapUrl);
    $this
      ->assertSession()
      ->responseContains('node/' . $this->node
      ->id());
    SimpleSitemap::load('test')
      ->delete();
    $variants = SimpleSitemap::loadMultiple();
    $this
      ->assertArrayNotHasKey('test', $variants);

    // Test if sitemap has been removed along with the variant.
    $this
      ->drupalGet('test/sitemap.xml');
    $this
      ->assertSession()
      ->statusCodeEquals(404);
  }

  /**
   * @todo Test removeSitemap().
   */

  /**
   * Test cases for ::testGenerationResume.
   */
  public function generationResumeProvider() {
    return [
      [
        1000,
        500,
        1,
      ],
      [
        1000,
        500,
        3,
        [
          'de',
        ],
      ],
      [
        1000,
        500,
        5,
        [
          'de',
          'es',
        ],
      ],
      [
        10,
        10000,
        10,
      ],
    ];
  }

  /**
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *
   * @dataProvider generationResumeProvider
   */
  public function testGenerationResume($element_count, $generate_duration, $max_links, $langcodes = []) {
    $this
      ->addLanguages($langcodes);
    $expected_sitemap_count = (int) ceil($element_count * (count($langcodes) + 1) / $max_links);
    $this
      ->drupalCreateContentType([
      'type' => 'blog',
    ]);
    for ($i = 1; $i <= $element_count; $i++) {
      $this
        ->createNode([
        'title' => 'node-' . $i,
        'type' => 'blog',
      ]);
    }
    $this->generator
      ->entityManager()
      ->setBundleSettings('node', 'blog');
    $this->generator
      ->customLinkManager()
      ->remove();
    $this->generator
      ->saveSetting('generate_duration', $generate_duration)
      ->saveSetting('max_links', $max_links)
      ->saveSetting('skip_untranslated', FALSE);
    $this->generator
      ->rebuildQueue();
    $generate_count = 0;
    while (\Drupal::service('simple_sitemap.queue_worker')
      ->generationInProgress()) {
      $generate_count++;
      $this->generator
        ->generateSitemap(QueueWorker::GENERATE_TYPE_BACKEND);
    }

    // Test if sitemap generation has been resumed when time limit is very low.
    $this
      ->assertTrue($generate_duration > $element_count || $generate_count > 1, 'This assertion tests if the sitemap generation is split up into batches due to a low generation time limit setting. The failing of this assertion can mean that the sitemap was wrongfully generated in one go, but it can also mean that the assumed low time setting is still high enough for a one pass generation.');

    // Test if correct number of sitemaps have been created.
    $chunks = $this->database
      ->query('SELECT id FROM {simple_sitemap} WHERE delta != 0 AND status = 1');
    $chunks->allowRowCount = TRUE;
    $chunk_count = $chunks
      ->rowCount();
    $this
      ->assertSame($chunk_count, $expected_sitemap_count);

    // Test if index has been created when necessary.
    $index = $this->database
      ->query('SELECT id FROM {simple_sitemap} WHERE delta = 0 AND status = 1')
      ->fetchField();
    $this
      ->assertTrue($chunk_count > 1 ? FALSE !== $index : !$index);
  }

  /**
   * Test the removal of hreflang tags in HTML.
   */
  public function testHrefLangRemoval() {

    // Test the nodes markup contains hreflang with default settings.
    $this->generator
      ->saveSetting('disable_language_hreflang', FALSE);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $this
      ->assertNotEmpty($this
      ->xpath("//link[@hreflang]"));
    Cache::invalidateTags($this->node
      ->getCacheTags());

    // Test the hreflang markup gets removed.
    $this->generator
      ->saveSetting('disable_language_hreflang', TRUE);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $this
      ->assertEmpty($this
      ->xpath("//link[@hreflang]"));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$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.
SimplesitemapTest::generationResumeProvider public function Test cases for ::testGenerationResume.
SimplesitemapTest::getOverridesCount protected function Returns the number of entity overrides for the given entity type/ID.
SimplesitemapTest::testAddCustomLink public function Test custom link.
SimplesitemapTest::testAddCustomLinkDefaults public function Test default settings of custom links.
SimplesitemapTest::testAtomicEntityIndexation public function Test indexing an atomic entity (here: a user)
SimplesitemapTest::testBaseUrlSetting public function Test setting the base URL.
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::testGenerationResume public function @dataProvider generationResumeProvider
SimplesitemapTest::testHrefLangRemoval public function Test the removal of hreflang tags in HTML.
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::testLinkCount public function Test link count.
SimplesitemapTest::testLocking public function Tests locks
SimplesitemapTest::testMaxLinksSetting public function Test max links setting and the sitemap index.
SimplesitemapTest::testNewEntityWithIdSet public function Tests that a page does not break if an entity has its id set.
SimplesitemapTest::testRemoveCustomLinks public function Test removing 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.
SimplesitemapTest::testSitemapVariants public function Test adding and removing sitemap variants.
SimplesitemapTestBase::$database protected property Database service.
SimplesitemapTestBase::$defaultSitemapUrl protected property
SimplesitemapTestBase::$defaultTheme protected property Use the classy theme. Overrides BrowserTestBase::$defaultTheme
SimplesitemapTestBase::$generator protected property Simple sitemap generator.
SimplesitemapTestBase::$modules protected static property Modules to enable for this test. Overrides BrowserTestBase::$modules 1
SimplesitemapTestBase::$node protected property A node.
SimplesitemapTestBase::$node2 protected property A node.
SimplesitemapTestBase::$privilegedUser protected property A user with all the permissions.
SimplesitemapTestBase::$profile protected property Use the testing profile. Overrides BrowserTestBase::$profile
SimplesitemapTestBase::addLanguages protected function
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 1
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. 4
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. 1
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.