class NormalizeTest

Test the HAL normalizer.

Hierarchy

Expanded class hierarchy of NormalizeTest

File

drupal/core/modules/hal/lib/Drupal/hal/Tests/NormalizeTest.php, line 13
Contains \Drupal\hal\Tests\NormalizeTest.

Namespace

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

  /**
   * Tests the normalize function.
   */
  public function testNormalize() {
    $target_entity_de = entity_create('entity_test', array(
      'langcode' => 'de',
      'field_test_entity_reference' => NULL,
    ));
    $target_entity_de
      ->save();
    $target_entity_en = entity_create('entity_test', array(
      'langcode' => 'en',
      'field_test_entity_reference' => NULL,
    ));
    $target_entity_en
      ->save();

    // Create a German entity.
    $values = array(
      'langcode' => 'de',
      'name' => $this
        ->randomName(),
      'user_id' => 1,
      'field_test_text' => array(
        'value' => $this
          ->randomName(),
        'format' => 'full_html',
      ),
      'field_test_entity_reference' => array(
        'target_id' => $target_entity_de
          ->id(),
      ),
    );

    // Array of translated values.
    $translation_values = array(
      'name' => $this
        ->randomName(),
      'field_test_entity_reference' => array(
        'target_id' => $target_entity_en
          ->id(),
      ),
    );
    $entity = entity_create('entity_test', $values);
    $entity
      ->save();

    // Add an English value for name and entity reference properties.
    $entity
      ->getTranslation('en')
      ->set('name', array(
      0 => array(
        'value' => $translation_values['name'],
      ),
    ));
    $entity
      ->getTranslation('en')
      ->set('field_test_entity_reference', array(
      0 => $translation_values['field_test_entity_reference'],
    ));
    $entity
      ->save();
    $type_uri = url('rest/type/entity_test/entity_test', array(
      'absolute' => TRUE,
    ));
    $relation_uri = url('rest/relation/entity_test/entity_test/field_test_entity_reference', array(
      'absolute' => TRUE,
    ));
    $expected_array = array(
      '_links' => array(
        'curies' => array(
          array(
            'href' => '/relations',
            'name' => 'site',
            'templated' => true,
          ),
        ),
        'self' => array(
          'href' => $this
            ->getEntityUri($entity),
        ),
        'type' => array(
          'href' => $type_uri,
        ),
        $relation_uri => array(
          array(
            'href' => $this
              ->getEntityUri($target_entity_de),
            'lang' => 'de',
          ),
          array(
            'href' => $this
              ->getEntityUri($target_entity_en),
            'lang' => 'en',
          ),
        ),
      ),
      '_embedded' => array(
        $relation_uri => array(
          array(
            '_links' => array(
              'self' => array(
                'href' => $this
                  ->getEntityUri($target_entity_de),
              ),
              'type' => array(
                'href' => $type_uri,
              ),
            ),
            'uuid' => array(
              array(
                'value' => $target_entity_de
                  ->uuid(),
              ),
            ),
            'lang' => 'de',
          ),
          array(
            '_links' => array(
              'self' => array(
                'href' => $this
                  ->getEntityUri($target_entity_en),
              ),
              'type' => array(
                'href' => $type_uri,
              ),
            ),
            'uuid' => array(
              array(
                'value' => $target_entity_en
                  ->uuid(),
              ),
            ),
            'lang' => 'en',
          ),
        ),
      ),
      'uuid' => array(
        array(
          'value' => $entity
            ->uuid(),
        ),
      ),
      'langcode' => array(
        array(
          'value' => 'de',
        ),
      ),
      'name' => array(
        array(
          'value' => $values['name'],
          'lang' => 'de',
        ),
        array(
          'value' => $translation_values['name'],
          'lang' => 'en',
        ),
      ),
      'field_test_text' => array(
        array(
          'value' => $values['field_test_text']['value'],
          'format' => $values['field_test_text']['format'],
        ),
      ),
    );
    $normalized = $this->serializer
      ->normalize($entity, $this->format);
    $this
      ->assertEqual($normalized['_links']['self'], $expected_array['_links']['self'], 'self link placed correctly.');

    // @todo Test curies.
    // @todo Test type.
    $this
      ->assertFalse(isset($normalized['id']), 'Internal id is not exposed.');
    $this
      ->assertEqual($normalized['uuid'], $expected_array['uuid'], 'Non-translatable fields is normalized.');
    $this
      ->assertEqual($normalized['name'], $expected_array['name'], 'Translatable field with multiple language values is normalized.');
    $this
      ->assertEqual($normalized['field_test_text'], $expected_array['field_test_text'], 'Field with properties is normalized.');
    $this
      ->assertEqual($normalized['_embedded'][$relation_uri], $expected_array['_embedded'][$relation_uri], 'Entity reference field is normalized.');
    $this
      ->assertEqual($normalized['_links'][$relation_uri], $expected_array['_links'][$relation_uri], 'Links are added for entity reference field.');
  }

  /**
   * Constructs the entity URI.
   *
   * @param $entity
   *   The entity.
   *
   * @return string
   *   The entity URI.
   */
  protected function getEntityUri($entity) {
    $entity_uri_info = $entity
      ->uri();
    return url($entity_uri_info['path'], array(
      'absolute' => TRUE,
    ));
  }

}

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
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
NormalizeTest::getEntityUri protected function Constructs the entity URI.
NormalizeTest::getInfo public static function
NormalizeTest::testNormalize public function Tests the normalize function.
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