From fb2b4a1d3286bb0c1bb6207fd1aa541037709295 Mon Sep 17 00:00:00 2001
From: Luqman Aden <luqman@oxide.computer>
Date: Thu, 5 Oct 2023 15:16:22 -0700
Subject: [PATCH] tools/install_opte: Freeze the package to the pinned version.
 (#4215)

---
 tools/install_opte.sh   | 27 +++++++++++++++++++++++++++
 tools/uninstall_opte.sh | 14 ++++++++++++++
 2 files changed, 41 insertions(+)

diff --git a/tools/install_opte.sh b/tools/install_opte.sh
index f670adf163..20a33b05a5 100755
--- a/tools/install_opte.sh
+++ b/tools/install_opte.sh
@@ -51,6 +51,26 @@ fi
 # Grab the version of the opte package to install
 OPTE_VERSION="$(cat "$OMICRON_TOP/tools/opte_version")"
 
+OMICRON_FROZEN_PKG_COMMENT="OMICRON-PINNED-PACKAGE"
+
+# Once we install, we mark the package as frozen at that particular version.
+# This makes sure that a `pkg update` won't automatically move us forward
+# (and hence defeat the whole point of pinning).
+# But this also prevents us from installig the next version so we must
+# unfreeze first.
+if PKG_FROZEN=$(pkg freeze | grep driver/network/opte); then
+    FROZEN_COMMENT=$(echo "$PKG_FROZEN" | awk '{ print $(NF) }')
+
+    # Compare the comment to make sure this is indeed our previous doing
+    if [ "$FROZEN_COMMENT" != "$OMICRON_FROZEN_PKG_COMMENT" ]; then
+        echo "Found driver/network/opte previously frozen but not by us:"
+        echo $PKG_FROZEN
+        exit 1
+    fi
+
+    pfexec pkg unfreeze driver/network/opte
+fi
+
 # Actually install the xde kernel module and opteadm tool
 RC=0
 pfexec pkg install -v pkg://helios-dev/driver/network/opte@"$OPTE_VERSION" || RC=$?
@@ -63,6 +83,13 @@ else
     exit "$RC"
 fi
 
+RC=0
+pfexec pkg freeze -c "$OMICRON_FROZEN_PKG_COMMENT" driver/network/opte@"$OPTE_VERSION" || RC=$?
+if [[ "$RC" -ne 0 ]]; then
+    echo "Failed to pin opte package to $OPTE_VERSION"
+    exit $RC
+fi
+
 # Check the user's path
 RC=0
 which opteadm > /dev/null || RC=$?
diff --git a/tools/uninstall_opte.sh b/tools/uninstall_opte.sh
index a833d029aa..c8ee0f5b28 100755
--- a/tools/uninstall_opte.sh
+++ b/tools/uninstall_opte.sh
@@ -165,6 +165,19 @@ function restore_xde_and_opte {
     fi
 }
 
+function unfreeze_opte_pkg {
+    OMICRON_FROZEN_PKG_COMMENT="OMICRON-PINNED-PACKAGE"
+
+    # If we've frozen a particular version, let's be good citizens
+    # and clear that as well.
+    if PKG_FROZEN=$(pkg freeze | grep driver/network/opte); then
+        FROZEN_COMMENT=$(echo "$PKG_FROZEN" | awk '{ print $(NF) }')
+        if [ "$FROZEN_COMMENT" == "$OMICRON_FROZEN_PKG_COMMENT" ]; then
+            pkg unfreeze driver/network/opte
+        fi
+    fi
+}
+
 function ensure_not_already_on_helios {
     local RC=0
     pkg list "$STOCK_CONSOLIDATION"* || RC=$?
@@ -179,5 +192,6 @@ uninstall_xde_and_opte
 for PUBLISHER in "${PUBLISHERS[@]}"; do
     remove_publisher "$PUBLISHER"
 done
+unfreeze_opte_pkg
 ensure_not_already_on_helios
 to_stock_helios "$CONSOLIDATION"