AssertSameWithCountRule

Author: mhujer

README.md

@@ -23,6 +23,7 @@ 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.
+* Check that you are not using `assertSame()` with `count($variable)` as second parameter. `assertCount($variable)` should be used instead.
 
 ## How to document mock objects in phpDocs?
 

src/Rules/PHPUnit/AssertSameWithCountRule.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+
+class AssertSameWithCountRule 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 [];
+		}
+
+		$right = $node->args[1]->value;
+
+		if (
+			$right instanceof Node\Expr\FuncCall
+			&& $right->name instanceof Node\Name
+			&& strtolower($right->name->toString()) === 'count'
+		) {
+			return [
+				'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
+			];
+		}
+
+		return [];
+	}
+
+}

strictRules.neon

@@ -7,3 +7,7 @@ services:
 		class: PHPStan\Rules\PHPUnit\AssertSameNullExpectedRule
 		tags:
 			- phpstan.rules.rule
+	-
+		class: PHPStan\Rules\PHPUnit\AssertSameWithCountRule
+		tags:
+			- phpstan.rules.rule

tests/Rules/PHPUnit/AssertSameWithCountRuleTest.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PHPStan\Rules\Rule;
+
+class AssertSameWithCountRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new AssertSameWithCountRule();
+	}
+
+	public function testRule()
+	{
+		$this->analyse([__DIR__ . '/data/assert-same-count.php'], [
+			[
+				'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
+				10,
+			],
+		]);
+	}
+
+}

tests/Rules/PHPUnit/data/assert-same-count.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace ExampleTestCase;
+
+class AssertSameWithCountTestCase extends \PHPUnit\Framework\TestCase
+{
+
+	public function testAssertSameWithCount()
+	{
+		$this->assertSame(5, count([1, 2, 3]));
+	}
+
+	public function testAssertSameWithCountMethodIsOK()
+	{
+		$this->assertSame(5, $this->count()); // OK
+	}
+
+}