Fix Moodle plugin CI errors

microsoft · Nov 19, 2024 · ca24f21 · ca24f21
1 parent 749cfa9
commit ca24f21
Show file tree

Hide file tree

Showing 101 changed files with 1,292 additions and 1,187 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -0,0 +1,86 @@
+services:
+  - name: selenium/standalone-chrome:3
+    alias: behat
+  - name: mysql:8.0
+    alias: db
+    command:
+      - '--character-set-server=utf8mb4'
+      - '--collation-server=utf8mb4_unicode_ci'
+      - '--innodb_file_per_table=On'
+      - '--wait-timeout=28800'
+      - '--skip-log-bin'
+
+cache:
+  paths:
+    - .cache
+
+variables:
+  DEBIAN_FRONTEND: 'noninteractive'
+  COMPOSER_ALLOW_SUPERUSER: 1
+  COMPOSER_CACHE_DIR: "$CI_PROJECT_DIR/.cache/composer"
+  NPM_CONFIG_CACHE: "$CI_PROJECT_DIR/.cache/npm"
+  CI_BUILD_DIR: '/tmp/plugin'
+  MOODLE_BRANCH: 'MOODLE_405_STABLE'
+  MOODLE_BEHAT_WWWROOT: 'http://localhost:8000'
+  MOODLE_BEHAT_WDHOST: 'http://behat:4444/wd/hub'
+  MOODLE_START_BEHAT_SERVERS: 'no'
+  MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+  DB: 'mysqli'
+
+stages:
+  - moodle-plugin-ci
+
+.setupandruncheck: &setupandruncheck
+  stage: moodle-plugin-ci
+  before_script:
+    - mkdir -pv "$CI_BUILD_DIR"
+    - cp -ru "$CI_PROJECT_DIR/"* "$CI_BUILD_DIR"
+    - mkdir -p /usr/share/man/man1 /usr/share/man/man3 /usr/share/man/man7
+    - apt-get -qq update
+    - apt-get -yqq install --no-install-suggests default-jre-headless default-mysql-client
+    - 'curl -sS https://raw.githubusercontent.com/creationix/nvm/v0.39.3/install.sh | bash'
+    - . ~/.bashrc
+    - nvm install --default --latest-npm lts/gallium
+    - 'curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer'
+    - composer create-project -n --no-dev --no-progress --no-ansi moodlehq/moodle-plugin-ci /opt/mci ^4
+    - export PATH="/opt/mci/bin:/opt/mci/vendor/bin:$PATH"
+    - moodle-plugin-ci add-plugin --clone https://github.com/microsoft/moodle-auth_oidc.git --branch $MOODLE_BRANCH
+    - moodle-plugin-ci install --db-host db --db-name moodle
+    - '{ php -S 0.0.0.0:8000 -t "$CI_PROJECT_DIR/moodle" >/dev/null 2>&1 & }'
+    - TXT_RED="\e[31m"
+
+  script:
+    - errors=()
+    - moodle-plugin-ci phplint || errors+=("phplint")
+    - moodle-plugin-ci phpmd || errors+=("phpmd")
+    - moodle-plugin-ci codechecker --max-warnings 0 || errors+=("codechecker")
+    - moodle-plugin-ci phpdoc --max-warnings 0 || errors+=("phpdoc")
+    - moodle-plugin-ci validate || errors+=("validate")
+    - moodle-plugin-ci savepoints || errors+=("savepoints")
+    - moodle-plugin-ci mustache || errors+=("mustache")
+    - moodle-plugin-ci grunt --max-lint-warnings 0 || errors+=("grunt")
+    - moodle-plugin-ci phpunit || errors+=("phpunit")
+    - moodle-plugin-ci behat --auto-rerun 0 --profile chrome || errors+=("behat")
+    - |-
+      if [ ${#errors[@]} -ne 0 ]; then
+        echo -e "${TXT_RED}Check errors: ${errors[@]}";
+        exit 1;
+      fi
+
+php81:
+  tags:
+    - docker
+  image: moodlehq/moodle-php-apache:8.1
+  <<: *setupandruncheck
+
+php82:
+  tags:
+    - docker
+  image: moodlehq/moodle-php-apache:8.2
+  <<: *setupandruncheck
+
+php83:
+  tags:
+    - docker
+  image: moodlehq/moodle-php-apache:8.3
+  <<: *setupandruncheck
diff --git a/.travis.yml b/.travis.yml
diff --git a/classes/adminsetting/tabs.php b/classes/adminsetting/tabs.php
@@ -30,8 +30,6 @@
 use moodle_url;
 use tabobject;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * A tab in the plugin configuration page.
  */
@@ -136,7 +134,7 @@ public function write_setting($data) {
      * @param moodle_url|null $url An explicit URL to use instead of settings page section.
      * @uses $CFG
      */
-    public function addtab($id, $name, moodle_url $url = null) {
+    public function addtab($id, $name, ?moodle_url $url = null) {
         if (empty($url)) {
             $urlparams = [
                 'section' => $this->section,

diff --git a/classes/adminsetting/usersynccreationrestriction.php b/classes/adminsetting/usersynccreationrestriction.php
@@ -72,8 +72,8 @@ public function __construct($name, $visiblename, $description, $defaultsetting)
         ];
         $order = 0;
         while ($order++ < 15) {
-            $this->remotefields['extensionAttribute' . $order] = get_string('settings_fieldmap_field_extensionattribute', 'auth_oidc',
-                $order);
+            $this->remotefields['extensionAttribute' . $order] = get_string('settings_fieldmap_field_extensionattribute',
+                'auth_oidc', $order);
         }
 
         return parent::__construct($name, $visiblename, $description, $defaultsetting);

diff --git a/classes/adminsetting/usersyncoptions.php b/classes/adminsetting/usersyncoptions.php
@@ -83,18 +83,18 @@ public function __construct($name, $visiblename, $description) {
      */
     public function output_html($data, $query = '') {
         global $OUTPUT;
-        if (!$this->load_choices() or empty($this->choices)) {
+        if (!$this->load_choices() || empty($this->choices)) {
             return '';
         }
         $default = $this->get_defaultsetting();
         if (is_null($default)) {
-            $default = array();
+            $default = [];
         }
         if (is_null($data)) {
-            $data = array();
+            $data = [];
         }
-        $options = array();
-        $defaults = array();
+        $options = [];
+        $defaults = [];
         foreach ($this->choices as $key => $description) {
             if (!empty($data[$key])) {
                 $checked = 'checked="checked"';

diff --git a/classes/adminsetting/verifysetup.php b/classes/adminsetting/verifysetup.php
@@ -87,14 +87,10 @@ public function output_html($data, $query = '') {
         if (\local_o365\adminsetting\detectoidc::setup_step_complete() === true) {
             $existingsetting = $this->config_read($this->name);
             if (!empty($existingsetting)) {
-                $messageattrs = [
-                    'class' => 'permmessage'
-                ];
+                $messageattrs = ['class' => 'permmessage'];
                 $message = \html_writer::tag('span', get_string('settings_detectperms_valid', 'local_o365'), $messageattrs);
             } else {
-                $messageattrs = [
-                    'class' => 'permmessage'
-                ];
+                $messageattrs = ['class' => 'permmessage'];
                 $message = \html_writer::tag('span', get_string('settings_detectperms_invalid', 'local_o365'), $messageattrs);
             }
         } else {

diff --git a/classes/event/api_call_failed.php b/classes/event/api_call_failed.php
@@ -25,8 +25,6 @@
 
 namespace local_o365\event;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Event fired whenever a user subscribes to a calendar.
  */

diff --git a/classes/event/calendar_subscribed.php b/classes/event/calendar_subscribed.php
@@ -25,8 +25,6 @@
 
 namespace local_o365\event;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Event fired whenever a user subscribes to a calendar.
  */

diff --git a/classes/event/calendar_unsubscribed.php b/classes/event/calendar_unsubscribed.php
@@ -25,8 +25,6 @@
 
 namespace local_o365\event;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Event fired whenever a user unsubscribes from a calendar.
  */

diff --git a/classes/feature/calsync/form/element/calendar.php b/classes/feature/calsync/form/element/calendar.php
@@ -31,6 +31,9 @@
 
 require_once("$CFG->libdir/form/advcheckbox.php");
 
+// phpcs:disable moodle.NamingConventions.ValidVariableName.VariableNameLowerCase -- Parent class uses uppercase variable names.
+// phpcs:disable moodle.NamingConventions.ValidFunctionName.LowercaseMethod -- Parent class uses uppercase method names.
+
 /**
  * Calendar form element. Provides checkbox to enable/disable calendar and options for sync behavior.
  */
@@ -50,15 +53,15 @@ class calendar extends \HTML_QuickForm_advcheckbox {
     /**
      * Constructor, accessed through __call constructor workaround.
      *
-     * @param string $elementName The name of the element.
-     * @param string $elementLabel The label of the element.
+     * @param string $elementname The name of the element.
+     * @param string $elementlabel The label of the element.
      * @param string $text Text that appears after the checkbox.
      * @param array $attributes Array of checkbox attributes.
      * @param array $customdata Array of form custom data.
      */
-    public function calendarconstruct($elementName = null, $elementLabel = null, $text = null, $attributes = null,
+    public function calendarconstruct($elementname = null, $elementlabel = null, $text = null, $attributes = null,
         $customdata = []) {
-        parent::__construct($elementName, $elementLabel, $text, $attributes, null);
+        parent::__construct($elementname, $elementlabel, $text, $attributes, null);
         $this->customdata = $customdata;
         $this->_type = 'advcheckbox';
     }
@@ -112,7 +115,7 @@ public function setValue($value) {
      *
      * @return string html for help button
      */
-    function getHelpButton(){
+    public function getHelpButton() {
         return $this->_helpbutton;
     }
 
@@ -183,3 +186,6 @@ public function toHtml() {
         return $html;
     }
 }
+
+// phpcs:enable moodle.NamingConventions.ValidVariableName.VariableNameLowerCase
+// phpcs:enable moodle.NamingConventions.ValidFunctionName.LowercaseMethod
diff --git a/classes/feature/calsync/form/subscriptions.php b/classes/feature/calsync/form/subscriptions.php
@@ -112,11 +112,11 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
             $newsetting = [
                     'user_id' => $USER->id,
                     'o365calid' => $sitecalenderid,
-                    'timecreated' => time()
+                    'timecreated' => time(),
             ];
             $newsetting['id'] = $DB->insert_record('local_o365_calsettings', (object)$newsetting);
         } else if (empty($fromform->settingcal) && !empty($usersetting)) {
-            $DB->delete_records('local_o365_calsettings', array('user_id' => $USER->id));
+            $DB->delete_records('local_o365_calsettings', ['user_id' => $USER->id]);
         }
 
         // Determine and organize existing subscriptions.
@@ -176,7 +176,7 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
                 $eventdata = [
                     'objectid' => $currentcaldata[$caltype]['recid'],
                     'userid' => $USER->id,
-                    'other' => ['caltype' => $caltype]
+                    'other' => ['caltype' => $caltype],
                 ];
                 $event = \local_o365\event\calendar_unsubscribed::create($eventdata);
                 $event->trigger();
@@ -202,13 +202,13 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
                             'o365calid' => $syncwith,
                             'syncbehav' => $syncbehav,
                             'isprimary' => ($syncwith == $primarycalid) ? '1' : '0',
-                            'timecreated' => time()
+                            'timecreated' => time(),
                         ];
                         $newsub['id'] = $DB->insert_record('local_o365_calsub', (object)$newsub);
                         $eventdata = [
                             'objectid' => $newsub['id'],
                             'userid' => $USER->id,
-                            'other' => ['caltype' => $caltype]
+                            'other' => ['caltype' => $caltype],
                         ];
                     } else {
                         // Already subscribed, update behavior.
@@ -222,7 +222,7 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
                         $eventdata = [
                             'objectid' => $currentcaldata[$caltype]['recid'],
                             'userid' => $USER->id,
-                            'other' => ['caltype' => $caltype]
+                            'other' => ['caltype' => $caltype],
                         ];
                     }
                     $event = \local_o365\event\calendar_subscribed::create($eventdata);
@@ -241,13 +241,13 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
             }
         }
         $todelete = (empty($fromform->settingcal)) ? $existingcoursesubs : array_diff_key($existingcoursesubs, $newcoursesubs);
-        $toadd = (empty($fromform->settingcal)) ? array() : array_diff_key($newcoursesubs, $existingcoursesubs);
+        $toadd = (empty($fromform->settingcal)) ? [] : array_diff_key($newcoursesubs, $existingcoursesubs);
         foreach ($todelete as $courseid => $unused) {
             $DB->delete_records('local_o365_calsub', ['user_id' => $USER->id, 'caltype' => 'course', 'caltypeid' => $courseid]);
             $eventdata = [
                 'objectid' => $USER->id,
                 'userid' => $USER->id,
-                'other' => ['caltype' => 'course', 'caltypeid' => $courseid]
+                'other' => ['caltype' => 'course', 'caltypeid' => $courseid],
             ];
             $event = \local_o365\event\calendar_unsubscribed::create($eventdata);
             $event->trigger();
@@ -273,7 +273,7 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
                 $eventdata = [
                     'objectid' => $USER->id,
                     'userid' => $USER->id,
-                    'other' => ['caltype' => 'course', 'caltypeid' => $courseid]
+                    'other' => ['caltype' => 'course', 'caltypeid' => $courseid],
                 ];
                 $event = \local_o365\event\calendar_subscribed::create($eventdata);
                 $event->trigger();
@@ -297,7 +297,7 @@ public static function update_subscriptions($fromform, $primarycalid, $cancreate
                     $eventdata = [
                         'objectid' => $USER->id,
                         'userid' => $USER->id,
-                        'other' => ['caltype' => 'course', 'caltypeid' => $courseid]
+                        'other' => ['caltype' => 'course', 'caltypeid' => $courseid],
                     ];
                     $event = \local_o365\event\calendar_subscribed::create($eventdata);
                     $event->trigger();
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,8 +25,6 @@ @@
     namespace local_o365\event;
-    defined('MOODLE_INTERNAL') || die();
     /**
      * Event fired whenever a user subscribes to a calendar.
      */
@@ Expand Down @@