[TASK] Introduce runTest.sh for unified testing. (#521)

Manual backport to 12.4 needed

Releases: main, 13.4, 12.4

Author: linawolf

.github/workflows/tests.yml

@@ -1,45 +1,49 @@
-name: Tests
+name: tests
 
-on: [ push, pull_request ]
+on:
+  push:
+  pull_request:
 
 jobs:
   lint:
-    name: Lint PHP files
+    name: Linting
     runs-on: ubuntu-latest
     strategy:
       matrix:
         php:
           - '8.2'
           - '8.3'
+          - '8.4'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup PHP version
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-versions }}
-
       - name: Lint PHP
-        run: find . -type f -name '*.php' ! -path "./.Build/*" -print0 | xargs -0 -n1 -P4 php -l -n | (! grep -v "No syntax errors detected" )
+        run: Build/Scripts/runTests.sh -p ${{ matrix.php }} -s lint
 
-  code-quality:
-    name: Code quality
+  quality:
+    name: Quality
     runs-on: ubuntu-latest
     env:
       php: '8.2'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup PHP version
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-versions }}
-
       - name: Install testing system
-        run: composer update --no-progress --prefer-dist --optimize-autoloader
+        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerUpdate
+
+      - name: Composer validate
+        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerValidate
+
+      - name: Composer normalize
+        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerNormalize -n
+
+      - name: CGL
+        run: Build/Scripts/runTests.sh -n -p ${{ env.php }} -s cgl -n
+
+      - name: Check Rst
+        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s checkRst
 
-      - name: Check PHP coding standards
-        run: |
-          make check-php
+      - name: Lint YAML
+        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s yamlLint

.gitignore

@@ -23,3 +23,5 @@
 composer.lock
 nbproject
 Documentation-GENERATED-temp/
+/composer.json.testing
+/.Build/

Build/.gitignore

@@ -0,0 +1 @@
+testing-docker/.env

Build/.php-cs-fixer.dist.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+return (new Config())
+    ->setFinder(
+        (new Finder())
+            ->in(__DIR__.'/../Documentation')
+    )
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@DoctrineAnnotation' => true,
+        // @todo: Switch to @PER-CS2.0 once php-cs-fixer's todo list is done: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/7247
+        '@PER-CS1.0' => true,
+        'array_indentation' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'cast_spaces' => ['space' => 'none'],
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'concat_space' => ['spacing' => 'one'],
+        'declare_equal_normalize' => ['space' => 'none'],
+        'declare_parentheses' => true,
+        'dir_constant' => true,
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'function_declaration' => [
+            'closure_fn_spacing' => 'none',
+        ],
+        'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']],
+        'type_declaration_spaces' => true,
+        'global_namespace_import' => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false],
+        'list_syntax' => ['syntax' => 'short'],
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'method_argument_space' => true,
+        'modernize_strpos' => true,
+        'modernize_types_casting' => true,
+        'native_function_casing' => true,
+        'no_alias_functions' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_empty_phpdoc' => true,
+        'no_empty_statement' => true,
+        'no_extra_blank_lines' => true,
+        'no_leading_namespace_whitespace' => true,
+        'no_null_property_initialization' => true,
+        'no_short_bool_cast' => true,
+        'no_singleline_whitespace_before_semicolons' => true,
+        'no_superfluous_elseif' => true,
+        'no_trailing_comma_in_singleline' => true,
+        'no_unneeded_control_parentheses' => true,
+        'no_unused_imports' => true,
+        'no_useless_nullsafe_operator' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
+        'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
+        'php_unit_mock_short_will_return' => true,
+        'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
+        'phpdoc_no_access' => true,
+        'phpdoc_no_empty_return' => true,
+        'phpdoc_no_package' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_types' => true,
+        'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
+        'return_type_declaration' => ['space_before' => 'none'],
+        'single_quote' => true,
+        'single_space_around_construct' => true,
+        'single_line_comment_style' => ['comment_types' => ['hash']],
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'single_line_empty_body' => true,
+        'trailing_comma_in_multiline' => ['elements' => ['arguments', 'arrays', 'match', 'parameters']],
+        'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
+        'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
+
+        // We need this for documentation!
+        'no_useless_else' => false, // We want to preserve else with comments only
+    ]);