class EntitySerializationTest

Tests entity normalization and serialization of supported core formats.

Hierarchy

Expanded class hierarchy of EntitySerializationTest

File

drupal/core/modules/serialization/lib/Drupal/serialization/Tests/EntitySerializationTest.php, line 20
Contains \Drupal\serialization\Tests\EntitySerializationTest.

Namespace

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

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

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

  /**
   * The serializer serivce.
   *
   * @var \Symfony\Component\Serializer\Serializer.
   */
  protected $serializer;
  public static function getInfo() {
    return array(
      'name' => 'Entity serialization tests',
      'description' => 'Tests that entities can be serialized to supported core formats.',
      'group' => 'Serialization',
    );
  }
  protected function setUp() {
    parent::setUp();

    // Create a test entity to serialize.
    $this->values = array(
      'name' => $this
        ->randomName(),
      'user_id' => $GLOBALS['user']->uid,
      'field_test_text' => array(
        'value' => $this
          ->randomName(),
        '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,
        ),
      ),
      'revision_id' => array(
        array(
          'value' => 1,
        ),
      ),
      'uuid' => array(
        array(
          'value' => $this->entity
            ->uuid(),
        ),
      ),
      'langcode' => array(
        array(
          'value' => Language::LANGCODE_NOT_SPECIFIED,
        ),
      ),
      'default_langcode' => array(
        array(
          'value' => NULL,
        ),
      ),
      'name' => array(
        array(
          'value' => $this->values['name'],
        ),
      ),
      'type' => array(
        array(
          'value' => 'entity_test_mulrev',
        ),
      ),
      'user_id' => array(
        array(
          'target_id' => $this->values['user_id'],
        ),
      ),
      '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.');
  }

  /**
   * 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>',
      'revision_id' => '<revision_id><value>' . $this->entity
        ->getRevisionId() . '</value></revision_id>',
      'uuid' => '<uuid><value>' . $this->entity
        ->uuid() . '</value></uuid>',
      'langcode' => '<langcode><value>' . Language::LANGCODE_NOT_SPECIFIED . '</value></langcode>',
      'default_langcode' => '<default_langcode><value/></default_langcode>',
      'name' => '<name><value>' . $this->values['name'] . '</value></name>',
      'type' => '<type><value>entity_test_mulrev</value></type>',
      'user_id' => '<user_id><target_id>' . $this->values['user_id'] . '</target_id></user_id>',
      '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);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
EntitySerializationTest::$entity protected property The test entity.
EntitySerializationTest::$serializer protected property The serializer serivce.
EntitySerializationTest::$values protected property The test values.
EntitySerializationTest::getInfo public static function
EntitySerializationTest::setUp protected function Sets up Drupal unit test environment. Overrides NormalizerTestBase::setUp
EntitySerializationTest::testNormalize public function Test the normalize function.
EntitySerializationTest::testSerialize public function Test registered Serializer's entity serialization for core's formats.
NormalizerTestBase::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules 1
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property