Refactor VM port parsing to handle ignore flags (#17)

Author: eshlox

lib/vm.sh

@@ -49,32 +49,83 @@ dvm_vm_dir() {
 	printf '%s\n' "${LIMA_HOME:-$HOME/.lima}/$vm"
 }
 
-dvm_vm_ports_from_yaml() {
-	local file guest host ports
+dvm_vm_ports_from_yaml_parse() {
+	local file mode
 	file="$1/lima.yaml"
-	[ -f "$file" ] || {
-		printf -- '-\n'
-		return 0
-	}
-	ports="$(
-		awk '
-			/hostPort:/ { host=$NF; gsub(/"/, "", host) }
-			/guestPort:/ { guest=$NF; gsub(/"/, "", guest) }
-			host && guest { print host ":" guest; host=""; guest="" }
-		' "$file" | paste -sd, -
-	)"
+	mode="$2"
+	[ -f "$file" ] || return 0
+	awk -v mode="$mode" '
+		function reset() {
+			host = ""
+			guest = ""
+			ignore = ""
+		}
+		function value(line, key, tmp) {
+			tmp = line
+			gsub(/"/, "", tmp)
+			sub("^.*" key ":[[:space:]]*", "", tmp)
+			sub("[[:space:]]*#.*$", "", tmp)
+			sub("[[:space:]].*$", "", tmp)
+			return tmp
+		}
+		function emit() {
+			if (guest == "") {
+				return
+			}
+			if (ignore == "true") {
+				if (mode == "canonical") {
+					print guest ":" guest
+				}
+				return
+			}
+			if (host != "") {
+				print host ":" guest
+			}
+		}
+		BEGIN {
+			reset()
+		}
+		/^[[:space:]]*portForwards:/ {
+			in_ports = 1
+			next
+		}
+		in_ports && /^[^[:space:]-]/ {
+			emit()
+			reset()
+			in_ports = 0
+		}
+		!in_ports {
+			next
+		}
+		/^[[:space:]]*-/ {
+			emit()
+			reset()
+		}
+		/hostPort:[[:space:]]*/ {
+			host = value($0, "hostPort")
+		}
+		/guestPort:[[:space:]]*/ {
+			guest = value($0, "guestPort")
+		}
+		/ignore:[[:space:]]*true/ {
+			ignore = "true"
+		}
+		END {
+			if (in_ports) {
+				emit()
+			}
+		}
+	' "$file"
+}
+
+dvm_vm_ports_from_yaml() {
+	local ports
+	ports="$(dvm_vm_ports_from_yaml_parse "$1" display | paste -sd, -)"
 	printf '%s\n' "${ports:-"-"}"
 }
 
 dvm_vm_ports_canonical_from_yaml() {
-	local file
-	file="$1/lima.yaml"
-	[ -f "$file" ] || return 0
-	awk '
-		/hostPort:/ { host=$NF; gsub(/"/, "", host) }
-		/guestPort:/ { guest=$NF; gsub(/"/, "", guest) }
-		host && guest { print host ":" guest; host=""; guest="" }
-	' "$file" | sort
+	dvm_vm_ports_from_yaml_parse "$1" canonical | sort
 }
 
 dvm_list() {

tests/smoke.sh

@@ -91,13 +91,29 @@ write_port_forward() {
 YAML
 }
 
+write_ignore_port() {
+	local guest vm
+	vm="$1"
+	guest="$2"
+	mkdir -p "$DVM_TEST_VM_HOME/$vm"
+	if [ ! -f "$DVM_TEST_VM_HOME/$vm/lima.yaml" ]; then
+		printf 'portForwards:\n' >"$DVM_TEST_VM_HOME/$vm/lima.yaml"
+	fi
+	cat >>"$DVM_TEST_VM_HOME/$vm/lima.yaml" <<YAML
+- guestPort: $guest
+  proto: any
+  ignore: true
+YAML
+}
+
 write_port_forwards_from_expr() {
 	local expr port vm
 	vm="$1"
 	expr="$2"
 	rm -f "$DVM_TEST_VM_HOME/$vm/lima.yaml"
 	if printf '%s\n' "$expr" | grep -Fq '"ignore":true'; then
 		printf 'ignore-port 5355\n' >>"$DVM_TEST_LOG"
+		write_ignore_port "$vm" 5355
 	fi
 	while IFS= read -r port; do
 		[ -n "$port" ] || continue
@@ -145,6 +161,7 @@ create)
 			case "$2" in
 			*'"guestPort":5355'*'"ignore":true'* | *'"ignore":true'*'"guestPort":5355'*)
 				printf 'ignore-port 5355\n' >>"$DVM_TEST_LOG"
+				write_ignore_port "$vm" 5355
 				;;
 			esac
 			shift
@@ -301,6 +318,10 @@ grep -Fxq 'inline:app' "$VM_HOME_ROOT/dvm-app/home/inline-ran"
 "$TMP/local-bin/dvm-test" list >"$TMP/list.out"
 grep -Fq app "$TMP/list.out"
 grep -Fq '3000:3000,5173:5173' "$TMP/list.out"
+if grep -Fq '5355' "$TMP/list.out"; then
+	echo "ignored port 5355 leaked into dvm list output" >&2
+	exit 1
+fi
 
 cat >"$DVM_CONFIG/vms/app.sh" <<CONFIG
 DVM_GUEST_HOME="$VM_HOME_ROOT/dvm-app/home"