perf: initial PHPBench integration

Author: dkarlovi

Makefile

@@ -44,6 +44,9 @@ psalm: ensure
 phpunit:
 	sh -c "${PHPQA_DOCKER_COMMAND} phpunit-7 --verbose"
 
+benchmark: ensure
+	sh -c "${PHPQA_DOCKER_COMMAND} phpbench run --iterations=10 --report=aggregate -v"
+
 phpunit-coverage: ensure
 	sh -c "${PHPQA_DOCKER_COMMAND} phpdbg -qrr /tools/phpunit-7 --verbose --coverage-text --log-junit=var/phpunit.junit.xml --coverage-xml var/coverage-xml/"
 

composer.json

@@ -26,6 +26,7 @@
         "nicmart/tree": "^0.2,>= 0.2.4",
         "nyholm/nsa": "^1.1",
         "nyholm/symfony-bundle-test": "^1.4",
+        "phpbench/phpbench": "^0.16",
         "phpoffice/phpspreadsheet": "^1.4,>= 1.4.1",
         "phpunit/phpunit": "^7.0",
         "symfony/console": "^3.4 || ^4.0",

phpbench.json.dist

@@ -0,0 +1,18 @@
+{
+    "bootstrap": "vendor/autoload.php",
+    "path": "tests/Xezilaires/Performance",
+
+    "retry_threshold": 5,
+    "progress": "dots",
+
+    "annotation_import_use": true,
+    "extensions": [
+        "PhpBench\\Extensions\\Dbal\\DbalExtension",
+        "PhpBench\\Extensions\\XDebug\\XDebugExtension"
+    ],
+    "storage": "dbal",
+    "storage.dbal.connection": {
+        "driver": "pdo_sqlite",
+        "path": "var/phpbench-history.db"
+    }
+}

phpstan.neon.dist

@@ -25,3 +25,4 @@ parameters:
           paths:
             - %currentWorkingDirectory%/tests/Xezilaires/Bridge/Spout/SpreadsheetTest.php
             - %currentWorkingDirectory%/tests/Xezilaires/Functional/FunctionalTestCase.php
+            - %currentWorkingDirectory%/tests/Xezilaires/Performance/PerformanceTestCase.php

resources/fixtures/massive.xlsx

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the xezilaires project.
+ *
+ * (c) Dalibor Karlović <dalibor@flexolabs.io>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Xezilaires\Test\Performance;
+
+use PhpBench\Benchmark\Metadata\Annotations as Bench;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Serializer;
+use Xezilaires\Bridge\Symfony\Serializer\ObjectSerializer;
+use Xezilaires\Metadata\ColumnReference;
+use Xezilaires\Metadata\Mapping;
+use Xezilaires\Spreadsheet;
+use Xezilaires\SpreadsheetIterator;
+use Xezilaires\Test\FixtureTrait;
+use Xezilaires\Test\Model\Product;
+
+/**
+ * @Bench\BeforeMethods({"setUp"})
+ */
+abstract class PerformanceTestCase
+{
+    use FixtureTrait;
+
+    /**
+     * @var Mapping
+     */
+    private $mapping;
+
+    public function setUp(): void
+    {
+        $this->mapping = new Mapping(
+            Product::class,
+            [
+                'name' => new ColumnReference('A'),
+                'price' => new ColumnReference('B'),
+            ],
+            [
+                'start' => 2,
+            ]
+        );
+    }
+
+    /**
+     * @Bench\Assert(stat="mean", value="10")
+     * @Bench\Revs(1000)
+     */
+    public function benchIteratorConstruction(): void
+    {
+        $this->getSpreadsheet($this->fixture('massive.xlsx'));
+    }
+
+    /**
+     * @Bench\Assert(stat="mean", value="10")
+     * @Bench\Revs(1000)
+     */
+    public function benchIteratorIteration(): void
+    {
+        $iterator = $this->createIterator($this->getSpreadsheet($this->fixture('products.xlsx')), $this->mapping);
+
+        foreach ($iterator as $row) {
+        }
+    }
+
+    abstract protected function getSpreadsheet(\SplFileObject $file): Spreadsheet;
+
+    private function createIterator(Spreadsheet $spreadsheet, Mapping $mapping): SpreadsheetIterator
+    {
+        $serializer = new ObjectSerializer(new Serializer([new ObjectNormalizer()]));
+
+        return new SpreadsheetIterator($spreadsheet, $mapping, $serializer);
+    }
+}

tests/Xezilaires/Performance/PerformanceTestCase.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the xezilaires project.
+ *
+ * (c) Dalibor Karlović <dalibor@flexolabs.io>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Xezilaires\Test\Performance\Spout;
+
+use PhpBench\Benchmark\Metadata\Annotations as Bench;
+use Xezilaires\Spreadsheet;
+use Xezilaires\Test\Performance\PerformanceTestCase;
+
+/**
+ * @internal
+ *
+ * @small
+ */
+final class SpoutSpreadsheetIteratorBench extends PerformanceTestCase
+{
+    protected function getSpreadsheet(\SplFileObject $file): Spreadsheet
+    {
+        return new \Xezilaires\Bridge\Spout\Spreadsheet($file);
+    }
+}