Rector requires phpunit installed to work correctly

[slepic]

PHP version 7.2.19

Rector version: 0.5.9

Full Command: vendor/bin/rector process app --level php72 --autoload-file app/bootstrap.php
(the bootstrap.php file loads the vendor/autoload.php and inits nette robot loader and container, I do not want to say anymore at this point, since it is a private project)

Environment: phpunit/phpunit is not installed - not in require, nor require-dev section of compoesr.json of the project being processed by rector.

Current behaviour:
Error: Analyze error: Class PHPUnit\\Framework\\TestCase was not found while trying to analyse it on every source file in the project.

Expected behaviour:
OK - no files changed, or maybe some files changed yes, but no error.

Additional information:
if i do
composer require --dev phpunit/phpunit
and rerun the rector command, I get expected behaviour.

[slepic]

Well, I was just now trying to setup a new project where i would only install rector and try on some dummy class, and it behaves as expected. So I suppose that would be a problem with some 3rd party package installed by our project. Let me dig deeper...

[TomasVotruba]

The important part is analyzed code. It usually is just 1 file that is causing all the harm.

Narrow it down like:

vendor/bin/rector process src/SingleFile.php

[slepic]

This seems not to be the case. It happens on every file, even the app/bootstrap.php itself.
Here is a check of usage of the TestCase class:

$ find vendor -type d -name src |xargs find |xargs grep -nH 'PHPUnit\\Framework\\TestCase' \; 2>/dev/null
vendor/rector/rector/src/Rector/Annotation/RenameAnnotationRector.php:48:class SomeTest extends PHPUnit\Framework\TestCase
vendor/rector/rector/src/Rector/Annotation/RenameAnnotationRector.php:60:class SomeTest extends PHPUnit\Framework\TestCase
vendor/rector/rector/src/Rector/Annotation/RenameAnnotationRector.php:72:                        'PHPUnit\Framework\TestCase' => [
vendor/rector/rector/src/Rector/AbstractPHPUnitRector.php:40:        return $this->isTypes($classNode, ['PHPUnit\Framework\TestCase', 'PHPUnit_Framework_TestCase']);
vendor/rector/rector/packages/Symfony/src/Rector/MethodCall/SimplifyWebTestCaseAssertionsRector.php:47:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/Symfony/src/Rector/MethodCall/SimplifyWebTestCaseAssertionsRector.php:70:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/NetteTesterToPHPUnit/src/Rector/Class_/NetteTesterClassToPHPUnitClassRector.php:67:class ExtensionTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/NetteTesterToPHPUnit/src/Rector/Class_/NetteTesterClassToPHPUnitClassRector.php:116:        $class->extends = new FullyQualified('PHPUnit\Framework\TestCase');
vendor/rector/rector/packages/PhpSpecToPHPUnit/src/PHPUnitTypeDeclarationDecorator.php:16:        if (! class_exists('PHPUnit\Framework\TestCase')) {
vendor/rector/rector/packages/PhpSpecToPHPUnit/src/PHPUnitTypeDeclarationDecorator.php:25:        $reflectionMethod = new ReflectionMethod('PHPUnit\Framework\TestCase', 'setUp');
vendor/rector/rector/packages/PhpSpecToPHPUnit/src/Naming/PhpSpecRenaming.php:63:        $class->extends = new FullyQualified('PHPUnit\Framework\TestCase');
vendor/rector/rector/packages/PHPUnitSymfony/src/Rector/StaticCall/AddMessageToEqualsResponseCodeRector.php:31:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/PHPUnitSymfony/src/Rector/StaticCall/AddMessageToEqualsResponseCodeRector.php:47:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/RemovingStatic/src/Rector/Class_/PHPUnitStaticToKernelTestCaseGetRector.php:87:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/RemovingStatic/src/Rector/Class_/PHPUnitStaticToKernelTestCaseGetRector.php:157:        if ($this->isType($class, 'PHPUnit\Framework\TestCase')) {
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/RemoveExpectAnyFromMockRector.php:21:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/RemoveExpectAnyFromMockRector.php:36:use PHPUnit\Framework\TestCase;
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/UseSpecificWillMethodRector.php:36:class SomeClass extends PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/UseSpecificWillMethodRector.php:50:class SomeClass extends PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/AssertEqualsParameterToSpecificMethodsTypeRector.php:26:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/AssertEqualsParameterToSpecificMethodsTypeRector.php:43:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/SpecificAssertInternalTypeRector.php:56:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/SpecificAssertInternalTypeRector.php:68:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/SpecificAssertContainsRector.php:37:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/SpecificAssertContainsRector.php:50:final class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/ReplaceAssertArraySubsetRector.php:41:class SomeTest extends \PHPUnit\Framework\TestCase
vendor/rector/rector/packages/PHPUnit/src/Rector/MethodCall/ReplaceAssertArraySubsetRector.php:55:class SomeTest extends \PHPUnit\Framework\TestCase
vendor/phpstan/phpstan/src/Testing/TestCase.php:38:abstract class TestCase extends \PHPUnit\Framework\TestCase
vendor/phpstan/phpstan/src/Testing/LevelsTestCase.php:7:abstract class LevelsTestCase extends \PHPUnit\Framework\TestCase
vendor/phpstan/phpstan-phpunit/src/Type/PHPUnit/CreateMockDynamicReturnTypeExtension.php:29:		return 'PHPUnit\Framework\TestCase';
vendor/phpstan/phpstan-phpunit/src/Type/PHPUnit/Assert/AssertMethodTypeSpecifyingExtension.php:27:		return 'PHPUnit\Framework\TestCase';
vendor/phpstan/phpstan-phpunit/src/Type/PHPUnit/GetMockBuilderDynamicReturnTypeExtension.php:18:		return 'PHPUnit\Framework\TestCase';
vendor/phpstan/phpstan-phpunit/src/Type/PHPUnit/MockBuilderDynamicReturnTypeExtension.php:28:		$testCase = $this->broker->getClass('PHPUnit\Framework\TestCase');
vendor/symplify/package-builder/src/Tests/AbstractKernelTestCase.php:6:use PHPUnit\Framework\TestCase;

it shows that rector/rector, phpstan/phpstan, phpstan/phpstan-phpunit and symplify/package-builder are declaring symbols that depend on the TestCase class, but this code is in the src, therefore the entire packages should require phpunit/phpunit, which they only do in require-dev. Not sure if that will help though, it seems rather difficult to cherry pick the essential conditions for this bug to occur.

I was also looking if there is some package that would declare autoloader for tests inside autoload section instead of autoload-dev section, but it seems they're not.

EDIT:
I also though that maybe nette robot loader is too rush loading vendor sources, but we only load our sources using the robot loader:

$configurator->createRobotLoader()
	->addDirectory(ROOT_DIR . '/libs')
	->addDirectory(ROOT_DIR . '/app')
	->register();

[TomasVotruba]

I see, it might be related to new dependency:
phpstan/phpstan-phpunit

What happened when you composer remove phpstan/phpstan-phpunit it?

[slepic]

Had to downgrade to 0.5.8 to get rid of phpstan-phpunit, but when i did, it worked correctly. So yeah it seems phpstan-phpunit is causing the problem.

Here is few top frames of stack trace of the exception thrown deep inside the process command (sry for the format, phpstorm didint want to cooperate very well while trying to export it):

array (
  'file' => '/app/vendor/phpstan/phpstan-phpunit/src/Type/PHPUnit/MockBuilderDynamicReturnTypeExtension.php',
  'line' => 28,
  'function' => 'getClass',
  'class' => 'PHPStan\\Broker\\Broker',
  'type' => '->',
  'args' => 
  array (
    0 => 'PHPUnit\\Framework\\TestCase',
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Broker/Broker.php',
  'line' => 186,
  'function' => 'getClass',
  'class' => 'PHPStan\\Type\\PHPUnit\\MockBuilderDynamicReturnTypeExtension',
  'type' => '->',
  'args' => 
  array (
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Analyser/Scope.php',
  'line' => 1353,
  'function' => 'getDynamicMethodReturnTypeExtensionsForClass',
  'class' => 'PHPStan\\Broker\\Broker',
  'type' => '->',
  'args' => 
  array (
    0 => 'Nette\\Configurator',
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Analyser/Scope.php',
  'line' => 353,
  'function' => 'resolveType',
  'class' => 'PHPStan\\Analyser\\Scope',
  'type' => '->',
  'args' => 
  array (
    0 => 
    PhpParser\Node\Expr\MethodCall::__set_state(array(
       'var' => 
      PhpParser\Node\Expr\Variable::__set_state(array(
         'name' => 'configurator',
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 187,
          'comments' => 
          array (
            0 => 
            PhpParser\Comment::__set_state(array(
               'text' => '// enable RobotLoader - this will load all classes automatically
',
               'line' => 27,
               'filePos' => 826,
               'tokenPos' => 186,
            )),
          ),
          'endLine' => 28,
          'endTokenPos' => 187,
        ),
      )),
       'name' => 
      PhpParser\Node\Identifier::__set_state(array(
         'name' => 'createRobotLoader',
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 189,
          'endLine' => 28,
          'endTokenPos' => 189,
        ),
      )),
       'args' => 
      array (
      ),
       'attributes' => 
      array (
        'startLine' => 28,
        'startTokenPos' => 187,
        'comments' => 
        array (
          0 => 
          PhpParser\Comment::__set_state(array(
             'text' => '// enable RobotLoader - this will load all classes automatically
',
             'line' => 27,
             'filePos' => 826,
             'tokenPos' => 186,
          )),
        ),
        'endLine' => 28,
        'endTokenPos' => 191,
      ),
    )),
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Analyser/Scope.php',
  'line' => 1338,
  'function' => 'getType',
  'class' => 'PHPStan\\Analyser\\Scope',
  'type' => '->',
  'args' => 
  array (
    0 => 
    PhpParser\Node\Expr\MethodCall::__set_state(array(
       'var' => 
      PhpParser\Node\Expr\Variable::__set_state(array(
         'name' => 'configurator',
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 187,
          'comments' => 
          array (
            0 => 
            PhpParser\Comment::__set_state(array(
               'text' => '// enable RobotLoader - this will load all classes automatically
',
               'line' => 27,
               'filePos' => 826,
               'tokenPos' => 186,
            )),
          ),
          'endLine' => 28,
          'endTokenPos' => 187,
        ),
      )),
       'name' => 
      PhpParser\Node\Identifier::__set_state(array(
         'name' => 'createRobotLoader',
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 189,
          'endLine' => 28,
          'endTokenPos' => 189,
        ),
      )),
       'args' => 
      array (
      ),
       'attributes' => 
      array (
        'startLine' => 28,
        'startTokenPos' => 187,
        'comments' => 
        array (
          0 => 
          PhpParser\Comment::__set_state(array(
             'text' => '// enable RobotLoader - this will load all classes automatically
',
             'line' => 27,
             'filePos' => 826,
             'tokenPos' => 186,
          )),
        ),
        'endLine' => 28,
        'endTokenPos' => 191,
      ),
    )),
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Analyser/Scope.php',
  'line' => 353,
  'function' => 'resolveType',
  'class' => 'PHPStan\\Analyser\\Scope',
  'type' => '->',
  'args' => 
  array (
    0 => 
    PhpParser\Node\Expr\MethodCall::__set_state(array(
       'var' => 
      PhpParser\Node\Expr\MethodCall::__set_state(array(
         'var' => 
        PhpParser\Node\Expr\Variable::__set_state(array(
           'name' => 'configurator',
           'attributes' => 
          array (
            'startLine' => 28,
            'startTokenPos' => 187,
            'comments' => 
            array (
              0 => 
              PhpParser\Comment::__set_state(array(
                 'text' => '// enable RobotLoader - this will load all classes automatically
',
                 'line' => 27,
                 'filePos' => 826,
                 'tokenPos' => 186,
              )),
            ),
            'endLine' => 28,
            'endTokenPos' => 187,
          ),
        )),
         'name' => 
        PhpParser\Node\Identifier::__set_state(array(
           'name' => 'createRobotLoader',
           'attributes' => 
          array (
            'startLine' => 28,
            'startTokenPos' => 189,
            'endLine' => 28,
            'endTokenPos' => 189,
          ),
        )),
         'args' => 
        array (
        ),
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 187,
          'comments' => 
          array (
            0 => 
            PhpParser\Comment::__set_state(array(
               'text' => '// enable RobotLoader - this will load all classes automatically
',
               'line' => 27,
               'filePos' => 826,
               'tokenPos' => 186,
            )),
          ),
          'endLine' => 28,
          'endTokenPos' => 191,
        ),
      )),
       'name' => 
      PhpParser\Node\Identifier::__set_state(array(
         'name' => 'addDirectory',
         'attributes' => 
        array (
          'startLine' => 29,
          'startTokenPos' => 194,
          'endLine' => 29,
          'endTokenPos' => 194,
        ),
      )),
       'args' => 
      array (
        0 => 
        PhpParser\Node\Arg::__set_state(array(
           'value' => 
          PhpParser\Node\Expr\BinaryOp\Concat::__set_state(array(
             'left' => 
            PhpParser\Node\Expr\ConstFetch::__set_state(array(
               'name' => 
              PhpParser\Node\Name\FullyQualified::__set_state(array(
                 'parts' => 
                array (
                  0 => 'ROOT_DIR',
                ),
                 'attributes' => 
                array (
                  'startLine' => 29,
                  'startTokenPos' => 196,
                  'endLine' => 29,
                  'endTokenPos' => 196,
                  'originalName' => 
                  PhpParser\Node\Name::__set_state(array(
                     'parts' => 
                    array (
                      0 => 'ROOT_DIR',
                    ),
                     'attributes' => 
                    array (
                      'startLine' => 29,
                      'startTokenPos' => 196,
                      'endLine' => 29,
                      'endTokenPos' => 196,
                    ),
                  )),
                ),
              )),
               'attributes' => 
              array (
                'startLine' => 29,
                'startTokenPos' => 196,
                'endLine' => 29,
                'endTokenPos' => 196,
              ),
            )),
             'right' => 
            PhpParser\Node\Scalar\String_::__set_state(array(
               'value' => '/libs',
               'attributes' => 
              array (
                'startLine' => 29,
                'startTokenPos' => 200,
                'endLine' => 29,
                'endTokenPos' => 200,
                'kind' => 1,
              ),
            )),
             'attributes' => 
            array (
              'startLine' => 29,
              'startTokenPos' => 196,
              'endLine' => 29,
              'endTokenPos' => 200,
            ),
          )),
           'byRef' => false,
           'unpack' => false,
           'attributes' => 
          array (
            'startLine' => 29,
            'startTokenPos' => 196,
            'endLine' => 29,
            'endTokenPos' => 200,
          ),
        )),
      ),
       'attributes' => 
      array (
        'startLine' => 28,
        'startTokenPos' => 187,
        'comments' => 
        array (
          0 => 
          PhpParser\Comment::__set_state(array(
             'text' => '// enable RobotLoader - this will load all classes automatically
',
             'line' => 27,
             'filePos' => 826,
             'tokenPos' => 186,
          )),
        ),
        'endLine' => 29,
        'endTokenPos' => 201,
      ),
    )),
  ),
)
array (
  'file' => '/app/vendor/phpstan/phpstan/src/Analyser/Scope.php',
  'line' => 1338,
  'function' => 'getType',
  'class' => 'PHPStan\\Analyser\\Scope',
  'type' => '->',
  'args' => 
  array (
    0 => 
    PhpParser\Node\Expr\MethodCall::__set_state(array(
       'var' => 
      PhpParser\Node\Expr\MethodCall::__set_state(array(
         'var' => 
        PhpParser\Node\Expr\Variable::__set_state(array(
           'name' => 'configurator',
           'attributes' => 
          array (
            'startLine' => 28,
            'startTokenPos' => 187,
            'comments' => 
            array (
              0 => 
              PhpParser\Comment::__set_state(array(
                 'text' => '// enable RobotLoader - this will load all classes automatically
',
                 'line' => 27,
                 'filePos' => 826,
                 'tokenPos' => 186,
              )),
            ),
            'endLine' => 28,
            'endTokenPos' => 187,
          ),
        )),
         'name' => 
        PhpParser\Node\Identifier::__set_state(array(
           'name' => 'createRobotLoader',
           'attributes' => 
          array (
            'startLine' => 28,
            'startTokenPos' => 189,
            'endLine' => 28,
            'endTokenPos' => 189,
          ),
        )),
         'args' => 
        array (
        ),
         'attributes' => 
        array (
          'startLine' => 28,
          'startTokenPos' => 187,
          'comments' => 
          array (
            0 => 
            PhpParser\Comment::__set_state(array(
               'text' => '// enable RobotLoader - this will load all classes automatically
',
               'line' => 27,
               'filePos' => 826,
               'tokenPos' => 186,
            )),
          ),
          'endLine' => 28,
          'endTokenPos' => 191,
        ),
      )),
       'name' => 
      PhpParser\Node\Identifier::__set_state(array(
         'name' => 'addDirectory',
         'attributes' => 
        array (
          'startLine' => 29,
          'startTokenPos' => 194,
          'endLine' => 29,
          'endTokenPos' => 194,
        ),
      )),
       'args' => 
      array (
        0 => 
        PhpParser\Node\Arg::__set_state(array(
           'value' => 
          PhpParser\Node\Expr\BinaryOp\Concat::__set_state(array(
             'left' => 
            PhpParser\Node\Expr\ConstFetch::__set_state(array(
               'name' => 
              PhpParser\Node\Name\FullyQualified::__set_state(array(
                 'parts' => 
                array (
                  0 => 'ROOT_DIR',
                ),
                 'attributes' => 
                array (
                  'startLine' => 29,
                  'startTokenPos' => 196,
                  'endLine' => 29,
                  'endTokenPos' => 196,
                  'originalName' => 
                  PhpParser\Node\Name::__set_state(array(
                     'parts' => 
                    array (
                      0 => 'ROOT_DIR',
                    ),
                     'attributes' => 
                    array (
                      'startLine' => 29,
                      'startTokenPos' => 196,
                      'endLine' => 29,
                      'endTokenPos' => 196,
                    ),
                  )),
                ),
              )),
               'attributes' => 
              array (
                'startLine' => 29,
                'startTokenPos' => 196,
                'endLine' => 29,
                'endTokenPos' => 196,
              ),
            )),
             'right' => 
            PhpParser\Node\Scalar\String_::__set_state(array(
               'value' => '/libs',
               'attributes' => 
              array (
                'startLine' => 29,
                'startTokenPos' => 200,
                'endLine' => 29,
                'endTokenPos' => 200,
                'kind' => 1,
              ),
            )),
             'attributes' => 
            array (
              'startLine' => 29,
              'startTokenPos' => 196,
              'endLine' => 29,
              'endTokenPos' => 200,
            ),
          )),
           'byRef' => false,
           'unpack' => false,
           'attributes' => 
          array (
            'startLine' => 29,
            'startTokenPos' => 196,
            'endLine' => 29,
            'endTokenPos' => 200,
          ),
        )),
      ),
       'attributes' => 
      array (
        'startLine' => 28,
        'startTokenPos' => 187,
        'comments' => 
        array (
          0 => 
          PhpParser\Comment::__set_state(array(
             'text' => '// enable RobotLoader - this will load all classes automatically
',
             'line' => 27,
             'filePos' => 826,
             'tokenPos' => 186,
          )),
        ),
        'endLine' => 29,
        'endTokenPos' => 201,
      ),
    )),
  ),
)

[TomasVotruba]

Thanks, that's it!

Solution would be to add class_exists('*...TestCase') here:

rector/packages/NodeTypeResolver/src/DependencyInjection/PHPStanServicesFactory.php

Line 26 in 541ffe9

if (file_exists($phpstanPhpunitExtensionConfig)) {

[slepic]

Yep confirmed. That fixes it. Thanks.
Here you go #1813