123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569 |
- <?php
- declare(strict_types=1);
- /*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- * Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Tests\Fixer\PhpUnit;
- use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\Utils;
- use PHPUnit\Framework\TestCase;
- /**
- * @author Filippo Tessarotto <zoeslam@gmail.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer
- */
- final class PhpUnitTestCaseStaticMethodCallsFixerTest extends AbstractFixerTestCase
- {
- public function testFixerContainsAllPhpunitStaticMethodsInItsList(): void
- {
- $assertionRefClass = new \ReflectionClass(TestCase::class);
- $updatedStaticMethodsList = $assertionRefClass->getMethods(\ReflectionMethod::IS_PUBLIC);
- $staticMethods = (new \ReflectionClass(PhpUnitTestCaseStaticMethodCallsFixer::class))->getConstant('STATIC_METHODS');
- $missingMethods = [];
- foreach ($updatedStaticMethodsList as $method) {
- if ($method->isStatic() && !isset($staticMethods[$method->name])) {
- $missingMethods[] = $method->name;
- }
- }
- self::assertSame([], $missingMethods, \sprintf(
- 'The following static methods from "%s" are missing from "%s::$staticMethods": %s',
- TestCase::class,
- PhpUnitTestCaseStaticMethodCallsFixer::class,
- // `Utils::naturalLanguageJoin` does not accept empty array, so let's use it only if there's an actual difference.
- [] === $missingMethods ? '' : Utils::naturalLanguageJoin($missingMethods)
- ));
- }
- public function testWrongConfigTypeForMethodsKey(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('[php_unit_test_case_static_method_calls] Invalid configuration: The option "methods" with value array is expected to be of type "string[]", but one of the elements is of type "int".');
- $this->fixer->configure(['methods' => [123 => 1]]); // @phpstan-ignore-line
- }
- public function testWrongConfigTypeForMethodsValue(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('[php_unit_test_case_static_method_calls] Invalid configuration: The option "methods" with value array is expected to be of type "string[]", but one of the elements is of type "int".');
- $this->fixer->configure(['methods' => ['assertSame' => 123]]); // @phpstan-ignore-line
- }
- /**
- * @param _AutogeneratedInputConfiguration $config
- *
- * @dataProvider provideFixCases
- */
- public function testFix(string $expected, ?string $input = null, array $config = []): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- public static function provideFixCases(): iterable
- {
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- static::assertSame(1, 2);
- static::markTestIncomplete('foo');
- static::fail('foo');
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- $this->markTestIncomplete('foo');
- $this->fail('foo');
- }
- }
- EOF,
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testMocks()
- {
- $mock = $this->createMock(MyInterface::class);
- $mock
- ->expects(static::once())
- ->method('run')
- ->with(
- static::identicalTo(1),
- static::stringContains('foo')
- )
- ->will(static::onConsecutiveCalls(
- static::returnSelf(),
- static::throwException(new \Exception())
- ))
- ;
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testMocks()
- {
- $mock = $this->createMock(MyInterface::class);
- $mock
- ->expects($this->once())
- ->method('run')
- ->with(
- $this->identicalTo(1),
- $this->stringContains('foo')
- )
- ->will($this->onConsecutiveCalls(
- $this->returnSelf(),
- $this->throwException(new \Exception())
- ))
- ;
- }
- }
- EOF,
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testWeirdIndentation()
- {
- static
- // @TODO
- ::
- assertSame
- (1, 2);
- // $this->markTestIncomplete('foo');
- /*
- $this->fail('foo');
- */
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testWeirdIndentation()
- {
- $this
- // @TODO
- ->
- assertSame
- (1, 2);
- // $this->markTestIncomplete('foo');
- /*
- $this->fail('foo');
- */
- }
- }
- EOF,
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- $this->markTestIncomplete('foo');
- $this->fail('foo');
- $lambda = function () {
- $this->assertSame(1, 23);
- self::assertSame(1, 23);
- static::assertSame(1, 23);
- };
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- self::markTestIncomplete('foo');
- static::fail('foo');
- $lambda = function () {
- $this->assertSame(1, 23);
- self::assertSame(1, 23);
- static::assertSame(1, 23);
- };
- }
- }
- EOF,
- ['call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_THIS],
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- self::assertSame(1, 2);
- self::markTestIncomplete('foo');
- self::fail('foo');
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- self::markTestIncomplete('foo');
- static::fail('foo');
- }
- }
- EOF,
- ['call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_SELF],
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- $this->assertSame(1, 2);
- static::setUpBeforeClass();
- static::setUpBeforeClass();
- $otherTest->setUpBeforeClass();
- OtherTest::setUpBeforeClass();
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- static::assertSame(1, 2);
- $this->assertSame(1, 2);
- static::setUpBeforeClass();
- $this->setUpBeforeClass();
- $otherTest->setUpBeforeClass();
- OtherTest::setUpBeforeClass();
- }
- }
- EOF,
- [
- 'call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_THIS,
- 'methods' => ['setUpBeforeClass' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_STATIC],
- ],
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public static function foo()
- {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- $lambda = function () {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- };
- }
- public function bar()
- {
- $lambda = static function () {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- };
- $myProphecy->setCount(0)->will(function () {
- $this->getCount()->willReturn(0);
- });
- }
- static public function baz()
- {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- $lambda = function () {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- };
- }
- static final protected function xyz()
- {
- static::assertSame(1, 2);
- }
- }
- EOF,
- null,
- [
- 'call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_THIS,
- ],
- ];
- yield [
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function foo()
- {
- $this->assertSame(1, 2);
- $this->assertSame(1, 2);
- $this->assertSame(1, 2);
- }
- public function bar()
- {
- $lambdaOne = static function () {
- $this->assertSame(1, 21);
- self::assertSame(1, 21);
- static::assertSame(1, 21);
- };
- $lambdaTwo = function () {
- $this->assertSame(1, 21);
- self::assertSame(1, 21);
- static::assertSame(1, 21);
- };
- }
- public function baz2()
- {
- $this->assertSame(1, 22);
- $this->assertSame(1, 22);
- $this->assertSame(1, 22);
- $this->assertSame(1, 23);
- }
- }
- EOF,
- <<<'EOF'
- <?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function foo()
- {
- $this->assertSame(1, 2);
- self::assertSame(1, 2);
- static::assertSame(1, 2);
- }
- public function bar()
- {
- $lambdaOne = static function () {
- $this->assertSame(1, 21);
- self::assertSame(1, 21);
- static::assertSame(1, 21);
- };
- $lambdaTwo = function () {
- $this->assertSame(1, 21);
- self::assertSame(1, 21);
- static::assertSame(1, 21);
- };
- }
- public function baz2()
- {
- $this->assertSame(1, 22);
- self::assertSame(1, 22);
- static::assertSame(1, 22);
- STATIC::assertSame(1, 23);
- }
- }
- EOF,
- [
- 'call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_THIS,
- ],
- ];
- yield 'do not change class property and method signature' => [
- <<<'EOF'
- <?php
- class FooTest extends TestCase
- {
- public function foo()
- {
- $this->assertSame = 42;
- }
- public function assertSame($foo, $bar){}
- }
- EOF,
- ];
- yield 'do not change when only case is different' => [
- <<<'EOF'
- <?php
- class FooTest extends TestCase
- {
- public function foo()
- {
- STATIC::assertSame(1, 1);
- }
- }
- EOF,
- ];
- yield 'do not crash on abstract static function' => [
- <<<'EOF'
- <?php
- abstract class FooTest extends TestCase
- {
- abstract public static function dataProvider();
- }
- EOF,
- null,
- [
- 'call_type' => PhpUnitTestCaseStaticMethodCallsFixer::CALL_TYPE_THIS,
- ],
- ];
- yield 'handle $this with double colon following' => [
- '<?php
- class FooTest extends TestCase
- {
- public function testFoo()
- {
- static::assertTrue(true);
- }
- }',
- '<?php
- class FooTest extends TestCase
- {
- public function testFoo()
- {
- $this::assertTrue(true);
- }
- }',
- ];
- }
- public function testAnonymousClassFixing(): void
- {
- $this->doTest(
- '<?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- static::assertSame(1, 2);
- $foo = new class() {
- public function assertSame($a, $b)
- {
- $this->assertSame(1, 2);
- }
- };
- }
- }',
- '<?php
- class MyTest extends \PHPUnit_Framework_TestCase
- {
- public function testBaseCase()
- {
- $this->assertSame(1, 2);
- $foo = new class() {
- public function assertSame($a, $b)
- {
- $this->assertSame(1, 2);
- }
- };
- }
- }'
- );
- }
- /**
- * @dataProvider provideFix81Cases
- *
- * @requires PHP 8.1
- */
- public function testFix81(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{string}>
- */
- public static function provideFix81Cases(): iterable
- {
- yield [
- '<?php
- class FooTest extends TestCase
- {
- public function testFoo()
- {
- $a = $this::assertTrue(...);
- }
- }
- ',
- ];
- }
- }
|