Merge pull request #9 from robiningelbrecht/output-execution-time

Output execution time

Author: robiningelbrecht

phpunit.xml.dist

@@ -18,8 +18,5 @@
     <include>
       <directory>src</directory>
     </include>
-    <exclude>
-      <file>src/Exitter.php</file>
-    </exclude>
   </source>
 </phpunit>

src/ConsoleOutput.php

@@ -4,6 +4,9 @@
 
 use RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\MinCoverageResult;
 use RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\ResultStatus;
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\ResourceUsageFormatter;
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\SystemResourceUsageFormatter;
+use SebastianBergmann\Timer\Duration;
 use Symfony\Component\Console\Formatter\OutputFormatterStyle;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Helper\TableCell;
@@ -12,10 +15,11 @@
 use Symfony\Component\Console\Helper\TableStyle;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class ConsoleOutput
+final class ConsoleOutput
 {
     public function __construct(
         private readonly OutputInterface $output,
+        private readonly ResourceUsageFormatter $resourceUsageFormatter,
     ) {
         $this->output->setDecorated(true);
         $this->output->getFormatter()->setStyle(
@@ -36,10 +40,18 @@ public function __construct(
         );
     }
 
+    public static function create(): self
+    {
+        return new self(
+            output: new \Symfony\Component\Console\Output\ConsoleOutput(),
+            resourceUsageFormatter: SystemResourceUsageFormatter::create()
+        );
+    }
+
     /**
      * @param \RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\MinCoverageResult[] $results
      */
-    public function print(array $results): void
+    public function print(array $results, Duration $duration): void
     {
         $statusWeights = array_map(fn (MinCoverageResult $result) => $result->getStatus()->getWeight(), $results);
         $finalStatus = ResultStatus::fromWeight(max($statusWeights));
@@ -99,5 +111,6 @@ public function print(array $results): void
                 ],
             ]);
         $table->render();
+        $this->output->writeln($this->resourceUsageFormatter->resourceUsage($duration));
     }
 }

src/Exitter.php

@@ -2,6 +2,9 @@
 
 namespace RobinIngelbrecht\PHPUnitCoverageTools;
 
+/**
+ * @codeCoverageIgnore
+ */
 class Exitter
 {
     public function exit(): void

src/Subscriber/Application/ApplicationFinishedSubscriber.php

@@ -14,6 +14,8 @@
 use RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\MinCoverageRule;
 use RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\MinCoverageRules;
 use RobinIngelbrecht\PHPUnitCoverageTools\MinCoverage\ResultStatus;
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\SystemTimer;
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\Timer;
 use Symfony\Component\Console\Helper\FormatterHelper;
 
 final class ApplicationFinishedSubscriber extends FormatterHelper implements FinishedSubscriber
@@ -24,11 +26,13 @@ public function __construct(
         private readonly bool $cleanUpCloverXml,
         private readonly Exitter $exitter,
         private readonly ConsoleOutput $consoleOutput,
+        private readonly Timer $timer,
     ) {
     }
 
     public function notify(Finished $event): void
     {
+        $this->timer->start();
         /** @var string $reflectionFileName */
         $reflectionFileName = (new \ReflectionClass(ClassLoader::class))->getFileName();
         $absolutePathToCloverXml = dirname($reflectionFileName, 3).'/'.$this->relativePathToCloverXml;
@@ -48,15 +52,21 @@ public function notify(Finished $event): void
             if ($this->minCoverageRules->hasTotalRule() && \XMLReader::ELEMENT == $reader->nodeType && 'metrics' == $reader->name && 2 === $reader->depth) {
                 /** @var \SimpleXMLElement $node */
                 $node = simplexml_load_string($reader->readOuterXml());
-                $metricTotal = CoverageMetric::fromCloverXmlNode($node, MinCoverageRule::TOTAL);
+                $metricTotal = CoverageMetric::fromCloverXmlNode(
+                    node: $node,
+                    forClass: MinCoverageRule::TOTAL
+                );
                 continue;
             }
             if ($this->minCoverageRules->hasOtherRulesThanTotalRule() && \XMLReader::ELEMENT == $reader->nodeType && 'class' == $reader->name && 3 === $reader->depth) {
                 /** @var \SimpleXMLElement $node */
                 $node = simplexml_load_string($reader->readInnerXml());
                 /** @var string $className */
                 $className = $reader->getAttribute('name');
-                $metrics[] = CoverageMetric::fromCloverXmlNode($node, $className);
+                $metrics[] = CoverageMetric::fromCloverXmlNode(
+                    node: $node,
+                    forClass: $className
+                );
             }
         }
         $reader->close();
@@ -74,7 +84,11 @@ public function notify(Finished $event): void
             metrics: $metrics,
             metricTotal: $metricTotal,
         );
-        $this->consoleOutput->print($results);
+
+        $this->consoleOutput->print(
+            results: $results,
+            duration: $this->timer->stop()
+        );
 
         $needsExit = !empty(array_filter(
             $results,
@@ -134,7 +148,8 @@ public static function fromConfigurationAndParameters(
             minCoverageRules: $rules,
             cleanUpCloverXml: $cleanUpCloverXml,
             exitter: new Exitter(),
-            consoleOutput: new ConsoleOutput(new \Symfony\Component\Console\Output\ConsoleOutput()),
+            consoleOutput: ConsoleOutput::create(),
+            timer: SystemTimer::create(),
         );
     }
 }

src/Timer/ResourceUsageFormatter.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace RobinIngelbrecht\PHPUnitCoverageTools\Timer;
+
+use SebastianBergmann\Timer\Duration;
+
+interface ResourceUsageFormatter
+{
+    public function resourceUsage(Duration $duration): string;
+
+    public function resourceUsageSinceStartOfRequest(): string;
+}

src/Timer/SystemResourceUsageFormatter.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace RobinIngelbrecht\PHPUnitCoverageTools\Timer;
+
+use SebastianBergmann\Timer\Duration;
+use SebastianBergmann\Timer\ResourceUsageFormatter as PhpUnitResourceUsageFormatter;
+
+final class SystemResourceUsageFormatter implements ResourceUsageFormatter
+{
+    private function __construct(
+        private readonly PhpUnitResourceUsageFormatter $resourceUsageFormatter
+    ) {
+    }
+
+    public static function create(): self
+    {
+        return new self(new PhpUnitResourceUsageFormatter());
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function resourceUsage(Duration $duration): string
+    {
+        return $this->resourceUsageFormatter->resourceUsage($duration);
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function resourceUsageSinceStartOfRequest(): string
+    {
+        return $this->resourceUsageFormatter->resourceUsageSinceStartOfRequest();
+    }
+}

src/Timer/SystemTimer.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace RobinIngelbrecht\PHPUnitCoverageTools\Timer;
+
+use SebastianBergmann\Timer\Duration;
+use SebastianBergmann\Timer\Timer as PhpUnitTimer;
+
+final class SystemTimer implements Timer
+{
+    private function __construct(
+        private readonly PhpUnitTimer $timer,
+    ) {
+    }
+
+    public static function create(): self
+    {
+        return new self(new PhpUnitTimer());
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function start(): void
+    {
+        $this->timer->start();
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function stop(): Duration
+    {
+        return $this->timer->stop();
+    }
+}

src/Timer/Timer.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace RobinIngelbrecht\PHPUnitCoverageTools\Timer;
+
+use SebastianBergmann\Timer\Duration;
+
+interface Timer
+{
+    public function start(): void;
+
+    public function stop(): Duration;
+}

tests/FixedResourceUsageFormatter.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Tests;
+
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\ResourceUsageFormatter;
+use SebastianBergmann\Timer\Duration;
+
+final class FixedResourceUsageFormatter implements ResourceUsageFormatter
+{
+    private function __construct(
+        private readonly float $usageInMb
+    ) {
+    }
+
+    public static function withUsageInMb(float $usageInMb): self
+    {
+        return new self($usageInMb);
+    }
+
+    public function resourceUsage(Duration $duration): string
+    {
+        return sprintf(
+            'Time: %s, Memory: %s MB',
+            $duration->asString(),
+            number_format($this->usageInMb, 2, '.', ''),
+        );
+    }
+
+    public function resourceUsageSinceStartOfRequest(): string
+    {
+        return sprintf(
+            'Time: 00:00.350, Memory: %s MB',
+            number_format($this->usageInMb, 2, '.', ''),
+        );
+    }
+}

tests/PausedTimer.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Tests;
+
+use RobinIngelbrecht\PHPUnitCoverageTools\Timer\Timer;
+use SebastianBergmann\Timer\Duration;
+
+final class PausedTimer implements Timer
+{
+    private function __construct(
+        private readonly Duration $duration
+    ) {
+    }
+
+    public static function withDuration(Duration $duration): self
+    {
+        return new self($duration);
+    }
+
+    public function start(): void
+    {
+    }
+
+    public function stop(): Duration
+    {
+        return $this->duration;
+    }
+}