Refactor log parser, adapt to new events

composer.json

@@ -41,7 +41,7 @@
         "facile-it/facile-coding-standard": "^0.5.1",
         "jangregor/phpstan-prophecy": "^1.0.0",
         "phpspec/prophecy": "dev-allow-sebastian-comparator-5 as 1.15",
-        "phpspec/prophecy-phpunit": "dev-allow-phpunit-10",
+        "phpspec/prophecy-phpunit": "dev-phpunit-10",
         "phpstan/extension-installer": "^1.0",
         "phpstan/phpstan": "^1.7",
         "phpstan/phpstan-phpunit": "^1.1",

docker/Dockerfile

@@ -6,14 +6,15 @@ RUN apk --no-cache add \
         git \
         zsh \
         openssh-client \
+        linux-headers \
         supervisor \
         sudo \
         less \
         vim \
         nano \
-        libzip-dev \
-    && docker-php-ext-install -j5 zip pcntl \
-    && pecl install xdebug \
+        libzip-dev
+RUN docker-php-ext-install -j5 zip pcntl
+RUN pecl install xdebug \
     && docker-php-ext-enable xdebug
 
 #COMPOSER

src/Configuration/DependencyInjection/CoverageContainerDefinition.php

@@ -75,9 +75,7 @@ private function configureCoverage(ContainerBuilder $container): void
             new Reference(CoverageMerger::class),
         ]));
         $container->setDefinition(CoveragePrinter::class, new Definition(CoveragePrinter::class, [
-            new Reference(PHPDbgBinFile::class),
-            new Reference(XDebugProxy::class),
-            new Reference(PcovProxy::class),
+            new Reference(CommandLineWithCoverage::class),
             new Reference(OutputInterface::class),
         ]));
     }

src/Configuration/DependencyInjection/ParserDefinition.php

@@ -9,11 +9,13 @@
 use Paraunit\Parser\DeprecationParser;
 use Paraunit\Parser\JSON\AbnormalTerminatedParser;
 use Paraunit\Parser\JSON\GenericParser;
-use Paraunit\Parser\JSON\Log;
 use Paraunit\Parser\JSON\LogFetcher;
 use Paraunit\Parser\JSON\LogParser;
 use Paraunit\Parser\JSON\RetryParser;
+use Paraunit\Parser\JSON\RiskyParser;
 use Paraunit\Parser\JSON\UnknownResultParser;
+use Paraunit\Parser\JSON\WarningParser;
+use Paraunit\Parser\ValueObject\TestStatus;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -55,40 +57,38 @@ private function defineParsers(ContainerBuilder $container): array
         $parserDefinitions = [
             'paraunit.parser.success_parser' => new Definition(GenericParser::class, [
                 new Reference('paraunit.test_result.success_container'),
-                Log::STATUS_SUCCESSFUL,
+                TestStatus::Passed,
             ]),
             'paraunit.parser.incomplete_parser' => new Definition(GenericParser::class, [
                 new Reference('paraunit.test_result.incomplete_container'),
-                Log::STATUS_INCOMPLETE,
+                TestStatus::MarkedIncomplete,
             ]),
             'paraunit.parser.skipped_parser' => new Definition(GenericParser::class, [
                 new Reference('paraunit.test_result.skipped_container'),
-                Log::STATUS_SKIPPED,
+                TestStatus::Skipped,
             ]),
-            'paraunit.parser.risky_parser' => new Definition(GenericParser::class, [
+            'paraunit.parser.risky_parser' => new Definition(RiskyParser::class, [
                 new Reference('paraunit.test_result.risky_container'),
-                Log::STATUS_RISKY,
             ]),
-            'paraunit.parser.warning_parser' => new Definition(GenericParser::class, [
+            'paraunit.parser.warning_parser' => new Definition(WarningParser::class, [
                 new Reference('paraunit.test_result.warning_container'),
-                Log::STATUS_WARNING,
+                TestStatus::WarningTriggered,
             ]),
             'paraunit.parser.failure_parser' => new Definition(GenericParser::class, [
                 new Reference('paraunit.test_result.failure_container'),
-                Log::STATUS_FAILURE,
+                TestStatus::Failed,
             ]),
             'paraunit.parser.error_parser' => new Definition(GenericParser::class, [
                 new Reference('paraunit.test_result.error_container'),
-                Log::STATUS_ERROR,
+                TestStatus::Errored,
             ]),
             AbnormalTerminatedParser::class => new Definition(AbnormalTerminatedParser::class, [
                 new Reference('paraunit.test_result.abnormal_terminated_container'),
                 new Reference(ChunkSize::class),
-                LogFetcher::LOG_ENDING_STATUS,
+                TestStatus::LogTerminated,
             ]),
             UnknownResultParser::class => new Definition(UnknownResultParser::class, [
                 new Reference('paraunit.test_result.unknown_container'),
-                '',
             ]),
         ];
 

src/Configuration/DependencyInjection/TestResultDefinition.php

@@ -67,8 +67,7 @@ private function getFormatDefinitions(): array
                 'fail',
                 'failures',
             ]),
-            'warning' => new Definition(TestResultWithSymbolFormat::class, [
-                'W',
+            'warning' => new Definition(TestResultFormat::class, [
                 'warning',
                 'warnings',
             ]),

src/Configuration/EnvVariables.php

@@ -11,4 +11,6 @@ class EnvVariables
     public const PIPELINE_NUMBER = 'PARAUNIT_PIPELINE_NUMBER';
 
     public const PROCESS_UNIQUE_ID = 'PARAUNIT_PROCESS_UNIQUE_ID';
+
+    public const XDEBUG_MODE = 'XDEBUG_MODE';
 }

src/Configuration/register_subscribers.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Paraunit\Parser\JSON\TestHook;
+use Paraunit\Parser\TestHook;
 use PHPUnit\Event\Facade;
 
 // TODO - wait for feedback and refactor accordingly
@@ -15,5 +15,5 @@
 Facade::registerSubscriber(new TestHook\Incomplete());
 Facade::registerSubscriber(new TestHook\Risky());
 Facade::registerSubscriber(new TestHook\Skipped());
-Facade::registerSubscriber(new TestHook\Successful());
+Facade::registerSubscriber(new TestHook\Passed());
 Facade::registerSubscriber(new TestHook\Warning());

src/Coverage/CoverageDriver.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Paraunit\Coverage;
+
+enum CoverageDriver
+{
+    case Xdebug;
+    case Pcov;
+    case PHPDbg;
+}

src/Parser/DeprecationParser.php

@@ -5,19 +5,16 @@
 namespace Paraunit\Parser;
 
 use Paraunit\Lifecycle\ProcessParsingCompleted;
+use Paraunit\Parser\ValueObject\Test;
 use Paraunit\Process\AbstractParaunitProcess;
 use Paraunit\TestResult\Interfaces\TestResultHandlerInterface;
 use Paraunit\TestResult\TestResultWithMessage;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class DeprecationParser implements EventSubscriberInterface
 {
-    /** @var TestResultHandlerInterface */
-    private $testResultContainer;
-
-    public function __construct(TestResultHandlerInterface $testResultContainer)
+    public function __construct(private readonly TestResultHandlerInterface $testResultContainer)
     {
-        $this->testResultContainer = $testResultContainer;
     }
 
     /**
@@ -38,7 +35,7 @@ public function handleDeprecations(ProcessParsingCompleted $event): void
             return;
         }
 
-        if (strpos($process->getOutput(), 'deprecation') !== false) {
+        if (str_contains($process->getOutput(), 'deprecation')) {
             $testResult = $this->createTestResult($process);
             $this->testResultContainer->handleTestResult($process, $testResult);
         }
@@ -47,7 +44,7 @@ public function handleDeprecations(ProcessParsingCompleted $event): void
     private function createTestResult(AbstractParaunitProcess $process): TestResultWithMessage
     {
         return new TestResultWithMessage(
-            $process->getTestClassName() ?? $process->getFilename(),
+            new Test($process->getTestClassName() ?? $process->getFilename()),
             $process->getOutput()
         );
     }

src/Parser/JSON/AbnormalTerminatedParser.php

@@ -5,6 +5,9 @@
 namespace Paraunit\Parser\JSON;
 
 use Paraunit\Configuration\ChunkSize;
+use Paraunit\Parser\ValueObject\LogData;
+use Paraunit\Parser\ValueObject\Test;
+use Paraunit\Parser\ValueObject\TestStatus;
 use Paraunit\Process\AbstractParaunitProcess;
 use Paraunit\TestResult\Interfaces\TestResultHandlerInterface;
 use Paraunit\TestResult\Interfaces\TestResultInterface;
@@ -13,23 +16,19 @@
 
 class AbnormalTerminatedParser extends GenericParser
 {
-    /** @var ChunkSize */
-    private $chunkSize;
-
-    /** @var string */
-    private $lastStartedTest = '[UNKNOWN]';
+    private Test $lastStartedTest;
 
     public function __construct(
         TestResultHandlerInterface $testResultHandler,
-        ChunkSize $chunkSize
+        private readonly ChunkSize $chunkSize,
     ) {
-        parent::__construct($testResultHandler, LogFetcher::LOG_ENDING_STATUS);
-        $this->chunkSize = $chunkSize;
+        parent::__construct($testResultHandler, TestStatus::LogTerminated);
+        $this->lastStartedTest = Test::unknown();
     }
 
-    public function handleLogItem(AbstractParaunitProcess $process, Log $logItem): ?TestResultInterface
+    public function handleLogItem(AbstractParaunitProcess $process, LogData $logItem): ?TestResultInterface
     {
-        if ($logItem->getStatus() === Log::STATUS_TEST_START) {
+        if ($logItem->status === TestStatus::Prepared) {
             $process->setWaitingForTestResult(true);
             $this->saveTestFQCN($process, $logItem);
 
@@ -51,9 +50,9 @@ public function handleLogItem(AbstractParaunitProcess $process, Log $logItem): ?
         return null;
     }
 
-    private function saveTestFQCN(AbstractParaunitProcess $process, Log $logItem): void
+    private function saveTestFQCN(AbstractParaunitProcess $process, LogData $logItem): void
     {
-        $this->lastStartedTest = $logItem->getTest();
+        $this->lastStartedTest = $logItem->test;
 
         if ($process->getTestClassName()) {
             return;
@@ -62,8 +61,9 @@ private function saveTestFQCN(AbstractParaunitProcess $process, Log $logItem): v
         if ($this->chunkSize->isChunked()) {
             $suiteName = basename($process->getFilename());
         } else {
-            $suiteName = explode('::', $logItem->getTest())[0];
+            $suiteName = explode('::', $logItem->test->name)[0];
         }
+
         $process->setTestClassName($suiteName);
     }
 }

src/Parser/JSON/GenericParser.php

@@ -4,6 +4,8 @@
 
 namespace Paraunit\Parser\JSON;
 
+use Paraunit\Parser\ValueObject\LogData;
+use Paraunit\Parser\ValueObject\TestStatus;
 use Paraunit\Process\AbstractParaunitProcess;
 use Paraunit\TestResult\Interfaces\TestResultHandlerInterface;
 use Paraunit\TestResult\Interfaces\TestResultInterface;
@@ -12,27 +14,19 @@
 
 class GenericParser implements ParserChainElementInterface
 {
-    /** @var TestResultHandlerInterface */
-    protected $testResultContainer;
-
-    /** @var string */
-    protected $status;
-
     /**
-     * @param string $status The status that the parser should catch
+     * @param TestStatus $status The status that the parser should catch
      */
     public function __construct(
-        TestResultHandlerInterface $testResultContainer,
-        string $status
+        protected readonly TestResultHandlerInterface $testResultContainer,
+        protected readonly TestStatus $status,
     ) {
-        $this->testResultContainer = $testResultContainer;
-        $this->status = $status;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function handleLogItem(AbstractParaunitProcess $process, Log $logItem): ?TestResultInterface
+    public function handleLogItem(AbstractParaunitProcess $process, LogData $logItem): ?TestResultInterface
     {
         if ($this->logMatches($logItem)) {
             $testResult = $this->createFromLog($logItem);
@@ -45,19 +39,17 @@ public function handleLogItem(AbstractParaunitProcess $process, Log $logItem): ?
         return null;
     }
 
-    protected function logMatches(Log $log): bool
+    protected function logMatches(LogData $log): bool
     {
-        return $log->getStatus() === $this->status;
+        return $log->status === $this->status;
     }
 
-    private function createFromLog(Log $logItem): TestResultInterface
+    protected function createFromLog(LogData $logItem): TestResultInterface
     {
-        $message = $logItem->getMessage();
-
-        if ($message) {
-            return new TestResultWithMessage($logItem->getTest(), $message);
+        if ($logItem->message) {
+            return new TestResultWithMessage($logItem->test, $logItem->message);
         }
 
-        return new MuteTestResult($logItem->getTest());
+        return new MuteTestResult($logItem->test);
     }
 }