chore: improve test suite (#3814)

Allows running tests without constantly running `composer install` on each extension.

.github/workflows/REUSABLE_backend.yml

@@ -21,6 +21,12 @@ on:
         required: false
         default: '.'
 
+      # Only relevant in mono-repos.
+      monorepo_tests:
+        description: "The list of directories to test in a monorepo. This should be a space-separated list of directories relative to the backend directory."
+        type: string
+        required: false
+
       php_versions:
         description: Versions of PHP to test with. Should be array of strings encoded as JSON array
         type: string
@@ -47,6 +53,7 @@ on:
 
 env:
   COMPOSER_ROOT_VERSION: dev-main
+  # `inputs.composer_directory` defaults to `inputs.backend_directory`
   FLARUM_TEST_TMP_DIR_LOCAL: tests/integration/tmp
 
 jobs:
@@ -143,18 +150,27 @@ jobs:
         run: composer install
         working-directory: ${{ inputs.backend_directory }}
 
-      - name: Setup Composer tests
-        run: composer test:setup
+      # If we have a `inputs.monorepo_tests`, we will run tests for each item of the provided array in a ::group::item
+      # If we don't have a `inputs.monorepo_tests`, we will run tests for the current repository
+      # We also have to run the `composer test:setup` script first before running each test
+      - name: Run tests
+        run: |
+          if [ -z "${{ inputs.monorepo_tests }}" ]; then
+            composer test:setup
+            composer test
+          else
+            for test in ${{ inputs.monorepo_tests }}; do
+              echo "::group::Running tests for $test"
+              composer test:setup --working-dir=$test
+              composer test --working-dir=$test
+              echo "::endgroup::"
+            done
+          fi
         working-directory: ${{ inputs.backend_directory }}
         env:
           DB_PORT: 13306
           DB_PASSWORD: root
           DB_PREFIX: ${{ matrix.prefix }}
-
-      - name: Run Composer tests
-        run: composer test
-        working-directory: ${{ inputs.backend_directory }}
-        env:
           COMPOSER_PROCESS_TIMEOUT: 600
 
   phpstan:

.github/workflows/backend.yml

@@ -0,0 +1,11 @@
+name: Backend Tests
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: ./.github/workflows/REUSABLE_backend.yml
+    with:
+      enable_backend_testing: true
+      backend_directory: .
+      monorepo_tests: "framework/core extensions/akismet extensions/approval extensions/flags extensions/likes extensions/mentions extensions/nicknames extensions/statistics extensions/sticky extensions/subscriptions extensions/suspend extensions/tags"

.github/workflows/frontend.yml

@@ -1,4 +1,4 @@
-name: Framework JS
+name: Frontend Workflow
 
 on: [workflow_dispatch, push, pull_request]
 

.github/workflows/phpstan.yml

@@ -1,4 +1,4 @@
-name: Framework PHP
+name: Static Code Analysis
 
 on: [workflow_dispatch, push, pull_request]
 
@@ -8,5 +8,4 @@ jobs:
     with:
       enable_backend_testing: false
       enable_phpstan: true
-
       backend_directory: .

composer.json

@@ -60,6 +60,26 @@
             "framework/core/src/helpers.php"
         ]
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Flarum\\Tests\\": "tests",
+            "Flarum\\Akismet\\Tests\\": "extensions/akismet/tests",
+            "Flarum\\Approval\\Tests\\": "extensions/approval/tests",
+            "Flarum\\Flags\\Tests\\": "extensions/flags/tests",
+            "Flarum\\Likes\\Tests\\": "extensions/likes/tests",
+            "Flarum\\Lock\\Tests\\": "extensions/lock/tests",
+            "Flarum\\Mentions\\Tests\\": "extensions/mentions/tests",
+            "Flarum\\Nicknames\\Tests\\": "extensions/nicknames/tests",
+            "Flarum\\PackageManager\\Tests\\": "extensions/package-manager/tests",
+            "Flarum\\Pusher\\Tests\\": "extensions/pusher/tests",
+            "Flarum\\Statistics\\Tests\\": "extensions/statistics/tests",
+            "Flarum\\Sticky\\Tests\\": "extensions/sticky/tests",
+            "Flarum\\Subscriptions\\Tests\\": "extensions/subscriptions/tests",
+            "Flarum\\Suspend\\Tests\\": "extensions/suspend/tests",
+            "Flarum\\Tags\\Tests\\": "extensions/tags/tests",
+            "Flarum\\Testing\\Tests\\": "php-packages/testing/tests"
+        }
+    },
     "replace": {
         "flarum/core": "self.version",
         "flarum/akismet": "self.version",

extensions/akismet/tests/integration/setup.php

@@ -7,10 +7,6 @@
  * LICENSE file that was distributed with this source code.
  */
 
-use Flarum\Testing\integration\Setup\SetupScript;
-
-require __DIR__.'/../../vendor/autoload.php';
-
-$setup = new SetupScript();
+$setup = require __DIR__.'/../../../../php-packages/testing/bootstrap/monorepo.php';
 
 $setup->run();

extensions/akismet/tests/phpunit.integration.xml

@@ -10,6 +10,7 @@
     convertWarningsToExceptions="true"
     processIsolation="true"
     stopOnFailure="false"
+    bootstrap="../../../php-packages/testing/bootstrap/monorepo.php"
 >
     <coverage processUncoveredFiles="true">
         <include>

extensions/akismet/tests/phpunit.unit.xml

@@ -10,6 +10,7 @@
     convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
+    bootstrap="../../../php-packages/testing/bootstrap/monorepo.php"
 >
     <coverage processUncoveredFiles="true">
         <include>

extensions/approval/tests/integration/setup.php

@@ -7,10 +7,6 @@
  * LICENSE file that was distributed with this source code.
  */
 
-use Flarum\Testing\integration\Setup\SetupScript;
-
-require __DIR__.'/../../vendor/autoload.php';
-
-$setup = new SetupScript();
+$setup = require __DIR__.'/../../../../php-packages/testing/bootstrap/monorepo.php';
 
 $setup->run();

extensions/approval/tests/phpunit.integration.xml

@@ -10,6 +10,7 @@
     convertWarningsToExceptions="true"
     processIsolation="true"
     stopOnFailure="false"
+    bootstrap="../../../php-packages/testing/bootstrap/monorepo.php"
 >
     <coverage processUncoveredFiles="true">
         <include>

extensions/approval/tests/phpunit.unit.xml

@@ -10,6 +10,7 @@
     convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
+    bootstrap="../../../php-packages/testing/bootstrap/monorepo.php"
 >
     <coverage processUncoveredFiles="true">
         <include>

extensions/flags/tests/integration/setup.php

@@ -7,10 +7,6 @@
  * LICENSE file that was distributed with this source code.
  */
 
-use Flarum\Testing\integration\Setup\SetupScript;
-
-require __DIR__.'/../../vendor/autoload.php';
-
-$setup = new SetupScript();
+$setup = require __DIR__.'/../../../../php-packages/testing/bootstrap/monorepo.php';
 
 $setup->run();