class DenormalizeTest

Test the HAL normalizer's denormalize function.

Hierarchy

Expanded class hierarchy of DenormalizeTest

File

drupal/core/modules/hal/lib/Drupal/hal/Tests/DenormalizeTest.php, line 15
Contains \Drupal\hal\Tests\DenormalizeTest.

Namespace

Drupal\hal\Tests
View source
class DenormalizeTest extends NormalizerTestBase {
  public static function getInfo() {
    return array(
      'name' => 'Denormalize Test',
      'description' => 'Test that entities can be denormalized from HAL.',
      'group' => 'HAL',
    );
  }

  /**
   * Tests that the type link relation in incoming data is handled correctly.
   */
  public function testTypeHandling() {

    // Valid type.
    $data_with_valid_type = array(
      '_links' => array(
        'type' => array(
          'href' => url('rest/type/entity_test/entity_test', array(
            'absolute' => TRUE,
          )),
        ),
      ),
    );
    $denormalized = $this->serializer
      ->denormalize($data_with_valid_type, $this->entityClass, $this->format);
    $this
      ->assertEqual(get_class($denormalized), $this->entityClass, 'Request with valid type results in creation of correct bundle.');

    // Multiple types.
    $data_with_multiple_types = array(
      '_links' => array(
        'type' => array(
          array(
            'href' => url('rest/types/foo', array(
              'absolute' => TRUE,
            )),
          ),
          array(
            'href' => url('rest/type/entity_test/entity_test', array(
              'absolute' => TRUE,
            )),
          ),
        ),
      ),
    );
    $denormalized = $this->serializer
      ->denormalize($data_with_multiple_types, $this->entityClass, $this->format);
    $this
      ->assertEqual(get_class($denormalized), $this->entityClass, 'Request with multiple types results in creation of correct bundle.');

    // Invalid type.
    $data_with_invalid_type = array(
      '_links' => array(
        'type' => array(
          'href' => url('rest/types/foo', array(
            'absolute' => TRUE,
          )),
        ),
      ),
    );
    try {
      $this->serializer
        ->denormalize($data_with_invalid_type, $this->entityClass, $this->format);
      $this
        ->fail('Exception should be thrown when type is invalid.');
    } catch (UnexpectedValueException $e) {
      $this
        ->pass('Exception thrown when type is invalid.');
    }

    // No type.
    $data_with_no_type = array(
      '_links' => array(),
    );
    try {
      $this->serializer
        ->denormalize($data_with_no_type, $this->entityClass, $this->format);
      $this
        ->fail('Exception should be thrown when no type is provided.');
    } catch (UnexpectedValueException $e) {
      $this
        ->pass('Exception thrown when no type is provided.');
    }
  }

  /**
   * Test that a field set to an empty array is different than an empty field.
   */
  public function testMarkFieldForDeletion() {
    $no_field_data = array(
      '_links' => array(
        'type' => array(
          'href' => url('rest/type/entity_test/entity_test', array(
            'absolute' => TRUE,
          )),
        ),
      ),
    );
    $no_field_denormalized = $this->serializer
      ->denormalize($no_field_data, $this->entityClass, $this->format);
    $no_field_value = $no_field_denormalized->field_test_text
      ->getValue();
    $empty_field_data = array(
      '_links' => array(
        'type' => array(
          'href' => url('rest/type/entity_test/entity_test', array(
            'absolute' => TRUE,
          )),
        ),
      ),
      'field_test_text' => array(),
    );
    $empty_field_denormalized = $this->serializer
      ->denormalize($empty_field_data, $this->entityClass, $this->format);
    $empty_field_value = $empty_field_denormalized->field_test_text
      ->getValue();
    $this
      ->assertTrue(!empty($no_field_value) && empty($empty_field_value), 'A field set to an empty array in the data is structured differently than an empty field.');
  }

  /**
   * Test that non-reference fields can be denormalized.
   */
  public function testBasicFieldDenormalization() {
    $data = array(
      '_links' => array(
        'type' => array(
          'href' => url('rest/type/entity_test/entity_test', array(
            'absolute' => TRUE,
          )),
        ),
      ),
      'uuid' => array(
        array(
          'value' => 'e5c9fb96-3acf-4a8d-9417-23de1b6c3311',
        ),
      ),
      'field_test_text' => array(
        array(
          'value' => $this
            ->randomName(),
          'format' => 'full_html',
        ),
      ),
      'field_test_translatable_text' => array(
        array(
          'value' => $this
            ->randomName(),
          'format' => 'full_html',
        ),
        array(
          'value' => $this
            ->randomName(),
          'format' => 'filtered_html',
        ),
        array(
          'value' => $this
            ->randomName(),
          'format' => 'filtered_html',
          'lang' => 'de',
        ),
        array(
          'value' => $this
            ->randomName(),
          'format' => 'full_html',
          'lang' => 'de',
        ),
      ),
    );
    $expected_value_default = array(
      array(
        'value' => $data['field_test_translatable_text'][0]['value'],
        'format' => 'full_html',
      ),
      array(
        'value' => $data['field_test_translatable_text'][1]['value'],
        'format' => 'filtered_html',
      ),
    );
    $expected_value_de = array(
      array(
        'value' => $data['field_test_translatable_text'][2]['value'],
        'format' => 'filtered_html',
      ),
      array(
        'value' => $data['field_test_translatable_text'][3]['value'],
        'format' => 'full_html',
      ),
    );
    $denormalized = $this->serializer
      ->denormalize($data, $this->entityClass, $this->format);
    $this
      ->assertEqual($data['uuid'], $denormalized
      ->get('uuid')
      ->getValue(), 'A preset value (e.g. UUID) is overridden by incoming data.');
    $this
      ->assertEqual($data['field_test_text'], $denormalized
      ->get('field_test_text')
      ->getValue(), 'A basic text field is denormalized.');
    $this
      ->assertEqual($expected_value_default, $denormalized
      ->get('field_test_translatable_text')
      ->getValue(), 'Values in the default language are properly handled for a translatable field.');
    $this
      ->assertEqual($expected_value_de, $denormalized
      ->getTranslation('de')
      ->get('field_test_translatable_text')
      ->getValue(), 'Values in a translation language are properly handled for a translatable field.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DenormalizeTest::getInfo public static function
DenormalizeTest::testBasicFieldDenormalization public function Test that non-reference fields can be denormalized.
DenormalizeTest::testMarkFieldForDeletion public function Test that a field set to an empty array is different than an empty field.
DenormalizeTest::testTypeHandling public function Tests that the type link relation in incoming data is handled correctly.
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
NormalizerTestBase::$entityClass protected property The class name of the test class.
NormalizerTestBase::$format protected property The format being tested.
NormalizerTestBase::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
NormalizerTestBase::$serializer protected property The mock serializer.
NormalizerTestBase::setUp function Overrides \Drupal\simpletest\DrupalUnitTestBase::setup(). Overrides DrupalUnitTestBase::setUp
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