Initial commit

Author: vedmaka

.github/workflows/main.yml

@@ -0,0 +1,18 @@
+on: [push]
+
+jobs:
+  mediawiki-extension-action:
+    runs-on: ubuntu-latest
+    name: Dummy extension test
+    steps:
+      # check out the repository
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Test dummy extension
+        uses: ./ # Uses an action in the root directory
+        id: extension-test
+        with:
+          php: 7.4
+          mwbranch: REL1_35
+          extension: DummyExtension
+          testgroup: extension-DummyExtension

DummyExtension.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace DummyExtension;
+
+class DummyExtension {
+
+	public function testMe( $a, $b ) {
+		return $a + $b;
+	}
+
+}

README.md

@@ -0,0 +1,85 @@
+# Mediawiki Extension PHPUnit Runner
+
+The action is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action)
+that uses the following actions to install an ephemeral MediaWiki instance with Composer and PHP on board and run
+PHPUnit tests for your extension repo:
+
+* [shivammathur/setup-php](https://github.com/shivammathur/setup-php)
+* [actions/cache](https://github.com/actions/cache)
+* [actions/checkout](https://github.com/actions/checkout)
+
+# Usage
+
+```yaml
+- uses: actions/mediawiki-phpunit@v1
+  with:
+    php: 7.4
+    mwbranch: REL1_35
+    extension: DummyExtension
+    testgroup: extension-DummyExtension
+```
+
+# Inputs
+
+* `php` - version of PHP to install
+* `mwbranch` - MediaWiki branch to install
+* `extension` - extension name to test (this should match the desired extension directory)
+* `testgroup` - @group of tests to run (this should match your extension group defined on unit tests)
+
+# Example
+
+The below is an example of how to setup your GitHub Actions workflow on extension repository:
+
+`.github/workflows/main.yml`
+
+```yaml
+name: Example
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ "*" ]
+
+jobs:
+  test:
+    name: "PHPUnit: MW ${{ matrix.mw }}, PHP ${{ matrix.php }}"
+    strategy:
+      matrix:
+        include:
+          - mw: 'REL1_35'
+            php: 7.4
+          - mw: 'REL1_36'
+            php: 7.4
+          - mw: 'REL1_37'
+            php: 7.4
+          - mw: 'master'
+            php: 7.4
+    runs-on: ubuntu-latest
+    steps:
+      # check out the extension repository
+      - name: Checkout
+        uses: actions/checkout@v3
+      # run the action to install MediaWiki, PHP, Composer
+      # and run PHPUnit tests for the extension
+      - name: Mediawiki PHPUnit
+        uses: actions/mediawiki-phpunit@v1
+        with:
+          php: ${{ matrix.php }}
+          mwbranch: ${{ matrix.mw }}
+          extension: MyExtension
+          testgroup: extension-MyExtension
+```
+
+Example of adding a group to your extension tests:
+
+`MyExtension/tests/phpunit/MyExtensionTest.php`
+
+```php
+/**
+ * @group extension-MyExtension
+ */
+class MyExtensionTest extends MediaWikiTestCase {
+    // ...
+}
+```

action.yml

@@ -0,0 +1,52 @@
+name: 'Mediawiki Extension PHPUnit Runner'
+description: 'Setups MediaWiki and runs PHPUnit test for an extension'
+author: 'WikiTeq'
+branding:
+  color: yellow
+  icon: book-open
+inputs:
+  php:
+    description: 'PHP version'
+    required: true
+  mwbranch:
+    description: 'Mediawiki branch to test against'
+    required: true
+  extension:
+    description: 'Extension name to test'
+    required: true
+  testgroup:
+    description: 'Extension tests @group'
+    required: true
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ inputs.php }}
+        extensions: mbstring, intl
+        tools: composer:2.1.14
+
+    - name: Cache Composer cache
+      uses: actions/cache@v2
+      with:
+        path: ~/.composer/cache
+        key: composer-php${{ inputs.php }}
+
+    - name: Install MediaWiki
+      run: bash $GITHUB_ACTION_PATH/install.sh ${{ inputs.mwbranch }} ${{ inputs.extension }}
+      shell: bash
+
+    - uses: actions/checkout@v2
+      with:
+        path: mediawiki/extensions/${{ inputs.extension }}
+
+    - name: Composer update
+      working-directory: mediawiki
+      run: composer update
+      shell: bash
+
+    - name: Run PHPUnit
+      working-directory: mediawiki
+      run: php tests/phpunit/phpunit.php --group ${{ inputs.testgroup }}
+      shell: bash

extension.json

@@ -0,0 +1,18 @@
+{
+	"name": "DummyExtension",
+	"version": "1.0",
+	"author": [
+		"Anonymous"
+	],
+	"url": "https://www.mediawiki.org/wiki/Extension:DummyExtension",
+	"descriptionmsg": "dummyextension-desc",
+	"type": "extension",
+	"requires": {
+		"MediaWiki": ">= 1.35.0"
+	},
+	"license-name": "GPL-2.0-or-later",
+	"AutoloadClasses": {
+		"DummyExtension\\DummyExtension": "DummyExtension.php"
+	},
+	"manifest_version": 2
+}

install.sh

@@ -0,0 +1,40 @@
+#!/bin/sh -l
+
+set -o pipefail
+
+MW_BRANCH=$1
+EXTENSION_NAME=$2
+
+wget https://github.com/wikimedia/mediawiki/archive/$MW_BRANCH.tar.gz -nv -q
+
+tar -zxf $MW_BRANCH.tar.gz
+mv mediawiki-$MW_BRANCH mediawiki
+
+cd mediawiki
+
+composer -q install
+php maintenance/install.php --dbtype sqlite --dbuser root --dbname mw --dbpath $(pwd) --pass AdminPassword WikiName AdminUser > /dev/null
+
+# echo 'error_reporting(E_ALL| E_STRICT);' >> LocalSettings.php
+# echo 'ini_set("display_errors", 1);' >> LocalSettings.php
+echo '$wgShowExceptionDetails = true;' >> LocalSettings.php
+echo '$wgShowDBErrorBacktrace = true;' >> LocalSettings.php
+echo '$wgDevelopmentWarnings = true;' >> LocalSettings.php
+
+echo "wfLoadExtension( '$EXTENSION_NAME' );" >> LocalSettings.php
+
+cat <<EOT >> composer.local.json
+{
+  "require": {
+
+  },
+	"extra": {
+		"merge-plugin": {
+			"merge-dev": true,
+			"include": [
+				"extensions/*/composer.json"
+			]
+		}
+	}
+}
+EOT

tests/phpunit/DummyExtensionTest.php

@@ -0,0 +1,29 @@
+<?php
+
+use DummyExtension\DummyExtension;
+
+/**
+ * Class DummyExtensionTest
+ * @group extension-DummyExtension
+ */
+class DummyExtensionTest extends MediaWikiLangTestCase {
+
+	public function setUp(): void {
+		$this->setMwGlobals(
+			[
+				'wgDummyExtensionTestSetting' => false
+			]
+		);
+	}
+
+	/**
+	 * @throws MWException
+	 * @covers \DummyExtension\DummyExtension::testMe
+	 */
+	public function testDummyTestMe() {
+		$dummy = new DummyExtension();
+		$result = $dummy->testMe( 5, 10 );
+		$this->assertTrue( $result === 15 );
+	}
+
+}