driver(internal): consolidate some functions to single GetInfo() function

Signed-off-by: Ansuman Sahoo <[email protected]>

Author: unsuman

pkg/driver/driver.go

@@ -38,9 +38,6 @@ type Lifecycle interface {
 
 // GUI defines GUI-related operations.
 type GUI interface {
-	// CanRunGUI returns bool to indicate if the hostagent need to run GUI synchronously
-	CanRunGUI() bool
-
 	// RunGUI is for starting GUI synchronously by hostagent. This method should be wait and return only after vm terminates
 	// It returns error if there are any failures
 	RunGUI() error
@@ -72,23 +69,23 @@ type GuestAgent interface {
 	GuestAgentConn(_ context.Context) (net.Conn, error)
 }
 
-type Plugin interface {
-	// Name returns the name of the driver
-	Name() string
-
-	// SetConfig sets the configuration for the instance.
-	SetConfig(inst *store.Instance, sshLocalPort int)
-}
-
 // Driver interface is used by hostagent for managing vm.
 type Driver interface {
 	Lifecycle
 	GUI
 	SnapshotManager
 	Registration
 	GuestAgent
-	Plugin
 
-	GetVSockPort() int
-	GetVirtioPort() string
+	GetInfo() Info
+
+	// SetConfig sets the configuration for the instance.
+	SetConfig(inst *store.Instance, sshLocalPort int)
+}
+
+type Info struct {
+	DriverName string
+	CanRunGUI  bool
+	VsockPort  int
+	VirtioPort string
 }

pkg/driver/qemu/qemu_driver.go

@@ -69,14 +69,6 @@ func (l *LimaQemuDriver) SetConfig(inst *store.Instance, sshLocalPort int) {
 	l.SSHLocalPort = sshLocalPort
 }
 
-func (l *LimaQemuDriver) GetVirtioPort() string {
-	return l.VirtioPort
-}
-
-func (l *LimaQemuDriver) GetVSockPort() int {
-	return l.VSockPort
-}
-
 func (l *LimaQemuDriver) Validate() error {
 	if runtime.GOOS == "darwin" {
 		if err := l.checkBinarySignature(); err != nil {
@@ -519,18 +511,19 @@ func (a *qArgTemplateApplier) applyTemplate(qArg string) (string, error) {
 	return b.String(), nil
 }
 
-func (l *LimaQemuDriver) Name() string {
-	return "qemu"
+func (l *LimaQemuDriver) GetInfo() driver.Info {
+	return driver.Info{
+		DriverName: "qemu",
+		CanRunGUI:  false,
+		VsockPort:  l.VSockPort,
+		VirtioPort: l.VirtioPort,
+	}
 }
 
 func (l *LimaQemuDriver) Initialize(_ context.Context) error {
 	return nil
 }
 
-func (l *LimaQemuDriver) CanRunGUI() bool {
-	return false
-}
-
 func (l *LimaQemuDriver) RunGUI() error {
 	return nil
 }

pkg/driver/vz/vz_driver_darwin.go

@@ -92,14 +92,6 @@ func (l *LimaVzDriver) SetConfig(inst *store.Instance, sshLocalPort int) {
 	l.SSHLocalPort = sshLocalPort
 }
 
-func (l *LimaVzDriver) GetVirtioPort() string {
-	return l.VirtioPort
-}
-
-func (l *LimaVzDriver) GetVSockPort() int {
-	return l.VSockPort
-}
-
 func (l *LimaVzDriver) Validate() error {
 	macOSProductVersion, err := osutil.ProductVersion()
 	if err != nil {
@@ -208,7 +200,7 @@ func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {
 	return errCh, nil
 }
 
-func (l *LimaVzDriver) CanRunGUI() bool {
+func (l *LimaVzDriver) canRunGUI() bool {
 	switch *l.Instance.Config.Video.Display {
 	case "vz", "default":
 		return true
@@ -218,7 +210,7 @@ func (l *LimaVzDriver) CanRunGUI() bool {
 }
 
 func (l *LimaVzDriver) RunGUI() error {
-	if l.CanRunGUI() {
+	if l.canRunGUI() {
 		return l.machine.StartGraphicApplication(1920, 1200)
 	}
 	//nolint:revive // error-strings
@@ -265,8 +257,16 @@ func (l *LimaVzDriver) GuestAgentConn(_ context.Context) (net.Conn, error) {
 	return nil, errors.New("unable to connect to guest agent via vsock port 2222")
 }
 
-func (l *LimaVzDriver) Name() string {
-	return "vz"
+func (l *LimaVzDriver) GetInfo() driver.Info {
+	var info driver.Info
+	if l.Instance != nil && l.Instance.Config != nil {
+		info.CanRunGUI = l.canRunGUI()
+	}
+
+	info.DriverName = "vz"
+	info.VsockPort = l.VSockPort
+	info.VirtioPort = l.VirtioPort
+	return info
 }
 
 func (l *LimaVzDriver) Register(_ context.Context) error {

pkg/driver/wsl2/wsl_driver_windows.go

@@ -68,14 +68,6 @@ func New() *LimaWslDriver {
 	}
 }
 
-func (l *LimaWslDriver) GetVirtioPort() string {
-	return l.VirtioPort
-}
-
-func (l *LimaWslDriver) GetVSockPort() int {
-	return l.VSockPort
-}
-
 func (l *LimaWslDriver) SetConfig(inst *store.Instance, sshLocalPort int) {
 	l.Instance = inst
 	l.SSHLocalPort = sshLocalPort
@@ -173,7 +165,7 @@ func (l *LimaWslDriver) Start(ctx context.Context) (chan error, error) {
 
 // Requires WSLg, which requires specific version of WSL2 to be installed.
 // TODO: Add check and add support for WSLg (instead of VNC) to hostagent.
-func (l *LimaWslDriver) CanRunGUI() bool {
+func (l *LimaWslDriver) canRunGUI() bool {
 	// return *l.InstConfig.Video.Display == "wsl"
 	return false
 }
@@ -222,8 +214,13 @@ func (l *LimaWslDriver) GuestAgentConn(ctx context.Context) (net.Conn, error) {
 	return winio.Dial(ctx, sockAddr)
 }
 
-func (l *LimaWslDriver) Name() string {
-	return "wsl2"
+func (l *LimaWslDriver) GetInfo() driver.Info {
+	return driver.Info{
+		DriverName: "wsl",
+		CanRunGUI:  l.canRunGUI(),
+		VsockPort:  l.VSockPort,
+		VirtioPort: l.VirtioPort,
+	}
 }
 
 func (l *LimaWslDriver) Initialize(_ context.Context) error {

pkg/hostagent/hostagent.go

@@ -136,8 +136,8 @@ func New(instName string, stdout io.Writer, signalCh chan os.Signal, opts ...Opt
 		return nil, fmt.Errorf("failed to create driver instance: %w", err)
 	}
 
-	vSockPort := limaDriver.GetVSockPort()
-	virtioPort := limaDriver.GetVirtioPort()
+	vSockPort := limaDriver.GetInfo().VsockPort
+	virtioPort := limaDriver.GetInfo().VirtioPort
 
 	if err := cidata.GenerateCloudConfig(inst.Dir, instName, inst.Config); err != nil {
 		return nil, err
@@ -364,7 +364,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		logrus.Infof("VNC Password: `%s`", vncpwdfile)
 	}
 
-	if a.driver.CanRunGUI() {
+	if a.driver.GetInfo().CanRunGUI {
 		go func() {
 			err = a.startRoutinesAndWait(ctx, errCh)
 			if err != nil {

pkg/instance/start.go

@@ -190,7 +190,7 @@ func Start(ctx context.Context, inst *store.Instance, limactl string, launchHost
 		"hostagent",
 		"--pidfile", haPIDPath,
 		"--socket", haSockPath)
-	if prepared.Driver.CanRunGUI() {
+	if prepared.Driver.GetInfo().CanRunGUI {
 		args = append(args, "--run-gui")
 	}
 	if prepared.GuestAgent != "" {

pkg/registry/registry.go

@@ -170,7 +170,7 @@ func init() {
 
 func Register(driver driver.Driver) {
 	if DefaultRegistry != nil {
-		name := driver.Name()
+		name := driver.GetInfo().DriverName
 		if _, exists := DefaultRegistry.drivers[name]; exists {
 			return
 		}