class TranslatableMarkupTest in Drupal 8

Tests the TranslatableMarkup class.

@coversDefaultClass \Drupal\Core\StringTranslation\TranslatableMarkup @group StringTranslation

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\StringTranslation\TranslatableMarkupTest

File

core/tests/Drupal/Tests/Core/StringTranslation/TranslatableMarkupTest.php, line 16

Namespace

Drupal\Tests\Core\StringTranslation

class TranslatableMarkupTest extends UnitTestCase {

  /**
   * The error message of the last error in the error handler.
   *
   * @var string
   */
  protected $lastErrorMessage;

  /**
   * The error number of the last error in the error handler.
   *
   * @var int
   */
  protected $lastErrorNumber;

  /**
   * Custom error handler that saves the last error.
   *
   * We need this custom error handler because we cannot rely on the error to
   * exception conversion as __toString is never allowed to leak any kind of
   * exception.
   *
   * @param int $error_number
   *   The error number.
   * @param string $error_message
   *   The error message.
   */
  public function errorHandler($error_number, $error_message) {
    $this->lastErrorNumber = $error_number;
    $this->lastErrorMessage = $error_message;
  }

  /**
   * Tests that errors are correctly handled when a __toString() fails.
   *
   * @covers ::__toString
   */
  public function testToString() {
    $translation = $this
      ->createMock(TranslationInterface::class);
    $string = 'May I have an exception please?';
    $text = $this
      ->getMockBuilder(TranslatableMarkup::class)
      ->setConstructorArgs([
      $string,
      [],
      [],
      $translation,
    ])
      ->setMethods([
      '_die',
    ])
      ->getMock();
    $text
      ->expects($this
      ->once())
      ->method('_die')
      ->willReturn('');
    $translation
      ->method('translateString')
      ->with($text)
      ->willReturnCallback(function () {
      throw new \Exception('Yes you may.');
    });

    // We set a custom error handler because of https://github.com/sebastianbergmann/phpunit/issues/487
    set_error_handler([
      $this,
      'errorHandler',
    ]);

    // We want this to trigger an error.
    (string) $text;
    restore_error_handler();
    $this
      ->assertEquals(E_USER_ERROR, $this->lastErrorNumber);
    $this
      ->assertRegExp('/Exception thrown while calling __toString on a .*Mock_TranslatableMarkup_.* object in .*TranslatableMarkupTest.php on line [0-9]+: Yes you may./', $this->lastErrorMessage);
  }

  /**
   * @covers ::__construct
   */
  public function testIsStringAssertion() {
    $translation = $this
      ->getStringTranslationStub();
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('$string ("foo") must be a string.');
    new TranslatableMarkup(new TranslatableMarkup('foo', [], [], $translation));
  }

  /**
   * @covers ::__construct
   */
  public function testIsStringAssertionWithFormattableMarkup() {
    $formattable_string = new FormattableMarkup('@bar', [
      '@bar' => 'foo',
    ]);
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('$string ("foo") must be a string.');
    new TranslatableMarkup($formattable_string);
  }

}

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.
TranslatableMarkupTest::$lastErrorMessage	protected	property	The error message of the last error in the error handler.
TranslatableMarkupTest::$lastErrorNumber	protected	property	The error number of the last error in the error handler.
TranslatableMarkupTest::errorHandler	public	function	Custom error handler that saves the last error.
TranslatableMarkupTest::testIsStringAssertion	public	function	@covers ::__construct
TranslatableMarkupTest::testIsStringAssertionWithFormattableMarkup	public	function	@covers ::__construct
TranslatableMarkupTest::testToString	public	function	Tests that errors are correctly handled when a __toString() fails.
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.
UnitTestCase::setUp	protected	function		340