annotate core/tests/Drupal/KernelTests/AssertLegacyTrait.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\KernelTests;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Translates Simpletest assertion methods to PHPUnit.
Chris@0 7 *
Chris@0 8 * Protected methods are custom. Public static methods override methods of
Chris@0 9 * \PHPUnit\Framework\Assert.
Chris@0 10 *
Chris@18 11 * Deprecated Scheduled for removal in Drupal 10.0.0. Use PHPUnit's native
Chris@0 12 * assert methods instead.
Chris@18 13 *
Chris@18 14 * @todo https://www.drupal.org/project/drupal/issues/3031580 Note that
Chris@18 15 * deprecations in this file do not use the @ symbol in Drupal 8 because this
Chris@18 16 * will be removed in Drupal 10.0.0.
Chris@0 17 */
Chris@0 18 trait AssertLegacyTrait {
Chris@0 19
Chris@0 20 /**
Chris@0 21 * @see \Drupal\simpletest\TestBase::assert()
Chris@0 22 *
Chris@18 23 * Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
Chris@0 24 * instead.
Chris@0 25 */
Chris@0 26 protected function assert($actual, $message = '') {
Chris@0 27 parent::assertTrue((bool) $actual, $message);
Chris@0 28 }
Chris@0 29
Chris@0 30 /**
Chris@0 31 * @see \Drupal\simpletest\TestBase::assertTrue()
Chris@0 32 */
Chris@0 33 public static function assertTrue($actual, $message = '') {
Chris@0 34 if (is_bool($actual)) {
Chris@0 35 parent::assertTrue($actual, $message);
Chris@0 36 }
Chris@0 37 else {
Chris@0 38 parent::assertNotEmpty($actual, $message);
Chris@0 39 }
Chris@0 40 }
Chris@0 41
Chris@0 42 /**
Chris@0 43 * @see \Drupal\simpletest\TestBase::assertFalse()
Chris@0 44 */
Chris@0 45 public static function assertFalse($actual, $message = '') {
Chris@0 46 if (is_bool($actual)) {
Chris@0 47 parent::assertFalse($actual, $message);
Chris@0 48 }
Chris@0 49 else {
Chris@0 50 parent::assertEmpty($actual, $message);
Chris@0 51 }
Chris@0 52 }
Chris@0 53
Chris@0 54 /**
Chris@0 55 * @see \Drupal\simpletest\TestBase::assertEqual()
Chris@0 56 *
Chris@18 57 * Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
Chris@0 58 * instead.
Chris@0 59 */
Chris@0 60 protected function assertEqual($actual, $expected, $message = '') {
Chris@0 61 $this->assertEquals($expected, $actual, $message);
Chris@0 62 }
Chris@0 63
Chris@0 64 /**
Chris@0 65 * @see \Drupal\simpletest\TestBase::assertNotEqual()
Chris@0 66 *
Chris@18 67 * Deprecated Scheduled for removal in Drupal 10.0.0. Use
Chris@0 68 * self::assertNotEquals() instead.
Chris@0 69 */
Chris@0 70 protected function assertNotEqual($actual, $expected, $message = '') {
Chris@0 71 $this->assertNotEquals($expected, $actual, $message);
Chris@0 72 }
Chris@0 73
Chris@0 74 /**
Chris@0 75 * @see \Drupal\simpletest\TestBase::assertIdentical()
Chris@0 76 *
Chris@18 77 * Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame()
Chris@0 78 * instead.
Chris@0 79 */
Chris@0 80 protected function assertIdentical($actual, $expected, $message = '') {
Chris@0 81 $this->assertSame($expected, $actual, $message);
Chris@0 82 }
Chris@0 83
Chris@0 84 /**
Chris@0 85 * @see \Drupal\simpletest\TestBase::assertNotIdentical()
Chris@0 86 *
Chris@18 87 * Deprecated Scheduled for removal in Drupal 10.0.0. Use
Chris@0 88 * self::assertNotSame() instead.
Chris@0 89 */
Chris@0 90 protected function assertNotIdentical($actual, $expected, $message = '') {
Chris@0 91 $this->assertNotSame($expected, $actual, $message);
Chris@0 92 }
Chris@0 93
Chris@0 94 /**
Chris@0 95 * @see \Drupal\simpletest\TestBase::assertIdenticalObject()
Chris@0 96 *
Chris@18 97 * Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
Chris@0 98 * instead.
Chris@0 99 */
Chris@0 100 protected function assertIdenticalObject($actual, $expected, $message = '') {
Chris@0 101 // Note: ::assertSame checks whether its the same object. ::assertEquals
Chris@0 102 // though compares
Chris@0 103
Chris@0 104 $this->assertEquals($expected, $actual, $message);
Chris@0 105 }
Chris@0 106
Chris@0 107 /**
Chris@0 108 * @see \Drupal\simpletest\TestBase::pass()
Chris@0 109 *
Chris@18 110 * Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
Chris@0 111 * instead.
Chris@0 112 */
Chris@0 113 protected function pass($message) {
Chris@0 114 $this->assertTrue(TRUE, $message);
Chris@0 115 }
Chris@0 116
Chris@0 117 /**
Chris@0 118 * @see \Drupal\simpletest\TestBase::verbose()
Chris@0 119 */
Chris@0 120 protected function verbose($message) {
Chris@0 121 if (in_array('--debug', $_SERVER['argv'], TRUE)) {
Chris@0 122 // Write directly to STDOUT to not produce unexpected test output.
Chris@0 123 // The STDOUT stream does not obey output buffering.
Chris@0 124 fwrite(STDOUT, $message . "\n");
Chris@0 125 }
Chris@0 126 }
Chris@0 127
Chris@0 128 }