123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773 |
- <?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\Fixer\PhpUnit\PhpUnitTargetVersion;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\WhitespacesFixerConfig;
- /**
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\PhpUnit\PhpUnitNoExpectationAnnotationFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\PhpUnit\PhpUnitNoExpectationAnnotationFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\PhpUnit\PhpUnitNoExpectationAnnotationFixer
- */
- final class PhpUnitNoExpectationAnnotationFixerTest 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 'empty exception message' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, \'\');
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting rooted exception' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException \FooException
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception with msg' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, \'foo@bar\');
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage foo@bar
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception with code' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, null, 123);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionCode 123
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception with msg and code' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, \'foo\', 123);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage foo
- * @expectedExceptionCode 123
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception with msg regex [but too low target]' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessageRegExp /foo.*$/
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- null,
- ['target' => PhpUnitTargetVersion::VERSION_3_2],
- ];
- yield 'expecting exception with msg regex' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedExceptionRegExp(\FooException::class, \'/foo.*$/\');
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessageRegExp /foo.*$/
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ['target' => PhpUnitTargetVersion::VERSION_4_3],
- ];
- yield 'use_class_const=false' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\'FooException\');
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ['use_class_const' => false],
- ];
- yield 'keep rest of docblock' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Summary.
- *
- * @param int $param
- * @return void
- */
- public function testFnc($param)
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Summary.
- *
- * @param int $param
- * @expectedException FooException
- * @return void
- */
- public function testFnc($param)
- {
- aaa();
- }
- }',
- ];
- yield 'fix method without visibility' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- function testFnc($param)
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- */
- function testFnc($param)
- {
- aaa();
- }
- }',
- ];
- yield 'fix final method' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- final function testFnc($param)
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- */
- final function testFnc($param)
- {
- aaa();
- }
- }',
- ];
- yield 'ignore when no docblock' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- final function testFoo($param)
- {
- aaa();
- }
- /**
- */
- final function testFnc($param)
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- final function testFoo($param)
- {
- aaa();
- }
- /**
- * @expectedException FooException
- */
- final function testFnc($param)
- {
- aaa();
- }
- }',
- ];
- yield 'valid docblock but for property, not method' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionCode 123
- */
- public $foo;
- public function bar()
- {
- /**
- * @expectedException FooException
- * @expectedExceptionCode 123
- */
- $baz = 1;
- /**
- * @expectedException FooException
- * @expectedExceptionCode 123
- */
- while (false) {}
- }
- }',
- ];
- yield 'respect \' and " in expected msg' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Summary.
- *
- */
- public function testFnc($param)
- {
- $this->setExpectedException(\FooException::class, \'Foo \\\' bar " baz\');
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Summary.
- *
- * @expectedException FooException
- * @expectedExceptionMessage Foo \' bar " baz
- */
- public function testFnc($param)
- {
- aaa();
- }
- }',
- ];
- yield 'special \ handling' => [
- <<<'EOT'
- <?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testElementNonExistentOne()
- {
- $this->setExpectedException(\Cake\View\Exception\MissingElementException::class, 'A backslash at the end \\');
- $this->View->element('non_existent_element');
- }
- /**
- */
- public function testElementNonExistentTwo()
- {
- $this->setExpectedExceptionRegExp(\Cake\View\Exception\MissingElementException::class, '#^Element file "Element[\\\\/]non_existent_element\\.ctp" is missing\\.$#');
- $this->View->element('non_existent_element');
- }
- }
- EOT,
- <<<'EOT'
- <?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException \Cake\View\Exception\MissingElementException
- * @expectedExceptionMessage A backslash at the end \
- */
- public function testElementNonExistentOne()
- {
- $this->View->element('non_existent_element');
- }
- /**
- * @expectedException \Cake\View\Exception\MissingElementException
- * @expectedExceptionMessageRegExp #^Element file "Element[\\/]non_existent_element\.ctp" is missing\.$#
- */
- public function testElementNonExistentTwo()
- {
- $this->View->element('non_existent_element');
- }
- }
- EOT,
- ];
- yield 'message on newline' => [
- <<<'EOT'
- <?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testMessageOnMultilines()
- {
- $this->setExpectedException(\RuntimeException::class, 'Message on multilines AAA €');
- aaa();
- }
- /**
- * @foo
- */
- public function testMessageOnMultilinesWithAnotherTag()
- {
- $this->setExpectedException(\RuntimeException::class, 'Message on multilines BBB è');
- bbb();
- }
- /**
- *
- * @foo
- */
- public function testMessageOnMultilinesWithAnotherSpaceAndTag()
- {
- $this->setExpectedException(\RuntimeException::class, 'Message on multilines CCC ✔');
- ccc();
- }
- }
- EOT,
- <<<'EOT'
- <?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException \RuntimeException
- * @expectedExceptionMessage Message
- * on
- * multilines AAA
- * €
- */
- public function testMessageOnMultilines()
- {
- aaa();
- }
- /**
- * @expectedException \RuntimeException
- * @expectedExceptionMessage Message
- * on
- * multilines BBB
- * è
- * @foo
- */
- public function testMessageOnMultilinesWithAnotherTag()
- {
- bbb();
- }
- /**
- * @expectedException \RuntimeException
- * @expectedExceptionMessage Message
- * on
- * multilines CCC
- * ✔
- *
- * @foo
- */
- public function testMessageOnMultilinesWithAnotherSpaceAndTag()
- {
- ccc();
- }
- }
- EOT,
- ];
- yield 'annotation with double @' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Double "@" is/was below
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * Double "@" is/was below
- * @@expectedException FooException
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'annotation with text before @' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * We are providing invalid input, for that we @expectedException FooException
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield [
- '<?php
- abstract class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage
- */
- abstract public function testFnc();
- }',
- ];
- yield 'expecting exception in single line comment' => [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /** */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /** @expectedException FooException */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield 'expecting exception with message below' => [
- '<?php
- class MyTest extends TestCase
- {
- /**
- */
- public function testSomething()
- {
- $this->setExpectedException(\Foo\Bar::class);
- $this->initialize();
- }
- }',
- '<?php
- class MyTest extends TestCase
- {
- /**
- * @expectedException Foo\Bar
- *
- * Testing stuff.
- */
- public function testSomething()
- {
- $this->initialize();
- }
- }',
- ];
- }
- /**
- * @dataProvider provideWithWhitespacesConfigCases
- */
- public function testWithWhitespacesConfig(string $expected, ?string $input = null): void
- {
- $expected = str_replace([' ', "\n"], ["\t", "\r\n"], $expected);
- if (null !== $input) {
- $input = str_replace([' ', "\n"], ["\t", "\r\n"], $input);
- }
- $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t", "\r\n"));
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{string, string}>
- */
- public static function provideWithWhitespacesConfigCases(): iterable
- {
- yield [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, \'foo\', 123);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage foo
- * @expectedExceptionCode 123
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- yield [
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- */
- public function testFnc()
- {
- $this->setExpectedException(\FooException::class, \'foo\', 123);
- aaa();
- }
- }',
- '<?php
- final class MyTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @expectedException FooException
- * @expectedExceptionMessage foo
- * @expectedExceptionCode 123
- */
- public function testFnc()
- {
- aaa();
- }
- }',
- ];
- }
- }
|