[MDL-62777] Inform about newly created settings during CLI upgrades - Moodle Tracker

XML

Word

Printable

Details

Type: Improvement
Status: Closed
Priority: Minor
Resolution: Fixed
Affects Version/s: 3.4.3, 3.5
Fix Version/s: 3.6
Component/s: Administration
Labels:
- CatalystIT
- Partner
- ci
- release_notes

Database:

Any
Affected Branches:
MOODLE_34_STABLE, MOODLE_35_STABLE
Fixed Branches:
MOODLE_36_STABLE
Pull from Repository:
git://github.com/junpataleta/moodle.git
Pull Master Branch:
~~MDL-62777~~-master
Pull Master Diff URL:
https://github.com/junpataleta/moodle/compare/cc486e6125...MDL-62777-master
Testing Instructions:
Hide

Note: MDK would be useful for this test.

Default CLI upgrade

If you have a current installation, uninstall it.

mdk uninstall -y

Check out an old Moodle version. E.g. Moodle 3.4

git checkout v3.4.0

Install the instance

mdk install

Checkout the codebase with this patch applied

git checkout master

Run the upgrade script:

php admin/cli/upgrade.php --non-interactive --allow-unstable

Confirm that at the end of the upgrade, you see the new settings that were set with default values.

Verbose CLI upgrade

Uninstall your instance.

mdk uninstall -y

Check out an old Moodle version. E.g. Moodle 3.4

git checkout v3.4.0

Install the instance with some of the admin settings changed

mdk install -r mindev

The "mindev" script will alter developer settings such as "Debug messages"

Checkout the codebase with this patch applied

git checkout master

Run the upgrade script with the "verbose-settings" option:

php admin/cli/upgrade.php --non-interactive --allow-unstable --verbose-settings

Confirm that at the end of the upgrade, you see the new settings along with the default values that were set for them.

Open your Moodle instance and go to "Site administration / Development / Debugging"

Confirm that the "Debug messages" setting is still set to Developer.

Regression test: CLI install

Uninstall your instance.

mdk uninstall -y

Do a fresh install

mdk install

Confirm that the installation completes successfully.

Regression test: Web upgrade

Uninstall your instance.

mdk uninstall -y

Check out an old Moodle version. E.g. Moodle 3.4

git checkout v3.4.0

Install the instance with some of the admin settings changed

mdk install -r mindev

Checkout the codebase with this patch applied

git checkout master

Open your Moodle instance on your web browser.

Log in as an admin.

Run through the upgrade.

Confirm that the upgrade completes successfully.

Open your Moodle instance and go to "Site administration / Development / Debugging"

Confirm that the "Debug messages" setting is still set to Developer.
Show
Note: MDK would be useful for this test. Default CLI upgrade If you have a current installation, uninstall it. mdk uninstall -y Check out an old Moodle version. E.g. Moodle 3.4 git checkout v3.4.0 Install the instance mdk install Checkout the codebase with this patch applied git checkout master Run the upgrade script: php admin/cli/upgrade.php --non-interactive --allow-unstable Confirm that at the end of the upgrade, you see the new settings that were set with default values. Verbose CLI upgrade Uninstall your instance. mdk uninstall -y Check out an old Moodle version. E.g. Moodle 3.4 git checkout v3.4.0 Install the instance with some of the admin settings changed mdk install -r mindev The " mindev " script will alter developer settings such as " Debug messages " Checkout the codebase with this patch applied git checkout master Run the upgrade script with the " verbose-settings " option: php admin/cli/upgrade.php --non-interactive --allow-unstable --verbose-settings Confirm that at the end of the upgrade, you see the new settings along with the default values that were set for them. Open your Moodle instance and go to " Site administration / Development / Debugging " Confirm that the " Debug messages " setting is still set to Developer. Regression test: CLI install Uninstall your instance. mdk uninstall -y Do a fresh install mdk install Confirm that the installation completes successfully. Regression test: Web upgrade Uninstall your instance. mdk uninstall -y Check out an old Moodle version. E.g. Moodle 3.4 git checkout v3.4.0 Install the instance with some of the admin settings changed mdk install -r mindev Checkout the codebase with this patch applied git checkout master Open your Moodle instance on your web browser. Log in as an admin. Run through the upgrade. Confirm that the upgrade completes successfully. Open your Moodle instance and go to " Site administration / Development / Debugging " Confirm that the " Debug messages " setting is still set to Developer.

Description

When doing a Moodle update / upgrade via CLI (/admin/cli/upgrade.php), there is an output which informs about the affected components / plugins and about the progress. Example:

-->Sprachpakete verwalten: de

++ Das Sprachpaket ‘de' ist aktuell. ++

-->Kernsystem

++ Fortschritt (3,02 Sekunden) ++

-->mod_choicegroup

++ Fortschritt (0,12 Sekunden) ++

-->block_quickmail

++ Fortschritt (0,08 Sekunden) ++

-->local_boostnavigation

++ Fortschritt (0,09 Sekunden) ++

Die Aktualisierung wurde erfolgreich beendet.

(sorry for the example being in german, but you have hopefully all seen this before in english)

Now, when there are new settings in core or in a plugin which are installed during an update / upgrade, the admin can see and modify them within the manual upgrade wizard in the browser.

When using the CLI upgrade, the admin does not have any idea if and which new settings are installed. They are simply installed silently with their default values.

I would propose to add an output for each newly installed setting to inform the admin about this fact and to give him the chance to review the setting later manually. Example:

-->Sprachpakete verwalten: de

++ Das Sprachpaket ‘de' ist aktuell. ++

-->Kernsystem

++ Fortschritt (3,02 Sekunden) ++

-->mod_choicegroup

++ Fortschritt (0,12 Sekunden) ++

-->block_quickmail

++ Fortschritt (0,08 Sekunden) ++

-->local_boostnavigation

++ New setting "local_boostnavigation | removeprivatefilesnode" installed with default value: 0

++ Fortschritt (0,09 Sekunden) ++

Die Aktualisierung wurde erfolgreich beendet.

PS: The proposed patch by davosmith in ~~MDL-41047~~ which unfortunately got stuck might serve as a boilerplate for this ticket.

Attachments

- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

1.PNG
285 kB
22/Oct/18 1:41 PM
2.PNG
225 kB
22/Oct/18 1:41 PM
Selection_091.png
154 kB
27/Jun/18 5:13 PM

Issue Links

caused a regression

MDL-63795 Not all core settings defaults are applied anymore

Closed

duplicates

MDL-40628 show new available global settings after cli upgrade

Closed

has a non-specific relationship to

MDL-41047 Improve progress information during long upgrades

Closed

is duplicated by

MDL-51457 CLI upgrade should indicate updated settings

Closed

Activity

People

Assignee:: Matt Porritt

Reporter:: Alexander Bias

Peer reviewer:: Luca Bösch

Integrator:: Jun Pataleta

Tester:: Janelle Barcega

Participants:: Alexander Bias, Andrew Lyons, CiBoT, David Monllaó, Eloy Lafuente (stronk7), Eric Merrill, Janelle Barcega, Jun Pataleta, Luca Bösch, Matt Porritt

Component watchers:: David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo

Votes:: 1 Vote for this issue

Watchers:: 9 Start watching this issue

Dates

Created:: 22/Jun/18 10:28 PM

Updated:: 03/Jan/19 11:38 PM

Resolved:: 24/Oct/18 4:13 AM

Fix Release Date:: 3/Dec/18

Time Tracking

Estimated:

Remaining:

Logged:

Details

Default CLI upgrade

Verbose CLI upgrade

Regression test: CLI install

Regression test: Web upgrade

Description

Attachments

Attachments

Issue Links

Activity

People

Dates

Time Tracking