build: Add phpbench (#1204)

Author: theofidry

.github/workflows/benchmark-empty.yaml

@@ -0,0 +1,23 @@
+# Fallback workflow to be able to have the branch protection enabled at all times.
+name: Benchmark Tests
+
+on:
+    # To be aware it need to be the counter-part of benchmark.yaml.
+    push:
+        branches: [ main ]
+
+# See https://stackoverflow.com/a/72408109
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    # This is a "trick", a meta task which does not change, and we can use in
+    # the protected branch rules as opposed to the tests one above which
+    # may change regularly.
+    validate-tests:
+        name: Benchmark tests status
+        runs-on: ubuntu-latest
+        steps:
+            - name: Successful run
+              run: exit 0

.github/workflows/benchmark.yaml

@@ -0,0 +1,114 @@
+name: Benchmark Tests
+
+# To be aware it need to be the counter-part of benchmark-empty.yaml.
+on:
+    pull_request: ~
+
+# See https://stackoverflow.com/a/72408109
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+env:
+    TERM: xterm
+
+jobs:
+    main-bench-test:
+        runs-on: ubuntu-latest
+        name: Benchmark main branch
+        steps:
+            -   name: Checkout main branch
+                uses: actions/checkout@v4
+                with:
+                    ref: main
+                    fetch-depth: 0
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: '8.2'
+                    ini-values: phar.readonly=0, display_errors=On, error_reporting=-1
+                    tools: composer
+                    coverage: none
+
+            -   name: Install Composer dependencies
+                uses: ramsey/composer-install@v2
+
+            -   name: Ensure that the make target is up to date
+                run: make _vendor_install
+
+            -   name: Install PHPBench
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: vendor-bin/phpbench
+
+            -   name: Ensure that the PHPBench make target is up to date
+                run: make phpbench_install
+
+            -   name: Run PHPBench
+                run: make phpbench_main
+
+            -   uses: actions/upload-artifact@v3
+                name: Upload the Benchmark results
+                with:
+                    name: bench-main-result
+                    path: dist/bench-branch-main-result.xml
+
+    pr-bench-test:
+        runs-on: ubuntu-latest
+        name: Benchmark PR
+        needs: main-bench-test
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+                with:
+                    fetch-depth: 0
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: '8.2'
+                    ini-values: phar.readonly=0, display_errors=On, error_reporting=-1
+                    tools: composer
+                    coverage: none
+
+            -   name: Install Composer dependencies
+                uses: ramsey/composer-install@v2
+
+            -   name: Ensure that the make target is up to date
+                run: make _vendor_install
+
+            -   name: Install PHPBench
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: vendor-bin/phpbench
+
+            -   name: Ensure that the PHPBench make target is up to date
+                run: make phpbench_install
+
+            -   name: Download the Benchmark results of the main branch
+                uses: actions/download-artifact@v3
+                with:
+                    name: bench-branch-main-result
+
+            -   name: Run PHPBench against PR branch
+                run: make phpbench_pr
+
+
+    # This is a "trick", a meta task which does not change, and we can use in
+    # the protected branch rules as opposed to the tests one above which
+    # may change regularly.
+    validate-tests:
+        name: Benchmark tests status
+        runs-on: ubuntu-latest
+        needs:
+            - pr-bench-test
+        if: always()
+        steps:
+            - name: Successful run
+              if: ${{ !(contains(needs.*.result, 'failure')) }}
+              run: exit 0
+
+            - name: Failing run
+              if: ${{ contains(needs.*.result, 'failure') }}
+              run: exit 1