Merge ~smoser/ubuntu/+source/initramfs-tools:bug/1714308-initramfs-dns into ubuntu/+source/initramfs-tools:ubuntu/devel

[Scott Moser]

25228cf... by Scott Moser on 2018-05-02

add 'dhcp-identifier: mac' to netplan dhcp stanzas

dfc5290... by Scott Moser on 2018-05-02

clean up implementation of only declaring macaddress= once.

[Mathieu Trudel-Lapierre (cyphermox)]

This won't be sufficient, looks like it's missing at least the rest of the yaml:

network:
  version: 2
  ethernets:

[etc.]

Even fudging this together for now, restarting systemd-networkd leads to the system hanging.

review: Needs Fixing

[Scott Moser (smoser)]

> This won't be sufficient, looks like it's missing at least the rest of the
> yaml:
>
> network:
> version: 2
> ethernets:

I'll add this.

>
> [etc.]
>
> Even fudging this together for now, restarting systemd-networkd leads to the
> system hanging.

Well, why would you *restart* systemd-networkd ? these are written in the initramfs systemd-networkd would not have been started yet.

b692527... by Scott Moser on 2018-05-07

add 'network/ethernets/' header stanza to each netplan rendered config.

2 things:
a.) add the network/ethernets namespace to the rendered yaml files.
b.) render addresses as a single line list.

[Scott Moser (smoser)]

updated to write network/config header.

[Mathieu Trudel-Lapierre (cyphermox)]

This won't work as-is; we'll need 'critical: yes' also under dhcp / dhcp-identifer. I'm preparing the SRU for this.

Currently, the behavior for systemd appears to be to release IP addresses when it reloads... :(

review: Needs Fixing

[Scott Moser (smoser)]

"Under" ?

Can you give an example?

It doesn't seem to make sense for 'critical' to apply at the same level of 'dhcp6' or 'dhcp4', as it is possible that one is critical and one is not.

[Mathieu Trudel-Lapierre (cyphermox)]

This has been merged already; NFS appears to work quite well now (no hang when running 'netplan apply'). Thanks!

diff --git a/debian/changelog b/debian/changelog
index 2f34bfa..eadc51b 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+initramfs-tools (0.130ubuntu4) UNRELEASED; urgency=medium
+
+  * scripts/functions: write netplan config files to /run/netplan for
+    network devices configured with configure_networking. (LP: #1713803)
+
+ -- Scott Moser <[e-mail]>  Fri, 09 Mar 2018 09:23:46 +0100
+
 initramfs-tools (0.130ubuntu3) bionic; urgency=medium
 
   * Fix resuming a hibernate session from a swapfile (LP: #1644975)
diff --git a/scripts/functions b/scripts/functions
index e5e1029..72d5b48 100644
--- a/scripts/functions
+++ b/scripts/functions
@@ -388,6 +388,8 @@ configure_networking()
 
 	netinfo_to_resolv_conf /etc/resolv.conf \
 		/run/net-${DEVICE}.conf /run/net-*.conf /run/net6-*.conf
+	netinfo_to_netplan /run/netplan \
+		/run/net-${DEVICE}.conf /run/net-*.conf /run/net6-*.conf
 }
 
 netinfo_to_resolv_conf() {
@@ -398,10 +400,8 @@ netinfo_to_resolv_conf() {
 		( _in_subshell=1; netinfo_to_resolv_conf "$@" )
 		return
 	fi
-
 	local output="$1" search="" ns="" f="" n=""
 	shift
-	{
 	for f in "$@"; do
 		[ -f "$f" ] || continue
 		unset IPV4DNS0 IPV4DNS1 IPV6DNS0 IPV6DNS1
@@ -427,13 +427,191 @@ netinfo_to_resolv_conf() {
 		search=${search# }
 		ns=${ns# }
 	done
+
+	local rconf="" CR="
+"
 	for n in ${ns}; do
-		echo "nameserver $n"
+		rconf="${rconf}nameserver $n${CR}"
 	done
 	if [ -n "${search}" ]; then
-		echo "search ${search}"
+		rconf="${rconf}search ${search}${CR}"
+	fi
+	if [ -z "$rconf" ]; then
+		echo "no search or nameservers found in $*" 1>&2
+	fi
+	if [ "$rconf" = "-" ]; then
+		echo -n "$rconf"
+	else
+		echo -n "$rconf" > "$output"
+	fi
+}
+
+mask2cidr() {
+	# https://forum.openwrt.org/viewtopic.php?pid=220781#p220781
+	# Assumes there's no "255." after a non-255 byte in the mask
+	local x=${1##*255.}
+	set -- 0^^^128^192^224^240^248^252^254^ $(( (${#1} - ${#x})*2 )) ${x%%.*}
+	x=${1%%$3*}
+	echo $(( $2 + (${#x}/4) ))
+}
+
+_declare_sh_append_var() {
+	# append_var(name, skip, strings)
+	# write a declaration of name that will append to any existing
+	local name="$1" skip="$2" add="" n=""
+	shift 2
+	for n in "$@"; do
+		[ -n "$n" -a "$n" != "$skip" ] || continue
+		add="$add $n"
+	done
+	add=${add# }
+	[ -n "$add" ] || return 0
+	echo "$name=\"\${${name}:+\${${name}} }${add}\""
+}
+
+_declare_ip_info() {
+	# declare_ip_info(version, proto, address, netmask, gateway)
+	local version="$1" proto="$2" address="$3" netmask="$4" gateway="$5"
+	local netprefix=""
+	if [ "$proto" = "dhcp" -o "$proto" = "dhcp4" -o "$proto" = "dhcp6" ]; then
+		echo "dhcp${version}=true"
+	elif [ "$proto" = "static" ]; then
+		if [ -n "$address" ]; then
+			netprefix=$netmask
+			if [ "$version" = "4" ]; then
+				netprefix=$(mask2cidr "$netmask")
+			fi
+			_declare_sh_append_var addresses "" "$address/$netprefix"
+		fi
+		if [ -n "$gateway" ]; then
+			echo "gateway${version}=$gateway"
+		fi
+	fi
+}
+
+_render_netplan() {
+	# write a netplan stanza for the given device.
+	local name="$1" mac="$2" dhcp4="$3" dhcp6="$4" addrs="$5" \
+		gateway4="$6" gateway6="$7" ns_addrs="$8" ns_search="$9"
+	local n found="" bi="    " alist="" slist=""
+	echo "network:"
+	echo "  version: 2"
+	echo "  ethernets:"
+	echo "    $name:"
+	if [ -n "$mac" ]; then
+		echo "$bi  match:"
+		echo "$bi    macaddress: \"$mac\""
+		echo "$bi  set-name: $name"
+	fi
+	if [ -n "$dhcp4" ]; then
+		echo "$bi  dhcp4: $dhcp4"
+		echo "$bi  dhcp-identifier: mac"
 	fi
-	} > "$output"
+	[ -n "$dhcp6" ] && echo "$bi  dhcp6: $dhcp6"
+	if [ -n "$addrs" ]; then
+		alist=""
+		found=","
+		for n in $addrs; do
+			# remove dups
+			[ "${found#*,$n,}" = "${found}" ] || continue
+			found="${found}$n,"
+			alist="${alist}\"$n\", "
+		done
+		echo "$bi  addresses: [${alist%, }]"
+	fi
+	[ -n "$gateway4" ] && echo "$bi  gateway4: \"$gateway4\""
+	[ -n "$gateway6" ] && echo "$bi  gateway6: \"$gateway6\""
+
+	if [ -n "$ns_addrs" ]; then
+		alist="["
+		for n in $ns_addrs; do
+			# do not put in duplicates
+			[ "${alist#*\"$n\"}" = "$alist" ] || continue
+			alist="${alist}\"$n\", ";
+		done
+		alist="${alist%, }]"
+
+		if [ -n "$ns_search" ]; then
+			slist="["
+			for n in ${ns_search}; do
+				# do not put in duplicates
+				[ "${slist#*\"$n\"}" = "$slist" ] || continue
+				slist="${slist}\"$n\", ";
+			done
+			slist="${slist%, }]"
+		fi
+		echo "$bi  nameservers:"
+		echo "$bi    addresses: $alist"
+		[ -n "$slist" ] && echo "$bi    search: $slist"
+	fi
+}
+
+netinfo_to_netplan() {
+	# read /run/net-* files write netplan config.
+	if [ "${_in_subshell:-0}" = "0" ]; then
+		# subshell to avoid modification of variables by '.'
+		( _in_subshell=1; netinfo_to_netplan "$@" )
+		return
+	fi
+	local out_d="$1" tmpd
+	if command -v mktemp >/dev/null 2>&1; then
+		tmpd=$(mktemp -d "${TMPDIR:-/tmp}/${0##*/}.XXXXXX")
+	else
+		tmpd="${TMPDIR:-/tmp}/${0##*/}.niinfo.$$"
+		mkdir -p "$tmpd" || return
+	fi
+
+	local devices="" pre="" mac="" first=""
+	# we go through all the files presented and create per-device files in
+	# a tmpdir that are shell sourceable and closer to the netplan that
+	# we want to render. Then render those to netplan stanzas.
+	for f in "$@"; do
+		[ -f "$f" ] || continue
+		unset DEVICE DEVICE6 PROTO IPV6PROTO
+		unset IPV6ADDR IPV6NETMASK IPV6GATEWAY
+		unset IPV4ADDR IPV4NETMASK IPV4GATEWAY
+		. "$f" || { echo "WARN: failed '. \"$f\"'" 1>&2; return 1; }
+		local name=""
+		name=${DEVICE:-${DEVICE6}}
+		[ -n "$name" ] || {
+			echo "WARN: $f did not define DEVICE or DEVICE6" 1>&2;
+			return 1;
+		}
+		case " ${devices} " in
+			*\ ${name}\ *) first=false;;
+			*) first=true; devices="${devices} ${name}";;
+		esac
+
+		{
+		if [ "$first" = "true" -a -r "/sys/class/net/$name/address" ]; then
+				read mac < /sys/class/net/$name/address &&
+					echo "macaddress=$mac" ||
+					echo "WARN: failed to read mac for $name" 1>&2
+		fi
+		if [ -n "$DEVICE" ]; then
+			_declare_ip_info 4 "$PROTO" "$IPV4ADDR" "$IPV4NETMASK" "$IPV4GATEWAY"
+		elif [ -n "$DEVICE6" ]; then
+			_declare_ip_info 6 "$IPV6PROTO" "$IPV6ADDR" "$IPV6NETMASK" \
+				"$IPV6GATEWAY"
+		fi
+		_declare_sh_append_var ns_addresses "0.0.0.0" \
+			"${IPV4DNS0}" "${IPV4DNS1}" "${IPV6DNS0}" "${IPV6DNS1}"
+		_declare_sh_append_var ns_search "" "$DOMAINSEARCH" "$IPV6DOMAINSEARCH"
+		} >> "$tmpd/$name"
+	done
+
+	[ -d "$out_d" ] || mkdir -p "$out_d" ||
+		{ echo "WARN: failed mkdir $out_d"; return 1; }
+
+	for name in $devices; do
+		local macaddress="" dhcp4="" dhcp6="" addresses=""
+		local gateway4="" gateway6="" ns_addresses="" ns_search=""
+		. "$tmpd/$name"
+		_render_netplan "$name" "$macaddress" "$dhcp4" "$dhcp6" "$addresses" \
+			"$gateway4" "$gateway6" "$ns_addresses" "$ns_search" \
+			> "${out_d}/$name.yaml"
+	done
+	rm -Rf "$tmpd"
 }
 
 # Wait for queued kernel/udev events
diff --git a/tests/test_netinfo.d/ipv4/netplan/eth1.yaml b/tests/test_netinfo.d/ipv4/netplan/eth1.yaml
new file mode 100644
index 0000000..96770c6
--- /dev/null
+++ b/tests/test_netinfo.d/ipv4/netplan/eth1.yaml
@@ -0,0 +1,9 @@
+network:
+  version: 2
+  ethernets:
+    eth1:
+      dhcp4: true
+      dhcp-identifier: mac
+      nameservers:
+        addresses: ["192.168.122.1"]
+        search: ["foo.com"]
diff --git a/tests/test_netinfo.d/ipv4and6/netplan/eth0.yaml b/tests/test_netinfo.d/ipv4and6/netplan/eth0.yaml
new file mode 100644
index 0000000..b7433c5
--- /dev/null
+++ b/tests/test_netinfo.d/ipv4and6/netplan/eth0.yaml
@@ -0,0 +1,10 @@
+network:
+  version: 2
+  ethernets:
+    eth0:
+      dhcp4: true
+      dhcp-identifier: mac
+      dhcp6: true
+      nameservers:
+        addresses: ["192.168.122.1", "2001:67c:1562:8010::2:1"]
+        search: ["foo.com", "example.com", "ubuntu.com"]
diff --git a/tests/test_netinfo.d/ipv4static/netplan/eth1.yaml b/tests/test_netinfo.d/ipv4static/netplan/eth1.yaml
new file mode 100644
index 0000000..4fea0e5
--- /dev/null
+++ b/tests/test_netinfo.d/ipv4static/netplan/eth1.yaml
@@ -0,0 +1,6 @@
+network:
+  version: 2
+  ethernets:
+    eth1:
+      addresses: ["10.0.0.2/24"]
+      gateway4: "10.0.0.1"
diff --git a/tests/test_netinfo.d/ipv6/netplan/eno1.yaml b/tests/test_netinfo.d/ipv6/netplan/eno1.yaml
new file mode 100644
index 0000000..631d62b
--- /dev/null
+++ b/tests/test_netinfo.d/ipv6/netplan/eno1.yaml
@@ -0,0 +1,8 @@
+network:
+  version: 2
+  ethernets:
+    eno1:
+      dhcp6: true
+      nameservers:
+        addresses: ["2001:67c:1562:8010::2:1"]
+        search: ["example.com", "ubuntu.com"]
diff --git a/tests/test_netinfo.sh b/tests/test_netinfo.sh
index bd92173..2ebc554 100755
--- a/tests/test_netinfo.sh
+++ b/tests/test_netinfo.sh
@@ -52,6 +52,18 @@ run_resolvconf() {
    pass_on_nodiff "$tname" "$expected" "$found"
 }
 
+run_netinfo_to_netplan() {
+   local bname="$1" testdir="$2" results_d="$3"
+   local tname="$bname-netinfo-to-netplan"
+   shift 3
+   local found_d="$results_d/netplan"
+   local expected_d="$testdir/netplan"
+   [ -d "$expected_d" ] || return $RET_SKIP
+
+   _run_in_functions "$tname" netinfo_to_netplan "$found_d" "$@" || return
+   pass_on_nodiff "$tname" "$expected_d" "$found_d"
+}
+
 record() {
    local ret="$1"
    case "$ret" in
@@ -73,6 +85,9 @@ for testdir in "${data_dir}"/*; do
    run_resolvconf "$dname" "$testdir" "$results_d" $confs
    record $?
 
+   run_netinfo_to_netplan "$dname" "$testdir" "$results_d" $confs
+   record $?
+
    rm -Rf "${results_d}"
 done