Behattests one by one (#238)

* behat link to workflowdrafts

* new wf edit header

* change to tab links

* add_workflow.feature

* new line at end of file

* disable_workflow.feature

* new line!

* interaction.feature

* interaction_forms.feature

* exclude hidden courses of remaining course list if user has not capability viewhiddencourses

* manual_trigger.feature

* upload_workflow.feature

* fix settings to work with subplugins correctly

* fix settings problems, subplugin descriptions, version.php of subplugins, counters in the tabs

* codechecker/phpdoc issues

* change ci to test only against 4.5

* behat and php 8.3 issues

* lint issue

* remove additional process class fields for error message table

* fix error writing wf error table

* fix name of uploadfile

* use label of filepicker for testing

Author: bluetom

.github/workflows/config.json

@@ -2,10 +2,6 @@
   "main-moodle": "MOODLE_405_STABLE",
   "main-php": "8.3",
   "moodle-php": {
-    "MOODLE_401_STABLE": ["7.4", "8.1"],
-    "MOODLE_402_STABLE": ["8.0", "8.2"],
-    "MOODLE_403_STABLE": ["8.0", "8.2"],
-    "MOODLE_404_STABLE": ["8.1", "8.3"],
     "MOODLE_405_STABLE": ["8.1", "8.2", "8.3"]
   },
   "moodle-plugin-ci": "4.4.5"

CHANGES.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+4.5.0 (2025-03-13)
+------------------
+* [FEATURE]
+* [FIXED]
+* Moodle 4.5 compatible version

classes/local/form/form_trigger_instance.php

@@ -101,6 +101,8 @@ public function __construct($url, $workflowid, $trigger = null, $subpluginname =
      * Defines forms elements
      */
     public function definition() {
+        global $OUTPUT;
+
         $mform = $this->_form;
 
         $mform->addElement('hidden', 'id'); // Save the record's id.

classes/local/manager/process_manager.php

@@ -25,6 +25,7 @@
 
 use core\event\course_deleted;
 use Exception;
+use stdClass;
 use tool_lifecycle\local\entity\process;
 use tool_lifecycle\event\process_proceeded;
 use tool_lifecycle\event\process_rollback;
@@ -255,7 +256,12 @@ public static function abort_process($process) {
     public static function insert_process_error(process $process, Exception $e) {
         global $DB;
 
-        $procerror = (object) clone $process;
+        $procerror = new stdClass();
+        $procerror->id = $process->id;
+        $procerror->courseid = $process->courseid;
+        $procerror->workflowid = $process->workflowid;
+        $procerror->stepindex = $process->stepindex;
+        $procerror->timestepchanged = $process->timestepchanged;
         $procerror->errormessage = get_class($e) . ': ' . $e->getMessage();
         $procerror->errortrace = $e->getTraceAsString();
         $procerror->errortimecreated = time();
@@ -264,7 +270,7 @@ public static function insert_process_error(process $process, Exception $e) {
             $m .= $v['file'] . ':' . $v['line'] . '::';
         }
         $procerror->errorhash = md5($m);
-        $procerror->waiting = intval($procerror->waiting);
+        $procerror->waiting = intval($process->waiting);
 
         $DB->insert_record_raw('tool_lifecycle_proc_error', $procerror, false, false, true);
         $DB->delete_records('tool_lifecycle_process', ['id' => $process->id]);

classes/local/manager/workflow_manager.php

@@ -233,7 +233,10 @@ public static function get_manual_trigger_tools_for_active_workflows() {
         $tools = [];
         foreach ($triggers as $trigger) {
             $settings = settings_manager::get_settings($trigger->id, settings_type::TRIGGER);
-            $tools[] = new manual_trigger_tool($trigger->id, $settings['icon'], $settings['displayname'], $settings['capability']);
+            if (isset($settings['displayname'])) {
+                $tools[] = new manual_trigger_tool($trigger->id, $settings['icon'],
+                    $settings['displayname'], $settings['capability']);
+            }
         }
         return $tools;
     }

classes/tabs.php

@@ -36,38 +36,98 @@ class tabs {
     /**
      * Generates a Moodle tabrow i.e. an array of tabs
      *
-     * @return array
+     * @param bool $activelink display active workflows tab as link
+     * @param bool $deactivatelink display deactivated workflows tab as link
+     * @param bool $draftlink display draft workflows tab as link
+     * @return array of tabobjects
      * @throws \coding_exception
+     * @throws \dml_exception
      * @throws moodle_exception
      */
-    public static function get_tabrow() {
+    public static function get_tabrow($activelink = false, $deactivatelink = false, $draftlink = false) {
+        global $DB;
 
-        $targeturl = new \moodle_url('/admin/settings.php', ['section' => 'lifecycle']);
+        $classnotnull = 'badge badge-primary badge-pill ml-1';
+        $classnull = 'badge badge-secondary badge-pill ml-1';
+
+        // Get number of drafts.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NULL AND timedeactive IS NULL";
+        $i = $DB->count_records_sql($sql);
+        $drafts = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of active workflows.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NOT NULL";
+        $i = $DB->count_records_sql($sql);
+        $activewf = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of deactivated workflows.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NULL AND timedeactive IS NOT NULL";
+        $i = $DB->count_records_sql($sql);
+        $deactivatedewf = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of delayed courses.
+        $sql = "select count(id)
+        from {tool_lifecycle_delayed}";
+        $i = $DB->count_records_sql($sql);
+        $delayedcourses = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of lifecycle course backups.
+        $sql = "select count(id)
+        from {tool_lifecycle_backups}";
+        $i = $DB->count_records_sql($sql);
+        $coursebackups = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of stores lifecycle errors.
+        $sql = "select count(id)
+        from {tool_lifecycle_proc_error}";
+        $i = $DB->count_records_sql($sql);
+        $lcerrors = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // General Settings and Subplugins.
+        $targeturl = new \moodle_url('/admin/category.php', ['category' => 'lifecycle']);
         $tabrow[] = new \tabobject('settings', $targeturl,
             get_string('general_config_header', 'tool_lifecycle'));
 
+        // Tab to the draft workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/workflowdrafts.php', ['id' => 'workflowdrafts']);
         $tabrow[] = new \tabobject('workflowdrafts', $targeturl,
-            get_string('workflow_drafts_header', 'tool_lifecycle'));
+            get_string('workflow_drafts_header', 'tool_lifecycle').$drafts,
+            get_string('workflow_drafts_header', 'tool_lifecycle'), $draftlink);
 
+        // Tab to the active workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/activeworkflows.php', ['id' => 'activeworkflows']);
         $tabrow[] = new \tabobject('activeworkflows', $targeturl,
-            get_string('active_workflows_header', 'tool_lifecycle'));
+            get_string('active_workflows_header', 'tool_lifecycle').$activewf,
+            get_string('active_workflows_header', 'tool_lifecycle'), $activelink);
 
+        // Tab to the deactivated workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/deactivatedworkflows.php', ['id' => 'deactivatedworkflows']);
         $tabrow[] = new \tabobject('deactivatedworkflows', $targeturl,
-            get_string('deactivated_workflows_header', 'tool_lifecycle'));
-
-        $targeturl = new \moodle_url('/admin/tool/lifecycle/coursebackups.php', ['id' => 'coursebackups']);
-        $tabrow[] = new \tabobject('coursebackups', $targeturl,
-            get_string('course_backups_list_header', 'tool_lifecycle'));
+            get_string('deactivated_workflows_header', 'tool_lifecycle').$deactivatedewf,
+            get_string('deactivated_workflows_header', 'tool_lifecycle'), $deactivatelink);
 
+        // Tab to the delayed courses list page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/delayedcourses.php', ['id' => 'delayedcourses']);
         $tabrow[] = new \tabobject('delayedcourses', $targeturl,
+            get_string('delayed_courses_header', 'tool_lifecycle').$delayedcourses,
             get_string('delayed_courses_header', 'tool_lifecycle'));
 
+        // Tab to the course backups list page.
+        $targeturl = new \moodle_url('/admin/tool/lifecycle/coursebackups.php', ['id' => 'coursebackups']);
+        $tabrow[] = new \tabobject('coursebackups', $targeturl,
+            get_string('course_backups_list_header', 'tool_lifecycle').$coursebackups,
+            get_string('course_backups_list_header', 'tool_lifecycle'));
+
+        // Tab to the lifecycle errors page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/errors.php', ['id' => 'errors']);
         $tabrow[] = new \tabobject('errors', $targeturl,
+            get_string('process_errors_header', 'tool_lifecycle').$lcerrors,
             get_string('process_errors_header', 'tool_lifecycle'));
 
         return $tabrow;

classes/view_controller.php

@@ -52,31 +52,31 @@ class view_controller {
      * @throws \invalid_parameter_exception
      */
     public function handle_view($renderer, $filterdata) {
-        global $DB;
+        global $DB, $USER;
 
-        $courses = get_user_capability_course('tool/lifecycle:managecourses', null, false);
+        $coursesasmanager = get_user_capability_course('tool/lifecycle:managecourses', null, false);
+        $courseids1 = array_column($coursesasmanager, 'id');
+        $usercourses = enrol_get_users_courses($USER->id);
+        $courseids2 = array_column($usercourses, 'id');
+        $courses = array_intersect($courseids1, $courseids2);
         if (!$courses) {
             echo 'no courses';
             // TODO show error.
             return;
         }
 
-        $arrayofcourseids = [];
-        foreach ($courses as $course) {
-            $arrayofcourseids[$course->id] = $course->id;
-        }
-        $listofcourseids = implode(',', $arrayofcourseids);
-
-        $processes = $DB->get_recordset_sql("SELECT p.id as processid, c.id as courseid, c.fullname as coursefullname, " .
-        "c.shortname as courseshortname, s.id as stepinstanceid, s.instancename as stepinstancename, s.subpluginname " .
+        [$insql, $inparams] = $DB->get_in_or_equal($courses);
+        $sql = "SELECT p.id as processid, c.id as courseid, c.fullname as coursefullname, " .
+            "c.shortname as courseshortname, s.id as stepinstanceid, s.instancename as stepinstancename, s.subpluginname " .
             "FROM {tool_lifecycle_process} p join " .
             "{course} c on p.courseid = c.id join " .
             "{tool_lifecycle_step} s ".
             "on p.workflowid = s.workflowid AND p.stepindex = s.sortindex " .
-            "WHERE p.courseid IN (". $listofcourseids . ")");
+            "WHERE p.courseid $insql";
+        $processes = $DB->get_recordset_sql($sql, $inparams);
 
         $requiresinteraction = [];
-        $remainingcourses = $arrayofcourseids;
+        $remainingcourses = $inparams;
 
         foreach ($processes as $process) {
             $step = step_manager::get_step_instance($process->stepinstanceid);

lang/de/tool_lifecycle.php

@@ -150,7 +150,7 @@
 $string['step_settings_header'] = 'Einstellungen des Schritts';
 $string['step_show'] = 'Anzeigen';
 $string['step_sortindex'] = 'Hoch/Runter';
-$string['step_subpluginname'] = 'Subpluginname';
+$string['step_subpluginname'] = 'Schritt Typ';
 $string['step_subpluginname_help'] = 'Name des Schritt/Trigger-Subplugins (nur für Admins sichtbar).';
 $string['step_type'] = 'Typ';
 $string['steps_installed'] = 'Installierte Schritt-Subplugins';
@@ -172,7 +172,7 @@
 $string['trigger_instancename_help'] = 'Titel der Trigger-Instanz (nur sichtbar für Admins).';
 $string['trigger_settings_header'] = 'Einstellungen des Triggers';
 $string['trigger_sortindex'] = 'Hoch/Runter';
-$string['trigger_subpluginname'] = 'Subplugin Name';
+$string['trigger_subpluginname'] = 'Trigger Typ';
 $string['trigger_subpluginname_help'] = 'Name des Schritt/Trigger-Subplugins (nur für Admins sichtbar).';
 $string['trigger_workflow'] = 'Workflow';
 $string['triggers_installed'] = 'Installierte Trigger';

lang/en/tool_lifecycle.php

@@ -182,7 +182,7 @@
 $string['step_settings_header'] = 'Settings of the step';
 $string['step_show'] = 'Show';
 $string['step_sortindex'] = 'Up/Down';
-$string['step_subpluginname'] = 'Subplugin name';
+$string['step_subpluginname'] = 'Step type';
 $string['step_subpluginname_help'] = 'Step subplugin/trigger title (visible for admins only).';
 $string['step_type'] = 'Type';
 $string['steps_installed'] = 'Installed Steps';
@@ -204,7 +204,7 @@
 $string['trigger_instancename_help'] = 'Trigger instance title (visible for admins only).';
 $string['trigger_settings_header'] = 'Settings of the trigger';
 $string['trigger_sortindex'] = 'Up/Down';
-$string['trigger_subpluginname'] = 'Subplugin name';
+$string['trigger_subpluginname'] = 'Trigger type';
 $string['trigger_subpluginname_help'] = 'Step subplugin/trigger title (visible for admins only).';
 $string['trigger_workflow'] = 'Workflow';
 $string['triggers_installed'] = 'Installed Triggers';

settings.php

@@ -30,26 +30,49 @@
 // Check for the moodle/site:config permission.
 if ($hassiteconfig) {
 
-    $settings = new admin_settingpage('lifecycle', get_string('pluginname', 'tool_lifecycle'));
-    $ADMIN->add('tools', $settings);
-
     $triggers = core_component::get_plugin_list('lifecycletrigger');
     $steps = core_component::get_plugin_list('lifecyclestep');
 
+    $ADMIN->add('tools', new admin_category('lifecycle',
+        get_string('pluginname', 'tool_lifecycle')));
+    $settings = new admin_settingpage('lifecycle_settings',
+        get_string('general_config_header', 'tool_lifecycle'));
+
     if (!$ADMIN->fulltree) {
-        // Include settings page of each trigger subplugin, if there is one.
+        $stepsortriggersettings = false;
+        // Check if there are trigger settings pages.
         if ($triggers) {
             foreach ($triggers as $trigger => $path) {
                 if (file_exists($settingsfile = $path . '/settings.php')) {
-                    include($settingsfile);
+                    $stepsortriggersettings = true;
+                    break;
                 }
             }
         }
-        // Include settings page of each step subplugin, if there is one.
-        if ($steps) {
+        // Check if there are step settings pages.
+        if (!$stepsortriggersettings && $steps) {
             foreach ($steps as $step => $path) {
                 if (file_exists($settingsfile = $path . '/settings.php')) {
-                    include($settingsfile);
+                    $stepsortriggersettings = true;
+                    break;
+                }
+            }
+        }
+        if ($stepsortriggersettings) {
+            // Include settings page of each trigger subplugin, if there is one.
+            if ($triggers) {
+                foreach ($triggers as $trigger => $path) {
+                    if (file_exists($settingsfile = $path . '/settings.php')) {
+                        include($settingsfile);
+                    }
+                }
+            }
+            // Include settings page of each step subplugin, if there is one.
+            if ($steps) {
+                foreach ($steps as $step => $path) {
+                    if (file_exists($settingsfile = $path . '/settings.php')) {
+                        include($settingsfile);
+                    }
                 }
             }
         }
@@ -80,10 +103,8 @@
                 get_string('triggers_installed', 'tool_lifecycle'), ''));
             foreach ($triggers as $trigger => $path) {
                 $settings->add(new admin_setting_description('lifecycletriggersetting_'.$trigger,
-                    get_string('pluginname', 'lifecycletrigger_' . $trigger), ''));
-                if (file_exists($settingsfile = $path . '/settings.php')) {
-                    include($settingsfile);
-                }
+                    get_string('pluginname', 'lifecycletrigger_' . $trigger),
+                    get_string('plugindescription', 'lifecycletrigger_' . $trigger)));
             }
         } else {
             $settings->add(new admin_setting_heading('adminsettings_notriggers',
@@ -95,14 +116,13 @@
                 get_string('steps_installed', 'tool_lifecycle'), ''));
             foreach ($steps as $step => $path) {
                 $settings->add(new admin_setting_description('lifecyclestepsetting_'.$step,
-                    get_string('pluginname', 'lifecyclestep_' . $step), ''));
-                if (file_exists($settingsfile = $path . '/settings.php')) {
-                    include($settingsfile);
-                }
+                    get_string('pluginname', 'lifecyclestep_' . $step),
+                    get_string('plugindescription', 'lifecyclestep_' . $step)));
             }
         } else {
             $settings->add(new admin_setting_heading('adminsettings_nosteps',
                 get_string('adminsettings_nosteps', 'tool_lifecycle'), ''));
         }
+        $ADMIN->add('lifecycle', $settings);
     }
 }