class DependencyRemovalTest in Search API Autocomplete 8

Tests dependency handling of the search entity.

@group search_api_autocomplete

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\search_api_autocomplete\Kernel\DependencyRemovalTest uses PluginTestTrait

Expanded class hierarchy of DependencyRemovalTest

File

tests/src/Kernel/DependencyRemovalTest.php, line 17

Namespace

Drupal\Tests\search_api_autocomplete\Kernel

View source

class DependencyRemovalTest extends KernelTestBase {
  use PluginTestTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'entity_test',
    'search_api_autocomplete',
    'search_api_autocomplete_test',
    'search_api',
    'search_api_test',
    'search_api_test_example_content',
    'system',
    'user',
    'views',
  ];

  /**
   * The autocomplete search entity used in this test.
   *
   * @var \Drupal\search_api_autocomplete\SearchInterface
   */
  protected $search;

  /**
   * A config entity, to be used as a dependency in the tests.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityInterface
   */
  protected $dependency;

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

    // Do not use a batch for tracking the initial items after creating an
    // index when running the tests via the GUI. Otherwise, it seems Drupal's
    // Batch API gets confused and the test fails.
    if (php_sapi_name() != 'cli') {
      \Drupal::state()
        ->set('search_api_use_tracking_batch', FALSE);
    }
    $this
      ->installEntitySchema('entity_test_mulrev_changed');
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('search_api', [
      'search_api_item',
    ]);
    $this
      ->installSchema('system', [
      'key_value_expire',
    ]);
    $this
      ->installConfig('search_api');
    $this
      ->installConfig('search_api_autocomplete_test');

    // Create our test search, but don't save it yet so individual tests can
    // still easily change the settings.
    $this->search = Search::create([
      'id' => 'search_api_autocomplete_test_view',
      'label' => 'Test',
      'status' => TRUE,
      'index_id' => 'autocomplete_search_index',
      'suggester_settings' => [
        'search_api_autocomplete_test' => [],
      ],
      'search_settings' => [
        'views:search_api_autocomplete_test_view' => [],
      ],
    ]);

    // Use a search server as the dependency, since we have that available
    // anyways. The entity type should not matter at all, though.
    $this->dependency = Server::create([
      'id' => 'dependency',
      'name' => 'Test dependency',
      'backend' => 'search_api_test',
    ]);
    $this->dependency
      ->save();
  }

  /**
   * Tests that the dependency on the index works correctly.
   */
  public function testIndexDependency() {
    $this->search
      ->save();
    $index = $this->search
      ->getIndex();

    // Verify that the dependency is included.
    $dependencies = $this->search
      ->getDependencies();
    $this
      ->assertArrayHasKey('config', $dependencies);
    $this
      ->assertContains($index
      ->getConfigDependencyName(), $dependencies['config']);

    // Verify that deleting the index will also delete the search.
    $index
      ->delete();
    $search = Search::load($this->search
      ->id());
    $this
      ->assertNull($search);
  }

  /**
   * Tests that the Views dependency works correctly for a search view.
   */
  public function testViewsDependency() {
    $this->search
      ->save();
    $view = View::load('search_api_autocomplete_test_view');

    // Verify that the dependencies are both included.
    $dependencies = $this->search
      ->getDependencies();
    $this
      ->assertArrayHasKey('config', $dependencies);
    $this
      ->assertContains($view
      ->getConfigDependencyName(), $dependencies['config']);
    $this
      ->assertArrayHasKey('module', $dependencies);
    $this
      ->assertContains('views', $dependencies['module']);

    // Verify that deleting the view will also delete the search.
    $view
      ->delete();
    $search = Search::load($this->search
      ->id());
    $this
      ->assertNull($search);
  }

  /**
   * Tests that a general search plugin dependency works correctly.
   *
   * @param bool $removable
   *   TRUE if the search plugin's dependency should be removable, FALSE
   *   otherwise.
   *
   * @dataProvider searchPluginDependencyDataProvider
   */
  public function testSearchPluginDependency($removable) {
    $dependency_key = $this->dependency
      ->getConfigDependencyKey();
    $dependency_name = $this->dependency
      ->getConfigDependencyName();
    $this->search
      ->set('search_settings', [
      'search_api_autocomplete_test' => [
        'dependencies' => [
          $dependency_key => [
            $dependency_name,
          ],
        ],
      ],
    ]);
    $this->search
      ->save();
    $this
      ->setReturnValue('search', 'onDependencyRemoval', $removable);

    // Verify that the dependencies are all included.
    $dependencies = $this->search
      ->getDependencies();
    $this
      ->assertArrayHasKey($dependency_key, $dependencies);
    $this
      ->assertContains($dependency_name, $dependencies[$dependency_key]);
    $this
      ->assertArrayHasKey('module', $dependencies);
    $this
      ->assertContains('search_api_autocomplete_test', $dependencies['module']);

    // Delete the dependency and verify that the result is as expected.
    $this->dependency
      ->delete();
    $search = Search::load($this->search
      ->id());
    if ($removable) {
      $this
        ->assertNotNull($search);
      $dependencies = $search
        ->getDependencies();
      $dependencies += [
        $dependency_key => [],
      ];
      $this
        ->assertNotContains($dependency_name, $dependencies[$dependency_key]);
    }
    else {
      $this
        ->assertNull($search);
    }
  }

  /**
   * Provides test data sets for testSearchPluginDependency().
   *
   * @return array[]
   *   An array of argument arrays for testSearchPluginDependency().
   *
   * @see \Drupal\Tests\search_api_autocomplete\Kernel\DependencyRemovalTest::testSearchPluginDependency()
   */
  public function searchPluginDependencyDataProvider() {
    return [
      'soft dependency' => [
        TRUE,
      ],
      'hard dependency' => [
        FALSE,
      ],
    ];
  }

  /**
   * Tests that a suggester dependency works correctly.
   *
   * @param bool $removable
   *   TRUE if the suggester's dependency should be removable, FALSE otherwise.
   * @param bool $second_suggester
   *   TRUE if a second suggester, apart from the test suggester, should be
   *   included in the search, FALSE otherwise.
   *
   * @dataProvider suggesterDependencyDataProvider
   */
  public function testSuggesterDependency($removable, $second_suggester) {
    $dependency_key = $this->dependency
      ->getConfigDependencyKey();
    $dependency_name = $this->dependency
      ->getConfigDependencyName();
    $suggester_id = 'search_api_autocomplete_test';
    $settings = [
      $suggester_id => [
        'dependencies' => [
          $dependency_key => [
            $dependency_name,
          ],
        ],
      ],
    ];
    if ($second_suggester) {

      // Make the test backend support autocomplete so that the "Server"
      // suggester becomes available.
      $callback = [
        TestsHelper::class,
        'getSupportedFeatures',
      ];
      $this
        ->setMethodOverride('backend', 'getSupportedFeatures', $callback);
      $callback = [
        TestsHelper::class,
        'getAutocompleteSuggestions',
      ];
      $this
        ->setMethodOverride('backend', 'getAutocompleteSuggestions', $callback);
      $settings['server'] = [];
    }
    $this->search
      ->set('suggester_settings', $settings);
    $this->search
      ->save();
    $this
      ->setReturnValue('suggester', 'onDependencyRemoval', $removable);

    // Verify that the dependencies are all included.
    $dependencies = $this->search
      ->getDependencies();
    $this
      ->assertArrayHasKey($dependency_key, $dependencies);
    $this
      ->assertContains($dependency_name, $dependencies[$dependency_key]);
    $this
      ->assertArrayHasKey('module', $dependencies);
    $this
      ->assertContains('search_api_autocomplete_test', $dependencies['module']);

    // Delete the dependency and verify that the result is as expected.
    $this->dependency
      ->delete();
    $search = Search::load($this->search
      ->id());
    $this
      ->assertNotNull($search);
    $this
      ->assertEquals($removable || $second_suggester, $search
      ->status());
    $dependencies = $search
      ->getDependencies();
    $dependencies += [
      $dependency_key => [],
    ];
    $this
      ->assertNotContains($dependency_name, $dependencies[$dependency_key]);
    $this
      ->assertEquals($removable, $search
      ->isValidSuggester($suggester_id));
  }

  /**
   * Provides test data sets for testSuggesterDependency().
   *
   * @return array[]
   *   An array of argument arrays for testSuggesterDependency().
   *
   * @see \Drupal\Tests\search_api_autocomplete\Kernel\DependencyRemovalTest::testSuggesterDependency()
   */
  public function suggesterDependencyDataProvider() {
    return [
      'soft dependency, one suggester' => [
        TRUE,
        FALSE,
      ],
      'hard dependency, one suggester' => [
        FALSE,
        FALSE,
      ],
      'soft dependency, two suggesters' => [
        TRUE,
        TRUE,
      ],
      'hard dependency, two suggesters' => [
        FALSE,
        TRUE,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
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::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
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.
DependencyRemovalTest::$dependency	protected	property	A config entity, to be used as a dependency in the tests.
DependencyRemovalTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
DependencyRemovalTest::$search	protected	property	The autocomplete search entity used in this test.
DependencyRemovalTest::searchPluginDependencyDataProvider	public	function	Provides test data sets for testSearchPluginDependency().
DependencyRemovalTest::setUp	protected	function	Overrides KernelTestBase::setUp
DependencyRemovalTest::suggesterDependencyDataProvider	public	function	Provides test data sets for testSuggesterDependency().
DependencyRemovalTest::testIndexDependency	public	function	Tests that the dependency on the index works correctly.
DependencyRemovalTest::testSearchPluginDependency	public	function	Tests that a general search plugin dependency works correctly.
DependencyRemovalTest::testSuggesterDependency	public	function	Tests that a suggester dependency works correctly.
DependencyRemovalTest::testViewsDependency	public	function	Tests that the Views dependency works correctly for a search view.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
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.
PluginTestTrait::getCalledMethods	protected	function	Retrieves the methods called on a given plugin.
PluginTestTrait::getMethodArguments	protected	function	Retrieves the arguments of a certain method called on the given plugin.
PluginTestTrait::setError	protected	function	Sets an exception to be thrown on calls to the given method.
PluginTestTrait::setMethodOverride	protected	function	Overrides a method for a certain plugin.
PluginTestTrait::setReturnValue	protected	function	Sets the return value for a certain method on a test plugin.
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.
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.

You are here

class DependencyRemovalTest in Search API Autocomplete 8

Hierarchy

File

Namespace

Members

API Navigation