[regression-in-stable] grub-multi-install fails with exit 1 when question grub-efi/install_devices_empty is skipped

[Michael Vogt]

[Impact]

 * When both grub-pc & grub-efi-*-signed are installed, it is ok for one of them to not install onto any devices and mark install_devices_empty as true such that machine is booted with just one boot loader type, and not both.
 * In such cases, the recently SRUed postinst will behave incorrectly upon reconfigure, instead demanding user to install both types of bootloaders somewhere.
* Error can only be triggered by abandonned grub-pc install, as grub-multi-install validates install_devices values and resets configuration logic.

[Test Case]

 * Install in efi mode. Ensure that grub-pc is installed, configure debconf to have seen grub-pc/install_devices_empty question and have it as true, and have grub-pc/install_devices seen and empty.

 * Attempt reconfigure of grub-pc, it should be successful.

All this can be done in chroot as follows:

mkdir -p /boot/grub/i386-pc
touch /boot/grub/i386-pc/core.img
dpkg-reconfigure grub-pc
(answer defaults, and choose to not install GRUB to any devices)

Then:
dpkg-reconfigure -u grub-pc
should succed, with exit code 0, when this bug is fixed. The current broken packages return exit code 1.

 * Populate grub-efi/install_devices & grub-pc/install_devices with invalid devices and set install_devices_empty to false, attempt non-interactive reconfigure. It should still fail. (A check that previous bug-fix does not regress).

[Regression Potential]

 * This partially revert previous update which made that code path error out. One too many error paths got added by xnox. The other bug, to ensure when installing onto missing devices noninteractively the package configure fails is still being check for (test #3).

[Other Info]

 * original bug report

A 20.04 machine with grub-efi-amd64-signed that recently got upgraded fails with:
"""
dpkg: error processing package grub-efi-amd64-signed (--configure):
 installed grub-efi-amd64-signed package post-installation script subprocess returned error exit status 1
"""

unfortunately not much more context was provided. After some debugging it turns out that there are the following lines in /usr/lib/grub/grub-multi-install:

"""
  db_get "$question"
  if [ -z "$RET" ]; then
    # Reset the seen flag if the current answer is false, since
    # otherwise we'll loop with no indication of why.
    db_get grub-efi/install_devices_empty
    if [ "$RET" = false ]; then
      db_fset grub-efi/install_devices_empty seen false
    fi
    if db_input critical grub-efi/install_devices_empty; then
      db_go
      db_get grub-efi/install_devices_empty
      if [ "$RET" = true ]; then
        break
      else
        db_fset "$question" seen false
        db_fset grub-efi/install_devices_empty seen false
      fi
    else
      exit 1 # noninteractive
    fi
"""
when grub-efi/install_devices_empty has the flag "seen" the line

    if db_input critical grub-efi/install_devices_empty; then

will return "30" if the question was already shown but the rfset eset happens only if the anser was "false" earlier. So the code jumps to "exit 1".

So either the code need to always reset the seen flag ( db_fset grub-efi/install_devices_empty seen false) or deal with exit code 30 from "db_input critical grub-efi/install_devices_empty" more gracefully.

I can provide a /var/cache/debconf/config.dat to reproduce. I'm not entirely sure how to reproduce from a clean install, the bug will only happen after the first upgrade.

[Michael Vogt (mvo)]

Some debug lines from setting "sh -x" inside the grub-multi-install https://paste.ubuntu.com/p/9CBGGvJjz9/

and the debconf db grub entries: https://paste.ubuntu.com/p/j2DwtQHzSb/

I think the only relevant part here is that grub-efi/install_devices_empty was already seen *and* is set to "True" as this leads to the issue.

[Michael Vogt (mvo)]

Looking at the diff in http://launchpadlibrarian.net/497631450/grub2_2.04-1ubuntu26_2.04-1ubuntu26.4.diff.gz I see that this appears to be a new change during the SRU cycle, specifically:

"""
diff -Nru grub2-2.04/debian/grub-multi-install grub2-2.04/debian/grub-multi-install
--- grub2-2.04/debian/grub-multi-install 2020-04-15 11:31:27.000000000 +0000
+++ grub2-2.04/debian/grub-multi-install 2020-09-08 10:23:00.000000000 +0000
@@ -8,6 +8,13 @@

 . /usr/share/debconf/confmodule

+# shamelessly stolen from ucf:
+#
+# Load our templates, just in case our template has
+# not been loaded or the Debconf DB lost or corrupted
+# since then.
+db_x_loadtemplatefile "$(dpkg-query --control-path grub-common templates)" grub-common
+
 ###############################################################################
 # COPY FROM POSTINST
 ###############################################################################
@@ -373,7 +380,7 @@
         continue
       fi
     else
- break # noninteractive
+ exit 1 # noninteractive
     fi
   fi

@@ -395,7 +402,7 @@
         db_fset grub-efi/install_devices_empty seen false
       fi
     else
- break # noninteractive
+ exit 1 # noninteractive
     fi
   else
     break
"""

The new "exit 1" will break stable users that have answered the "grub-efi/install_devices_empty" question already with the answer "yes" because for those the question will be skipped (as it was already asked) and hence the if goes into the "exit 1" condition and the postinst fails.

[Michael Vogt (mvo)]

One more idea: maybe if we really need to exit, then instead of two "exit 1" (which is super generic) have "exit 22" and "exit 33" (or similar). And maybe a message to stderr. I think this would help the automatic errortracker reports too.

[Łukasz Zemczak (sil2100)]

We'll make sure this gets looked at and prioritize accordingly. Thank you for reporting it!

[Dimitri John Ledkov (xnox)]

Name: grub-efi/install_devices
Template: grub-efi/install_devices
Value:
Owners: grub-common, grub-efi-amd64
Flags: seen
Variables:
 CHOICES =
 RAW_CHOICES =

Name: grub-efi/install_devices_empty
Template: grub-efi/install_devices_empty
Value: true
Owners: grub-common, grub-efi-amd64
Flags: seen

question is grub-efi/install_devices

  db_get "$question"
  if [ -z "$RET" ]; then
    # Reset the seen flag if the current answer is false, since
    # otherwise we'll loop with no indication of why.
    db_get grub-efi/install_devices_empty
    if [ "$RET" = false ]; then
      db_fset grub-efi/install_devices_empty seen false
    fi
    if db_input critical grub-efi/install_devices_empty; then
      db_go
      db_get grub-efi/install_devices_empty
      if [ "$RET" = true ]; then
        break
      else
        db_fset "$question" seen false
        db_fset grub-efi/install_devices_empty seen false
      fi
    else
      exit 1 # noninteractive
    fi
  else
    break
  fi

So, if install_devices is empty & install_devices_empty is true and seen, asking grub-efi/install_devices_empty will be skipped. and shouldn't error out.

I wonder if I cause this mistake in postinst, and grub-multi-install.

[Dimitri John Ledkov (xnox)]

Hm, so before calling grub_multi_install we check if we have been installed into target as efi with

        if test -e /boot/grub/$target/core.efi; then
          db_get grub2/no_efi_extra_removable
          if [ "$RET" = true ]; then
            NO_EXTRA_REMOVABLE="--no-extra-removable"
          fi
          NO_NVRAM="$(no_nvram_arg)"
          run_grub_multi_install --target="$target" "$NO_EXTRA_REMOVABLE" "$NO_NVRAM"
        fi

so it would seem that /boot/grub/x86_64-efi/core.efi exists, yet user chose not to install grub-efi.

[Dimitri John Ledkov (xnox)]

we do similar check for grub-pc checking for /core.img to be present.

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Launchpad Janitor (janitor)]

This bug was fixed in the package grub2 - 2.04-1ubuntu35

---------------
grub2 (2.04-1ubuntu35) groovy; urgency=medium

  * postinst.in, grub-multi-install: fix logic of skipping installing onto
    any device, if one chose to not install bootloader on any device. LP:
    #1896608
  * Do not finalize params twice on arm64. LP: #1897819

 -- Dimitri John Ledkov <email address hidden> Thu, 01 Oct 2020 22:59:51 +0800

[Brian Murray (brian-murray)]

Hello Michael, or anyone else affected,

Accepted grub2 into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/grub2/2.04-1ubuntu26.6 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[costinel (costinel)]

I have upgrade the packages from the link provided (manual download since they're not yet accepted into focal-proposed) and grub-pc postinst script exits cleanly now. thanks.

[Scott Talbert (swt-techie)]

The build page for this update for focal seems to indicate that the packages for amd64 and arm64 are in an UNAPPROVED queue. Does something need to be triggered there?

https://launchpad.net/ubuntu/+source/grub2/2.04-1ubuntu26.6/+build/20118987

[Scott Talbert (swt-techie)]

Never mind my last comment - that issue with the UNAPPROVED builds seems to have been resolved.

The 2.04-1ubuntu26.6 packages from focal-proposed seem to have resolved the issue for me as well.

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted grub2 (2.04-1ubuntu26.6) for focal have finished running.
The following regressions have been reported in tests triggered by the package:

ubuntu-image/1.10+20.04ubuntu1 (armhf)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/focal/update_excuses.html#grub2

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Gianfranco Costamagna (costamagnagianfranco)]

comment 13 suggests the fix works.

[Keith (keith7)]

The fix on the proposed channel is working for me too. Thanks guys!

[Launchpad Janitor (janitor)]

This bug was fixed in the package grub2 - 2.04-1ubuntu26.6

---------------
grub2 (2.04-1ubuntu26.6) focal; urgency=medium

  * postinst.in, grub-multi-install: fix logic of skipping installing onto
    any device, if one chose to not install bootloader on any device. LP:
    #1896608
  * Do not finalize params twice on arm64. LP: #1897819

grub2 (2.04-1ubuntu26.5) focal; urgency=medium

  * ubuntu-linuxefi-arm64.patch: Fix build on armhf (LP: #1862279)

 -- Dimitri John Ledkov <email address hidden> Thu, 01 Oct 2020 23:19:24 +0800

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for grub2 has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[Brian Murray (brian-murray)]

Hello Michael, or anyone else affected,

Accepted grub2 into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/grub2/2.02-2ubuntu8.19 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted grub2 (2.02-2ubuntu8.19) for bionic have finished running.
The following regressions have been reported in tests triggered by the package:

ubuntu-image/1.10+18.04ubuntu1 (ppc64el)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/bionic/update_excuses.html#grub2

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Dimitri John Ledkov (xnox)]

installed grub2 2.02-2ubuntu8.18 and configured debconf & /boot to reproduce the issue (touched the core.img, as well as enxsured that install_devices_empty & install_devices are marked as seen, and set to true and empty respectively).

dpkg-reconfigure -u grub-pc exits zero as expected.

upgraded to 2.04-2ubuntu8.19, and executed dpkg-reconfigure -u grub-pc again, and it is also successful.

bionic-updates didn't have the "exit 1" bug, and it still is not there with latest round of fixes from focal.

[Launchpad Janitor (janitor)]

This bug was fixed in the package grub2 - 2.02-2ubuntu8.19

---------------
grub2 (2.02-2ubuntu8.19) bionic; urgency=medium

  * grub-install: cherry-pick patch from grub-devel to make grub-install
    fault tolerant. Create backup of files in /boot/grub, and restore them
    on failure to complete grub-install. LP: #1891680
    Also cherry-pick patch to make atexit work correctly.
  * postinst.in: do not exit successfully when failing to show critical
    grub-pc/install_devices_failed and grub-pc/install_devices_empty
    prompts in non-interactive mode. This enables surfacing upgrade errors
    to the users and/or automation. LP: #1891680 LP: #1896608
  * postinst.in: do not attempt to call grub-install upon fresh install of
    grub-pc because it it a job of installers to do that after fresh
    install. Fixup for the issue unmasked by above. LP: #1891680
  * postinst.in: Fixup postinst.in, to attempt grub-install upon explicit
    dpkg-reconfigure grub-pc. LP: #1892526

 -- Dimitri John Ledkov <email address hidden> Thu, 22 Oct 2020 15:01:52 +0100