class TimestampNormalizerTest in Drupal 8

Unit test coverage for the "Timestamp" @DataType.

@group serialization @coversDefaultClass \Drupal\serialization\Normalizer\TimestampNormalizer

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\serialization\Unit\Normalizer\TimestampNormalizerTest

See also

\Drupal\Core\TypedData\Plugin\DataType\Timestamp

File

core/modules/serialization/tests/src/Unit/Normalizer/TimestampNormalizerTest.php, line 21

Namespace

Drupal\Tests\serialization\Unit\Normalizer

class TimestampNormalizerTest extends UnitTestCase {

  /**
   * The tested data type's normalizer.
   *
   * @var \Drupal\serialization\Normalizer\TimestampNormalizer
   */
  protected $normalizer;

  /**
   * The tested data type.
   *
   * @var \Drupal\Core\Field\Plugin\Field\FieldType\TimestampItem
   */
  protected $data;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->normalizer = new TimestampNormalizer($this
      ->prophesize(ConfigFactoryInterface::class)
      ->reveal());
    $this->data = $this
      ->prophesize(Timestamp::class);
  }

  /**
   * @covers ::supportsNormalization
   */
  public function testSupportsNormalization() {
    $this
      ->assertTrue($this->normalizer
      ->supportsNormalization($this->data
      ->reveal()));
    $integer = $this
      ->prophesize(IntegerData::class);
    $this
      ->assertFalse($this->normalizer
      ->supportsNormalization($integer
      ->reveal()));
    $datetime = $this
      ->prophesize(DateTimeInterface::class);
    $this
      ->assertFalse($this->normalizer
      ->supportsNormalization($datetime
      ->reveal()));
  }

  /**
   * @covers ::supportsDenormalization
   */
  public function testSupportsDenormalization() {
    $this
      ->assertTrue($this->normalizer
      ->supportsDenormalization($this->data
      ->reveal(), Timestamp::class));
  }

  /**
   * @covers ::normalize
   */
  public function testNormalize() {
    $random_rfc_3339_string = $this
      ->randomMachineName();
    $drupal_date_time = $this
      ->prophesize(TimestampNormalizerTestDrupalDateTime::class);
    $drupal_date_time
      ->setTimezone(new \DateTimeZone('UTC'))
      ->willReturn($drupal_date_time
      ->reveal());
    $drupal_date_time
      ->format(\DateTime::RFC3339)
      ->willReturn($random_rfc_3339_string);
    $this->data
      ->getDateTime()
      ->willReturn($drupal_date_time
      ->reveal());
    $normalized = $this->normalizer
      ->normalize($this->data
      ->reveal());
    $this
      ->assertSame($random_rfc_3339_string, $normalized);
  }

  /**
   * Tests the denormalize function with good data.
   *
   * @covers ::denormalize
   * @dataProvider providerTestDenormalizeValidFormats
   */
  public function testDenormalizeValidFormats($normalized, $expected) {
    $denormalized = $this->normalizer
      ->denormalize($normalized, Timestamp::class, NULL, []);
    $this
      ->assertSame($expected, $denormalized);
  }

  /**
   * Data provider for testDenormalizeValidFormats.
   *
   * @return array
   */
  public function providerTestDenormalizeValidFormats() {
    $expected_stamp = 1478422920;
    $data = [];
    $data['U'] = [
      $expected_stamp,
      $expected_stamp,
    ];
    $data['RFC3339'] = [
      '2016-11-06T09:02:00+00:00',
      $expected_stamp,
    ];
    $data['RFC3339 +0100'] = [
      '2016-11-06T09:02:00+01:00',
      $expected_stamp - 1 * 3600,
    ];
    $data['RFC3339 -0600'] = [
      '2016-11-06T09:02:00-06:00',
      $expected_stamp + 6 * 3600,
    ];
    $data['ISO8601'] = [
      '2016-11-06T09:02:00+0000',
      $expected_stamp,
    ];
    $data['ISO8601 +0100'] = [
      '2016-11-06T09:02:00+0100',
      $expected_stamp - 1 * 3600,
    ];
    $data['ISO8601 -0600'] = [
      '2016-11-06T09:02:00-0600',
      $expected_stamp + 6 * 3600,
    ];
    return $data;
  }

  /**
   * Tests the denormalize function with bad data.
   *
   * @covers ::denormalize
   */
  public function testDenormalizeException() {
    $this
      ->expectException(UnexpectedValueException::class);
    $this
      ->expectExceptionMessage('The specified date "2016/11/06 09:02am GMT" is not in an accepted format: "U" (UNIX timestamp), "Y-m-d\\TH:i:sO" (ISO 8601), "Y-m-d\\TH:i:sP" (RFC 3339).');
    $normalized = '2016/11/06 09:02am GMT';
    $this->normalizer
      ->denormalize($normalized, Timestamp::class, NULL, []);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
TimestampNormalizerTest::$data	protected	property	The tested data type.
TimestampNormalizerTest::$normalizer	protected	property	The tested data type's normalizer.
TimestampNormalizerTest::providerTestDenormalizeValidFormats	public	function	Data provider for testDenormalizeValidFormats.
TimestampNormalizerTest::setUp	protected	function	Overrides UnitTestCase::setUp
TimestampNormalizerTest::testDenormalizeException	public	function	Tests the denormalize function with bad data.
TimestampNormalizerTest::testDenormalizeValidFormats	public	function	Tests the denormalize function with good data.
TimestampNormalizerTest::testNormalize	public	function	@covers ::normalize
TimestampNormalizerTest::testSupportsDenormalization	public	function	@covers ::supportsDenormalization
TimestampNormalizerTest::testSupportsNormalization	public	function	@covers ::supportsNormalization
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.