Only report test outcome (errored, failed, incomplete, skipped, or pa…

…ssed)
sebastianbergmann · Jan 19, 2023 · 2d45550 · 2d45550
1 parent dd745da
commit 2d45550
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 88 deletions.
diff --git a/ChangeLog-10.0.md b/ChangeLog-10.0.md
@@ -48,6 +48,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * The `size` attribute of `<test>` elements in the TestDox XML logfile now contains a textual representation instead of a number (`"unknown"` instead of `"-1"`, for instance)
 * The JUnit XML logfile now has both `name` and `file` attributes on `<testcase>` elements for PHPT tests
 * The JUnit XML logfile no longer has `<system-out>` elements that contains the output printed to `stdout` by a test
+* The JUnit XML logfile now only reports test outcome (errored, failed, incomplete, skipped, or passed) and no longer test issues (considered risky, for instance)
 * The `forceCoversAnnotation` attribute of the `<phpunit>` element of PHPUnit's XML configuration file has been renamed to `requireCoverageMetadata`
 * The `beStrictAboutCoversAnnotation` attribute of the `<phpunit>` element of PHPUnit's XML configuration file has been renamed to `beStrictAboutCoverageMetadata`
 * The public methods of `PHPUnit\Framework\Assert` and `PHPUnit\Framework\TestCase` are now `final`

diff --git a/src/Logging/JUnit/JunitXmlLogger.php b/src/Logging/JUnit/JunitXmlLogger.php
@@ -25,7 +25,6 @@
 use PHPUnit\Event\Facade;
 use PHPUnit\Event\InvalidArgumentException;
 use PHPUnit\Event\Telemetry\HRTime;
-use PHPUnit\Event\Test\ConsideredRisky;
 use PHPUnit\Event\Test\Errored;
 use PHPUnit\Event\Test\Failed;
 use PHPUnit\Event\Test\Finished;
@@ -91,11 +90,11 @@ final class JunitXmlLogger
      * @throws EventFacadeIsSealedException
      * @throws UnknownSubscriberTypeException
      */
-    public function __construct(Printer $printer, bool $reportRiskyTests)
+    public function __construct(Printer $printer)
     {
         $this->printer = $printer;
 
-        $this->registerSubscribers($reportRiskyTests);
+        $this->registerSubscribers();
         $this->createDocument();
     }
 
@@ -262,22 +261,11 @@ public function testFailed(Failed $event): void
         $this->testSuiteFailures[$this->testSuiteLevel]++;
     }
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws NoDataSetFromDataProviderException
-     */
-    public function testConsideredRisky(ConsideredRisky $event): void
-    {
-        $this->handleRisky($event->test(), $event->message());
-
-        $this->testSuiteErrors[$this->testSuiteLevel]++;
-    }
-
     /**
      * @throws EventFacadeIsSealedException
      * @throws UnknownSubscriberTypeException
      */
-    private function registerSubscribers(bool $reportRiskyTests): void
+    private function registerSubscribers(): void
     {
         Facade::registerSubscribers(
             new TestSuiteStartedSubscriber($this),
@@ -290,10 +278,6 @@ private function registerSubscribers(bool $reportRiskyTests): void
             new TestSkippedSubscriber($this),
             new TestRunnerExecutionFinishedSubscriber($this),
         );
-
-        if ($reportRiskyTests) {
-            Facade::registerSubscriber(new TestConsideredRiskySubscriber($this));
-        }
     }
 
     private function createDocument(): void
@@ -330,26 +314,6 @@ private function handleFault(Test $test, Throwable $throwable, string $type): vo
         $this->currentTestCase->appendChild($fault);
     }
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws NoDataSetFromDataProviderException
-     */
-    private function handleRisky(Test $test, string $message): void
-    {
-        assert($this->currentTestCase !== null);
-
-        $buffer = $this->testAsString($test) . $message;
-
-        $risky = $this->document->createElement(
-            'error',
-            Xml::prepareString($buffer)
-        );
-
-        $risky->setAttribute('type', 'PHPUnit\Framework\RiskyTest');
-
-        $this->currentTestCase->appendChild($risky);
-    }
-
     /**
      * @throws InvalidArgumentException
      * @throws NoDataSetFromDataProviderException

diff --git a/src/Logging/JUnit/Subscriber/TestConsideredRiskySubscriber.php b/src/Logging/JUnit/Subscriber/TestConsideredRiskySubscriber.php
diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -234,7 +234,6 @@ public function run(Configuration $configuration, TestSuite $suite): TestResult
         if ($configuration->hasLogfileJunit()) {
             new JunitXmlLogger(
                 $this->printerFor($configuration->logfileJunit()),
-                $configuration->reportUselessTests()
             );
         }
 

diff --git a/tests/end-to-end/logging/log-junit-to-file.phpt b/tests/end-to-end/logging/log-junit-to-file.phpt
@@ -26,7 +26,7 @@ unlink($logfile);
 --EXPECTF--
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites>
-  <testsuite name="PHPUnit\SelfTest\Basic\StatusTest" file="%sStatusTest.php" tests="12" assertions="4" errors="4" failures="2" skipped="5" time="%f">
+  <testsuite name="PHPUnit\SelfTest\Basic\StatusTest" file="%sStatusTest.php" tests="12" assertions="4" errors="2" failures="2" skipped="5" time="%f">
     <testcase name="testSuccess" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f"/>
     <testcase name="testFailure" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f">
       <failure type="PHPUnit\Framework\ExpectationFailedException">PHPUnit\SelfTest\Basic\StatusTest::testFailure%A
@@ -46,10 +46,7 @@ RuntimeException:%w
     <testcase name="testSkipped" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
       <skipped/>
     </testcase>
-    <testcase name="testRisky" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
-      <error type="PHPUnit\Framework\RiskyTest">PHPUnit\SelfTest\Basic\StatusTest::testRisky%A
-This test did not perform any assertions</error>
-    </testcase>
+    <testcase name="testRisky" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f"/>
     <testcase name="testSuccessWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f"/>
     <testcase name="testFailureWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f">
       <failure type="PHPUnit\Framework\ExpectationFailedException">PHPUnit\SelfTest\Basic\StatusTest::testFailureWithMessage%A
@@ -70,9 +67,6 @@ RuntimeException: error with custom message
     <testcase name="testSkippedWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
       <skipped/>
     </testcase>
-    <testcase name="testRiskyWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
-      <error type="PHPUnit\Framework\RiskyTest">PHPUnit\SelfTest\Basic\StatusTest::testRiskyWithMessage%A
-This test did not perform any assertions</error>
-    </testcase>
+    <testcase name="testRiskyWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f"/>
   </testsuite>
 </testsuites>
diff --git a/tests/end-to-end/logging/log-junit-to-stdout.phpt b/tests/end-to-end/logging/log-junit-to-stdout.phpt
@@ -15,7 +15,7 @@ require_once __DIR__ . '/../../bootstrap.php';
 --EXPECTF--
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites>
-  <testsuite name="PHPUnit\SelfTest\Basic\StatusTest" file="%sStatusTest.php" tests="12" assertions="4" errors="4" failures="2" skipped="5" time="%f">
+  <testsuite name="PHPUnit\SelfTest\Basic\StatusTest" file="%sStatusTest.php" tests="12" assertions="4" errors="2" failures="2" skipped="5" time="%f">
     <testcase name="testSuccess" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f"/>
     <testcase name="testFailure" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f">
       <failure type="PHPUnit\Framework\ExpectationFailedException">PHPUnit\SelfTest\Basic\StatusTest::testFailure%A
@@ -35,10 +35,7 @@ RuntimeException:%w
     <testcase name="testSkipped" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
       <skipped/>
     </testcase>
-    <testcase name="testRisky" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
-      <error type="PHPUnit\Framework\RiskyTest">PHPUnit\SelfTest\Basic\StatusTest::testRisky%A
-This test did not perform any assertions</error>
-    </testcase>
+    <testcase name="testRisky" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f"/>
     <testcase name="testSuccessWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f"/>
     <testcase name="testFailureWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="1" time="%f">
       <failure type="PHPUnit\Framework\ExpectationFailedException">PHPUnit\SelfTest\Basic\StatusTest::testFailureWithMessage%A
@@ -59,9 +56,6 @@ RuntimeException: error with custom message
     <testcase name="testSkippedWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
       <skipped/>
     </testcase>
-    <testcase name="testRiskyWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f">
-      <error type="PHPUnit\Framework\RiskyTest">PHPUnit\SelfTest\Basic\StatusTest::testRiskyWithMessage%A
-This test did not perform any assertions</error>
-    </testcase>
+    <testcase name="testRiskyWithMessage" file="%sStatusTest.php" line="%d" class="PHPUnit\SelfTest\Basic\StatusTest" classname="PHPUnit.SelfTest.Basic.StatusTest" assertions="0" time="%f"/>
   </testsuite>
 </testsuites>