Merge pull request #2 from Aeliot-Tm/baseline_builder

Baseline builder

Author: Aeliot-Tm

bin/include_autoloader.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+if (isset($GLOBALS['_composer_autoload_path'])) {
+    define('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH', $GLOBALS['_composer_autoload_path']);
+    unset($GLOBALS['_composer_autoload_path']);
+} else {
+    $paths = [
+        __DIR__ . '/../../autoload.php',
+        __DIR__ . '/../vendor/autoload.php',
+        __DIR__ . '/vendor/autoload.php',
+    ];
+    foreach ($paths as $file) {
+        if (file_exists($file)) {
+            define('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH', $file);
+            break;
+        }
+    }
+    unset($paths, $file);
+}
+
+if (!defined('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH')) {
+    fwrite(
+        STDERR,
+        'You need to set up the project dependencies using Composer:' . PHP_EOL . PHP_EOL .
+        '    composer install' . PHP_EOL . PHP_EOL .
+        'You can learn all about Composer on https://getcomposer.org/.' . PHP_EOL
+    );
+    die(1);
+}
+
+require PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH;

bin/pccb_clover_build_baseline

@@ -0,0 +1,28 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+use Aeliot\PHPUnitCodeCoverageBaseline\BaselineBuilder;
+use Aeliot\PHPUnitCodeCoverageBaseline\Console\GetOpt;
+use Aeliot\PHPUnitCodeCoverageBaseline\Console\OptionsConfig;
+use Aeliot\PHPUnitCodeCoverageBaseline\Console\OptionsReader;
+use Aeliot\PHPUnitCodeCoverageBaseline\Reader\CloverReader;
+use Aeliot\PHPUnitCodeCoverageBaseline\Writer\BaselineWriter;
+
+require __DIR__ . '/include_autoloader.php';
+
+$optionsConfig = new OptionsConfig();
+$optionsConfig->add('baseline', 'b', 'phpunit.clover.baseline.json');
+$optionsConfig->add('clover', 'c', 'build/coverage/clover.xml');
+
+/** @var array{ baseline: string, clover: string } $options */
+$options = (new OptionsReader($optionsConfig, new GetOpt()))->read();
+
+try {
+    $builder = new BaselineBuilder(new BaselineWriter($options['baseline']), new CloverReader($options['clover']));
+    $builder->build();
+} catch (\Exception $exception) {
+    echo sprintf('[ERROR] %s%s', $exception->getMessage(), PHP_EOL);
+    exit(2);
+}

bin/phpunit_clover_compare renamed to bin/pccb_clover_compare

@@ -1,11 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-/**
- * DISCLAIMER: this is the base implementation of the comparing of Clover report with its baseline.
- *
- * TODO: add generating/updating of baseline from Clover report
- */
+declare(strict_types=1);
 
 use Aeliot\PHPUnitCodeCoverageBaseline\Comparator;
 use Aeliot\PHPUnitCodeCoverageBaseline\Console\GetOpt;
@@ -14,35 +10,7 @@ use Aeliot\PHPUnitCodeCoverageBaseline\Console\OptionsReader;
 use Aeliot\PHPUnitCodeCoverageBaseline\Reader\BaselineReader;
 use Aeliot\PHPUnitCodeCoverageBaseline\Reader\CloverReader;
 
-if (isset($GLOBALS['_composer_autoload_path'])) {
-    define('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH', $GLOBALS['_composer_autoload_path']);
-    unset($GLOBALS['_composer_autoload_path']);
-} else {
-    $paths = [
-        __DIR__ . '/../../autoload.php',
-        __DIR__ . '/../vendor/autoload.php',
-        __DIR__ . '/vendor/autoload.php',
-    ];
-    foreach ($paths as $file) {
-        if (file_exists($file)) {
-            define('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH', $file);
-            break;
-        }
-    }
-    unset($paths, $file);
-}
-
-if (!defined('PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH')) {
-    fwrite(
-        STDERR,
-        'You need to set up the project dependencies using Composer:' . PHP_EOL . PHP_EOL .
-        '    composer install' . PHP_EOL . PHP_EOL .
-        'You can learn all about Composer on https://getcomposer.org/.' . PHP_EOL
-    );
-    die(1);
-}
-
-require PHPUNIT_CCB_COMPOSER_AUTOLOAD_PATH;
+require __DIR__ . '/include_autoloader.php';
 
 $optionsConfig = new OptionsConfig();
 $optionsConfig->add('baseline', 'b', 'phpunit.clover.baseline.json');

composer.json

@@ -24,6 +24,6 @@
     }
   },
   "bin": [
-    "bin/phpunit_clover_compare"
+    "bin/pccb_clover_compare"
   ]
 }

src/BaselineBuilder.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\PHPUnitCodeCoverageBaseline;
+
+use Aeliot\PHPUnitCodeCoverageBaseline\Reader\CloverReader;
+use Aeliot\PHPUnitCodeCoverageBaseline\Writer\BaselineWriter;
+
+final class BaselineBuilder
+{
+    private BaselineWriter $baselineWriter;
+    private CloverReader $cloverReader;
+
+    public function __construct(BaselineWriter $baselineWriter, CloverReader $cloverReader)
+    {
+        $this->baselineWriter = $baselineWriter;
+        $this->cloverReader = $cloverReader;
+    }
+
+    public function build(): void
+    {
+        $baseline = $this->cloverReader->read();
+        $this->baselineWriter->write($baseline);
+    }
+}

src/Writer/BaselineWriter.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\PHPUnitCodeCoverageBaseline\Writer;
+
+/**
+ * @codeCoverageIgnore
+ */
+final class BaselineWriter
+{
+    private string $path;
+
+    public function __construct(string $path)
+    {
+        $this->path = $path;
+    }
+
+    /**
+     * @param array<string,int> $baseline
+     */
+    public function write(array $baseline): void
+    {
+        file_put_contents($this->path, json_encode($baseline, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT));
+    }
+}

tests/Unit/BaselineBuilderTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\PHPUnitCodeCoverageBaseline\Test\Unit;
+
+use Aeliot\PHPUnitCodeCoverageBaseline\BaselineBuilder;
+use Aeliot\PHPUnitCodeCoverageBaseline\Reader\CloverReader;
+use Aeliot\PHPUnitCodeCoverageBaseline\Writer\BaselineWriter;
+use PHPUnit\Framework\TestCase;
+
+final class BaselineBuilderTest extends TestCase
+{
+    public function testPositiveFlow(): void
+    {
+        $data = ['a' => 1, 'b' => 2];
+
+        $baselineWriter = $this->createMock(BaselineWriter::class);
+        $baselineWriter->expects($this->once())->method('write')->with($data);
+
+        $cloverReader = $this->createMock(CloverReader::class);
+        $cloverReader->expects($this->once())->method('read')->willReturn($data);
+
+        (new BaselineBuilder($baselineWriter, $cloverReader))->build();
+    }
+}