Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-65644

Add Moodle 3.7.0 upgrade line to all the upgrade.php scripts

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.7, 3.8
    • Fix Version/s: 3.7.1
    • Component/s: Installation
    • Labels:
    • Testing Instructions:
      Hide

      1) Check that all the "Command(s) to detect ..." in the description of the issue work as expected (no occurrences normally, some cases or exceptions allowed in some of them...)

      2) Check all upgrade scripts have the 3.7.0 comment before the return with:

       find . -ipath '*/db/upgrade.php' | xargs grep -B4 'return true;'
      

      • Random exceptions: Some upgrade scripts could be missing the comments before the return. Surely it's because some new steps already have been introduced after release. Verify the comments are present in the correct place (before those new steps).

      3) This should return nothing too or the same exceptions as in step 2:

      for u in `find . -name upgrade.php | grep 'db/upgrade'`; do grep -B4 'return true;' "$u" | grep "Automatically generated" > /dev/null; if [ $? -ne 0 ]; then echo "$u"; fi ; done
      

      4) Verify that the differences between the stable branch and master continue being 100% the same after the patch than before it (aka. the patch is 100% the same for both branches).

      5) rock on.

      Show
      1) Check that all the " Command(s) to detect ..." in the description of the issue work as expected (no occurrences normally, some cases or exceptions allowed in some of them...) 2) Check all upgrade scripts have the 3.7.0 comment before the return with: find . -ipath '*/db/upgrade.php' | xargs grep -B4 'return true;' Random exceptions: Some upgrade scripts could be missing the comments before the return. Surely it's because some new steps already have been introduced after release. Verify the comments are present in the correct place (before those new steps). 3) This should return nothing too or the same exceptions as in step 2: for u in `find . -name upgrade.php | grep 'db/upgrade'`; do grep -B4 'return true;' "$u" | grep "Automatically generated" > /dev/null; if [ $? -ne 0 ]; then echo "$u"; fi ; done 4) Verify that the differences between the stable branch and master continue being 100% the same after the patch than before it (aka. the patch is 100% the same for both branches). 5) rock on.
    • Affected Branches:
      MOODLE_37_STABLE, MOODLE_38_STABLE
    • Fixed Branches:
      MOODLE_37_STABLE
    • Pull from Repository:
    • Pull 3.7 Branch:
    • Pull Master Branch:

      Description

      (NOTE: Before 3.2, the comment was "// Moodle v3.1.0 release upgrade line." and it was changed to have "Automatically generated..." for v3.2.0 and upwards.)

      In order to have it properly detected for the future it would be great to add to all the upgrade.php scripts some lines like these:

      // Automatically generated Moodle v3.7.0 release upgrade line.
      // Put any upgrade step following this.
      

      exactly before the "return true;" present in all the scripts.

      I think it's ok to do that both in the 37_STABLE and master branches, so they will allow quickly find where 3.7.0 started and act once we decide future requirements.

      The change can be performed globally with:

      #!/bin/bash
      export rel="3.7.0" && find . -name upgrade.php | \
      xargs grep -l 'function.*xmldb_.*_upgrade' | \
      grep '/db/' | \
      xargs grep -L "Automatically generated Moodle v${rel} release upgrade" | \
      xargs perl -p -i -e 's@( *)(return true;)@\1// Automatically generated Moodle v$ENV{rel} release upgrade line.\n\1// Put any upgrade step following this.\n\n\1\2@s'
      

      Command to detect all the upgrade.php files not having those lines:

      find . -name upgrade.php | xargs grep -l 'function.*xmldb_.*_upgrade' | grep '/db/' | xargs grep -L 'Automatically generated Moodle v3.7.0 release upgrade'
      

      Commands to detect that we have not added the lines to incorrect files:

      grep -lr 'Automatically generated Moodle v3.7.0 release upgrade' * | grep -v '/db/'
      grep -lr 'Automatically generated Moodle v3.7.0 release upgrade' * | xargs grep -L 'function.*xmldb_.*_upgrade'
      

      Command to detect if the lines have been added after a post-release upgrade step. If there are upgrade steps found verify that all them were already there the day of the release and have not been introduced later (you can look for differences between the release v3.7.0 and current master to verify that)

      export rel="3.7.0" && export ver="201905" &&
      find . -name upgrade.php | \
      xargs grep -B25 "Automatically generated Moodle v${rel} release upgrade" | \
      grep "upgrade_.*_savepoint.*${ver}"
      

      Ciao

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                stronk7 Eloy Lafuente (stronk7)
                Reporter:
                stronk7 Eloy Lafuente (stronk7)
                Integrator:
                Andrew Nicols
                Tester:
                Mihail Geshoski
                Participants:
                Component watchers:
                Matteo Scaramuccia, Andrew Nicols, Mathew May, Michael Hawkins, Shamim Rezaie, Simey Lameze
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  8/Jul/19

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 hours, 40 minutes
                  2h 40m