AssertSameBooleanExpectedRule

Author: mhujer

README.md

@@ -18,8 +18,10 @@ It also contains this framework-specific rule (can be enabled separately):
 
 * Check that both values passed to `assertSame()` method are of the same type.
 
-It also contains this strict framework-specific rule (can be enabled separately):
+It also contains this strict framework-specific rules (can be enabled separately):
 
+* Check that you are not using `assertSame()` with `true` as expected value. `assertTrue()` should be used instead.
+* Check that you are not using `assertSame()` with `false` as expected value. `assertFalse()` should be used instead.
 * Check that you are not using `assertSame()` with `null` as expected value. `assertNull()` should be used instead.
 
 ## How to document mock objects in phpDocs?

src/Rules/PHPUnit/AssertSameBooleanExpectedRule.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Type\FalseBooleanType;
+use PHPStan\Type\TrueBooleanType;
+
+class AssertSameBooleanExpectedRule implements \PHPStan\Rules\Rule
+{
+
+	public function getNodeType(): string
+	{
+		return \PhpParser\NodeAbstract::class;
+	}
+
+	/**
+	 * @param \PhpParser\Node\Expr\MethodCall|\PhpParser\Node\Expr\StaticCall $node
+	 * @param \PHPStan\Analyser\Scope $scope
+	 * @return string[] errors
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!AssertRuleHelper::isMethodOrStaticCallOnTestCase($node, $scope)) {
+			return [];
+		}
+
+		if (count($node->args) < 2) {
+			return [];
+		}
+		if (!is_string($node->name) || strtolower($node->name) !== 'assertsame') {
+			return [];
+		}
+
+		$leftType = $scope->getType($node->args[0]->value);
+
+		if ($leftType instanceof TrueBooleanType) {
+			return [
+				'You should use assertTrue() instead of assertSame() when expecting "true"',
+			];
+		}
+
+		if ($leftType instanceof FalseBooleanType) {
+			return [
+				'You should use assertFalse() instead of assertSame() when expecting "false"',
+			];
+		}
+
+		return [];
+	}
+
+}

strictRules.neon

@@ -1,4 +1,8 @@
 services:
+	-
+		class: PHPStan\Rules\PHPUnit\AssertSameBooleanExpectedRule
+		tags:
+			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\PHPUnit\AssertSameNullExpectedRule
 		tags:

tests/Rules/PHPUnit/AssertSameBooleanExpectedRuleTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PHPStan\Rules\Rule;
+
+class AssertSameBooleanExpectedRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new AssertSameBooleanExpectedRule();
+	}
+
+	public function testRule()
+	{
+		$this->analyse([__DIR__ . '/data/assert-same-boolean-expected.php'], [
+			[
+				'You should use assertTrue() instead of assertSame() when expecting "true"',
+				10,
+			],
+			[
+				'You should use assertFalse() instead of assertSame() when expecting "false"',
+				11,
+			],
+			[
+				'You should use assertTrue() instead of assertSame() when expecting "true"',
+				14,
+			],
+			[
+				'You should use assertFalse() instead of assertSame() when expecting "false"',
+				17,
+			],
+		]);
+	}
+
+}

tests/Rules/PHPUnit/data/assert-same-boolean-expected.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types = 1);
+
+namespace ExampleTestCase;
+
+class AssertSameBooleanExpectedTestCase extends \PHPUnit\Framework\TestCase
+{
+
+	public function testAssertSameWithBooleanAsExpected()
+	{
+		$this->assertSame(true, 'a');
+		$this->assertSame(false, 'a');
+
+		$truish = true;
+		$this->assertSame($truish, true);
+
+		$falsish = false;
+		$this->assertSame($falsish, false);
+
+		/** @var bool $a */
+		$a = null;
+		$this->assertSame($a, 'b'); // OK
+	}
+
+}