Increase impose limit of 1000 chars on expected notes in test cases. (DB update)

Author: sangwinc

db/install.xml

@@ -175,7 +175,7 @@
         <FIELD NAME="prtname" TYPE="char" LENGTH="32" NOTNULL="true" SEQUENCE="false" COMMENT="The name of the PRT for which these are the expected outcomes."/>
         <FIELD NAME="expectedscore" TYPE="number" LENGTH="12" NOTNULL="false" SEQUENCE="false" DECIMALS="7" COMMENT="The expected score."/>
         <FIELD NAME="expectedpenalty" TYPE="number" LENGTH="12" NOTNULL="false" SEQUENCE="false" DECIMALS="7" COMMENT="The expected penalty."/>
-        <FIELD NAME="expectedanswernote" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" COMMENT="The expected answer note."/>
+        <FIELD NAME="expectedanswernote" TYPE="char" LENGTH="1023" NOTNULL="true" SEQUENCE="false" COMMENT="The expected answer note."/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -1035,6 +1035,16 @@ function xmldb_qtype_stack_upgrade($oldversion) {
         // STACK savepoint reached.
         upgrade_plugin_savepoint(true, 2025042500, 'qtype', 'stack');
     }
+
+    if ($oldversion < 2026042402) {
+        $table = new xmldb_table('qtype_stack_qtest_expected');
+        $field = new xmldb_field('expectedanswernote', XMLDB_TYPE_CHAR, '1023', null, XMLDB_NOTNULL, null, null, 'expectedpenalty');
+
+        $dbman->change_field_type($table, $field);
+
+        // STACK savepoint reached.
+        upgrade_plugin_savepoint(true, 2026042402, 'qtype', 'stack');
+    }
     // Add new upgrade blocks just above here.
 
     // Check the version of the Maxima library code that comes with this version

doc/en/STACK_question_admin/Testing.md

@@ -77,6 +77,7 @@ Notes:
 * Some answer tests generate notes which depend on the specific input.  For this reason, when automatically creating test case expectations from particular inputs the notes from the answer test are not included. You can choose to include these notes in the test case expectation manually.
 * We __anchor__ these notes to specify an expected start/end note.   Use the range notations: `[...]` to expect both ends fixed; `(...]` specifies only the final note; `[...)` specifies the start note; `(...)` does not expect a particular start/end note.
 * `(...]`is the default if no anchor wrapping is defined (this retains back compatibility).
+* Expected test cases are limited to 1000 characters.  (Since tags are typically each like `prt1-1-F |` (10 chars), that's a lot of checkable nodes.)
 
 Hence, with the anchored expectation  `[ prt1-1-F | prt1-3-F | prt1-4-F ]` the following will pass as tests.
 

lang/en/qtype_stack.php

@@ -603,6 +603,7 @@
 $string['questiontestsfirst'] = 'Expected first node of {$a->expected} but got {$a->actual}.';
 $string['questiontestslast'] = 'Expected last node of {$a->expected} but got {$a->actual}.';
 $string['questiontestsmissing'] = 'Expected node: {$a}.';
+$string['questiontestslong'] = 'Expected notes are truncated at 1000 characters in the database.  PRT {$a->prt} was {$a->len} characters.  Testcase not saved.';
 $string['runquestiontests'] = 'STACK question dashboard';
 $string['runquestiontests_help'] = 'The dashboard runs question tests which unit-test the questions to ensure the behaviour matches expectations expressed by the teacher, and deployed variants ensure random versions seen by a student are pre-tested against the question tests. These are tools to help you create and test reliable questions and should be used in all cases a question will be used by students.  The dashboard also has numerous other STACK specific functions.';
 $string['runquestiontests_alert'] = 'Question is missing tests or variants.';

questiontestedit.php

@@ -45,6 +45,7 @@
 if ($testcase || $confirmthistestcase) {
     $qtest = question_bank::get_qtype('stack')->load_question_test($questionid, $testcase);
 }
+$errors = [];
 
 // Process any other URL parameters, and do require_login.
 [$context, $seed, $urlparams] = qtype_stack_setup_question_test_page($question);
@@ -164,8 +165,16 @@
             [$data->{$prtname . 'answernote'}]
         ));
     }
+    if (strlen($data->{$prtname . 'answernote'}) > 1000) {
+        $errors[] = stack_string(
+            'questiontestslong',
+            ['prt' => $prtname, 'len' => strlen($data->{$prtname . 'answernote'})]
+            );
+    }
     question_bank::get_qtype('stack')->save_question_test($questionid, $qtest, $testcase);
-    redirect($backurl);
+    if (empty($errors)) {
+        redirect($backurl);
+    }
 }
 
 // Prepare the display options.
@@ -196,6 +205,10 @@
 
 echo html_writer::tag('p', stack_string('testinputsimpwarning'));
 
+if (!empty($errors)) {
+    echo html_writer::tag('div', implode(' ', $errors), ['class' => 'alert alert-danger']);
+}
+
 // Show the form.
 $mform->display();
 echo $OUTPUT->footer();

questiontype.php

@@ -1031,7 +1031,8 @@ public function save_question_test($questionid, stack_question_test $qtest, $tes
                     (float) $expectedresults->penalty
                 );
             }
-            $expected->expectedanswernote = $expectedresults->answernotes[0];
+            // We coerce the score and penalty to be numeric (correct DB type), so we should make sure the note isn't too long.
+            $expected->expectedanswernote = substr($expectedresults->answernotes[0], 0, 1000);
             $DB->insert_record('qtype_stack_qtest_expected', $expected);
         }
 

stack/maxima/stackmaxima.mac

@@ -3548,4 +3548,4 @@ is_lang(code):=ev(is(%_STACK_LANG=code),simp=true)$
 
 /* Stack expects some output with the version number the output happens at */
 /* maximalocal.mac after additional library loading */
-stackmaximaversion:2026042300$
+stackmaximaversion:2026042402$

version.php

@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2026042300;
+$plugin->version   = 2026042402;
 $plugin->requires  = 2022041900;
 $plugin->cron      = 0;
 $plugin->component = 'qtype_stack';