Test outcome refactor & error output improvements

Author: mathroc

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        php-versions: ['8.1', '8.2', '8.3', '8.4']
+        php-versions: ['8.2', '8.3', '8.4']
 
     steps:
       - uses: actions/checkout@v4

phpcs.xml.dist

@@ -19,7 +19,7 @@
         <exclude name="SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion" />
         <exclude name="SlevomatCodingStandard.Classes.RequireSelfReference" />
         <exclude name="SlevomatCodingStandard.Classes.RequireSingleLineMethodSignature" />
-        <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming" />
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousErrorNaming" />
         <exclude name="SlevomatCodingStandard.Commenting.DisallowCommentAfterCode" />
         <exclude name="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
         <exclude name="SlevomatCodingStandard.Commenting.RequireOneLineDocComment" />

src/Application.php

@@ -55,7 +55,7 @@ protected function execute(Input\InputInterface $input, Output\OutputInterface $
         $testSuite->addSubscriber(new Subscriber\Summary($input, $output));
         $testSuite->addSubscriber(new Subscriber\TestExecutor());
 
-        return $testSuite->run($input->getOption("bail") ?? false)
+        return $testSuite->run($input->getOption("bail") ?? false)->isSuccess()
             ? Command::SUCCESS
             : Command::FAILURE;
     }

src/Attributes/ExamplesSetup.php

@@ -3,11 +3,11 @@
 namespace TH\DocTest\Attributes;
 
 #[\Attribute]
-final class ExamplesSetup
+final readonly class ExamplesSetup
 {
     public function __construct(
         /** @var class-string */
-        public readonly string $setupClass,
+        public string $setupClass,
     ) {
     }
 }

src/Event/AfterTest.php

@@ -2,12 +2,12 @@
 
 namespace TH\DocTest\Event;
 
-use TH\DocTest\Example;
+use TH\DocTest\TestCase;
 
-final class AfterTest
+final readonly class AfterTest
 {
     public function __construct(
-        public readonly Example $example,
+        public TestCase $test,
     ) {
     }
 }

src/Event/AfterTestFailure.php

@@ -2,13 +2,13 @@
 
 namespace TH\DocTest\Event;
 
-use TH\DocTest\Example;
+use TH\DocTest\TestCase;
 
-final class AfterTestFailure
+final readonly class AfterTestFailure
 {
     public function __construct(
-        public readonly Example $example,
-        public readonly \Throwable $failure,
+        public TestCase $test,
+        public \Throwable $failure,
     ) {
     }
 }

src/Event/AfterTestSuccess.php

@@ -2,12 +2,12 @@
 
 namespace TH\DocTest\Event;
 
-use TH\DocTest\Example;
+use TH\DocTest\TestCase;
 
-final class AfterTestSuccess
+final readonly class AfterTestSuccess
 {
     public function __construct(
-        public readonly Example $example,
+        public TestCase $test,
     ) {
     }
 }

src/Event/AfterTestSuite.php

@@ -2,10 +2,12 @@
 
 namespace TH\DocTest\Event;
 
-final class AfterTestSuite
+use TH\DocTest\TestOutcome;
+
+final readonly class AfterTestSuite
 {
     public function __construct(
-        public readonly bool $success,
+        public TestOutcome $outcome,
     ) {
     }
 }

src/Event/BeforeTest.php

@@ -2,12 +2,12 @@
 
 namespace TH\DocTest\Event;
 
-use TH\DocTest\Example;
+use TH\DocTest\TestCase;
 
-final class BeforeTest
+final readonly class BeforeTest
 {
     public function __construct(
-        public readonly Example $example,
+        public TestCase $test,
     ) {
     }
 }

src/Event/ExecuteTest.php

@@ -2,12 +2,12 @@
 
 namespace TH\DocTest\Event;
 
-use TH\DocTest\Example;
+use TH\DocTest\TestCase;
 
-final class ExecuteTest
+final readonly class ExecuteTest
 {
     public function __construct(
-        public readonly Example $example,
+        public TestCase $test,
     ) {
     }
 }