From 78905ffb821763db9db33f15bfe33398b87dab6b Mon Sep 17 00:00:00 2001
From: Colin Walters <walters@verbum.org>
Date: Mon, 27 Nov 2023 13:50:07 -0500
Subject: [PATCH 1/2] man: Two finalization fixes

From PR review.
---
 man/ostree-admin-deploy.xml            | 2 +-
 man/ostree-admin-lock-finalization.xml | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/man/ostree-admin-deploy.xml b/man/ostree-admin-deploy.xml
index 30b5e90ac3..5ad71cafca 100644
--- a/man/ostree-admin-deploy.xml
+++ b/man/ostree-admin-deploy.xml
@@ -126,7 +126,7 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
 
                 <listitem><para>
                     The deployment will not be "finalized" by default on shutdown; to later
-                    queue it, use <literal>ostree admin unlock-finalization</literal>.
+                    queue it, use <literal>ostree admin lock-finalization --unlock</literal>.
                 </para></listitem>
             </varlistentry>
 
diff --git a/man/ostree-admin-lock-finalization.xml b/man/ostree-admin-lock-finalization.xml
index 0dc31e8b8c..ac469b7ca1 100644
--- a/man/ostree-admin-lock-finalization.xml
+++ b/man/ostree-admin-lock-finalization.xml
@@ -61,7 +61,8 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
             will be set into a "finalization locked" state, which means it will not be queued for the next boot by default.
         </para>
         <para>
-            This is the same as the <literal>--lock-finalization</literal> argument for <literal>ostree admin deploy</literal>.
+            This is the same as the <literal>--lock-finalization</literal> argument for <literal>ostree admin deploy</literal>,
+            which is the recommended way to use this feature in a race-free way.
         </para>
         <para>
             However more commonly, one will use the <literal>--unlock</literal> argument for this command to later unlock

From d3de3a0a882fc75f7a941d873fc9aaa2266c4ab4 Mon Sep 17 00:00:00 2001
From: Colin Walters <walters@verbum.org>
Date: Mon, 27 Nov 2023 15:34:20 -0500
Subject: [PATCH 2/2] tests: Add a dedicated finalization test

This one covers `admin lock-finalization --unlock`.
---
 tests/kolainst/destructive/finalization.sh | 57 ++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100755 tests/kolainst/destructive/finalization.sh

diff --git a/tests/kolainst/destructive/finalization.sh b/tests/kolainst/destructive/finalization.sh
new file mode 100755
index 0000000000..34624f5fa8
--- /dev/null
+++ b/tests/kolainst/destructive/finalization.sh
@@ -0,0 +1,57 @@
+#!/bin/bash
+set -xeuo pipefail
+
+. ${KOLA_EXT_DATA}/libinsttest.sh
+
+require_writable_sysroot
+prepare_tmpdir
+
+case "${AUTOPKGTEST_REBOOT_MARK:-}" in
+  "")
+  # Need to disable gpg verification for test builds
+  sed -i -e 's,gpg-verify=true,gpg-verify=false,' /etc/ostree/remotes.d/*.conf
+  # xref https://github.com/coreos/coreos-assembler/pull/2814
+  systemctl mask --now zincati
+
+  # Create a synthetic commit for upgrade
+  ostree commit --no-bindings --parent="${host_commit}" -b staged-deploy -I --tree=ref="${host_commit}"
+  newcommit=$(ostree rev-parse staged-deploy)
+  ostree admin deploy --lock-finalization staged-deploy
+  systemctl show -p ActiveState ostree-finalize-staged.service | grep active
+  ostree admin status > status.txt
+  assert_file_has_content status.txt 'finalization locked'
+  # Because finalization was locked, we shouldn't deploy on shutdown
+  /tmp/autopkgtest-reboot "2"
+  ;;
+  "2") 
+  # Verify we didn't finalize
+  newcommit=$(ostree rev-parse staged-deploy)
+  booted=$(rpm-ostree status --json | jq -r .deployments[0].checksum)
+  assert_not_streq "${newcommit}" "${booted}"
+  prev_bootid=$(journalctl --list-boots -o json |jq -r '.[] | select(.index == -1) | .boot_id')
+  journalctl -b $prev_bootid -u ostree-finalize-staged.service > svc.txt
+  assert_file_has_content svc.txt 'Not finalizing'
+  ostree admin status > status.txt
+  assert_not_file_has_content status.txt 'finalization locked'
+
+  # Now re-deploy
+  ostree admin deploy --lock-finalization staged-deploy
+  ostree admin status > status.txt
+  assert_file_has_content status.txt 'finalization locked'
+  # And unlock
+  ostree admin lock-finalization --unlock
+  ostree admin status > status.txt
+  assert_not_file_has_content status.txt 'finalization locked'
+
+  /tmp/autopkgtest-reboot "3"
+  ;;
+  "3") 
+  newcommit=$(ostree rev-parse staged-deploy)
+  booted=$(rpm-ostree status --json | jq -r .deployments[0].checksum)
+  assert_streq "${newcommit}" "${booted}"
+  prev_bootid=$(journalctl --list-boots -o json |jq -r '.[] | select(.index == -1) | .boot_id')
+  journalctl -b $prev_bootid -u ostree-finalize-staged.service > svc.txt
+  assert_file_has_content svc.txt 'Bootloader updated'
+  ;;
+  *) fatal "Unexpected AUTOPKGTEST_REBOOT_MARK=${AUTOPKGTEST_REBOOT_MARK}" ;;
+esac