[WIP] add report renderer

.gitignore

@@ -1,3 +1,5 @@
 /phpunit.xml
 /vendor
 /composer.lock
+/.phpunit.result.cache
+/.idea

README.md

@@ -39,6 +39,11 @@ SpeedTrap also supports these parameters:
 * **slowThreshold** - Number of milliseconds when a test is considered "slow" (Default: 500ms)
 * **reportLength** - Number of slow tests included in the report (Default: 10 tests)
 * **stopOnSlow** - Stop execution upon first slow test (Default: false). Activate by setting "true".
+* **reportRenderer** - Used to specify the report renderer to use (ConsoleRenderer is used by default if omitted)
+  * **class** the class to be used in order to render the result of SpeedTrap, for the moment 2 renderers are available
+    * \JohnKary\PHPUnit\Listener\Renderer\NgWarningsRenderer
+    * \JohnKary\PHPUnit\Listener\Renderer\ConsoleRenderer
+  * **options** options to pass to the renderer (this argument can be omitted if not options are needed)
 
 Each parameter is set in `phpunit.xml`:
 
@@ -59,6 +64,23 @@ Each parameter is set in `phpunit.xml`:
                     <element key="stopOnSlow">
                         <boolean>false</boolean>
                     </element>
+                    <element key="reportRenderer">
+                        <array>
+                            <element key="class">
+                                <string>\JohnKary\PHPUnit\Listener\Renderer\NgWarningsRenderer</string>
+                            </element>
+                            <element key="options">
+                                <array>
+                                  <element key="file">
+                                    <string>/tmp/phpunit-speedtrap-report.json</string>
+                                  </element>
+                                  <element key="projectBaseDir">
+                                    <string>/project</string>
+                                  </element>
+                                </array>
+                            </element>
+                        </array>
+                    </element>
                 </array>
             </arguments>
         </listener>

phpunit.xml.dist

@@ -1,40 +1,47 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!-- https://phpunit.readthedocs.io/en/stable/configuration.html -->
 <phpunit
-    xmlns:xsi                     = "http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation = "vendor/phpunit/phpunit/phpunit.xsd"
-    colors                        = "true"
-    bootstrap                     = "vendor/autoload.php">
-
-    <testsuites>
-        <testsuite name="Project Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener">
-            <arguments>
-                <array>
-                    <element key="slowThreshold">
-                        <integer>500</integer>
-                    </element>
-                    <element key="reportLength">
-                        <integer>5</integer>
-                    </element>
-                    <element key="stopOnSlow">
-                        <boolean>false</boolean>
-                    </element>
-                </array>
-            </arguments>
-        </listener>
-    </listeners>
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+    colors="true"
+    bootstrap="vendor/autoload.php">
 
-    <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
+  <coverage>
+    <include>
+      <directory>src</directory>
+    </include>
+  </coverage>
 
+  <testsuites>
+    <testsuite name="Project Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <listeners>
+    <listener class="\JohnKary\PHPUnit\Listener\SpeedTrapListener">
+      <arguments>
+        <array>
+          <element key="slowThreshold">
+            <integer>500</integer>
+          </element>
+          <element key="reportLength">
+            <integer>5</integer>
+          </element>
+          <element key="stopOnSlow">
+            <boolean>false</boolean>
+          </element>
+          <element key="reportRenderer">
+            <array>
+              <element key="class">
+                <string>\JohnKary\PHPUnit\Listener\Renderer\ConsoleRenderer</string>
+              </element>
+              <element key="options">
+                <array/>
+              </element>
+            </array>
+          </element>
+        </array>
+      </arguments>
+    </listener>
+  </listeners>
 </phpunit>

src/Renderer/ConsoleRenderer.php

@@ -0,0 +1,57 @@
+<?php
+declare(strict_types=1);
+
+namespace JohnKary\PHPUnit\Listener\Renderer;
+
+use JohnKary\PHPUnit\Listener\SpeedTrapReport;
+
+class ConsoleRenderer implements ReportRendererInterface
+{
+    /** @var SpeedTrapReport */
+    protected $speedTrapReport;
+
+    /**
+     * @see ReportRendererInterface::__construct
+     */
+    public function __construct(SpeedTrapReport $speedTrapReport, array $options)
+    {
+        $this->speedTrapReport = $speedTrapReport;
+    }
+
+    /**
+     * @see ReportRendererInterface::renderHeader
+     */
+    public function renderHeader(): void
+    {
+        echo sprintf(
+            "\n\nYou should really speed up these slow tests (>%sms)...\n",
+            $this->speedTrapReport->getSlowThreshold()
+        );
+    }
+
+    /**
+     * @see ReportRendererInterface::renderBody
+     */
+    public function renderBody(): void
+    {
+        $slowTests = $this->speedTrapReport->getSlow();
+
+        $length = $this->speedTrapReport->getReportLength();
+        for ($i = 1; $i <= $length; ++$i) {
+            [$testCase, $time] = array_shift($slowTests);
+            $label = sprintf('%s::%s', addslashes(get_class($testCase)), $testCase->getName());
+
+            echo sprintf(" %s. %sms to run %s\n", $i, $time, $label);
+        }
+    }
+
+    /**
+     * @see ReportRendererInterface::renderFooter
+     */
+    public function renderFooter(): void
+    {
+        if ($hidden = $this->speedTrapReport->getHiddenCount()) {
+            printf("...and there %s %s more above your threshold hidden from view\n", $hidden == 1 ? 'is' : 'are', $hidden);
+        }
+    }
+}

src/Renderer/ReportRendererInterface.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace JohnKary\PHPUnit\Listener\Renderer;
+
+use JohnKary\PHPUnit\Listener\SpeedTrapReport;
+
+interface ReportRendererInterface {
+
+    /**
+     * @param SpeedTrapReport $speedTrapReport parent process
+     * @param array             $options
+     */
+    function __construct(SpeedTrapReport $speedTrapReport, array $options);
+
+    /**
+     * Renders slowness report header.
+     */
+    function renderHeader(): void;
+
+    /**
+     * Renders slowness report body.
+     */
+    function renderBody(): void;
+
+    /**
+     * Renders slowness report footer.
+     */
+    function renderFooter(): void;
+
+}

src/Renderer/WarningsNgRenderer.php

@@ -0,0 +1,113 @@
+<?php
+declare(strict_types=1);
+
+namespace JohnKary\PHPUnit\Listener\Renderer;
+
+use Exception;
+use JohnKary\PHPUnit\Listener\SpeedTrapReport;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Renderer for Jenkins Warnings-NG format
+ * @see https://github.com/jenkinsci/warnings-ng-plugin/blob/master/plugin/src/test/resources/io/jenkins/plugins/analysis/warnings/steps/issues.json
+ */
+class WarningsNgRenderer implements ReportRendererInterface
+{
+    /** @var SpeedTrapReport */
+    protected $speedTrapReport;
+
+    /** @var string the full path to the report file in warnings-ng format  */
+    protected $targetFile;
+
+    /** @var string optional basedir, if specified transforms test filepath relative to this directory */
+    protected $projectBaseDir;
+
+    /** @var array */
+    protected $data;
+
+    /**
+     * @throws Exception
+     * @see ReportRendererInterface::__construct
+     */
+    public function __construct(SpeedTrapReport $speedTrapReport, array $options)
+    {
+        $this->speedTrapReport = $speedTrapReport;
+        $this->data = [];
+        if (
+            !isset($options['file'])
+            || !is_string($options['file'])
+        ) {
+           throw new Exception(
+               'WarningsNgRenderer - invalid filepath provided'
+           );
+        }
+        if (!is_writable(dirname($options['file'])))
+        {
+            throw new Exception(
+                'WarningsNgRenderer - parent directory should be writable '
+                . $options['file']
+            );
+        }
+        $this->targetFile = $options['file'];
+        $this->projectBaseDir = $options['projectBaseDir'] ?? false;
+        if ($this->projectBaseDir) {
+            if (is_dir($this->projectBaseDir)) {
+                $this->projectBaseDir = realpath($this->projectBaseDir);
+            } else {
+                throw new Exception(
+                    'WarningsNgRenderer - project base directory should exist'
+                    .$options['file']
+                );
+            }
+        }
+    }
+
+    /**
+     * @see ReportRendererInterface::renderHeader
+     */
+    public function renderHeader(): void
+    {
+        $this->data['_class'] = 'io.jenkins.plugins.analysis.core.restapi.ReportApi';
+        $this->data['issues'] = [];
+    }
+
+    /**
+     * @see ReportRendererInterface::renderBody
+     */
+    public function renderBody(): void
+    {
+        $slowTests = $this->speedTrapReport->getSlow();
+
+        $length = count($slowTests);
+        $this->data['size'] = $length;
+        for ($i = 1; $i <= $length; ++$i) {
+            /** @var TestCase $testCase */
+            [$testCase, $time] = array_shift($slowTests);
+            $label = sprintf("%sms to run %s", $time, $testCase->getName(true));
+
+            $testCaseClass = new \ReflectionClass(get_class($testCase));
+            $fileName = $testCaseClass->getFileName();
+            if ($this->projectBaseDir) {
+                $fileName = str_replace($this->projectBaseDir, '.', $fileName);
+            }
+
+            $this->data['issues'][] = [
+                "fileName" => $fileName,
+                "packageName" => $testCaseClass->getNamespaceName(),
+                "message" => $label,
+                "severity" => "HIGH",
+                "duration" => $time,
+            ];
+        }
+    }
+
+    /**
+     * @see ReportRendererInterface::renderFooter
+     */
+    public function renderFooter(): void
+    {
+        // write the file
+        file_put_contents($this->targetFile, json_encode($this->data, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
+    }
+
+}