class IntegrationTest in Search API Saved Searches 8

Tests overall functionality of the module.

@group search_api_saved_searches

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\search_api_saved_searches\Functional\IntegrationTest uses ExampleContentTrait

Expanded class hierarchy of IntegrationTest

File

tests/src/Functional/IntegrationTest.php, line 18

Namespace

Drupal\Tests\search_api_saved_searches\Functional

View source

class IntegrationTest extends BrowserTestBase {
  use ExampleContentTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'block',
    'field_ui',
    // @todo Remove "rest" dependency once we depend on Search API 1.8. See
    //   #2953267.
    'rest',
    'search_api_saved_searches',
    'search_api_test_views',
  ];

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

  /**
   * A admin user used in this test.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $adminUser;

  /**
   * A non-admin user used in this test.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $registeredUser;

  /**
   * A second non-admin user used in this test.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $registeredUser2;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Create test users.
    $this->adminUser = $this
      ->createUser([
      SavedSearchAccessControlHandler::ADMIN_PERMISSION,
      'administer search_api_saved_search display',
      'administer search_api_saved_search fields',
      'administer search_api_saved_search form display',
    ]);
    $this->registeredUser = $this
      ->createUser();
    $this->registeredUser2 = $this
      ->createUser();

    // Use the state system collector mail backend.
    $this
      ->config('system.mail')
      ->set('interface.default', 'test_mail_collector')
      ->save();

    // Report all log messages as errors.
    $logger = new TestLogger('');
    $this->container
      ->set('logger.factory', $logger);
    $this->container
      ->set('logger.channel.search_api_saved_searches', $logger);

    // Generate and index example content.
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
    $this
      ->indexItems('database_search_index');

    // Make normal admin UI navigation possible by enabling some common blocks.
    $this
      ->placeBlock('local_actions_block');
    $this
      ->placeBlock('local_tasks_block');
  }

  /**
   * Tests overall functionality of the module.
   *
   * Uses sub-methods to improve readability.
   */
  public function testModule() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->configureDefaultType();
    $this
      ->addNewType();
    $this
      ->checkFunctionalityAnonymous();
    $this
      ->checkFunctionalityRegistered();
    $this
      ->checkAccessChecks();
    $this
      ->deleteType();
  }

  /**
   * Checks and edits the default saved search type.
   */
  protected function configureDefaultType() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('admin/config/search/search-api-saved-searches');
    $assert_session
      ->pageTextContains('Saved searches');
    $assert_session
      ->pageTextContains('Default');
    $assert_session
      ->pageTextContains('A default type created automatically at module installation.');
    $this
      ->clickLink('Edit');
    $activation_mail = <<<'END'
- Activate: [search-api-saved-search:activate-url]
- View: [search-api-saved-search:view-url]
- Edit: [search-api-saved-search:edit-url]
- Delete: [search-api-saved-search:delete-url]
END;
    $edit = [
      'label' => 'My test default',
      'status' => TRUE,
      'options[displays][default]' => '0',
      'options[displays][selected][views_page:search_api_test_view__page_1]' => TRUE,
      'notification_plugins[email]' => TRUE,
      'notification_configs[email][activate][body]' => $activation_mail,
      'options[max_results]' => 13,
      'options[allow_keys_change]' => TRUE,
      'options[description]' => 'Description for the default type.',
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('Your settings have been saved.');
    $type = SavedSearchType::load('default');
    $expected = [
      'displays' => [
        'default' => FALSE,
        'selected' => [
          'views_page:search_api_test_view__page_1',
        ],
      ],
      'max_results' => 13,
      'allow_keys_change' => TRUE,
      'date_field' => [
        'database_search_index' => '',
      ],
      'description' => 'Description for the default type.',
    ];
    $this
      ->assertEquals($expected, $type
      ->getOptions());
    $this
      ->clickLink('Manage form display');
    $assert_session
      ->pageTextContains('Label');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $assert_session
      ->checkboxChecked('display_modes_custom[create]');
    $this
      ->clickLink('Create');
    $assert_session
      ->pageTextContains('Label');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $this
      ->placeBlock('search_api_saved_searches', [
      'label' => 'Default saved searches block',
      'type' => 'default',
    ]);
  }

  /**
   * Adds a new saved search type.
   */
  protected function addNewType() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('admin/config/search/search-api-saved-searches');
    $this
      ->clickLink('Add saved search type');
    $edit = [
      'label' => 'Foo &amp; Bar',
      'id' => 'foobar',
      'description' => 'Some description text for type <em>Foo &amp;&amp; Bar</em>.',
      'status' => TRUE,
      'options[displays][default]' => TRUE,
      'options[displays][selected][views_page:search_api_test_view__page_1]' => TRUE,
      'options[displays][selected][views_page:search_api_test_sorts__page_1]' => TRUE,
      'notification_plugins[email]' => TRUE,
      'options[max_results]' => '',
      'options[description]' => 'Description for the foobar type.',
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('Please configure the used notification methods.');
    $this
      ->assertNull(SavedSearchType::load('foobar'));
    $activation_mail = <<<'END'
- Activate: [search-api-saved-search:activate-url]
- View: [search-api-saved-search:view-url]
- Edit: [search-api-saved-search:edit-url]
- Delete: [search-api-saved-search:delete-url]
END;
    $edit = [
      'notification_configs[email][registered_choose_mail]' => TRUE,
      'notification_configs[email][activate][body]' => $activation_mail,
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('Your settings have been saved.');
    $this
      ->assertNotNull(SavedSearchType::load('foobar'));
    $this
      ->clickLink('Manage form display');
    $assert_session
      ->pageTextContains('Label');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $assert_session
      ->checkboxChecked('display_modes_custom[create]');
    $this
      ->clickLink('Create');
    $assert_session
      ->pageTextContains('Label');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $this
      ->placeBlock('search_api_saved_searches', [
      'label' => 'Foo &amp; Bar saved searches block',
      'type' => 'foobar',
    ]);
    $this
      ->drupalGet('admin/config/search/search-api-saved-searches');
    $this
      ->assertOnlyEscaped('Foo &amp; Bar');
    $assert_session
      ->responseContains('Some description text for type <em>Foo &amp;&amp; Bar</em>.');
  }

  /**
   * Checks functionality for anonymous users.
   */
  protected function checkFunctionalityAnonymous() {
    $assert_session = $this
      ->assertSession();
    if ($this->loggedInUser) {
      $this
        ->drupalLogout();
    }

    // Anonymous users don't have permission yet to use saved searches.
    $this
      ->drupalGet('search-api-test');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $this
      ->drupalGet('search-api-test-search-view-caching-none');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $this
      ->drupalGet('search-api-test-sorts');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');

    // Grant the permissions.
    $role = Role::load(Role::ANONYMOUS_ID);
    $this
      ->grantPermissions($role, [
      'use default search_api_saved_searches',
      'use foobar search_api_saved_searches',
    ]);

    // Now check that there are the expected blocks on all three search pages.
    $this
      ->drupalGet('search-api-test', [
      'query' => [
        'search_api_fulltext' => 'foo',
      ],
    ]);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Default saved searches block');
    $assert_session
      ->pageTextContains('Description for the default type.');
    $assert_session
      ->pageTextNotContains('Foo &amp; Bar saved searches block');
    $assert_session
      ->pageTextNotContains('Description for the foobar type.');
    $edit = [
      'label[0][value]' => 'First saved search',
      'notify_interval' => '3600',
      'mail[0][value]' => 'test@example.net',
    ];
    $this
      ->submitForm($edit, 'Save search');
    $assert_session
      ->pageTextContains('Your saved search was successfully created.');
    $assert_session
      ->pageTextContains('You will soon receive an e-mail with a confirmation link to activate it.');
    $this
      ->drupalGet('search-api-test-search-view-caching-none', [
      'query' => [
        'search_api_fulltext' => 'bar',
      ],
    ]);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Foo &amp; Bar saved searches block');
    $assert_session
      ->pageTextContains('Description for the foobar type.');
    $assert_session
      ->pageTextNotContains('Default saved searches block');
    $assert_session
      ->pageTextNotContains('Description for the default type.');
    $edit = [
      'label[0][value]' => 'Second saved search',
      'notify_interval' => '86400',
      'mail[0][value]' => 'foobar@example.net',
    ];
    $this
      ->submitForm($edit, 'Save search');
    $assert_session
      ->pageTextContains('Your saved search was successfully created.');
    $assert_session
      ->pageTextContains('You will soon receive an e-mail with a confirmation link to activate it.');
    $this
      ->drupalGet('search-api-test-sorts');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $second_mail = array_pop($captured_emails);
    $first_mail = array_pop($captured_emails);
    $this
      ->assertEquals('test@example.net', $first_mail['to']);
    $this
      ->assertEquals('foobar@example.net', $second_mail['to']);
    $regex = '#- (\\w+):\\s+(\\S+)#';
    $this
      ->assertEquals(4, preg_match_all($regex, $first_mail['body'], $matches, PREG_SET_ORDER));
    $first_mail_urls = [];
    foreach ($matches as $match) {
      $this
        ->assertStringContainsString('token=', $match[2], "{$match[1]} URL for first saved search doesn't include a token.");
      $first_mail_urls[$match[1]] = $match[2];
    }
    $this
      ->assertEquals(4, preg_match_all($regex, $second_mail['body'], $matches, PREG_SET_ORDER));
    $second_mail_urls = [];
    foreach ($matches as $match) {
      $this
        ->assertStringContainsString('token=', $match[2], "{$match[1]} URL for second saved search doesn't include a token.");
      $second_mail_urls[$match[1]] = $match[2];
    }

    // Check URLs for first saved search.
    $this
      ->drupalGet($first_mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Your saved search was successfully activated.');
    $this
      ->drupalGet($first_mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(404);
    $this
      ->drupalGet($first_mail_urls['View']);
    $assert_session
      ->statusCodeEquals(200);
    $search_url = $this
      ->buildUrl('search-api-test', [
      'query' => [
        'search_api_fulltext' => 'foo',
      ],
    ]);
    $assert_session
      ->addressEquals($search_url);
    $this
      ->drupalGet($first_mail_urls['Edit']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Edit saved search First saved search');
    $assert_session
      ->pageTextContains('Fulltext keywords');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $this
      ->drupalGet($first_mail_urls['Delete']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Do you really want to delete this saved search?');

    // Check URLs for second saved search.
    $this
      ->drupalGet($second_mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Your saved search was successfully activated.');
    $this
      ->drupalGet($second_mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(404);
    $this
      ->drupalGet($second_mail_urls['View']);
    $assert_session
      ->statusCodeEquals(200);
    $search_url = $this
      ->buildUrl('search-api-test-search-view-caching-none', [
      'query' => [
        'search_api_fulltext' => 'bar',
      ],
    ]);
    $assert_session
      ->addressEquals($search_url);
    $this
      ->drupalGet($second_mail_urls['Edit']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Edit saved search Second saved search');
    $assert_session
      ->pageTextNotContains('Fulltext keywords');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $this
      ->drupalGet($second_mail_urls['Delete']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Do you really want to delete this saved search?');
  }

  /**
   * Checks functionality for registered users.
   */
  protected function checkFunctionalityRegistered() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalLogin($this->registeredUser);

    // Registered users don't have permission yet to use saved searches.
    $this
      ->drupalGet('search-api-test');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $this
      ->drupalGet('search-api-test-search-view-caching-none');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $this
      ->drupalGet('search-api-test-sorts');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');

    // Grant the permissions.
    $role = Role::load(Role::AUTHENTICATED_ID);
    $this
      ->grantPermissions($role, [
      'use default search_api_saved_searches',
      'use foobar search_api_saved_searches',
    ]);

    // Now check that there are the expected blocks on all three search pages.
    $this
      ->drupalGet('search-api-test', [
      'query' => [
        'search_api_fulltext' => 'foo',
      ],
    ]);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Default saved searches block');
    $assert_session
      ->pageTextContains('Description for the default type.');
    $assert_session
      ->pageTextNotContains('Foo &amp; Bar saved searches block');
    $assert_session
      ->pageTextNotContains('Description for the foobar type.');
    $assert_session
      ->pageTextNotContains('E-mail');
    $edit = [
      'label[0][value]' => 'First saved search',
      'notify_interval' => '3600',
    ];
    $this
      ->submitForm($edit, 'Save search');
    $assert_session
      ->pageTextContains('Your saved search was successfully created.');
    $assert_session
      ->pageTextNotContains('You will soon receive an e-mail with a confirmation link to activate it.');
    $this
      ->drupalGet('search-api-test-search-view-caching-none', [
      'query' => [
        'search_api_fulltext' => 'bar',
      ],
    ]);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Foo &amp; Bar saved searches block');
    $assert_session
      ->pageTextContains('Description for the foobar type.');
    $assert_session
      ->pageTextNotContains('Default saved searches block');
    $assert_session
      ->pageTextNotContains('Description for the default type.');
    $edit = [
      'label[0][value]' => 'Second saved search',
      'notify_interval' => '86400',
      'mail[0][value]' => 'testuser@example.com',
    ];
    $this
      ->submitForm($edit, 'Save search');
    $assert_session
      ->pageTextContains('Your saved search was successfully created.');
    $assert_session
      ->pageTextContains('You will soon receive an e-mail with a confirmation link to activate it.');
    $this
      ->drupalGet('search-api-test-sorts');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextNotContains('Description for the');
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $mail = array_pop($captured_emails);
    $this
      ->assertEquals('testuser@example.com', $mail['to']);
    $regex = '#- (\\w+):\\s+(\\S+)#';
    $this
      ->assertEquals(4, preg_match_all($regex, $mail['body'], $matches, PREG_SET_ORDER));
    $mail_urls = [];
    foreach ($matches as $match) {
      if ($match[1] === 'Activate') {
        $this
          ->assertStringContainsString('token=', $match[2], "{$match[1]} URL for saved search doesn't include a token.");
      }
      else {
        $this
          ->assertStringNotContainsString('token=', $match[2], "{$match[1]} URL for saved search unnecessarily includes a token.");
      }
      $mail_urls[$match[1]] = $match[2];
    }

    // Check URLs for the saved search we got in the mail.
    $this
      ->drupalGet($mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Your saved search was successfully activated.');
    $this
      ->drupalGet($mail_urls['Activate']);
    $assert_session
      ->statusCodeEquals(404);
    $this
      ->drupalGet($mail_urls['View']);
    $assert_session
      ->statusCodeEquals(200);
    $search_url = $this
      ->buildUrl('search-api-test-search-view-caching-none', [
      'query' => [
        'search_api_fulltext' => 'bar',
      ],
    ]);
    $assert_session
      ->addressEquals($search_url);
    $this
      ->drupalGet($mail_urls['Edit']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Edit saved search Second saved search');
    $assert_session
      ->pageTextNotContains('Fulltext keywords');
    $assert_session
      ->pageTextContains('Notification interval');
    $assert_session
      ->pageTextContains('E-mail');
    $this
      ->drupalGet($mail_urls['Delete']);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->pageTextContains('Do you really want to delete this saved search?');
  }

  /**
   * Makes sure access checks work correctly.
   */
  protected function checkAccessChecks() {
    $assert_session = $this
      ->assertSession();

    // Make sure we really have all the expected saved searches present, to
    // avoid confusing assertion failures later.
    $total = \Drupal::entityQuery('search_api_saved_search')
      ->accessCheck(FALSE)
      ->count()
      ->execute();
    $this
      ->assertEquals(4, $total);
    $user1_uid = $this->registeredUser
      ->id();
    $tests = [
      'anonymous' => [
        'account' => NULL,
        'access' => [],
      ],
      'admin' => [
        'account' => $this->adminUser,
        'access' => [
          0,
          $user1_uid,
        ],
      ],
      '1st registered' => [
        'account' => $this->registeredUser,
        'access' => [
          $user1_uid,
        ],
      ],
      '2nd registered' => [
        'account' => $this->registeredUser2,
        'access' => [],
      ],
    ];
    foreach ($tests as $key => $info) {
      if ($this->loggedInUser) {
        $this
          ->drupalLogout();
      }
      if ($info['account']) {
        $this
          ->drupalLogin($info['account']);
      }
      foreach ([
        0,
        $user1_uid,
      ] as $uid) {

        // Unfortunately, web assertions don't let us pass a message, so we have
        // to use this to get any information on where this failed.
        $this
          ->verbose("Testing view for saved searches of user #{$uid} as {$key} user.");
        $this
          ->drupalGet("user/{$uid}/saved-searches");
        if (in_array($uid, $info['access'])) {
          $assert_session
            ->pageTextNotContains('The requested page could not be found.');
        }
        else {
          $assert_session
            ->pageTextContains('The requested page could not be found.');
        }
      }
    }
  }

  /**
   * Deletes the "Foobar" saved search type.
   */
  protected function deleteType() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/config/search/search-api-saved-searches/type/foobar/edit');
    $this
      ->clickLink('Delete');
    $count_foobar_searches = \Drupal::entityQuery('search_api_saved_search')
      ->accessCheck(FALSE)
      ->condition('type', 'foobar')
      ->count()
      ->execute();
    $this
      ->assertGreaterThan(0, $count_foobar_searches);
    $assert_session
      ->pageTextContains('Do you really want to delete this saved search type?');
    if ($count_foobar_searches > 1) {
      $message = "Foo &amp; Bar is used by {$count_foobar_searches} saved searches on your site. You cannot remove this saved search type until you have removed all of the Foo &amp; Bar saved searches.";
    }
    else {
      $message = 'Foo &amp; Bar is used by 1 saved search on your site. You cannot remove this saved search type until you have removed all of the Foo &amp; Bar saved searches.';
    }
    $assert_session
      ->pageTextContains($message);
    $this
      ->assertOnlyEscaped('Foo &amp; Bar');

    // Delete all saved searches of type "foobar".
    $this
      ->drupalGet('admin/content/saved-searches');
    $edit = [
      'type[]' => 'foobar',
    ];
    for ($i = 0; $i < $count_foobar_searches; ++$i) {
      $this
        ->submitForm($edit, 'Apply');
      $this
        ->clickLink('Delete');
      $this
        ->submitForm([], 'Delete');
      $assert_session
        ->pageTextContains('The saved search was successfully deleted.');
      $assert_session
        ->addressEquals($this
        ->buildUrl('admin/content/saved-searches'));
    }
    $this
      ->drupalGet('admin/config/search/search-api-saved-searches/type/foobar/delete');
    $assert_session
      ->pageTextContains('Do you really want to delete this saved search type?');
    $assert_session
      ->pageTextContains('This action cannot be undone.');
    $assert_session
      ->pageTextContains('Configuration deletions');
    $assert_session
      ->pageTextContains('The listed configuration will be deleted.');
    $assert_session
      ->pageTextContains('Block');
    $this
      ->assertOnlyEscaped('Foo &amp; Bar saved searches block');
    $assert_session
      ->pageTextContains('Entity form display');
    $assert_session
      ->pageTextContains('search_api_saved_search.foobar.create');
    $this
      ->submitForm([], 'Delete');
    $assert_session
      ->pageTextContains('The saved search type was successfully deleted.');
    $this
      ->assertNull(SavedSearchType::load('foobar'));
  }

  /**
   * Asserts that the given string is properly escaped on output.
   *
   * Will check that the string is present in its escaped form in the current
   * page's output (of the default session) and that it's neither present
   * unescaped nor double-escaped.
   *
   * @param string $string
   *   The string for which to test proper escaping.
   */
  protected function assertOnlyEscaped(string $string) {
    $assert_session = $this
      ->assertSession();
    $escaped = Html::escape($string);
    $double_escaped = Html::escape($escaped);
    $assert_session
      ->responseContains($escaped);
    if ($string !== $escaped) {
      $assert_session
        ->responseNotContains($string);
    }
    if ($double_escaped !== $escaped) {
      $assert_session
        ->responseNotContains($double_escaped);
    }
  }

}

Members

Name	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::$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
ExampleContentTrait::$entities	protected	property	The generated test entities, keyed by ID.
ExampleContentTrait::$ids	protected	property	The Search API item IDs of the generated entities.
ExampleContentTrait::addTestEntity	protected	function	Creates and saves a test entity with the given values.
ExampleContentTrait::getItemIds	protected	function	Returns the item IDs for the given entity IDs.	1
ExampleContentTrait::indexItems	protected	function	Indexes all (unindexed) items on the specified index.
ExampleContentTrait::insertExampleContent	protected	function	Creates several test entities.
ExampleContentTrait::removeTestEntity	protected	function	Deletes the test entity with the given ID.
ExampleContentTrait::setUpExampleStructure	protected	function	Sets up the necessary bundles on the test entity type.
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.
IntegrationTest::$adminUser	protected	property	A admin user used in this test.
IntegrationTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
IntegrationTest::$modules	public static	property	Modules to enable. Overrides BrowserTestBase::$modules
IntegrationTest::$registeredUser	protected	property	A non-admin user used in this test.
IntegrationTest::$registeredUser2	protected	property	A second non-admin user used in this test.
IntegrationTest::addNewType	protected	function	Adds a new saved search type.
IntegrationTest::assertOnlyEscaped	protected	function	Asserts that the given string is properly escaped on output.
IntegrationTest::checkAccessChecks	protected	function	Makes sure access checks work correctly.
IntegrationTest::checkFunctionalityAnonymous	protected	function	Checks functionality for anonymous users.
IntegrationTest::checkFunctionalityRegistered	protected	function	Checks functionality for registered users.
IntegrationTest::configureDefaultType	protected	function	Checks and edits the default saved search type.
IntegrationTest::deleteType	protected	function	Deletes the "Foobar" saved search type.
IntegrationTest::setUp	protected	function	Overrides BrowserTestBase::setUp
IntegrationTest::testModule	public	function	Tests overall functionality of the module.
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.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$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.

You are here

class IntegrationTest in Search API Saved Searches 8

Hierarchy

File

Namespace

Members

API Navigation