Refactor PortForward guest/host processing

Put into functions, so that they can be reused for ConfigFile.

Fix typo in comment, and add Instance to avoid future conflict.

Signed-off-by: Anders F Björklund <[email protected]>

Author: afbjorklund

pkg/limayaml/defaults.go

@@ -527,6 +527,47 @@ func FillDefault(y, d, o *LimaYAML, filePath string) {
 	y.CACertificates.Certs = caCerts
 }
 
+func processGuest(format string) (bytes.Buffer, error) {
+	tmpl, err := template.New("").Parse(format)
+	if err == nil {
+		user, _ := osutil.LimaUser(false)
+		data := map[string]string{
+			"Home": fmt.Sprintf("/home/%s.linux", user.Username),
+			"UID":  user.Uid,
+			"User": user.Username,
+		}
+		var out bytes.Buffer
+		if err := tmpl.Execute(&out, data); err == nil {
+			return out, nil
+		}
+	}
+	return bytes.Buffer{}, err
+}
+
+func processHost(format string, instDir string) (bytes.Buffer, error) {
+	tmpl, err := template.New("").Parse(format)
+	if err == nil {
+		user, _ := osutil.LimaUser(false)
+		home, _ := os.UserHomeDir()
+		limaHome, _ := dirnames.LimaDir()
+		data := map[string]string{
+			"Dir":  instDir,
+			"Home": home,
+			"Name": filepath.Base(instDir),
+			"UID":  user.Uid,
+			"User": user.Username,
+
+			"Instance": filepath.Base(instDir), // DEPRECATED, use `{{.Name}}`
+			"LimaHome": limaHome,               // DEPRECATED, (use `Dir` instead of `{{.LimaHome}}/{{.Instance}}`
+		}
+		var out bytes.Buffer
+		if err := tmpl.Execute(&out, data); err == nil {
+			return out, nil
+		}
+	}
+	return bytes.Buffer{}, err
+}
+
 func FillPortForwardDefaults(rule *PortForward, instDir string) {
 	if rule.Proto == "" {
 		rule.Proto = TCP
@@ -559,47 +600,20 @@ func FillPortForwardDefaults(rule *PortForward, instDir string) {
 		}
 	}
 	if rule.GuestSocket != "" {
-		tmpl, err := template.New("").Parse(rule.GuestSocket)
-		if err == nil {
-			user, _ := osutil.LimaUser(false)
-			data := map[string]string{
-				"Home": fmt.Sprintf("/home/%s.linux", user.Username),
-				"UID":  user.Uid,
-				"User": user.Username,
-			}
-			var out bytes.Buffer
-			if err := tmpl.Execute(&out, data); err == nil {
-				rule.GuestSocket = out.String()
-			} else {
-				logrus.WithError(err).Warnf("Couldn't process guestSocket %q as a template", rule.GuestSocket)
-			}
+		if out, err := processGuest(rule.GuestSocket); err == nil {
+			rule.GuestSocket = out.String()
+		} else {
+			logrus.WithError(err).Warnf("Couldn't process guestSocket %q as a template", rule.GuestSocket)
 		}
 	}
 	if rule.HostSocket != "" {
-		tmpl, err := template.New("").Parse(rule.HostSocket)
-		if err == nil {
-			user, _ := osutil.LimaUser(false)
-			home, _ := os.UserHomeDir()
-			limaHome, _ := dirnames.LimaDir()
-			data := map[string]string{
-				"Dir":  instDir,
-				"Home": home,
-				"Name": filepath.Base(instDir),
-				"UID":  user.Uid,
-				"User": user.Username,
-
-				"Instance": filepath.Base(instDir), // DEPRECATED, use `{{.Name}}`
-				"LimaHome": limaHome,               // DEPRECATED, (use `Dir` instead of `{{.LimaHome}}/{{.Instance}}`
-			}
-			var out bytes.Buffer
-			if err := tmpl.Execute(&out, data); err == nil {
-				rule.HostSocket = out.String()
-			} else {
-				logrus.WithError(err).Warnf("Couldn't process hostSocket %q as a template", rule.HostSocket)
-			}
+		if out, err := processHost(rule.HostSocket, instDir); err == nil {
+			rule.HostSocket = out.String()
+		} else {
+			logrus.WithError(err).Warnf("Couldn't process hostSocket %q as a template", rule.HostSocket)
 		}
 		if !filepath.IsAbs(rule.HostSocket) {
-			rule.HostSocket = filepath.Join(instDir, filenames.SocketDir, rule.HostSocket)
+			rule.HostSocket = filepath.Join(instDir, filenames.InstanceSocketDir, rule.HostSocket)
 		}
 	}
 }

pkg/store/filenames/filenames.go

@@ -45,8 +45,8 @@ const (
 	VzIdentifier       = "vz-identifier"
 	VzEfi              = "vz-efi"
 
-	// SocketDir is the default location for forwarded sockets with a relative paths in HostSocket
-	SocketDir = "sock"
+	// InstanceSocketDir is the default location for forwarded sockets with a relative path in HostSocket
+	InstanceSocketDir = "sock"
 )
 
 // Filenames used under a disk directory