class EntityTestDateRangeTest in Drupal 10

Tests the 'daterange' field's normalization.

@group datetime_range

Hierarchy

• class \Drupal\Tests\datetime_range\Functional\EntityResource\EntityTest\EntityTestDateRangeTest extends \Drupal\Tests\entity_test\Functional\Rest\EntityTestResourceTestBase uses AnonResourceTestTrait

File

core/modules/datetime_range/tests/src/Functional/EntityResource/EntityTest/EntityTestDateRangeTest.php, line 19

Namespace

Drupal\Tests\datetime_range\Functional\EntityResource\EntityTest

class EntityTestDateRangeTest extends EntityTestResourceTestBase {
  use AnonResourceTestTrait;

  /**
   * The ISO date string to use throughout the test.
   *
   * @var string
   */
  protected static $dateString = '2017-03-01T20:02:00';

  /**
   * Datetime Range test field name.
   *
   * @var string
   */
  protected static $fieldName = 'field_daterange';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'datetime_range',
    'entity_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Add datetime_range field.
    FieldStorageConfig::create([
      'field_name' => static::$fieldName,
      'type' => 'daterange',
      'entity_type' => static::$entityTypeId,
      'settings' => [
        'datetime_type' => DateRangeItem::DATETIME_TYPE_ALLDAY,
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => static::$fieldName,
      'entity_type' => static::$entityTypeId,
      'bundle' => $this->entity
        ->bundle(),
    ])
      ->save();

    // Reload entity so that it has the new field.
    $this->entity = $this->entityStorage
      ->load($this->entity
      ->id());
    $this->entity
      ->set(static::$fieldName, [
      'value' => static::$dateString,
      'end_value' => static::$dateString,
    ]);
    $this->entity
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  protected function createEntity() {
    $entity_test = EntityTest::create([
      'name' => 'Llama',
      'type' => static::$entityTypeId,
    ]);
    $entity_test
      ->setOwnerId(0);
    $entity_test
      ->save();
    return $entity_test;
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedNormalizedEntity() {
    return parent::getExpectedNormalizedEntity() + [
      static::$fieldName => [
        [
          'value' => '2017-03-02T07:02:00+11:00',
          'end_value' => '2017-03-02T07:02:00+11:00',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getNormalizedPostEntity() {
    return parent::getNormalizedPostEntity() + [
      static::$fieldName => [
        [
          'value' => '2017-03-01T20:02:00+00:00',
          'end_value' => '2017-03-01T20:02:00+00:00',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function assertNormalizationEdgeCases($method, Url $url, array $request_options) : void {
    parent::assertNormalizationEdgeCases($method, $url, $request_options);
    if ($this->entity
      ->getEntityType()
      ->hasKey('bundle')) {
      $fieldName = static::$fieldName;

      // DX: 422 when 'value' data type is incorrect.
      $normalization = $this
        ->getNormalizedPostEntity();
      $normalization[static::$fieldName][0]['value'] = [
        '2017',
        '03',
        '01',
        '21',
        '53',
        '00',
      ];
      $request_options[RequestOptions::BODY] = $this->serializer
        ->encode($normalization, static::$format);
      $response = $this
        ->request($method, $url, $request_options);
      $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0.value: This value should be of the correct primitive type.\n";
      $this
        ->assertResourceErrorResponse(422, $message, $response);

      // DX: 422 when 'end_value' is not specified.
      $normalization = $this
        ->getNormalizedPostEntity();
      unset($normalization[static::$fieldName][0]['end_value']);
      $request_options[RequestOptions::BODY] = $this->serializer
        ->encode($normalization, static::$format);
      $response = $this
        ->request($method, $url, $request_options);
      $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0.end_value: This value should not be null.\n";
      $this
        ->assertResourceErrorResponse(422, $message, $response);

      // DX: 422 when 'end_value' data type is incorrect.
      $normalization = $this
        ->getNormalizedPostEntity();
      $normalization[static::$fieldName][0]['end_value'] = [
        '2017',
        '03',
        '01',
        '21',
        '53',
        '00',
      ];
      $request_options[RequestOptions::BODY] = $this->serializer
        ->encode($normalization, static::$format);
      $response = $this
        ->request($method, $url, $request_options);
      $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0.end_value: This value should be of the correct primitive type.\n";
      $this
        ->assertResourceErrorResponse(422, $message, $response);

      // DX: 422 when end date value is invalid.
      $normalization = $this
        ->getNormalizedPostEntity();
      $value = '2017-13-55T20:02:00+00:00';
      $normalization[static::$fieldName][0]['end_value'] = $value;
      $request_options[RequestOptions::BODY] = $this->serializer
        ->encode($normalization, static::$format);
      $response = $this
        ->request($method, $url, $request_options);
      $message = "The specified date \"{$value}\" is not in an accepted format: \"Y-m-d\\TH:i:sP\" (RFC 3339), \"Y-m-d\\TH:i:sO\" (ISO 8601).";
      $this
        ->assertResourceErrorResponse(422, $message, $response);

      // @todo Expand in https://www.drupal.org/project/drupal/issues/2847041.
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnonResourceTestTrait::assertAuthenticationEdgeCases	protected	function
AnonResourceTestTrait::assertResponseWhenMissingAuthentication	protected	function
EntityTestDateRangeTest::$dateString	protected static	property	The ISO date string to use throughout the test.
EntityTestDateRangeTest::$defaultTheme	protected	property
EntityTestDateRangeTest::$fieldName	protected static	property	Datetime Range test field name.
EntityTestDateRangeTest::$modules	protected static	property
EntityTestDateRangeTest::assertNormalizationEdgeCases	protected	function
EntityTestDateRangeTest::createEntity	protected	function
EntityTestDateRangeTest::getExpectedNormalizedEntity	protected	function
EntityTestDateRangeTest::getNormalizedPostEntity	protected	function
EntityTestDateRangeTest::setUp	protected	function