Modernise CI

.github/workflows/ci.yml

@@ -5,107 +5,87 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ "*" ]
+  workflow_dispatch:
 
 jobs:
+
   test:
-    name: "PHPUnit: MW ${{ matrix.mw }}, PHP ${{ matrix.php }} (TYPE ${{ matrix.type }})"
+
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
 
     strategy:
       matrix:
         include:
-          - mw: 'REL1_39'
-            php: 7.4
-            type: normal
-            experimental: false
-          - mw: 'REL1_39'
-            php: 8.0
-            type: coverage
+          - mediawiki_version: '1.39'
+            smw_version: 5.1.0
+            scribunto_version: REL1_39
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mariadb:10"
+            coverage: false
             experimental: false
-          - mw: 'REL1_39'
-            php: 8.1
-            type: normal
+          - mediawiki_version: '1.40'
+            smw_version: 5.1.0
+            scribunto_version: REL1_40
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mariadb:11.2"
+            coverage: true
             experimental: false
-          - mw: 'REL1_40'
-            php: 8.1
-            type: normal
+          - mediawiki_version: '1.41'
+            smw_version: 5.1.0
+            scribunto_version: REL1_41
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mariadb:11.2"
+            coverage: false
             experimental: false
-          - mw: 'REL1_41'
-            php: 8.1
-            type: normal
+          - mediawiki_version: '1.42'
+            smw_version: 5.1.0
+            scribunto_version: REL1_42
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mariadb:11.2"
+            coverage: false
             experimental: false
-          - mw: 'REL1_42'
-            php: 8.2
-            type: normal
+          - mediawiki_version: '1.43'
+            smw_version: dev-master
+            scribunto_version: REL1_43
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mariadb:11.2"
+            coverage: false
             experimental: false
-          - mw: 'master'
-            php: 8.3
-            type: normal
-            experimental: true
-
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental }}
-
-    defaults:
-      run:
-        working-directory: mediawiki
 
     env:
-      MW_ROOT: mediawiki
-      TYPE: ${{ matrix.type }}
-
+      MW_VERSION: ${{ matrix.mediawiki_version }}
+      SMW_VERSION: ${{ matrix.smw_version }}
+      SCRIBUNTO_VERSION: ${{ matrix.scribunto_version }}
+      PHP_VERSION: ${{ matrix.php_version }}
+      DB_TYPE: ${{ matrix.database_type }}
+      DB_IMAGE: ${{ matrix.database_image }}
 
     steps:
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          php-version: ${{ matrix.php }}
-          extensions: mbstring, intl
-          tools: composer
+          submodules: recursive
 
-      - name: Cache MediaWiki
-        id: cache-mediawiki
-        uses: actions/cache@v4
-        with:
-          path: |
-            mediawiki
-            !mediawiki/extensions/
-            !mediawiki/vendor/
-          key: mw_${{ matrix.mw }}-php${{ matrix.php }}
+      - name: Update submodules
+        run: git submodule update --init --remote
 
-      - name: Cache Composer cache
-        uses: actions/cache@v4
-        with:
-          path: ~/.composer/cache
-          key: composer-php${{ matrix.php }}
+      - name: Run tests
+        run: make ci
+        if: matrix.coverage == false
 
-      - uses: actions/checkout@v4
-        with:
-          path: EarlyCopy
+      - name: Run tests with coverage
+        run: make ci-coverage
+        if: matrix.coverage == true
 
-      - name: Install MediaWiki
-        if: steps.cache-mediawiki.outputs.cache-hit != 'true'
-        working-directory: ~
-        run: bash EarlyCopy/.github/workflows/installWiki.sh ${{ matrix.mw }} SemanticScribunto
-
-      - uses: actions/checkout@v4
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v4
         with:
-          path: mediawiki/extensions/SemanticScribunto
-
-      - name: Composer update
-        run: composer update
-
-      - name: run update.php
-        run: php maintenance/update.php --quick
-
-      - if: env.TYPE != 'coverage'
-        name: Run PHPUnit w/o coverage
-        run: php tests/phpunit/phpunit.php -c extensions/SemanticScribunto/ --testsuite semantic-scribunto-unit
-
-      - if: env.TYPE == 'coverage'
-        name: Run PHPUnit w/ coverage
-        run: php tests/phpunit/phpunit.php -c extensions/SemanticScribunto/ --testsuite semantic-scribunto-unit --coverage-clover coverage.clover
-
-      - if: env.TYPE == 'coverage'
-        name: upload coverage report
-        working-directory: ~
-        run: bash EarlyCopy/.github/workflows/uploadCoverageReport.sh
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/php/coverage.xml
+        if: matrix.coverage == true

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "build"]
+	path = build
+	url = https://github.com/gesinn-it-pub/docker-compose-ci.git

.phpcs.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<ruleset>
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
+		<exclude name="Generic.Files.LineLength.TooLong" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
+		<exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.NoParamType" />
+		<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
+		<exclude name="Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition" /> 
+		<exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
+		<exclude name="Generic.CodeAnalysis.AssignmentInCondition.Found" />
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationProtected" />
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPublic" />
+		<exclude name="MediaWiki.PHPUnit.AssertEmpty.AssertEmptyUsed" />
+		<exclude name="Squiz.Operators.ValidLogicalOperators.NotAllowed" />
+		<exclude name="Generic.ControlStructures.DisallowYodaConditions.Found" />
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.WrongStyle" />
+		<exclude name="Generic.Files.OneObjectStructurePerFile.MultipleFound" />
+		<exclude name="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix" />
+		<exclude name="MediaWiki.Usage.ExtendClassUsage.FunctionConfigUsage" />
+		<exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgContLang" />
+		<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
+		<exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
+        <exclude name="Universal.WhiteSpace.CommaSpacing" />
+        <exclude name="MediaWiki.Commenting.MissingCovers.MissingCovers" />
+	</rule>
+	<rule ref="MediaWiki.NamingConventions.ValidGlobalName">
+		<properties>
+			<property name="allowedPrefixes" type="array" value="eg,wg" />
+		</properties>
+	</rule>
+	<rule ref="MediaWiki.Commenting.FunctionComment.ObjectTypeHintReturn">
+		<severity>0</severity>
+	</rule>
+	<file>.</file>
+	<exclude-pattern>/(vendor|conf)/</exclude-pattern>
+	<exclude-pattern type="relative">extensions/*</exclude-pattern>
+	<arg name="extensions" value="php"/>
+	<arg name="encoding" value="UTF-8"/>
+</ruleset>

Makefile

@@ -0,0 +1,33 @@
+-include .env
+export
+
+# setup for docker-compose-ci build directory
+# delete "build" directory to update docker-compose-ci
+
+ifeq (,$(wildcard ./build/))
+    $(shell git submodule update --init --remote)
+endif
+
+EXTENSION=SemanticScribunto
+
+# docker images
+MW_VERSION?=1.39
+PHP_VERSION?=8.1
+DB_TYPE?=mysql
+DB_IMAGE?="mariadb:10"
+
+# extensions
+SMW_VERSION?=dev-master
+SCRIBUNTO_VERSION?=REL1_39
+
+# composer
+# Enables "composer update" inside of extension
+COMPOSER_EXT?=true
+
+# nodejs
+# Enables node.js related tests and "npm install"
+# NODE_JS?=true
+
+# check for build dir and git submodule init if it does not exist
+include build/Makefile
+

codecov.yml

@@ -0,0 +1,2 @@
+fixes:
+  - "/var/www/html/extensions/SemanticScribunto/::"