Add phpbench benchmarks for parsing and analysing

.github/workflows/tests.yaml

@@ -41,3 +41,6 @@ jobs:
 
       - name: Run phpunit tests
         run: vendor/bin/phpunit --testsuite tests --colors=always --testdox
+
+      - name: Check that benchmarks run
+        run: vendor/bin/phpbench run --revs=1 --iterations=1 --stop-on-error --progress=none

.gitignore

@@ -1,3 +1,4 @@
 .idea
 vendor
 .phpunit.result.cache
+.phpbench

README.md

@@ -113,3 +113,23 @@ $modification->setReplacement('bar');
 $printer->addModification($modification);
 $printer->print();
 ```
+
+## Benchmarks
+
+The [benchmarks](test/benchmarks) measure parsing and analysing of generated logs with [phpbench](https://github.com/phpbench/phpbench).
+They are meant to compare a change against `master` locally, CI only checks that they still run.
+
+```
+composer bench
+```
+
+To compare a branch against `master`, store a baseline on `master` and reference it on the branch:
+
+```
+git switch master
+composer bench -- --tag=master
+git switch my-branch
+composer bench -- --ref=master
+```
+
+Disable Xdebug (`XDEBUG_MODE=off`) and keep the same PHP and opcache settings for both runs, otherwise the numbers are not comparable.

composer.json

@@ -13,7 +13,8 @@
     "php": ">=8.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "^12"
+    "phpunit/phpunit": "^12",
+    "phpbench/phpbench": "^1.7"
   },
   "autoload": {
     "psr-4": {
@@ -23,10 +24,15 @@
   "autoload-dev": {
     "psr-4": {
       "Aternos\\Codex\\Test\\Src\\": "test/src/",
-      "Aternos\\Codex\\Test\\Tests\\": "test/tests/"
-    }
+      "Aternos\\Codex\\Test\\Tests\\": "test/tests/",
+      "Aternos\\Codex\\Test\\Benchmarks\\": "test/benchmarks/"
+    },
+    "classmap": [
+      "test/benchmarks/Insight/KeywordProblems.php"
+    ]
   },
   "scripts": {
-    "test": "phpunit test/tests"
+    "test": "phpunit test/tests",
+    "bench": "phpbench run --report=default"
   }
 }