Merge pull request #1073 from moodle-an-hochschulen/issue-1014

Make codechecker happy again

Author: abias

.github/workflows/moodle-plugin-ci.yml

@@ -1,130 +1,23 @@
 name: Moodle Plugin CI
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      moodle-core-branch:
+        description: 'Moodle core branch to test against (if not provided, the branch will be auto-detected)'
+        required: false
+        type: string
+  repository_dispatch:
+    types: [moodle-plugin-ci]
 
 jobs:
-  test:
-    runs-on: ubuntu-22.04
-
-    services:
-      postgres:
-        image: postgres:14
-        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"
-          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
-
-    strategy:
-      fail-fast: false
-      matrix:
-        php: ['8.2', '8.3', '8.4']
-        moodle-branch: ['MOODLE_500_STABLE']
-        database: [pgsql, mariadb]
-
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-        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: Initialise moodle-plugin-ci
-        run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
-          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 }}
-
-      - name: PHP Lint
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phplint
-
-      - name: PHP Mess Detector
-        continue-on-error: true # This step will show errors but will not fail
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phpmd
-
-      - name: Moodle Code Checker
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phpcs --max-warnings 0
-
-      - name: Boost Union Code Checker
-        uses: JJ/github-pr-contains-action@releases/v14
-        if: ${{ !cancelled() }}
-        with:
-          github-token: ${{github.token}}
-          diffDoesNotContain: "theme->settings->"
-
-      - name: Moodle PHPDoc Checker
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phpdoc --max-warnings 0
-
-      - name: Validating
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci validate
-
-      - name: Check upgrade savepoints
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci savepoints
-
-      - name: Mustache Lint
-        continue-on-error: true # This step will show errors but will not fail
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci mustache
-
-      - name: Grunt
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci grunt --max-lint-warnings 0
-
-      - name: PHPUnit tests
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phpunit --fail-on-warning
-
-      - name: Raise Behat timeout (Required for theme_boost_union_general.feature)
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci add-config '$CFG->behat_increasetimeout = 3;'
-
-      - name: Behat features
-        id: behat
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci behat --profile chrome --suite boost_union
-
-      - name: Upload Behat Faildump
-        if: ${{ failure() && steps.behat.outcome == 'failure' }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: Behat Faildump (${{ join(matrix.*, ', ') }})
-          path: ${{ github.workspace }}/moodledata/behat_dump
-          retention-days: 7
-          if-no-files-found: ignore
-
-      - name: Mark cancelled jobs as failed.
-        if: ${{ cancelled() }}
-        run: exit 1
+  moodle-plugin-ci:
+    uses: moodle-an-hochschulen/moodle-workflows/.github/workflows/moodle-plugin-ci.yml@main
+    with:
+      moodle-core-branch: ${{ inputs.moodle-core-branch || github.event.client_payload.moodle-core-branch }}
+      pr-check-diff-does-not-contain: "theme->settings->"
+      behat-suite: "boost_union"
+      behat-timeout: 3 # Required for theme_boost_union_general.feature
+      mustache-continue-on-error: true

.github/workflows/moodle-release.yml

@@ -1,66 +1,17 @@
-#
-# Whenever a new tag starting with "v" is pushed, add the tagged version
-# to the Moodle Plugins directory at https://moodle.org/plugins
-#
-# revision: 2021070201
-#
-name: Releasing in the Plugins directory
+  name: Moodle Plugin Release
 
-on:
-  push:
-    tags:
-      - v*
+  on:
+    push:
+      tags:
+        - v*
+    workflow_dispatch:
+      inputs:
+        tag:
+          description: 'Git tag to be released'
+          required: true
 
-  workflow_dispatch:
-    inputs:
-      tag:
-        description: 'Tag to be released'
-        required: true
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  release-at-moodle-org:
-    runs-on: ubuntu-latest
-    env:
-      PLUGIN: theme_boost_union
-      CURL: curl -s
-      ENDPOINT: https://moodle.org/webservice/rest/server.php
-      TOKEN: ${{ secrets.MOODLE_ORG_TOKEN }}
-      FUNCTION: local_plugins_add_version
-
-    steps:
-      - name: Call the service function
-        id: add-version
-        run: |
-          if [[ ! -z "${{ github.event.inputs.tag }}" ]]; then
-            TAGNAME="${{ github.event.inputs.tag }}"
-          elif [[ $GITHUB_REF = refs/tags/* ]]; then
-            TAGNAME="${GITHUB_REF##*/}"
-          fi
-          if [[ -z "${TAGNAME}" ]]; then
-            echo "No tag name has been provided!"
-            exit 1
-          fi
-          ZIPURL="https://api.github.com/repos/${{ github.repository }}/zipball/${TAGNAME}"
-          RESPONSE=$(${CURL} ${ENDPOINT} --data-urlencode "wstoken=${TOKEN}" \
-                                         --data-urlencode "wsfunction=${FUNCTION}" \
-                                         --data-urlencode "moodlewsrestformat=json" \
-                                         --data-urlencode "frankenstyle=${PLUGIN}" \
-                                         --data-urlencode "zipurl=${ZIPURL}" \
-                                         --data-urlencode "vcssystem=git" \
-                                         --data-urlencode "vcsrepositoryurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \
-                                         --data-urlencode "vcstag=${TAGNAME}" \
-                                         --data-urlencode "changelogurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commits/${TAGNAME}" \
-                                         --data-urlencode "altdownloadurl=${ZIPURL}")
-          echo "response=${RESPONSE}" >> $GITHUB_OUTPUT
-
-      - name: Evaluate the response
-        id: evaluate-response
-        env:
-          RESPONSE: ${{ steps.add-version.outputs.response }}
-        run: |
-          jq <<< ${RESPONSE}
-          jq --exit-status ".id" <<< ${RESPONSE} > /dev/null
+  jobs:
+    release:
+      uses: moodle-an-hochschulen/moodle-workflows/.github/workflows/moodle-release.yml@main
+      secrets:
+        MOODLE_ORG_TOKEN: ${{ secrets.MOODLE_ORG_TOKEN }}

CHANGES.md

@@ -6,6 +6,8 @@ Changes
 
 ### Unreleased
 
+* 2025-10-15 - Make codechecker happy again
+* 2025-10-15 - Tests: Switch Github actions workflows to reusable workflows by Moodle an Hochschulen e.V.
 * 2025-10-20 - Tests: Add tests for Boost Union features which might but must not affect other active themes, resolves #761
 * 2025-10-16 - Feature: Add Bootstrap alert to Boost Union settings if Boost Union (or Boost Union Child) is not the active theme, resolves #773.
 * 2025-10-15 - Improvement: On course cards, display the course fields as Bootstrap badges, resolves #1070

accessibility/declaration.php

@@ -29,8 +29,8 @@
 require(__DIR__ . '/../../../config.php'); // phpcs:disable moodle.Files.RequireLogin.Missing
 
 // Require the necessary libraries.
-require_once($CFG->dirroot.'/theme/boost_union/lib.php');
-require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
+require_once($CFG->dirroot . '/theme/boost_union/lib.php');
+require_once($CFG->dirroot . '/theme/boost_union/locallib.php');
 
 // Set page URL.
 $PAGE->set_url('/theme/boost_union/accessibility/declaration.php');
@@ -50,8 +50,10 @@
 // If the declaration of accessibility page is disabled, we just show a short friendly warning page and are done.
 if ($config->enableaccessibilitydeclaration != THEME_BOOST_UNION_SETTING_SELECT_YES) {
     echo $OUTPUT->header();
-    $notification = new \core\output\notification(get_string('accessibilitydeclarationdisabled', 'theme_boost_union'),
-        \core\output\notification::NOTIFY_INFO);
+    $notification = new \core\output\notification(
+        get_string('accessibilitydeclarationdisabled', 'theme_boost_union'),
+        \core\output\notification::NOTIFY_INFO
+    );
     $notification->set_show_closebutton(false);
     echo $OUTPUT->render($notification);
     echo $OUTPUT->footer();

accessibility/support.php

@@ -29,8 +29,8 @@
 require(__DIR__ . '/../../../config.php'); // phpcs:disable moodle.Files.RequireLogin.Missing
 
 // Require the necessary libraries.
-require_once($CFG->dirroot.'/theme/boost_union/lib.php');
-require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
+require_once($CFG->dirroot . '/theme/boost_union/lib.php');
+require_once($CFG->dirroot . '/theme/boost_union/locallib.php');
 
 // Set page URL.
 $PAGE->set_url('/theme/boost_union/accessibility/support.php');
@@ -50,17 +50,21 @@
 // If the accessibility support page is disabled, we just show a short friendly warning page and are done.
 if ($config->enableaccessibilitysupport != THEME_BOOST_UNION_SETTING_SELECT_YES) {
     echo $OUTPUT->header();
-    $notification = new \core\output\notification(get_string('accessibilitysupportdisabled', 'theme_boost_union'),
-        \core\output\notification::NOTIFY_INFO);
+    $notification = new \core\output\notification(
+        get_string('accessibilitysupportdisabled', 'theme_boost_union'),
+        \core\output\notification::NOTIFY_INFO
+    );
     $notification->set_show_closebutton(false);
     echo $OUTPUT->render($notification);
     echo $OUTPUT->footer();
     die;
 }
 
 // If user login is required, we redirect to the login page.
-if (isset($config->allowaccessibilitysupportwithoutlogin) &&
-        $config->allowaccessibilitysupportwithoutlogin != THEME_BOOST_UNION_SETTING_SELECT_YES) {
+if (
+    isset($config->allowaccessibilitysupportwithoutlogin) &&
+        $config->allowaccessibilitysupportwithoutlogin != THEME_BOOST_UNION_SETTING_SELECT_YES
+) {
     if (!isloggedin() || isguestuser()) {
         redirect(get_login_url());
     }
@@ -114,7 +118,7 @@
 
     // Compose the mail content from form data.
     $subjectprefix = get_string('accessibilitysupportusermailsubject', 'theme_boost_union');
-    $subject = '['.$subjectprefix.'] '.$data->subject;
+    $subject = '[' . $subjectprefix . '] ' . $data->subject;
     $renderer = $PAGE->get_renderer('core');
     $message = $renderer->render_from_template('theme_boost_union/accessibility-support-email-body', $data);
 

classes/admin_externalpage_tabs.php

@@ -34,7 +34,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class admin_externalpage_tabs {
-
     /**
      * @var array Holds the tabs in this tab tree.
      */

classes/admin_setting_configdatetime.php

@@ -39,7 +39,6 @@
  * them as an array named after $name (so we only use $name2 internally for the setting)
  */
 class admin_setting_configdatetime extends \admin_setting {
-
     /**
      * Get the selected time.
      *
@@ -86,52 +85,52 @@ public function output_html($data, $query = '') {
         $default = $this->get_defaultsetting();
 
         if (is_array($default)) {
-            $defaultinfo = $default['y'].'-'.$default['M'].'-'.$default['d'].' '.$default['h'].':'.$default['m'];
+            $defaultinfo = $default['y'] . '-' . $default['M'] . '-' . $default['d'] . ' ' . $default['h'] . ':' . $default['m'];
         } else {
             $defaultinfo = null;
         }
 
         $return = '<div class="form-datetime defaultsnext">';
 
-        $return .= '<select id="'.$this->get_id().'y" name="'.$this->get_full_name().
+        $return .= '<select id="' . $this->get_id() . 'y" name="' . $this->get_full_name() .
                 '[y]" class="form-select d-inline-block me-2">';
         for ($i = 2020; $i <= date("Y") + 10; $i++) {
-            $return .= '<option value="'.$i.'"'.($i == $data['y'] ? ' selected="selected"' : '').'>'.$i.'</option>';
+            $return .= '<option value="' . $i . '"' . ($i == $data['y'] ? ' selected="selected"' : '') . '>' . $i . '</option>';
         }
         $return .= '</select>';
 
-        $return .= '<select id="'.$this->get_id().'M" name="'.$this->get_full_name().
+        $return .= '<select id="' . $this->get_id() . 'M" name="' . $this->get_full_name() .
                 '[M]" class="form-select d-inline-block me-2">';
         for ($i = 1; $i <= 12; $i++) {
             $sel = ($i == $data['M'] ? ' selected="selected"' : '');
             $dateobj = \DateTime::createFromFormat('!m', $i);
-            $return .= '<option value="'.$i.'"'.$sel.'>'.userdate($dateobj->getTimestamp(), '%B').'</option>';
+            $return .= '<option value="' . $i . '"' . $sel . '>' . userdate($dateobj->getTimestamp(), '%B') . '</option>';
         }
         $return .= '</select>';
 
-        $return .= '<select id="'.$this->get_id().'d" name="'.$this->get_full_name().
+        $return .= '<select id="' . $this->get_id() . 'd" name="' . $this->get_full_name() .
                 '[d]" class="form-select d-inline-block me-2">';
         for ($i = 1; $i <= 31; $i++) {
             $sel = ($i == $data['d'] ? ' selected="selected"' : '');
-            $return .= '<option value="'.$i.'"'.$sel.'>'.sprintf('%02d', $i).'</option>';
+            $return .= '<option value="' . $i . '"' . $sel . '>' . sprintf('%02d', $i) . '</option>';
         }
         $return .= '</select>';
 
-        $return .= '<select id="'.$this->get_id().'h" name="'.$this->get_full_name().
+        $return .= '<select id="' . $this->get_id() . 'h" name="' . $this->get_full_name() .
                 '[h]" class="form-select d-inline-block me-1">';
         for ($i = 0; $i < 24; $i++) {
             $sel = ($i == $data['h'] ? ' selected="selected"' : '');
-            $return .= '<option value="'.$i.'"'.$sel.'>'.sprintf('%02d', $i).'</option>';
+            $return .= '<option value="' . $i . '"' . $sel . '>' . sprintf('%02d', $i) . '</option>';
         }
         $return .= '</select>';
 
         $return .= '<span class="me-1">:</span>';
 
-        $return .= '<select id="'.$this->get_id().'m" name="'.$this->get_full_name().
+        $return .= '<select id="' . $this->get_id() . 'm" name="' . $this->get_full_name() .
                 '[m]" class="form-select d-inline-block me-2">';
         for ($i = 0; $i < 60; $i += 5) {
             $sel = ($i == $data['m'] ? ' selected="selected"' : '');
-            $return .= '<option value="'.$i.'"'.$sel.'>'.sprintf('%02d', $i).'</option>';
+            $return .= '<option value="' . $i . '"' . $sel . '>' . sprintf('%02d', $i) . '</option>';
         }
         $return .= '</select>';
 

classes/admin_setting_configstoredfilealwayscallback.php

@@ -34,7 +34,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class admin_setting_configstoredfilealwayscallback extends \admin_setting_configstoredfile {
-
     // This class is basically a admin_setting_configstoredfile class but which circumvents MDL-59082
     // and triggers the updatecallback everytime the setting is saved regardless if any values have changed.
     // As soon as MDL-59082 is fixed in Moodle core, this class could be removed again.