Add github actions (#407)

.github/workflows/moodle-ci.yml

@@ -0,0 +1,120 @@
+name: Moodle Plugin CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+
+    services:
+      postgres:
+        image: postgres:9.6
+        env:
+          POSTGRES_USER: 'postgres'
+          POSTGRES_HOST_AUTH_METHOD: 'trust'
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
+      mariadb:
+        image: mariadb:10
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - php: '7.4'
+            moodle-branch: 'MOODLE_310_STABLE'
+            database: pgsql
+          - php: '7.4'
+            moodle-branch: 'MOODLE_310_STABLE'
+            database: mariadb
+          - php: '7.2'
+            moodle-branch: 'MOODLE_310_STABLE'
+            database: pgsql
+          - php: '7.2'
+            moodle-branch: 'MOODLE_310_STABLE'
+            database: mariadb
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+          path: plugin
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
+          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
+          sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
+
+      - name: Install moodle-plugin-ci
+        run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+          MUSTACHE_IGNORE_NAMES: 'mobile_*.mustache'
+
+      - 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 --max-warnings 0
+
+      - 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
+          cd moodle
+          vendor/bin/phpunit --fail-on-risky --disallow-test-output -v admin/tool/dataprivacy/tests/metadata_registry_test.php
+          vendor/bin/phpunit --fail-on-risky --disallow-test-output -v lib/tests/externallib_test.php
+          vendor/bin/phpunit --fail-on-risky --disallow-test-output -v privacy/tests/provider_test.php
+
+      - name: Behat features
+        if: ${{ always() }}
+        run: moodle-plugin-ci behat --profile chrome

backup/moodle2/restore_customcert_activity_task.class.php

@@ -75,8 +75,8 @@ class restore_customcert_activity_task extends restore_activity_task {
     }
 
     /**
-     * Define the restore log rules that will be applied by the {@link restore_logs_processor} when restoring
+     * Define the restore log rules that will be applied by the {@see restore_logs_processor} when restoring
-     * customcert logs. It must return one array of {@link restore_log_rule} objects.
+     * customcert logs. It must return one array of {@see restore_log_rule} objects.
      *
      * @return array the restore log rules
      */

classes/event/course_module_viewed.php

@@ -43,10 +43,20 @@ class course_module_viewed extends \core\event\course_module_viewed {
         parent::init();
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return string[]
+     */
     public static function get_objectid_mapping() {
         return array('db' => 'customcert', 'restore' => 'customcert');
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return bool
+     */
     public static function get_other_mapping() {
         // No need to map.
         return false;

tests/behat/behat_mod_customcert.php

@@ -40,7 +40,7 @@ class behat_mod_customcert extends behat_base {
     /**
      * Adds an element to the specified page of a template.
      *
-     * @codingStandardsIgnoreLine
+     * phpcs:ignore
      * @Given /^I add the element "(?P<element_name>(?:[^"]|\\")*)" to page "(?P<page_number>\d+)" of the "(?P<template_name>(?:[^"]|\\")*)" certificate template$/
      * @param string $elementname
      * @param int $pagenum