1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Logging\TestDox;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Small;
use PHPUnit\Framework\TestCase;
use PHPUnit\TestFixture\BackedEnumeration;
use PHPUnit\TestFixture\Enumeration;
use PHPUnit\TestFixture\TestDox\TestDoxAttributeOnTestClassTest;
use PHPUnit\TestFixture\TestDoxTest;
use stdClass;
#[CoversClass(NamePrettifier::class)]
#[Group('testdox')]
#[Small]
final class NamePrettifierTest extends TestCase
{
/**
* @return non-empty-list<array{0: non-empty-string, 1: non-empty-string}>
*/
public static function classNameProvider(): array
{
return [
[
'Foo',
'FooTest',
],
[
'Foo',
'TestFoo',
],
[
'Foo',
'TestsFoo',
],
[
'Foo',
'TestFooTest',
],
[
'Foo (Test\Foo)',
'Test\FooTest',
],
[
'Foo (Tests\Foo)',
'Tests\FooTest',
],
[
'Unnamed Tests',
'TestTest',
],
[
'Système Testé',
'SystèmeTestéTest',
],
[
'Expression Évaluée',
'ExpressionÉvaluéeTest',
],
[
'Custom Title',
TestDoxAttributeOnTestClassTest::class,
],
];
}
/**
* @return non-empty-list<array{0: non-empty-string, 1: non-empty-string}>
*/
public static function methodNameProvider(): array
{
return [
[
'',
'',
],
[
'',
'test',
],
[
'This is a test',
'this_is_a_test',
],
[
'This is a test',
'test_this_is_a_test',
],
[
'Foo for bar is 0',
'testFooForBarIs0',
],
[
'Foo for baz is 1',
'testFooForBazIs1',
],
[
'This has a 123 in its name',
'testThisHasA123InItsName',
],
[
'Sets redirect header on 301',
'testSetsRedirectHeaderOn301',
],
[
'Sets redirect header on 302',
'testSetsRedirectHeaderOn302',
],
[
'100 users',
'test100Users',
],
];
}
/**
* @return non-empty-list<array{0: non-empty-string, 1: TestCase, 2: bool}>
*/
public static function objectProvider(): array
{
$object = new class
{
public function __toString(): string
{
return 'object as string';
}
};
$data = [['string'], true, 0.0, 1, 'string', $object, new stdClass, Enumeration::Test, BackedEnumeration::Test, null, ''];
$testWithDataWithIntegerKey = new TestDoxTest('testTwo');
$testWithDataWithIntegerKey->setData(0, $data);
$testWithDataWithStringKey = new TestDoxTest('testTwo');
$testWithDataWithStringKey->setData('a', $data);
$testWithDataAndTestDoxPlaceholders = new TestDoxTest('testFour');
$testWithDataAndTestDoxPlaceholders->setData('a', $data);
$testWithTestDoxFormatter = new TestDoxTest('testFive');
$testWithTestDoxFormatter->setData(0, [new DateTimeImmutable('2025-07-09')]);
return [
[
'One',
new TestDoxTest('testOne'),
false,
],
[
'Two with data set #0',
$testWithDataWithIntegerKey,
false,
],
[
'Two with data set "@a"',
$testWithDataWithStringKey,
false,
],
[
'This is a custom test description',
new TestDoxTest('testThree'),
false,
],
[
'This is a custom test description with placeholders array true 0.0 1 string object as string stdClass Test test null \'\' default',
$testWithDataAndTestDoxPlaceholders,
false,
],
[
'This is a custom description: 2025-07-09',
$testWithTestDoxFormatter,
false,
],
];
}
/**
* @param non-empty-string $expected
* @param non-empty-string $className
*/
#[DataProvider('classNameProvider')]
public function testNameOfTestClassCanBePrettified(string $expected, string $className): void
{
$this->assertSame($expected, (new NamePrettifier)->prettifyTestClassName($className));
}
/**
* @param non-empty-string $expected
* @param non-empty-string $methodName
*/
#[DataProvider('methodNameProvider')]
public function testNameOfTestMethodCanBePrettified(string $expected, string $methodName): void
{
$this->assertSame($expected, (new NamePrettifier)->prettifyTestMethodName($methodName));
}
/**
* @param non-empty-string $expected
*/
#[DataProvider('objectProvider')]
public function test_TestCase_can_be_prettified(string $expected, TestCase $testCase, bool $colorize): void
{
$this->assertSame($expected, (new NamePrettifier)->prettifyTestCase($testCase, $colorize));
}
public function testStripsNumericSuffixFromTestMethodNameWhenTestMethodNameWithoutThatSuffixWasPreviouslyProcessed(): void
{
$namePrettifier = new NamePrettifier;
$this->assertSame('This is a test', $namePrettifier->prettifyTestMethodName('testThisIsATest'));
$this->assertSame('This is a test', $namePrettifier->prettifyTestMethodName('testThisIsATest2'));
}
}
|