Closes #3741

sebastianbergmann · Jul 30, 2019 · 74d84f7 · 74d84f7
1 parent 1c015f5
commit 74d84f7
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 23 deletions.
diff --git a/ChangeLog-8.3.md b/ChangeLog-8.3.md
@@ -6,6 +6,7 @@ All notable changes of the PHPUnit 8.3 release series are documented in this fil
 
 ### Added
 
+* Implemented [#3741](https://github.com/sebastianbergmann/phpunit/issues/3741): Format class names as well as method names in testdox output
 * Implemented [#3748](https://github.com/sebastianbergmann/phpunit/issues/3748): Add option to sort tests based on information from `@small`, `@medium`, and `@large`
 * Added `TestCase::getActualOutputForAssertion()` as a wrapper for `TestCase::getActualOutput()` to prevent a test being marked as risky when it prints output and that output is not expected using `TestCase::expectOutputString()` or `TestCase::expectOutputRegEx()`
 

diff --git a/src/Util/TestDox/NamePrettifier.php b/src/Util/TestDox/NamePrettifier.php
@@ -49,20 +49,47 @@ public function prettifyTestClass(string $className): string
         } catch (UtilException $e) {
         }
 
-        $result = $className;
+        $parts     = \explode('\\', $className);
+        $className = \array_pop($parts);
 
         if (\substr($className, -1 * \strlen('Test')) === 'Test') {
-            $result = \substr($result, 0, \strripos($result, 'Test'));
+            $className = \substr($className, 0, \strlen($className) - \strlen('Test'));
         }
 
         if (\strpos($className, 'Tests') === 0) {
-            $result = \substr($result, \strlen('Tests'));
+            $className = \substr($className, \strlen('Tests'));
         } elseif (\strpos($className, 'Test') === 0) {
-            $result = \substr($result, \strlen('Test'));
+            $className = \substr($className, \strlen('Test'));
         }
 
-        if ($result[0] === '\\') {
-            $result = \substr($result, 1);
+        if (!empty($parts)) {
+            $parts[]            = $className;
+            $fullyQualifiedName = \implode('\\', $parts);
+        } else {
+            $fullyQualifiedName = $className;
+        }
+
+        $result       = '';
+        $wasLowerCase = false;
+
+        foreach (\range(0, \strlen($className) - 1) as $i) {
+            $isLowerCase = \mb_strtolower($className[$i], 'UTF-8') === $className[$i];
+
+            if ($wasLowerCase && !$isLowerCase) {
+                $result .= ' ';
+            }
+
+            $result .= $className[$i];
+
+            if ($isLowerCase) {
+                $wasLowerCase = true;
+            } else {
+                $wasLowerCase = false;
+            }
+        }
+
+        if ($fullyQualifiedName !== $className) {
+            return $result . ' (' . $fullyQualifiedName . ')';
         }
 
         return $result;
@@ -153,10 +180,9 @@ public function prettifyTestMethod(string $name): string
             return \trim(\str_replace('_', ' ', $name));
         }
 
-        $max        = \strlen($name);
         $wasNumeric = false;
 
-        for ($i = 0; $i < $max; $i++) {
+        foreach (\range(0, \strlen($name) - 1) as $i) {
             if ($i > 0 && \ord($name[$i]) >= 65 && \ord($name[$i]) <= 90) {
                 $buffer .= ' ' . \strtolower($name[$i]);
             } else {

diff --git a/tests/end-to-end/defaulttestsuite-using-testsuite.phpt b/tests/end-to-end/defaulttestsuite-using-testsuite.phpt
@@ -13,7 +13,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-DummyFoo
+Dummy Foo
  ✔ Foo equals foo
 
 Time: %s, Memory: %s

diff --git a/tests/end-to-end/defaulttestsuite.phpt b/tests/end-to-end/defaulttestsuite.phpt
@@ -11,7 +11,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-DummyBar
+Dummy Bar
  ✔ Bar equals bar
 
 Time: %s, Memory: %s

diff --git a/tests/end-to-end/group.phpt b/tests/end-to-end/group.phpt
@@ -14,7 +14,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-NumericGroupAnnotation
+Numeric Group Annotation
  ✔ Empty test for @ticket numeric annotation values
  ✔ Empty test for @group numeric annotation values
 

diff --git a/tests/end-to-end/loggers/_files/raw_output_StatusTest.txt b/tests/end-to-end/loggers/_files/raw_output_StatusTest.txt
@@ -3,7 +3,7 @@ PHPUnit %s Sebastian Bergmann and contributors.
 Runtime:       %s
 Configuration: %stests%ebasic%econfiguration.basic.xml
 
-[4mPHPUnit\SelfTest\Basic\SetUpBeforeClass[0m
+[4mSet Up Before Class (PHPUnit\SelfTest\Basic\SetUpBeforeClass)[0m
  [33m✘[0m One [33m %f [2mms[0m
    [33m┐[0m
    [33m├[0m [43;30mException: forcing an Exception in setUpBeforeClass()[0m
@@ -18,7 +18,7 @@ Configuration: %stests%ebasic%econfiguration.basic.xml
    [33m╵[0m %stests[2m%e[22mbasic[2m%e[22munit[2m%e[22mSetUpBeforeClassTest.php[2m:[22m[34m31[0m
    [33m┴[0m
 
-[4mPHPUnit\SelfTest\Basic\SetUp[0m
+[4mSet Up (PHPUnit\SelfTest\Basic\SetUp)[0m
  [33m✘[0m One with set up exception [33m %f [2mms[0m
    [33m┐[0m
    [33m├[0m [43;30mRuntimeException: throw exception in setUp[0m
@@ -115,7 +115,7 @@ Configuration: %stests%ebasic%econfiguration.basic.xml
    [33m╵[0m %stests[2m%e[22mbasic[2m%e[22munit[2m%e[22mStatusTest.php[2m:[22m[34m%d[0m
    [33m┴[0m
 
-[4mPHPUnit\SelfTest\Basic\TearDownAfterClass[0m
+[4mTear Down After Class (PHPUnit\SelfTest\Basic\TearDownAfterClass)[0m
  [32m✔[0m One [32m %f [2mms[0m
  [32m✔[0m Two [32m %f [2mms[0m
  [31m✘[0m Tear down after class [31m 0 [2mms[0m

diff --git a/tests/end-to-end/loggers/testdox-exclude-group.phpt b/tests/end-to-end/loggers/testdox-exclude-group.phpt
@@ -18,7 +18,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-.DoxGroup
+.Dox Group
 .                                                                  2 / 2 (100%) [x] Two
 
 

diff --git a/tests/end-to-end/loggers/testdox-group.phpt b/tests/end-to-end/loggers/testdox-group.phpt
@@ -18,7 +18,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-DoxGroup
+Dox Group
 ..                                                                  2 / 2 (100%) [x] One
 
 

diff --git a/tests/end-to-end/loggers/testdox-html.phpt b/tests/end-to-end/loggers/testdox-html.phpt
@@ -46,7 +46,7 @@ PHPUnit %s by Sebastian Bergmann and contributors.
     </head>
     <body>
 
-        <h2 id="BankAccountTest">BankAccount</h2>
+        <h2 id="BankAccountTest">Bank Account</h2>
         <ul>
 ...                                                                 3 / 3 (100%)            <li style="color: #555753;">✓ Balance is initially zero</li>
             <li style="color: #555753;">✓ Balance cannot become negative</li>

diff --git a/tests/end-to-end/loggers/testdox-text.phpt b/tests/end-to-end/loggers/testdox-text.phpt
@@ -16,7 +16,7 @@ PHPUnit\TextUI\Command::main();
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-BankAccount
+Bank Account
 ...                                                                 3 / 3 (100%) [x] Balance is initially zero
  [x] Balance cannot become negative
  [x] Balance cannot become negative

diff --git a/tests/end-to-end/regression/GitHub/3380/issue-3380-test.phpt b/tests/end-to-end/regression/GitHub/3380/issue-3380-test.phpt
@@ -19,7 +19,7 @@ unlink($tmpResultCache);
 --EXPECTF--
 PHPUnit %s by Sebastian Bergmann and contributors.
 
-DataproviderExecutionOrder
+Dataprovider Execution Order
  ✔ First test that always works
  ✔ Add numbers with a dataprovider with data set "1+2=3"
  ✔ Add numbers with a dataprovider with data set "2+1=3"
@@ -44,7 +44,7 @@ Time: %s, Memory: %s
 
 Summary of non-successful tests:
 
-DataproviderExecutionOrder
+Dataprovider Execution Order
  ✘ Add numbers with a dataprovider with data set "1+1=3"
    │
    │ Failed asserting that 2 is identical to 3.

diff --git a/tests/unit/Util/TestDox/CliTestDoxPrinterTest.php b/tests/unit/Util/TestDox/CliTestDoxPrinterTest.php
@@ -47,7 +47,7 @@ public function testPrintsTheClassNameOfTheTestClass(): void
         $this->printer->startTest($this);
         $this->printer->endTest($this, 0);
 
-        $this->assertStringStartsWith('PHPUnit\Util\TestDox\CliTestDoxPrinter', $this->printer->getBuffer());
+        $this->assertStringStartsWith('Cli Test Dox Printer (PHPUnit\Util\TestDox\CliTestDoxPrinter)', $this->printer->getBuffer());
     }
 
     public function testPrintsThePrettifiedMethodName(): void

diff --git a/tests/unit/Util/TestDox/NamePrettifierTest.php b/tests/unit/Util/TestDox/NamePrettifierTest.php
@@ -37,8 +37,8 @@ public function testTitleHasSensibleDefaults(): void
         $this->assertEquals('Foo', $this->namePrettifier->prettifyTestClass('FooTest'));
         $this->assertEquals('Foo', $this->namePrettifier->prettifyTestClass('TestFoo'));
         $this->assertEquals('Foo', $this->namePrettifier->prettifyTestClass('TestFooTest'));
-        $this->assertEquals('Foo', $this->namePrettifier->prettifyTestClass('Test\FooTest'));
-        $this->assertEquals('Foo', $this->namePrettifier->prettifyTestClass('Tests\FooTest'));
+        $this->assertEquals('Foo (Test\Foo)', $this->namePrettifier->prettifyTestClass('Test\FooTest'));
+        $this->assertEquals('Foo (Tests\Foo)', $this->namePrettifier->prettifyTestClass('Tests\FooTest'));
     }
 
     public function testTestNameIsConvertedToASentence(): void