Skip to content

Commit

Permalink
Adding GitHub Actions and information in README.md fixes iarenaza#32.
Browse files Browse the repository at this point in the history
  • Loading branch information
lucaboesch committed Dec 4, 2022
1 parent c667fbe commit 9af2700
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 7 deletions.
115 changes: 115 additions & 0 deletions .github/workflows/moodle-plugin-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
name: Moodle plugin CI
on: [push, pull_request]

jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
php: ['7.4', '8.0']
moodle-branch: ['MOODLE_311_STABLE', 'MOODLE_400_STABLE', 'MOODLE_401_STABLE', 'master']
database: ['mariadb', 'pgsql']

services:
postgres:
image: postgres:14
env:
POSTGRES_USER: 'postgres'
POSTGRES_HOST_AUTH_METHOD: 'trust'
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 3
ports:
- 5432:5432

mariadb:
image: mariadb:10.5
env:
MYSQL_USER: 'root'
MYSQL_ALLOW_EMPTY_PASSWORD: "true"
MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3

steps:
- name: Checkout
uses: actions/checkout@v3
with:
path: plugin

- name: Setup PHP ${{ matrix.php }}
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: ${{ matrix.extensions }}
ini-values: max_input_vars=5000
coverage: none

- name: Deploy moodle-plugin-ci
run: |
composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
# Add dirs to $PATH
echo $(cd ci/bin; pwd) >> $GITHUB_PATH
echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
# PHPUnit depends on en_AU.UTF-8 locale
sudo locale-gen en_AU.UTF-8
echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
- name: Install Moodle
# Need explicit IP to stop mysql client fail on attempt to use unix socket.
run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
env:
DB: ${{ matrix.database }}
MOODLE_BRANCH: ${{ matrix.moodle-branch }}
IGNORE_PATHS: 'templates/local/mobile'

- name: PHP Lint
if: ${{ always() }}
run: moodle-plugin-ci phplint

- name: PHP Copy/Paste Detector
continue-on-error: true # This step will show errors but will not fail
if: ${{ always() }}
run: moodle-plugin-ci phpcpd

- name: PHP Mess Detector
continue-on-error: true # This step will show errors but will not fail
if: ${{ always() }}
run: moodle-plugin-ci phpmd

- name: Moodle Code Checker
if: ${{ always() }}
run: moodle-plugin-ci codechecker

- name: Moodle PHPDoc Checker
if: ${{ always() }}
run: moodle-plugin-ci phpdoc

- name: Validating
if: ${{ always() }}
run: moodle-plugin-ci validate

- name: Check upgrade savepoints
if: ${{ always() }}
run: moodle-plugin-ci savepoints

- name: Mustache Lint
if: ${{ always() }}
run: moodle-plugin-ci mustache

- name: Grunt
if: ${{ always() }}
run: moodle-plugin-ci grunt --max-lint-warnings 0

- name: PHPUnit tests
if: ${{ always() }}
run: moodle-plugin-ci phpunit

- name: Behat features
if: ${{ always() }}
run: moodle-plugin-ci behat --profile chrome
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# To Install it manually #
moodle-filter_multilang2
========================


[![Latest Release](https://img.shields.io/github/v/release/iarenaza/moodle-filter_multilang2?sort=semver&color=orange)](https://github.com/iarenaza/moodle-filter_multilang2/releases)
[![Moodle Plugin
CI](https://github.com/iarenaza/moodle-filter_multilang2/workflows/Moodle%20plugin%20CI/badge.svg?branch=master)](https://github.com/iarenaza/moodle-filter_multilang2/actions?query=workflow%3A%22Moodle+plugin+CI%22+branch%3Amaster)

#
To Install it manually #
- Unzip the plugin in the moodle .../filter/ directory.

# To Enable it #
Expand Down
2 changes: 0 additions & 2 deletions classes/privacy/provider.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

namespace filter_multilang2\privacy;

defined('MOODLE_INTERNAL') || die();

/**
* Privacy Subsystem for filter_multilang2 implementing null_provider.
*
Expand Down
2 changes: 0 additions & 2 deletions filter.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

defined('MOODLE_INTERNAL') || die();

/**
* Given multilinguage text, return relevant text according to current language.
*
Expand Down
9 changes: 7 additions & 2 deletions tests/filter_test.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace filter_multilang2;

use filter_multilang2;

defined('MOODLE_INTERNAL') || die();

global $CFG;
Expand All @@ -42,8 +46,9 @@
* @copyright 2014 Damyon Wiese
* @copyright 2016 Iñaki Arenaza & Mondragon Unibertsitatea
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers filter_multilang2
*/
class filter_multilang2_testcase extends advanced_testcase {
class filter_test extends \advanced_testcase {

/** @var object The filter plugin object to perform the tests on */
protected $filter;
Expand All @@ -56,7 +61,7 @@ class filter_multilang2_testcase extends advanced_testcase {
protected function setUp():void {
parent::setUp();
$this->resetAfterTest(true);
$this->filter = new filter_multilang2(context_system::instance(), array());
$this->filter = new filter_multilang2(\context_system::instance(), array());
}

/**
Expand Down

0 comments on commit 9af2700

Please # to comment.