Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CodeQuality] Skip call parent::__construct() indirect parent on ConstructClassMethodToSetUpTestCaseRector #251

Merged
merged 20 commits into from
Sep 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions phpunit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
<testsuites>
<testsuite name="main">
<directory>tests</directory>
<exclude>tests/Rector/Class_/AddSeeTestAnnotationRector/Source</exclude>
<exclude>tests/Rector/ClassMethod/DependsAnnotationWithValueToAttributeRector/Source</exclude>
<directory>rules-tests</directory>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomasVotruba here rules-tests need to be registered to show the PHPUnit error, it was never executed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Damn, that's a big miss from my side 🤦 😅

<exclude>rules-tests/CodeQuality/Rector/Class_/AddSeeTestAnnotationRector/Source</exclude>
<exclude>rules-tests/AnnotationsToAttributes/Rector/ClassMethod/DependsAnnotationWithValueToAttributeRector/Source</exclude>
</testsuite>
</testsuites>
</phpunit>
1 change: 1 addition & 0 deletions rector.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->importNames();
$rectorConfig->removeUnusedImports();

$rectorConfig->paths([__DIR__ . '/src', __DIR__ . '/tests', __DIR__ . '/rules', __DIR__ . '/rules-tests']);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
declare(strict_types=1);

use Rector\PHPUnit\AnnotationsToAttributes\Rector\Class_\TicketAnnotationToAttributeRector;
use Rector\PHPUnit\Tests\ConfigList;
use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector\Fixture;

use Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector\Source\TestResponse;

final class SkipCallParentConstructExists extends TestResponse
{
private $someValue;

public function __construct()
{
$this->someValue = 1000;

parent::__construct();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector\Fixture;

use PHPUnit\Framework\TestCase;

final class SkipParameterUsed extends TestCase
{
public function __construct($param)
{
$this->initEarly($param);
}

private function initEarly($param)
{
echo 'init';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector\Source;

use PHPUnit\Framework\TestCase;

abstract class TestResponse extends TestCase
{
public function __construct()
{
echo "init";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,3 @@ final class SkipCustomIsset2 extends \PHPUnit\Framework\TestCase
$this->assertTrue(isset($foo->bar));
}
}

?>
-----
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\AssertIssetToSpecificMethodRector\Fixture;

// parent class not loaded
final class CustomIsset2 extends SomeAbstractClass {
}

final class SkipCustomIsset2 extends \PHPUnit\Framework\TestCase
{
public function test()
{
$foo = new \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\AssertIssetToSpecificMethodRector\Fixture\CustomIsset2();
$this->assertObjectHasAttribute('bar', $foo);
}
}

?>
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?php

declare(strict_types=1);
use Rector\PHPUnit\Tests\ConfigList;

use Rector\Config\RectorConfig;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@

use Nette\Utils\Json;
use PhpParser\Node;
use PhpParser\Node\Attribute;
use PhpParser\Node\AttributeGroup;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,8 @@
use PHPUnit\Framework\Attributes\Ticket;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
use Rector\PHPUnit\ValueObject\AnnotationWithValueToAttribute;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public function refactor(Node $node): ?int
return null;
}

if (! $this->isName($node->name, 'test*')) {
if (! fnmatch('test*', $node->name->toString(), FNM_NOESCAPE)) {
return null;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public function refactor(Node $node): ?Node
return null;
}

if ($this->isName($node->name, 'test*')) {
if (fnmatch('test*', $node->name->toString(), FNM_NOESCAPE)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomasVotruba @staabm using fnmatch() directly seems the solution

return null;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Expression;
use PhpParser\NodeTraverser;
use PHPStan\Reflection\ClassReflection;
use Rector\Core\NodeAnalyzer\ClassAnalyzer;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\Reflection\ReflectionResolver;
use Rector\Core\ValueObject\MethodName;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\PHPUnit\NodeAnalyzer\SetUpMethodDecorator;
Expand All @@ -33,7 +37,8 @@ public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly ClassAnalyzer $classAnalyzer,
private readonly VisibilityManipulator $visibilityManipulator,
private readonly SetUpMethodDecorator $setUpMethodDecorator
private readonly SetUpMethodDecorator $setUpMethodDecorator,
private readonly ReflectionResolver $reflectionResolver
) {
}

Expand Down Expand Up @@ -105,6 +110,10 @@ public function refactor(Node $node): ?Node
return null;
}

if ($this->shouldSkip($node, $constructClassMethod)) {
return null;
}

$addedStmts = $this->resolveStmtsToAddToSetUp($constructClassMethod);
$setUpClassMethod = $node->getMethod(MethodName::SET_UP);

Expand All @@ -125,6 +134,47 @@ public function refactor(Node $node): ?Node
return $node;
}

private function shouldSkip(Class_ $class, ClassMethod $classMethod): bool
{
$classReflection = $this->reflectionResolver->resolveClassReflection($class);
if (! $classReflection instanceof ClassReflection) {
return true;
}

$currentParent = current($classReflection->getParents());
if (! $currentParent instanceof ClassReflection) {
return true;
}

if ($currentParent->getName() !== 'PHPUnit\Framework\TestCase') {
return true;
}

$paramNames = [];
foreach ($classMethod->params as $param) {
$paramNames[] = $this->getName($param);
}

$isFoundParamUsed = false;
$this->traverseNodesWithCallable(
(array) $classMethod->stmts,
function (Node $subNode) use ($paramNames, &$isFoundParamUsed): ?int {
if ($subNode instanceof StaticCall && $this->isName($subNode->name, MethodName::CONSTRUCT)) {
return NodeTraverser::DONT_TRAVERSE_CHILDREN;
}

if ($subNode instanceof Variable && $this->isNames($subNode, $paramNames)) {
$isFoundParamUsed = true;
return NodeTraverser::STOP_TRAVERSAL;
}

return null;
}
);

return $isFoundParamUsed;
}

/**
* @return Stmt[]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public function refactor(Node $node): ?Node
return null;
}

if (! $this->isName($node->name, 'assert*')) {
if (! fnmatch('assert*', $methodName, FNM_NOESCAPE)) {
return null;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ public function refactor(Node $node): ?Node
return null;
}

$firstArgumentName = $this->getName($firstArgumentValue);
$firstArgumentName = $this->resolveFirstArgument($firstArgumentValue);

if ($firstArgumentName === null || ! array_key_exists(
$firstArgumentName,
self::FUNCTION_NAME_WITH_ASSERT_METHOD_NAMES
Expand Down Expand Up @@ -132,6 +133,13 @@ public function refactor(Node $node): ?Node
return $node;
}

private function resolveFirstArgument(FuncCall|Empty_ $firstArgumentValue): ?string
{
return $firstArgumentValue instanceof Empty_
? 'empty'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomasVotruba this is due to removal of EmptyNameResolver PR:

detected after rules-tests registered to phpunit.xml

#251 (review)

: $this->getName($firstArgumentValue);
}

private function renameMethod(
MethodCall|StaticCall $node,
FunctionNameWithAssertMethods $functionNameWithAssertMethods
Expand Down
1 change: 0 additions & 1 deletion rules/PHPUnit100/Rector/Class_/AddProphecyTraitRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\TraitUse;
use PHPStan\Reflection\ClassReflection;
use Rector\Core\NodeManipulator\ClassManipulator;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\Reflection\ReflectionResolver;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PHPStan\Type\ObjectType;
use PHPStan\Type\TypeWithClassName;
use Rector\Core\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public function refactor(Node $node): ?Node

$dataProviderClassMethods = $this->dataProviderClassMethodFinder->find($node);
foreach ($dataProviderClassMethods as $dataProviderClassMethod) {
if (! $this->isName($dataProviderClassMethod, 'test*')) {
if (! fnmatch('test*', $dataProviderClassMethod->name->toString(), FNM_NOESCAPE)) {
continue;
}

Expand Down
26 changes: 21 additions & 5 deletions src/NodeAnalyzer/AssertCallAnalyzer.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Type\TypeWithClassName;
use Rector\Core\PhpParser\AstResolver;
Expand Down Expand Up @@ -161,16 +162,31 @@ private function resolveClassMethodFromCall(StaticCall | MethodCall $call): ?Cla

private function isAssertMethodName(MethodCall|StaticCall $call): bool
{
return $this->nodeNameResolver->isNames($call->name, [
// phpunit
if (! $call->name instanceof Identifier) {
return false;
}

$callname = $call->name->toString();

foreach (['doTestFileInfo', 'expectNotToPerformAssertions'] as $methodCallName) {
if ($callname === $methodCallName) {
return true;
}
}

foreach ([
'*assert',
'assert*',
'expectException*',
'setExpectedException*',
'expectOutput*',
'should*',
'doTestFileInfo',
'expectNotToPerformAssertions',
]);
] as $methodCallNamePattern) {
if (fnmatch($methodCallNamePattern, $callname, FNM_NOESCAPE)) {
return true;
}
}
Comment on lines +184 to +188
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomasVotruba @staabm here the tweak fnmatch in loop :)


return false;
}
}
2 changes: 1 addition & 1 deletion src/NodeAnalyzer/TestsNodeAnalyzer.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function isTestClassMethod(ClassMethod $classMethod): bool
return false;
}

if ($this->nodeNameResolver->isName($classMethod, 'test*')) {
if (fnmatch('test*', $classMethod->name->toString(), FNM_NOESCAPE)) {
return true;
}

Expand Down
Loading