php_unit_construct.rst

Rule php_unit_construct

PHPUnit assertion method calls like ->assertSame(true, $foo) should be written with dedicated method like ->assertTrue($foo).

Warning

Using this rule is risky

Fixer could be risky if one is overriding PHPUnit's native methods.

Configuration

assertions

List of assertion methods to fix.

Allowed values: a subset of ['assertEquals', 'assertNotEquals', 'assertNotSame', 'assertSame']

Default value: ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 final class FooTest extends \PHPUnit_Framework_TestCase {
     public function testSomething() {
-        $this->assertEquals(false, $b);
-        $this->assertSame(true, $a);
-        $this->assertNotEquals(null, $c);
-        $this->assertNotSame(null, $d);
+        $this->assertFalse($b);
+        $this->assertTrue($a);
+        $this->assertNotNull($c);
+        $this->assertNotNull($d);
     }
 }

Example #2

With configuration: ['assertions' => ['assertSame', 'assertNotSame']].

--- Original
+++ New
 <?php
 final class FooTest extends \PHPUnit_Framework_TestCase {
     public function testSomething() {
         $this->assertEquals(false, $b);
-        $this->assertSame(true, $a);
+        $this->assertTrue($a);
         $this->assertNotEquals(null, $c);
-        $this->assertNotSame(null, $d);
+        $this->assertNotNull($d);
     }
 }

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer:risky
• @Symfony:risky

References

• Fixer class: PhpCsFixer\Fixer\PhpUnit\PhpUnitConstructFixer
• Test class: PhpCsFixer\Tests\Fixer\PhpUnit\PhpUnitConstructFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.