Add GA reusable test framework

Author: iMattPro

config/skeletons.yml

@@ -171,6 +171,17 @@ services:
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 
+    phpbb.skeleton.ext.skeleton.githubactions_custom:
+        class: phpbb\skeleton\skeleton
+        arguments:
+            - 'githubactions_custom'
+            - false
+            - ['tests']
+            - ['.github/workflows/tests.yml']
+            - 'TEST_DEPLOY'
+        tags:
+            - { name: phpbb.skeleton.ext.skeleton }
+
     phpbb.skeleton.ext.skeleton.build:
         class: phpbb\skeleton\skeleton
         arguments:

language/en/common.php

@@ -119,9 +119,12 @@
 	'SKELETON_QUESTION_COMPONENT_TESTS'				=> 'Create sample PHPUnit tests?',
 	'SKELETON_QUESTION_COMPONENT_TESTS_UI'			=> 'Tests (PHPUnit)',
 	'SKELETON_QUESTION_COMPONENT_TESTS_EXPLAIN'		=> 'Unit tests can test an extension to verify that specific portions of its source code work properly. This helps ensure basic code integrity and prevents regressions as an extension is being developed and debugged.',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'		=> 'Create a workflow for test execution using Github Actions?',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_UI'	=> 'Github Actions CI configuration',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_EXPLAIN'	=> 'Github Actions allow you to run PHPUnit tests on your GitHub repository. This will generate the workflow YML needed to begin testing your phpBB extension with each commit and pull request. Note that this workflow will be inside a hidden folder (.github/workflows).',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'			=> 'Create a GitHub Actions workflow using phpBB’s test framework?',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_UI'		=> 'Github Actions workflow',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_EXPLAIN'	=> 'Creates a GitHub Actions workflow to run PHPUnit tests on your repository using phpBB’s official test framework. The workflow YML file will be placed in the .github/workflows folder and will run tests automatically on each commit and pull request.',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM'			=> 'Create a custom GitHub Actions workflow for test execution?',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM_UI'		=> 'Github Actions custom workflow',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM_EXPLAIN'	=> 'Creates a customisable GitHub Actions workflow to run PHPUnit tests on your repository. This workflow is flexible to fit your specific testing needs and will be saved in the .github/workflows folder, triggered by each commit and pull request. Choosing this will override the non-customisable workflow.',
 	'SKELETON_QUESTION_COMPONENT_BUILD'				=> 'Create a sample build script for phing?',
 	'SKELETON_QUESTION_COMPONENT_BUILD_UI'			=> 'Build script (phing)',
 	'SKELETON_QUESTION_COMPONENT_BUILD_EXPLAIN'		=> 'A phing build script is generated for your extension which can be used to generate build packages to help simplify the release or deployment processes.',

skeleton/.github/workflows/tests.yml.twig

@@ -1,5 +1,6 @@
 name: Tests
 
+{% if COMPONENT.githubactions_custom %}
 env:
     EXTNAME: {{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }} # Your extension vendor/package name
     SNIFF: 1            # Run code sniffer on your code? 1 or 0
@@ -424,3 +425,34 @@ jobs:
               run: phpBB/vendor/bin/phpunit --configuration phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml --bootstrap ./tests/bootstrap.php
               working-directory: ./phpBB3
     # END Other Tests Job
+{% else %}
+on:
+	push:
+		branches:        # Run tests when commits are pushed to these branches in your repo
+			- main
+			- master
+			- develop
+			- dev/*
+	pull_request:        # Run tests when pull requests are made on these branches in your repo
+		branches:
+			- main
+			- master
+			- develop
+			- dev/*
+
+jobs:
+	call-tests:
+		uses: phpbb-extensions/test-framework/.github/workflows/[email protected]
+		with:
+			EXTNAME: {{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }} # Your extension vendor/package name
+			SNIFF: 1             # Run code sniffer on your code? 1 or 0
+			IMAGE_ICC: 1         # Run icc profile sniffer on your images? 1 or 0
+			EPV: 1               # Run EPV (Extension Pre Validator) on your code? 1 or 0
+			EXECUTABLE_FILES: 1  # Run check for executable files? 1 or 0
+			CODECOV: 0           # Run code coverage via codecov? 1 or 0
+			PHPBB_BRANCH: 3.3.x  # The phpBB branch to run tests on
+		secrets:
+			CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} # Do not change this
+
+# See the README for full details and setup instructions: https://github.com/phpbb-extensions/test-framework
+{% endif %}