123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537 |
- <?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\Tests\Test\AbstractFixerTestCase;
- /**
- * @internal
- *
- * @author Gert de Pagter <BackEndTea@gmail.com>
- *
- * @covers \PhpCsFixer\Fixer\PhpUnit\PhpUnitInternalClassFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\PhpUnit\PhpUnitInternalClassFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\PhpUnit\PhpUnitInternalClassFixer
- */
- final class PhpUnitInternalClassFixerTest extends AbstractFixerTestCase
- {
- /**
- * @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 'It does not change normal classes' => [
- '<?php
- class Hello
- {
- }
- ',
- ];
- yield 'It marks a test class as internal' => [
- '<?php
- /**
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- '<?php
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It adds an internal tag to a class that already has a doc block' => [
- '<?php
- /**
- * @coversNothing
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- '<?php
- /**
- * @coversNothing
- */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It does not change a class that is already internal' => [
- '<?php
- /**
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It does not change a class that is already internal and has other annotations' => [
- '<?php
- /**
- * @author me
- * @coversNothing
- * @internal
- * @group large
- */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It works on other indentation levels' => [
- '<?php
- if (class_exists("Foo\Bar")) {
- /**
- * @internal
- */
- class Test Extends TestCase
- {
- }
- }
- ',
- '<?php
- if (class_exists("Foo\Bar")) {
- class Test Extends TestCase
- {
- }
- }
- ',
- ];
- yield 'It works on other indentation levels when the class has other annotations' => [
- '<?php
- if (class_exists("Foo\Bar")) {
- /**
- * @author me again
- *
- *
- * @covers \Other\Class
- * @internal
- */
- class Test Extends TestCase
- {
- }
- }
- ',
- '<?php
- if (class_exists("Foo\Bar")) {
- /**
- * @author me again
- *
- *
- * @covers \Other\Class
- */
- class Test Extends TestCase
- {
- }
- }
- ',
- ];
- yield 'It works for tab ident' => [
- '<?php
- if (class_exists("Foo\Bar")) {
- /**
- * @author me again
- *
- *
- * @covers \Other\Class
- * @internal
- */
- class Test Extends TestCase
- {
- }
- }
- ',
- '<?php
- if (class_exists("Foo\Bar")) {
- /**
- * @author me again
- *
- *
- * @covers \Other\Class
- */
- class Test Extends TestCase
- {
- }
- }
- ',
- ];
- yield 'It always adds @internal to the bottom of the doc block' => [
- '<?php
- /**
- * @coversNothing
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- '<?php
- /**
- * @coversNothing
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It does not change a class with a single line internal doc block' => [
- '<?php
- /** @internal */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'It adds an internal tag to a class that already has a one linedoc block' => [
- '<?php
- /**
- * @coversNothing
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- '<?php
- /** @coversNothing */
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'By default it will not mark an abstract class as internal' => [
- '<?php
- abstract class Test extends TestCase
- {
- }
- ',
- ];
- yield 'If abstract is added as an option, abstract classes will be marked internal' => [
- '<?php
- /**
- * @internal
- */
- abstract class Test extends TestCase
- {
- }
- ',
- '<?php
- abstract class Test extends TestCase
- {
- }
- ',
- [
- 'types' => ['abstract'],
- ],
- ];
- yield 'If final is not added as an option, final classes will not be marked internal' => [
- '<?php
- final class Test extends TestCase
- {
- }
- ',
- null,
- [
- 'types' => ['abstract'],
- ],
- ];
- yield 'If normal is not added as an option, normal classes will not be marked internal' => [
- '<?php
- class Test extends TestCase
- {
- }
- ',
- null,
- [
- 'types' => ['abstract'],
- ],
- ];
- yield 'It works correctly with multiple classes in one file, even when one of them is not allowed' => [
- '<?php
- /**
- * @internal
- */
- class Test extends TestCase
- {
- }
- abstract class Test2 extends TestCase
- {
- }
- class FooBar
- {
- }
- /**
- * @internal
- */
- class Test extends TestCase
- {
- }
- ',
- '<?php
- class Test extends TestCase
- {
- }
- abstract class Test2 extends TestCase
- {
- }
- class FooBar
- {
- }
- class Test extends TestCase
- {
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFix80Cases
- *
- * @requires PHP 8.0
- */
- public function testFix80(string $expected, string $input): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{string, string}>
- */
- public static function provideFix80Cases(): iterable
- {
- yield 'it adds a docblock above when there is an attribute' => [
- '<?php
- /**
- * @internal
- */
- #[SimpleTest]
- class Test extends TestCase
- {
- }
- ',
- '<?php
- #[SimpleTest]
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'it adds the internal tag along other tags when there is an attribute' => [
- '<?php
- /**
- * @coversNothing
- * @internal
- */
- #[SimpleTest]
- class Test extends TestCase
- {
- }
- ',
- '<?php
- /**
- * @coversNothing
- */
- #[SimpleTest]
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'it adds a docblock above when there are attributes' => [
- '<?php
- /**
- * @internal
- */
- #[SimpleTest]
- #[Annotated]
- class Test extends TestCase
- {
- }
- ',
- '<?php
- #[SimpleTest]
- #[Annotated]
- class Test extends TestCase
- {
- }
- ',
- ];
- yield 'it adds the internal tag along other tags when there are attributes' => [
- '<?php
- /**
- * @coversNothing
- * @internal
- */
- #[SimpleTest]
- #[Annotated]
- class Test extends TestCase
- {
- }
- ',
- '<?php
- /**
- * @coversNothing
- */
- #[SimpleTest]
- #[Annotated]
- class Test extends TestCase
- {
- }
- ',
- ];
- }
- /**
- * @param _AutogeneratedInputConfiguration $config
- *
- * @dataProvider provideFix82Cases
- *
- * @requires PHP 8.2
- */
- public function testFix82(string $expected, ?string $input = null, array $config = []): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<int|string, array{string, 1: ?string, 2?: array<string, mixed>}>
- */
- public static function provideFix82Cases(): iterable
- {
- yield 'If final is not added as an option, final classes will not be marked internal' => [
- '<?php
- final readonly class Test extends TestCase
- {}
- ',
- null,
- [
- 'types' => ['normal'],
- ],
- ];
- yield [
- '<?php
- /**
- * @internal
- */
- readonly final class Test extends TestCase {}',
- '<?php
- readonly final class Test extends TestCase {}',
- ];
- }
- }
|