Merge ~slyon/network-manager:netplan-migrate-maintscript into network-manager:netplan/lunar-gu

[Lukas Märdian]

d/network-manager.postinst: Trigger Netplan migration on install/upgrade

Modify the connection's ID (con-name) to trigger its migration.
The Netplan integration will translate the original NM keyfile from
/etc/NetworkManager/system-connections/* to a YAML file located in
/etc/netplan/90-NM-*.yaml and re-generate a corresponding keyfile in
/run/NetworkManager/system-connections/netplan-NM-*.nmconnection
After successful migration, the original ID (con-name) is restored.

[Simon Chopin (schopin)]

question: What happens to the original keyfile?

If it's not removed, then re-running the script (cf https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html#maintainer-scripts-idempotency ) will overwrite the previous migration's yaml, which might have changed in the mean time.

review: Needs Information

[Lukas Märdian (slyon)]

The original keyfile in /etc/NetworkManager/system-connections/* is being deleted by the Netplan integration automatically during the process, after it got translated into /etc/netplan/90-NM-*.yaml successfully.

I.e. that would be within the first "nmcli con mod ..." call for each connection profile.

[Dave Jones (waveform)]

Left a couple of comments on the version comparison line which might bear some thought (but I'm unsure if they're actually relevant without additional context).

[Lukas Märdian (slyon)]

Thanks! Answered Dave's inline comment. I think the current implementation matches my intention.

[Lukas Märdian (slyon)]

Thanks all! We got some extra eyeballs, let's get this merged and deployed to the "Netplan Everywhere PPA (Lunar)" testers.

diff --git a/debian/network-manager.postinst b/debian/network-manager.postinst
index e2cb049..ba31d6b 100644
--- a/debian/network-manager.postinst
+++ b/debian/network-manager.postinst
@@ -81,3 +81,30 @@ esac
 
 #DEBHELPER#
 
+# Run "Netplan Everywhere" migration after debhelper (re-)started
+# NetworkManager.service for us
+# XXX: Shall we run this migration just on the upgrade to this specific
+#      version, or on any upgrade/install?
+#if dpkg --compare-versions "$2" lt "1.42.4-1ubuntu3"; then
+DIR="/etc/NetworkManager/system-connections"
+if [ "$1" = "configure" ] && [ -d "$DIR" ]; then
+    for CON in /etc/NetworkManager/system-connections/*; do
+        TYPE=$(file -b "$CON")
+        [ "$TYPE" = "ASCII text" ] || continue # skip non-keyfiles
+        UUID=$(grep "^uuid=" "$CON" | cut -c 6-)
+        if [ -n "$UUID" ]
+        then
+            ORIG_NAME=$(nmcli --get-values connection.id con show "$UUID")
+            echo "Migrating $ORIG_NAME ($UUID) to /etc/netplan" 1>&2
+            # Modify the connection's ID (con-name) to trigger its migration.
+            # The Netplan integration will translate the original NM keyfile from
+            # /etc/NetworkManager/system-connections/* to a YAML file located in
+            # /etc/netplan/90-NM-*.yaml and re-generate a corresponding keyfile in
+            # /run/NetworkManager/system-connections/netplan-NM-*.nmconnection
+            # After successful migration, the original ID (con-name) is restored.
+            nmcli con mod "$UUID" con-name "$ORIG_NAME".NETPLAN_MIGRATE
+            nmcli con mod "$UUID" con-name "$ORIG_NAME"
+       fi
+    done
+    nmcli con reload
+fi