Issue #3082340 by mondrake, longwave, alexpott, Krzysztof Domański: Replace... (8d8cff88) · Commits · project / drupal

core/tests/Drupal/KernelTests/Core/Test/Comparator/MarkupInterfaceComparatorTest.php

0 → 100644

+155 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\KernelTests\Core\Test\Comparator;

		use Drupal\Component\Render\FormattableMarkup;
		use Drupal\Core\StringTranslation\TranslatableMarkup;
		use Drupal\KernelTests\KernelTestBase;
		use Drupal\TestTools\Comparator\MarkupInterfaceComparator;
		use PHPUnit\Framework\Error\Error;
		use PHPUnit\Framework\Error\Notice;
		use SebastianBergmann\Comparator\Factory;
		use SebastianBergmann\Comparator\ComparisonFailure;

		/**
		* Tests \Drupal\TestTools\Comparator\MarkupInterfaceComparator.
		*
		* We need to test the class with a kernel test since casting MarkupInterface
		* objects to strings can require an initialised container.
		*
		* @group Test
		*
		* @coversDefaultClass \Drupal\TestTools\Comparator\MarkupInterfaceComparator
		*/
		class MarkupInterfaceComparatorTest extends KernelTestBase {

		/**
		* @var \Drupal\TestTools\Comparator\MarkupInterfaceComparator
		*/
		protected $comparator;

		/**
		* @var \SebastianBergmann\Comparator\Factory
		*/
		protected $factory;

		/**
		* {@inheritdoc}
		*/
		protected function setUp() {
		parent::setUp();
		$this->factory = new Factory();
		$this->comparator = new MarkupInterfaceComparator();
		$this->comparator->setFactory($this->factory);
		}

		/**
		* Provides test data for the comparator.
		*
		* @return array
		* Each array entry has:
		* - test expected value,
		* - test actual value,
		* - a bool indicating the expected return value of ::accepts,
		* - a value indicating the expected result of ::assertEquals, either TRUE
		* or a class name of an object thrown.
		*/
		public function dataSetProvider() {
		return [
		'FormattableMarkup vs FormattableMarkup, equal' => [
		new FormattableMarkup('goldfinger', []),
		new FormattableMarkup('goldfinger', []),
		TRUE,
		TRUE,
		],
		'FormattableMarkup vs FormattableMarkup, not equal' => [
		new FormattableMarkup('goldfinger', []),
		new FormattableMarkup('moonraker', []),
		TRUE,
		ComparisonFailure::class,
		],
		'FormattableMarkup vs string, equal' => [
		new FormattableMarkup('goldfinger', []),
		'goldfinger',
		TRUE,
		TRUE,
		],
		'string vs FormattableMarkup, equal' => [
		'goldfinger',
		new FormattableMarkup('goldfinger', []),
		TRUE,
		TRUE,
		],
		'TranslatableMarkup vs FormattableMarkup, equal' => [
		new TranslatableMarkup('goldfinger'),
		new FormattableMarkup('goldfinger', []),
		TRUE,
		TRUE,
		],
		'TranslatableMarkup vs string, not equal' => [
		new TranslatableMarkup('goldfinger'),
		'moonraker',
		TRUE,
		ComparisonFailure::class,
		],
		'TranslatableMarkup vs int, equal' => [
		new TranslatableMarkup('1234'),
		1234,
		TRUE,
		TRUE,
		],
		'int vs TranslatableMarkup, equal' => [
		1234,
		new TranslatableMarkup('1234'),
		TRUE,
		TRUE,
		],
		'FormattableMarkup vs array' => [
		new FormattableMarkup('goldfinger', []),
		['goldfinger'],
		FALSE,
		Notice::class,
		],
		'stdClass vs TranslatableMarkup' => [
		(object) ['goldfinger'],
		new TranslatableMarkup('goldfinger'),
		FALSE,
		Error::class,
		],
		'string vs string, equal' => [
		'goldfinger',
		'goldfinger',
		FALSE,
		TRUE,
		],
		];
		}

		/**
		* @covers ::accepts
		* @dataProvider dataSetProvider
		*/
		public function testAccepts($expected, $actual, $accepts_result, $equals_result) {
		if ($accepts_result) {
		$this->assertTrue($this->comparator->accepts($expected, $actual));
		}
		else {
		$this->assertFalse($this->comparator->accepts($expected, $actual));
		}
		}

		/**
		* @covers ::assertEquals
		* @dataProvider dataSetProvider
		*/
		public function testAssertEquals($expected, $actual, $accepts_result, $equals_result) {
		try {
		$this->assertNull($this->comparator->assertEquals($expected, $actual));
		$this->assertTrue($equals_result);
		}
		catch (\Throwable $e) {
		$this->assertInstanceOf($equals_result, $e);
		}
		}

		}

core/tests/Drupal/KernelTests/KernelTestBase.php

+4 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,7 @@
		use Drupal\Tests\PhpunitCompatibilityTrait;
		use Drupal\Tests\RandomGeneratorTrait;
		use Drupal\Tests\TestRequirementsTrait;
		use Drupal\TestTools\Comparator\MarkupInterfaceComparator;
		use PHPUnit\Framework\Exception;
		use PHPUnit\Framework\TestCase;
		use Symfony\Component\DependencyInjection\Reference;
		@@ -237,6 +238,9 @@ public static function setUpBeforeClass() {
		protected function setUp() {
		parent::setUp();

		// Allow tests to compare MarkupInterface objects via assertEquals().
		$this->registerComparator(new MarkupInterfaceComparator());

		$this->root = static::getDrupalRoot();
		$this->initFileCache();
		$this->bootEnvironment();

core/tests/Drupal/TestTools/Comparator/MarkupInterfaceComparator.php

0 → 100644

+34 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\TestTools\Comparator;

		use Drupal\Component\Render\MarkupInterface;
		use SebastianBergmann\Comparator\Comparator;

		/**
		* Compares MarkupInterface objects for equality.
		*/
		class MarkupInterfaceComparator extends Comparator {

		/**
		* {@inheritdoc}
		*/
		public function accepts($expected, $actual) {
		// If at least one argument is a MarkupInterface object, we take over and
		// convert to strings before comparing.
		return ($expected instanceof MarkupInterface && $actual instanceof MarkupInterface) \|\|
		($expected instanceof MarkupInterface && is_scalar($actual)) \|\|
		(is_scalar($expected) && $actual instanceof MarkupInterface);
		}

		/**
		* {@inheritdoc}
		*/
		public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = FALSE, $ignoreCase = FALSE) {
		$expected_safe = (string) $expected;
		$actual_safe = (string) $actual;
		$comparator = $this->factory->getComparatorFor($expected_safe, $actual_safe);
		$comparator->assertEquals($expected_safe, $actual_safe, $delta, $canonicalize, $ignoreCase);
		}

		}

core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit6/TestCompatibilityTrait.php

+0 −14

Original line number	Diff line number	Diff line
		@@ -39,18 +39,4 @@ public static function assertFalse($actual, $message = '') {
		}
		}

		/**
		* {@inheritdoc}
		*/
		public static function assertEquals($expected, $actual, $message = '', $delta = 0, $maxDepth = 10, $canonicalize = FALSE, $ignoreCase = FALSE) {
		// Cast objects implementing MarkupInterface to string instead of
		// relying on PHP casting them to string depending on what they are being
		// comparing with.
		if (method_exists(self::class, 'castSafeStrings')) {
		$expected = self::castSafeStrings($expected);
		$actual = self::castSafeStrings($actual);
		}
		parent::assertEquals($expected, $actual, $message, $delta, $maxDepth, $canonicalize, $ignoreCase);
		}

		}

core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit7/TestCompatibilityTrait.php

+0 −14

Original line number	Diff line number	Diff line
		@@ -39,18 +39,4 @@ public static function assertFalse($actual, string $message = ''): void {
		}
		}

		/**
		* {@inheritdoc}
		*/
		public static function assertEquals($expected, $actual, string $message = '', float $delta = 0, int $maxDepth = 10, bool $canonicalize = FALSE, bool $ignoreCase = FALSE): void {
		// Cast objects implementing MarkupInterface to string instead of
		// relying on PHP casting them to string depending on what they are being
		// comparing with.
		if (method_exists(self::class, 'castSafeStrings')) {
		$expected = self::castSafeStrings($expected);
		$actual = self::castSafeStrings($actual);
		}
		parent::assertEquals($expected, $actual, $message, $delta, $maxDepth, $canonicalize, $ignoreCase);
		}

		}