You are here

Home » API reference » Zircon Profile 8.0 » EntitySerializationTest.php

class EntitySerializationTest in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/serialization/src/Tests/EntitySerializationTest.php \Drupal\serialization\Tests\EntitySerializationTest

Tests that entities can be serialized to supported core formats.

@group serialization

Hierarchy

Expanded class hierarchy of EntitySerializationTest

File

core/modules/serialization/src/Tests/EntitySerializationTest.php, line 17
Contains \Drupal\serialization\Tests\EntitySerializationTest.

Namespace

Drupal\serialization\Tests
View source 
class EntitySerializationTest extends NormalizerTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = array(
    'serialization',
    'system',
    'field',
    'entity_test',
    'text',
    'filter',
    'user',
    'entity_serialization_test',
  );

  /**
   * The test values.
   *
   * @var array
   */
  protected $values;

  /**
   * The test entity.
   *
   * @var \Drupal\Core\Entity\ContentEntityBase
   */
  protected $entity;

  /**
   * The test user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $user;

  /**
   * The serializer service.
   *
   * @var \Symfony\Component\Serializer\Serializer.
   */
  protected $serializer;

  /**
   * The class name of the test class.
   *
   * @var string
   */
  protected $entityClass = 'Drupal\\entity_test\\Entity\\EntityTest';
  protected function setUp() {
    parent::setUp();

    // User create needs sequence table.
    $this
      ->installSchema('system', array(
      'sequences',
    ));

    // Create a test user to use as the entity owner.
    $this->user = \Drupal::entityManager()
      ->getStorage('user')
      ->create([
      'name' => 'serialization_test_user',
      'mail' => 'foo@example.com',
      'pass' => '123456',
    ]);
    $this->user
      ->save();

    // Create a test entity to serialize.
    $this->values = array(
      'name' => $this
        ->randomMachineName(),
      'user_id' => $this->user
        ->id(),
      'field_test_text' => array(
        'value' => $this
          ->randomMachineName(),
        'format' => 'full_html',
      ),
    );
    $this->entity = entity_create('entity_test_mulrev', $this->values);
    $this->entity
      ->save();
    $this->serializer = $this->container
      ->get('serializer');
    $this
      ->installConfig(array(
      'field',
    ));
  }

  /**
   * Test the normalize function.
   */
  public function testNormalize() {
    $expected = array(
      'id' => array(
        array(
          'value' => 1,
        ),
      ),
      'uuid' => array(
        array(
          'value' => $this->entity
            ->uuid(),
        ),
      ),
      'langcode' => array(
        array(
          'value' => 'en',
        ),
      ),
      'name' => array(
        array(
          'value' => $this->values['name'],
        ),
      ),
      'type' => array(
        array(
          'value' => 'entity_test_mulrev',
        ),
      ),
      'created' => array(
        array(
          'value' => $this->entity->created->value,
        ),
      ),
      'user_id' => array(
        array(
          'target_id' => $this->user
            ->id(),
          'url' => $this->user
            ->url(),
        ),
      ),
      'revision_id' => array(
        array(
          'value' => 1,
        ),
      ),
      'default_langcode' => array(
        array(
          'value' => TRUE,
        ),
      ),
      'field_test_text' => array(
        array(
          'value' => $this->values['field_test_text']['value'],
          'format' => $this->values['field_test_text']['format'],
        ),
      ),
    );
    $normalized = $this->serializer
      ->normalize($this->entity);
    foreach (array_keys($expected) as $fieldName) {
      $this
        ->assertEqual($expected[$fieldName], $normalized[$fieldName], "ComplexDataNormalizer produces expected array for {$fieldName}.");
    }
    $this
      ->assertEqual(array_diff_key($normalized, $expected), array(), 'No unexpected data is added to the normalized array.');
  }

  /**
   * Tests user normalization, using the entity_serialization_test module to
   * override some default access controls.
   */
  public function testUserNormalize() {

    // Test password isn't available.
    $normalized = $this->serializer
      ->normalize($this->user);
    $this
      ->assertFalse(array_key_exists('pass', $normalized), '"pass" key does not exist in normalized user');
    $this
      ->assertFalse(array_key_exists('mail', $normalized), '"mail" key does not exist in normalized user');

    // Test again using our test user, so that our access control override will
    // allow password viewing.
    $normalized = $this->serializer
      ->normalize($this->user, NULL, [
      'account' => $this->user,
    ]);

    // The key 'pass' will now exist, but the password value should be
    // normalized to NULL.
    $this
      ->assertIdentical($normalized['pass'], [
      NULL,
    ], '"pass" value is normalized to [NULL]');
  }

  /**
   * Test registered Serializer's entity serialization for core's formats.
   */
  public function testSerialize() {

    // Test that Serializer responds using the ComplexDataNormalizer and
    // JsonEncoder. The output of ComplexDataNormalizer::normalize() is tested
    // elsewhere, so we can just assume that it works properly here.
    $normalized = $this->serializer
      ->normalize($this->entity, 'json');
    $expected = json_encode($normalized);

    // Test 'json'.
    $actual = $this->serializer
      ->serialize($this->entity, 'json');
    $this
      ->assertIdentical($actual, $expected, 'Entity serializes to JSON when "json" is requested.');
    $actual = $this->serializer
      ->serialize($normalized, 'json');
    $this
      ->assertIdentical($actual, $expected, 'A normalized array serializes to JSON when "json" is requested');

    // Test 'ajax'.
    $actual = $this->serializer
      ->serialize($this->entity, 'ajax');
    $this
      ->assertIdentical($actual, $expected, 'Entity serializes to JSON when "ajax" is requested.');
    $actual = $this->serializer
      ->serialize($normalized, 'ajax');
    $this
      ->assertIdentical($actual, $expected, 'A normalized array serializes to JSON when "ajax" is requested');

    // Generate the expected xml in a way that allows changes to entity property
    // order.
    $expected = array(
      'id' => '<id><value>' . $this->entity
        ->id() . '</value></id>',
      'uuid' => '<uuid><value>' . $this->entity
        ->uuid() . '</value></uuid>',
      'langcode' => '<langcode><value>en</value></langcode>',
      'name' => '<name><value>' . $this->values['name'] . '</value></name>',
      'type' => '<type><value>entity_test_mulrev</value></type>',
      'created' => '<created><value>' . $this->entity->created->value . '</value></created>',
      'user_id' => '<user_id><target_id>' . $this->user
        ->id() . '</target_id><url>' . $this->user
        ->url() . '</url></user_id>',
      'revision_id' => '<revision_id><value>' . $this->entity
        ->getRevisionId() . '</value></revision_id>',
      'default_langcode' => '<default_langcode><value>1</value></default_langcode>',
      'field_test_text' => '<field_test_text><value>' . $this->values['field_test_text']['value'] . '</value><format>' . $this->values['field_test_text']['format'] . '</format></field_test_text>',
    );

    // Sort it in the same order as normalised.
    $expected = array_merge($normalized, $expected);

    // Add header and footer.
    array_unshift($expected, '<?xml version="1.0"?>' . PHP_EOL . '<response>');
    $expected[] = '</response>' . PHP_EOL;

    // Reduced the array to a string.
    $expected = implode('', $expected);

    // Test 'xml'. The output should match that of Symfony's XmlEncoder.
    $actual = $this->serializer
      ->serialize($this->entity, 'xml');
    $this
      ->assertIdentical($actual, $expected);
    $actual = $this->serializer
      ->serialize($normalized, 'xml');
    $this
      ->assertIdentical($actual, $expected);
  }

  /**
   * Tests denormalization of an entity.
   */
  public function testDenormalize() {
    $normalized = $this->serializer
      ->normalize($this->entity);
    foreach (array(
      'json',
      'xml',
    ) as $type) {
      $denormalized = $this->serializer
        ->denormalize($normalized, $this->entityClass, $type, array(
        'entity_type' => 'entity_test_mulrev',
      ));
      $this
        ->assertTrue($denormalized instanceof $this->entityClass, SafeMarkup::format('Denormalized entity is an instance of @class', array(
        '@class' => $this->entityClass,
      )));
      $this
        ->assertIdentical($denormalized
        ->getEntityTypeId(), $this->entity
        ->getEntityTypeId(), 'Expected entity type found.');
      $this
        ->assertIdentical($denormalized
        ->bundle(), $this->entity
        ->bundle(), 'Expected entity bundle found.');
      $this
        ->assertIdentical($denormalized
        ->uuid(), $this->entity
        ->uuid(), 'Expected entity UUID found.');
    }
  }

}

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. 2
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::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 function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertFalse public static function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertTrue public static function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose protected function
EntitySerializationTest::$entity protected property The test entity.
EntitySerializationTest::$entityClass protected property The class name of the test class.
EntitySerializationTest::$modules public static property Modules to install. Overrides NormalizerTestBase::$modules
EntitySerializationTest::$serializer protected property The serializer service.
EntitySerializationTest::$user protected property The test user.
EntitySerializationTest::$values protected property The test values.
EntitySerializationTest::setUp protected function Overrides NormalizerTestBase::setUp
EntitySerializationTest::testDenormalize public function Tests denormalization of an entity.
EntitySerializationTest::testNormalize public function Test the normalize function.
EntitySerializationTest::testSerialize public function Test registered Serializer's entity serialization for core's formats.
EntitySerializationTest::testUserNormalize public function Tests user normalization, using the entity_serialization_test module to override some default access controls.
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.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$expectedLogMessage protected property
KernelTestBase::$expectedLogSeverity protected property
KernelTestBase::$initialContainerBuilder private static 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 to prevent collisions between code that may be loaded by tests.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved.
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function
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::configImporter protected function Returns a ConfigImporter object to import test configuration.
KernelTestBase::copyConfig protected function Copies configuration objects from a source storage to a target storage.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getCompiledContainerBuilder private function Prepares a precompiled ContainerBuilder for all tests of this class.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test.
KernelTestBase::getDrupalRoot protected static function Returns the drupal root directory.
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 protected function Returns whether the current test runs in isolation.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 2
KernelTestBase::render protected function Renders a render array.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownAfterClass public static function
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.
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.
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.