Apply reviews

- Rename `GuestIPAddres` to `GuestIP`
- Change type of `GuestIP` from `string` to `net.IP`

Signed-off-by: Norio Nomura <norio.nomura@gmail.com>

Author: norio-nomura

pkg/hostagent/api/api.go

@@ -3,9 +3,11 @@
 
 package api
 
+import "net"
+
 type Info struct {
 	// Guest IP address directly accessible from the host.
-	GuestIPAddress string `json:"guestIPAddress,omitempty"`
+	GuestIP net.IP `json:"guestIPAddress,omitempty"`
 	// SSH local port on the host forwarded to the guest's port 22.
 	SSHLocalPort int `json:"sshLocalPort,omitempty"`
 }

pkg/hostagent/events/events.go

@@ -4,6 +4,7 @@
 package events
 
 import (
+	"net"
 	"time"
 )
 
@@ -17,7 +18,7 @@ type Status struct {
 	Errors []string `json:"errors,omitempty"`
 
 	// Guest IP address directly accessible from the host.
-	GuestIPAddress string `json:"guestIPAddress,omitempty"`
+	GuestIP net.IP `json:"guestIPAddress,omitempty"`
 	// SSH local port on the host forwarded to the guest's port 22.
 	SSHLocalPort int `json:"sshLocalPort,omitempty"`
 

pkg/hostagent/hostagent.go

@@ -86,8 +86,8 @@ type HostAgent struct {
 	// Guest interface name on the same subnet as the host,
 	guestIfnameOnSameSubnetAsHost string
 	// Guest IP address on the same subnet as the host.
-	guestIPAddress   string
-	guestIPAddressMu sync.RWMutex
+	guestIP   net.IP
+	guestIPMu sync.RWMutex
 }
 
 type options struct {
@@ -367,7 +367,7 @@ func (a *HostAgent) emitGuestIPAddressEvent(ctx context.Context, ip string) {
 	currentStatus := a.currentStatus
 	a.statusMu.RUnlock()
 
-	currentStatus.GuestIPAddress = ip
+	currentStatus.GuestIP = net.ParseIP(ip)
 
 	ev := events.Event{Status: currentStatus}
 	a.emitEvent(ctx, ev)
@@ -515,22 +515,22 @@ func (a *HostAgent) startRoutinesAndWait(ctx context.Context, errCh <-chan error
 }
 
 func (a *HostAgent) Info(_ context.Context) (*hostagentapi.Info, error) {
-	a.guestIPAddressMu.RLock()
-	defer a.guestIPAddressMu.RUnlock()
+	a.guestIPMu.RLock()
+	defer a.guestIPMu.RUnlock()
 	info := &hostagentapi.Info{
-		GuestIPAddress: a.guestIPAddress,
-		SSHLocalPort:   a.sshLocalPort,
+		GuestIP:      a.guestIP,
+		SSHLocalPort: a.sshLocalPort,
 	}
 	return info, nil
 }
 
 func (a *HostAgent) sshAddressPort() (sshAddress string, sshPort int) {
-	a.guestIPAddressMu.RLock()
-	defer a.guestIPAddressMu.RUnlock()
+	a.guestIPMu.RLock()
+	defer a.guestIPMu.RUnlock()
 	sshAddress = a.instSSHAddress
 	sshPort = a.sshLocalPort
-	if a.guestIPAddress != "" {
-		sshAddress = a.guestIPAddress
+	if a.guestIP != nil {
+		sshAddress = a.guestIP.String()
 		sshPort = 22
 		logrus.Debugf("Using the guest IP address %q directly", sshAddress)
 	}

pkg/hostagent/requirements.go

@@ -326,9 +326,9 @@ func (a *HostAgent) detectGuestIfnameOnSameSubnetAtHost(stdout string) error {
 			if ifi.HardwareAddr.String() != neighbor.LLADDR {
 				continue
 			}
-			a.guestIPAddressMu.Lock()
+			a.guestIPMu.Lock()
 			a.guestIfnameOnSameSubnetAsHost = neighbor.DEV
-			a.guestIPAddressMu.Unlock()
+			a.guestIPMu.Unlock()
 			logrus.Infof("Detected the guest has interface %q in same subnet on the host", a.guestIfnameOnSameSubnetAsHost)
 			return nil
 		}
@@ -359,9 +359,9 @@ func (a *HostAgent) detectGuestIPAddress(stdout string) error {
 				if addr.Family != "inet" {
 					continue
 				}
-				a.guestIPAddressMu.Lock()
-				a.guestIPAddress = addr.Local
-				a.guestIPAddressMu.Unlock()
+				a.guestIPMu.Lock()
+				a.guestIP = net.ParseIP(addr.Local)
+				a.guestIPMu.Unlock()
 				logrus.Infof("The guest IP address on the interface %q is %q", a.guestIfnameOnSameSubnetAsHost, addr.Local)
 				ctx := context.Background()
 				a.emitGuestIPAddressEvent(ctx, addr.Local)

pkg/instance/start.go

@@ -293,12 +293,12 @@ func watchHostAgentEvents(ctx context.Context, inst *limatype.Instance, haStdout
 			inst.SSHLocalPort = ev.Status.SSHLocalPort
 		}
 
-		if !printedGuestIPAddress && ev.Status.GuestIPAddress != "" {
-			logrus.Infof("Guest IP Address: %s", ev.Status.GuestIPAddress)
+		if !printedGuestIPAddress && ev.Status.GuestIP != nil {
+			logrus.Infof("Guest IP Address: %s", ev.Status.GuestIP.String())
 			printedGuestIPAddress = true
 
 			// Update the instance's Guest IP address
-			inst.GuestIPAddress = ev.Status.GuestIPAddress
+			inst.GuestIP = ev.Status.GuestIP
 		}
 
 		if showProgress && ev.Status.CloudInitProgress != nil {

pkg/limatype/lima_instance.go

@@ -6,6 +6,7 @@ package limatype
 import (
 	"encoding/json"
 	"errors"
+	"net"
 	"os"
 	"path/filepath"
 
@@ -48,7 +49,7 @@ type Instance struct {
 	LimaVersion     string            `json:"limaVersion"`
 	Param           map[string]string `json:"param,omitempty"`
 	// Guest IP address directly accessible from the host.
-	GuestIPAddress string `json:"guestIPAddress,omitempty"`
+	GuestIP net.IP `json:"guestIPAddress,omitempty"`
 }
 
 // Protect protects the instance to prohibit accidental removal.
@@ -113,8 +114,8 @@ func (inst *Instance) UnmarshalJSON(data []byte) error {
 func (inst *Instance) SSHAddressPort() (sshAddress string, sshPort int) {
 	sshAddress = inst.SSHAddress
 	sshPort = inst.SSHLocalPort
-	if inst.GuestIPAddress != "" {
-		sshAddress = inst.GuestIPAddress
+	if inst.GuestIP != nil {
+		sshAddress = inst.GuestIP.String()
 		sshPort = 22
 	}
 	return sshAddress, sshPort

pkg/store/instance.go

@@ -82,7 +82,7 @@ func Inspect(ctx context.Context, instName string) (*limatype.Instance, error) {
 				inst.Status = limatype.StatusBroken
 				inst.Errors = append(inst.Errors, fmt.Errorf("failed to get Info from %q: %w", haSock, err))
 			} else {
-				inst.GuestIPAddress = info.GuestIPAddress
+				inst.GuestIP = info.GuestIP
 				inst.SSHLocalPort = info.SSHLocalPort
 			}
 		}