[code-quality] Add MatchAssertSameExpectedTypeRector

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -31,6 +31,7 @@
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertSameTrueFalseToAssertTrueFalseRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertTrueFalseToSpecificMethodRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\FlipAssertRector;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\NarrowIdenticalWithConsecutiveRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\NarrowSingleWillReturnCallbackRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\RemoveExpectAnyFromMockRector;
@@ -43,7 +44,10 @@
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
         ConstructClassMethodToSetUpTestCaseRector::class,
+
         AssertSameTrueFalseToAssertTrueFalseRector::class,
+        MatchAssertSameExpectedTypeRector::class,
+
         AssertEqualsToSameRector::class,
         PreferPHPUnitThisCallRector::class,
         YieldDataProviderRector::class,

rules-tests/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector/Fixture/match_assert_type.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class MatchAssertType extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame('123', $this->getOrderId());
+    }
+
+    private function getOrderId(): int
+    {
+        return 123;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class MatchAssertType extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame(123, $this->getOrderId());
+    }
+
+    private function getOrderId(): int
+    {
+        return 123;
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector/Fixture/match_integer_to_string.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class MatchIntegerToString extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame(123, $this->getOrderId());
+    }
+
+    private function getOrderId(): string
+    {
+        return '123';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class MatchIntegerToString extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame('123', $this->getOrderId());
+    }
+
+    private function getOrderId(): string
+    {
+        return '123';
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector/Fixture/nullable_match_assert_type.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class NullableMatchAssertType extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame('123', $this->getOrderId());
+    }
+
+    private function getOrderId(): ?int
+    {
+        return 123;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class NullableMatchAssertType extends TestCase
+{
+    public function test()
+    {
+        $this->assertSame(123, $this->getOrderId());
+    }
+
+    private function getOrderId(): ?int
+    {
+        return 123;
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector/MatchAssertSameExpectedTypeRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class MatchAssertSameExpectedTypeRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(MatchAssertSameExpectedTypeRector::class);
+};

rules/CodeQuality/Rector/MethodCall/MatchAssertSameExpectedTypeRector.php

@@ -0,0 +1,118 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Scalar\LNumber;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Type\TypeCombinator;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\MatchAssertSameExpectedTypeRector\MatchAssertSameExpectedTypeRectorTest
+ */
+final class MatchAssertSameExpectedTypeRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Correct expected type in assertSame() method to match strict type of passed variable',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+class SomeTest extends TestCase
+{
+    public function run()
+    {
+        $this->assertSame('123', $this->getOrderId());
+    }
+
+    private function getOrderId(): int
+    {
+        return 123;
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+class SomeTest extends TestCase
+{
+    public function run()
+    {
+        $this->assertSame(123, $this->getOrderId());
+    }
+
+    private function getOrderId(): int
+    {
+        return 123;
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class, StaticCall::class];
+    }
+
+    /**
+     * @param MethodCall|StaticCall $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isPHPUnitMethodCallNames($node, ['assertSame', 'assertEquals'])) {
+            return null;
+        }
+
+        $expectedArg = $node->getArgs()[0];
+        if (! $expectedArg->value instanceof String_ && ! $expectedArg->value instanceof LNumber) {
+            return null;
+        }
+
+        $expectedType = $this->getType($expectedArg->value);
+
+        $variableExpr = $node->getArgs()[1]
+            ->value;
+        $variableType = $this->getType($variableExpr);
+
+        $directVariableType = TypeCombinator::removeNull($variableType);
+
+        if ($expectedType->isLiteralString()->yes() && $directVariableType->isInteger()->yes()) {
+            // update expected type to provided type
+            $expectedArg->value = new LNumber((int) $expectedArg->value->value);
+
+            return $node;
+        }
+
+        if ($expectedType->isInteger()->yes() && $directVariableType->isString()->yes()) {
+            // update expected type to provided type
+            $expectedArg->value = new String_((string) $expectedArg->value->value);
+
+            return $node;
+        }
+
+        return null;
+    }
+}