You are here

Home » API reference » Search API 8 » SerializationTest.php

class SerializationTest in Search API 8

Tests that various classes can be properly serialized and/or cloned.

@group search_api

Hierarchy

Expanded class hierarchy of SerializationTest

File

tests/src/Kernel/System/SerializationTest.php, line 17

Namespace

Drupal\Tests\search_api\Kernel\System
View source 
class SerializationTest extends KernelTestBase {

  /**
   * A test index for use in these tests.
   *
   * @var \Drupal\search_api\IndexInterface|null
   */
  protected $index;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'search_api',
    'search_api_test',
    'node',
    'user',
    'system',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('search_api', [
      'search_api_item',
    ]);
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installEntitySchema('node');
    $this
      ->installConfig('search_api');

    // As our test index, just use the one from the DB Defaults module.
    $path = __DIR__ . '/../../../../modules/search_api_db/search_api_db_defaults/config/optional/search_api.index.default_index.yml';
    $index_values = Yaml::decode(file_get_contents($path));
    $this->index = Index::create($index_values);
    $server = Server::create([
      'id' => 'test_server',
      'name' => 'Test Server',
      'status' => TRUE,
      'backend' => 'search_api_test',
    ]);
    $server
      ->save();
    $this->index
      ->setServer($server)
      ->save();
    $this->index = Index::load($this->index
      ->id());
  }

  /**
   * Tests that serialization of index entities doesn't lead to data loss.
   */
  public function testIndexSerialization() {
    $index = $this->index;

    // Make some changes to the index to ensure they're saved, too.
    $field_helper = \Drupal::getContainer()
      ->get('search_api.fields_helper');
    $field_info = [
      'type' => 'date',
      'datasource_id' => 'entity:node',
      'property_path' => 'uid:entity:created',
    ];
    $index
      ->addField($field_helper
      ->createField($index, 'test1', $field_info));
    $plugin_creation_helper = \Drupal::getContainer()
      ->get('search_api.plugin_helper');
    $index
      ->addDatasource($plugin_creation_helper
      ->createDatasourcePlugin($index, 'entity:user'));
    $index
      ->addProcessor($plugin_creation_helper
      ->createProcessorPlugin($index, 'highlight'));
    $index
      ->setTracker($plugin_creation_helper
      ->createTrackerPlugin($index, 'search_api_test'));

    /** @var \Drupal\search_api\IndexInterface $serialized */
    $serialized = unserialize(serialize($index));
    $this
      ->assertNotEmpty($serialized);
    $storage = \Drupal::entityTypeManager()
      ->getStorage('search_api_index');
    $index
      ->preSave($storage);
    $serialized
      ->preSave($storage);
    $this
      ->assertEquals($index
      ->toArray(), $serialized
      ->toArray());

    // Make sure no object properties will be serialized for an index.
    $index
      ->getDatasources();
    $index
      ->getFields();
    $index
      ->getProcessors();
    $index
      ->getTrackerInstance();
    $index
      ->getPropertyDefinitions(NULL);
    $contains_object = function ($var) use (&$contains_object) {
      if (is_object($var)) {
        return TRUE;
      }
      if (is_array($var)) {
        foreach ($var as $value) {
          if ($contains_object($value)) {
            return TRUE;
          }
        }
      }
      return FALSE;
    };
    $to_serialize = $index
      ->__sleep();
    foreach ($to_serialize as $property) {
      $this
        ->assertFalse($contains_object($index
        ->get($property)), "Serialized property \${$property} contains an object.");
    }
  }

  /**
   * Tests that serialization of server entities doesn't lead to data loss.
   */
  public function testServerSerialization() {

    // As our test server, just use the one from the DB Defaults module.
    $path = __DIR__ . '/../../../../modules/search_api_db/search_api_db_defaults/config/optional/search_api.server.default_server.yml';
    $values = Yaml::decode(file_get_contents($path));
    $server = new Server($values, 'search_api_server');
    $serialized = unserialize(serialize($server));
    $this
      ->assertNotEmpty($serialized);
    $this
      ->assertEquals($server, $serialized);
  }

  /**
   * Tests that serialization of search queries works correctly.
   */
  public function testQuerySerialization() {
    $query = $this
      ->createTestQuery();
    $serialized = unserialize(serialize($query));
    $this
      ->assertNotEmpty($serialized);
    $this
      ->assertEquals((string) $query, (string) $serialized);

    // Call serialize() on the restored query to make "equals" work correctly.
    // (__sleep() sets some properties as a by-product which the serialized
    // version doesn't have – namely, $indexId and $_serviceIds.)
    serialize($serialized);
    $this
      ->assertEquals($query, $serialized);
  }

  /**
   * Tests that cloning of search queries works correctly.
   */
  public function testQueryCloning() {
    $query = $this
      ->createTestQuery();

    // Since Drupal's DB layer sometimes has problems with side-effects of
    // __toString(), we here try to make sure this won't happen to us.
    $this
      ->assertIsString((string) $query);
    $clone = clone $query;

    // Modify the original query. None of this should change the clone in any
    // way.
    $query
      ->setOption('test1', 'foo');
    $query
      ->getParseMode()
      ->setConjunction('AND');
    $query
      ->addCondition('test1', 'bar');
    $condition_group_1 = $query
      ->getConditionGroup()
      ->getConditions()[1];
    $condition_group_2 = $condition_group_1
      ->getConditions()[2];
    $condition_group_3 = $query
      ->createConditionGroup('AND');
    $condition_group_1
      ->addCondition('test1', 'foobar');
    $condition_group_2
      ->addCondition('test1', 'foobar');
    $condition_group_3
      ->addCondition('test1', 'foobar');
    $query
      ->getResults()
      ->addWarning('This query is very dumb.');
    $query_2 = $this
      ->createTestQuery();
    $this
      ->assertEquals($query_2, $clone);
    $this
      ->assertNotSame($query
      ->getResults(), $clone
      ->getResults());
    $this
      ->assertNotSame($query
      ->getResults(), $query_2
      ->getResults());
    $this
      ->assertNotSame($query
      ->getConditionGroup(), $clone
      ->getConditionGroup());
    $this
      ->assertNotSame($query
      ->getConditionGroup(), $query_2
      ->getConditionGroup());
    $this
      ->assertNotSame($query
      ->getParseMode(), $clone
      ->getParseMode());
    $this
      ->assertNotSame($query
      ->getParseMode(), $query_2
      ->getParseMode());
  }

  /**
   * Tests that serialization of search results works correctly.
   */
  public function testResultSerialization() {
    $item = $this
      ->createTestItem();
    $results = $this
      ->createTestQuery()
      ->getResults()
      ->setResultCount(3)
      ->setResultItems([
      $item
        ->getId() => $item,
    ])
      ->addIgnoredSearchKey('test')
      ->addWarning('Something went a bit wrong.')
      ->setExtraData('test', [
      'foo' => 'bar',
    ]);

    /** @var \Drupal\search_api\Query\ResultSetInterface $serialized */
    $serialized = unserialize(serialize($results));

    // Call serialize() on the restored results to make "equals" work correctly.
    serialize($serialized);
    $this
      ->assertEquals($results, $serialized);
  }

  /**
   * Tests that serialization of items works correctly.
   */
  public function testItemSerialization() {
    $item = $this
      ->createTestItem();

    /** @var \Drupal\search_api\Query\ResultSetInterface $serialized */
    $serialized = unserialize(serialize($item));

    // Call serialize() on the restored item to make "equals" work correctly.
    serialize($serialized);
    $this
      ->assertEquals($item, $serialized);
  }

  /**
   * Tests that cloning of items works correctly.
   */
  public function testItemCloning() {
    $item = $this
      ->createTestItem();
    $clone = clone $item;
    $item
      ->setBoost(3);
    $item
      ->setExcerpt('Test 1');
    $item
      ->getExtraData('foo')->bar = 2;
    $item
      ->setExtraData('test', 3);
    $item
      ->setLanguage('de');
    $item
      ->setScore(3.14);
    $item
      ->getField('test')
      ->setLabel('Foobar');
    $item_2 = $this
      ->createTestItem();
    $this
      ->assertEquals($item_2, $clone);
    $this
      ->assertNotSame($item
      ->getExtraData('foo'), $clone
      ->getExtraData('foo'));
    $this
      ->assertNotSame($item
      ->getField('test'), $clone
      ->getField('test'));
    $this
      ->assertNotSame($item
      ->getField('foo'), $clone
      ->getField('foo'));
  }

  /**
   * Tests that serialization of fields works correctly.
   */
  public function testFieldSerialization() {
    $field = $this
      ->createTestField('test', 'entity:entity:entity_test_mulrev_changed');
    $serialized = unserialize(serialize($field));

    // Call getIndex() and serialize() on the restored field to make "equals"
    // work correctly. (__sleep() sets some properties as a by-product which the
    // serialized version doesn't have – $indexId, in this case.)
    $serialized
      ->getIndex();
    serialize($serialized);
    $this
      ->assertEquals($field, $serialized);
  }

  /**
   * Creates a search query for use in this test.
   *
   * @return \Drupal\search_api\Query\QueryInterface
   *   A test query.
   */
  protected function createTestQuery() {
    $query = $this->index
      ->query([
      'foo' => 'bar',
    ]);
    $query
      ->getParseMode()
      ->setConjunction('OR');
    $query
      ->keys('test foobar');
    $query
      ->setFulltextFields([
      'foo',
      'bar',
    ]);
    $query
      ->addCondition('title', 'foo', '<>');
    $condition_group_1 = $query
      ->createConditionGroup('OR', [
      'foobar',
    ]);
    $condition_group_1
      ->addCondition('foo', 'bar');
    $query
      ->addConditionGroup($condition_group_1);
    $condition_group_1
      ->addCondition('bar', [
      1,
      5,
    ], 'BETWEEN');
    $condition_group_2 = $query
      ->createConditionGroup('AND', [
      'baz',
    ]);
    $condition_group_2
      ->addCondition('baz', 2, '>');
    $condition_group_2
      ->addCondition('baz', NULL, '<>');
    $condition_group_1
      ->addConditionGroup($condition_group_2);
    $query
      ->addTag('serialization_test');
    $query
      ->getResults()
      ->addWarning('This query is dumb.');
    return $query;
  }

  /**
   * Creates an item for testing purposes.
   *
   * @return \Drupal\search_api\Item\ItemInterface
   *   A test item.
   */
  protected function createTestItem() {
    $item = new Item($this->index, 'entity:node/id');
    $item
      ->setBoost(2);
    $item
      ->setExcerpt('Foo bar baz');
    $item
      ->setExtraData('foo', (object) [
      'bar' => 1,
    ]);
    $item
      ->setExtraData('test', 1);
    $item
      ->setLanguage('en');
    $item
      ->setScore(4);
    $item
      ->setFields([
      'test' => $this
        ->createTestField(),
      'foo' => $this
        ->createTestField('foo', 'entity:entity_test_mulrev_changed'),
    ]);
    $item
      ->setFieldsExtracted(TRUE);
    return $item;
  }

  /**
   * Creates a field for testing purposes.
   *
   * @param string $id
   *   (optional) The field ID (and property path).
   * @param string|null $datasource_id
   *   (optional) The field's datasource ID.
   *
   * @return \Drupal\search_api\Item\FieldInterface
   *   A test field.
   */
  protected function createTestField($id = 'test', $datasource_id = NULL) {
    $field = new Field($this->index, $id);
    $field
      ->setDatasourceId($datasource_id);
    $field
      ->setPropertyPath($id);
    $field
      ->setLabel('Foo');
    $field
      ->setDescription('Bar');
    $field
      ->setType('float');
    $field
      ->setBoost(2);
    $field
      ->setIndexedLocked();
    $field
      ->setConfiguration([
      'foo' => 'bar',
      'test' => TRUE,
    ]);
    $field
      ->setValues([
      1,
      3,
      5,
    ]);
    return $field;
  }

}

Members

Namesort descending 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.
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.
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.
SerializationTest::$index protected property A test index for use in these tests.
SerializationTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
SerializationTest::createTestField protected function Creates a field for testing purposes.
SerializationTest::createTestItem protected function Creates an item for testing purposes.
SerializationTest::createTestQuery protected function Creates a search query for use in this test.
SerializationTest::setUp protected function Overrides KernelTestBase::setUp
SerializationTest::testFieldSerialization public function Tests that serialization of fields works correctly.
SerializationTest::testIndexSerialization public function Tests that serialization of index entities doesn't lead to data loss.
SerializationTest::testItemCloning public function Tests that cloning of items works correctly.
SerializationTest::testItemSerialization public function Tests that serialization of items works correctly.
SerializationTest::testQueryCloning public function Tests that cloning of search queries works correctly.
SerializationTest::testQuerySerialization public function Tests that serialization of search queries works correctly.
SerializationTest::testResultSerialization public function Tests that serialization of search results works correctly.
SerializationTest::testServerSerialization public function Tests that serialization of server entities doesn't lead to data loss.
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.