Merge pull request #11 from charonlab/phpbench

Migrate to PHPBench for performance tests

.github/workflows/phpbench.yml

@@ -0,0 +1,42 @@
+name: "Performance benchmark"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+    paths:
+      - composer.*
+      - phpbench.json
+      - src/**
+      - tests/**
+  push:
+    branches:
+      - "*.x"
+    paths:
+      - composer.*
+      - phpbench.json
+      - src/**
+      - tests/**
+
+jobs:
+  phpbench:
+    name: "PHPBench"
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.3"
+
+    steps:
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 0
+      - uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "pcov"
+          ini-values: "zend.assertions=1, apc.enable_cli=1"
+      - uses: "ramsey/composer-install@v3"
+      - name: "Run PHPBench"
+        run: "composer run phpbench"

composer.json

@@ -9,6 +9,7 @@
     },
     "require-dev": {
         "charonlab/coding-standard": "1.2.x-dev",
+        "phpbench/phpbench": "^1.2@dev",
         "phpunit/phpunit": "11.1.x-dev",
         "vimeo/psalm": "6.x-dev"
     },
@@ -40,6 +41,7 @@
         "lint-check": "phpcs",
         "lint-fix": "phpcbf",
         "static-analysis": "psalm --shepherd --stats",
-        "test": "phpunit --colors=always"
+        "test": "phpunit --colors=always",
+        "phpbench": "phpbench run --report=compressed"
     }
 }

phpbench.json

@@ -0,0 +1,22 @@
+{
+    "$schema":"./vendor/phpbench/phpbench/phpbench.schema.json",
+
+    "runner.bootstrap": "./vendor/autoload.php",
+    "runner.path": "tests/Performance",
+    "runner.progress": "plain",
+    "runner.iterations": 20,
+    "runner.revs": 1000,
+    "runner.file_pattern": "*Bench.php",
+    "report.generators": {
+
+        "compressed": {
+            "title": "Charon Container Benchmark Tests",
+            "generator": "expression",
+            "cols": [ "benchmark", "subject", "mem_peak", "mode", "mean", "best", "worst" ]
+        }
+    },
+
+    "core.extensions": [
+        "PhpBench\\Extensions\\XDebug\\XDebugExtension"
+    ]
+}

tests/Performance/AbstractBenchCase.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the charonlab/charon-container.
+ *
+ * Copyright (C) 2023-2024 Charon Lab Development Team
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE.md file for details.
+ */
+
+namespace Charon\Tests\Container\Performance;
+
+use Charon\Container\Container;
+use Charon\Container\ContainerInterface;
+
+class AbstractBenchCase
+{
+    /** @psalm-suppress PropertyNotSetInConstructor */
+    protected ContainerInterface $container;
+
+    public function setup(): void {
+        $this->container = new Container();
+    }
+
+    public function tearDown(): void {
+        unset($this->container);
+    }
+}

tests/Performance/Cases/ContainerBench.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the charonlab/charon-container.
+ *
+ * Copyright (C) 2023-2024 Charon Lab Development Team
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE.md file for details.
+ */
+
+namespace Charon\Tests\Container\Performance\Cases;
+
+use Charon\Tests\Container\Performance\AbstractBenchCase;
+use Charon\Tests\Container\Performance\Stubs\FooBar;
+use PhpBench\Attributes\AfterMethods;
+use PhpBench\Attributes\Assert;
+use PhpBench\Attributes\BeforeMethods;
+
+class ContainerBench extends AbstractBenchCase
+{
+    #[BeforeMethods('setup')]
+    #[AfterMethods('tearDown')]
+    #[Assert('mode(variant.time.avg) < 5ms')]
+    #[Assert('mode(variant.mem.real) < 10mb')]
+    public function benchResolvePerformance(): void {
+        $this->container->resolve(FooBar::class);
+    }
+}

tests/Performance/Stubs/Bar.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the charonlab/charon-container.
+ *
+ * Copyright (C) 2023-2024 Charon Lab Development Team
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE.md file for details.
+ */
+
+namespace Charon\Tests\Container\Performance\Stubs;
+
+class Bar
+{
+}

tests/Performance/Stubs/Foo.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the charonlab/charon-container.
+ *
+ * Copyright (C) 2023-2024 Charon Lab Development Team
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE.md file for details.
+ */
+
+namespace Charon\Tests\Container\Performance\Stubs;
+
+class Foo
+{
+}

tests/Performance/Stubs/FooBar.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the charonlab/charon-container.
+ *
+ * Copyright (C) 2023-2024 Charon Lab Development Team
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE.md file for details.
+ */
+
+namespace Charon\Tests\Container\Performance\Stubs;
+
+class FooBar
+{
+    public function __construct(
+        public Foo $foo,
+        public Bar $bar
+    ) {
+    }
+}

tests/BindableContainerTest.php → tests/Unit/BindableContainerTest.php

@@ -9,14 +9,14 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container;
+namespace Charon\Tests\Container\Unit;
 
 use Charon\Container\BindableContainerInterface;
 use Charon\Container\Container;
 use Charon\Container\Exception\CircularDependencyException;
-use Charon\Tests\Container\Fixtures\ClassACircularDependencies;
-use Charon\Tests\Container\Fixtures\SampleClass;
-use Charon\Tests\Container\Fixtures\SampleInterface;
+use Charon\Tests\Container\Unit\Stubs\ClassACircularDependencies;
+use Charon\Tests\Container\Unit\Stubs\SampleClass;
+use Charon\Tests\Container\Unit\Stubs\SampleInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 

tests/ContainerTest.php → tests/Unit/ContainerTest.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container;
+namespace Charon\Tests\Container\Unit;
 
 use Charon\Container\Container;
 use Charon\Container\Exception\NotFoundException;

tests/Fixtures/ClassACircularDependencies.php → tests/Unit/Stubs/ClassACircularDependencies.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container\Fixtures;
+namespace Charon\Tests\Container\Unit\Stubs;
 
 class ClassACircularDependencies
 {

tests/Fixtures/ClassBCircularDependencies.php → tests/Unit/Stubs/ClassBCircularDependencies.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container\Fixtures;
+namespace Charon\Tests\Container\Unit\Stubs;
 
 class ClassBCircularDependencies
 {

tests/Fixtures/SampleClass.php → tests/Unit/Stubs/SampleClass.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container\Fixtures;
+namespace Charon\Tests\Container\Unit\Stubs;
 
 class SampleClass implements SampleInterface
 {

tests/Fixtures/SampleInterface.php → tests/Unit/Stubs/SampleInterface.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container\Fixtures;
+namespace Charon\Tests\Container\Unit\Stubs;
 
 interface SampleInterface
 {

tests/Fixtures/Service.php → tests/Unit/Stubs/Service.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE.md file for details.
  */
 
-namespace Charon\Tests\Container\Fixtures;
+namespace Charon\Tests\Container\Unit\Stubs;
 
 class Service
 {