Merge pull request #3746 from unsuman/fix/rm-sshlocalport

AkihiroSuda · web-flow · commit 5b41de811300 · 2025-08-05T14:33:43.000+09:00
Fix: Pass `SSHLocalPort` in Instance to configure driver
diff --git a/pkg/driver/driver.go b/pkg/driver/driver.go
@@ -80,7 +80,7 @@ type Driver interface {
 	Info() Info
 
 	// SetConfig sets the configuration for the instance.
-	Configure(inst *store.Instance, sshLocalPort int) *ConfiguredDriver
+	Configure(inst *store.Instance) *ConfiguredDriver
 }
 
 type ConfiguredDriver struct {
diff --git a/pkg/driver/external/client/methods.go b/pkg/driver/external/client/methods.go
@@ -281,8 +281,8 @@ func (d *DriverClient) Info() driver.Info {
 	return info
 }
 
-func (d *DriverClient) Configure(inst *store.Instance, sshLocalPort int) *driver.ConfiguredDriver {
-	d.logger.Debugf("Setting config for instance %s with SSH local port %d", inst.Name, sshLocalPort)
+func (d *DriverClient) Configure(inst *store.Instance) *driver.ConfiguredDriver {
+	d.logger.Debugf("Setting config for instance %s with SSH local port %d", inst.Name, inst.SSHLocalPort)
 
 	instJSON, err := inst.MarshalJSON()
 	if err != nil {
@@ -295,7 +295,6 @@ func (d *DriverClient) Configure(inst *store.Instance, sshLocalPort int) *driver
 
 	_, err = d.DriverSvc.SetConfig(ctx, &pb.SetConfigRequest{
 		InstanceConfigJson: instJSON,
-		SshLocalPort:       int64(sshLocalPort),
 	})
 	if err != nil {
 		d.logger.Errorf("Failed to set config: %v", err)
diff --git a/pkg/driver/external/driver.pb.go b/pkg/driver/external/driver.pb.go
diff --git a/pkg/driver/external/driver.proto b/pkg/driver/external/driver.proto
@@ -42,7 +42,6 @@ message StartResponse {
 
 message SetConfigRequest {
   bytes instance_config_json = 1;
-  int64 ssh_local_port = 3;
 }
 
 message ChangeDisplayPasswordRequest {
diff --git a/pkg/driver/external/server/methods.go b/pkg/driver/external/server/methods.go
@@ -62,7 +62,7 @@ func (s *DriverServer) SetConfig(_ context.Context, req *pb.SetConfigRequest) (*
 		return &emptypb.Empty{}, err
 	}
 
-	_ = s.driver.Configure(&inst, int(req.SshLocalPort))
+	_ = s.driver.Configure(&inst)
 
 	return &emptypb.Empty{}, nil
 }
diff --git a/pkg/driver/qemu/qemu_driver.go b/pkg/driver/qemu/qemu_driver.go
@@ -64,9 +64,9 @@ func New() *LimaQemuDriver {
 	}
 }
 
-func (l *LimaQemuDriver) Configure(inst *store.Instance, sshLocalPort int) *driver.ConfiguredDriver {
+func (l *LimaQemuDriver) Configure(inst *store.Instance) *driver.ConfiguredDriver {
 	l.Instance = inst
-	l.SSHLocalPort = sshLocalPort
+	l.SSHLocalPort = inst.SSHLocalPort
 
 	return &driver.ConfiguredDriver{
 		Driver: l,
diff --git a/pkg/driver/vz/vz_driver_darwin.go b/pkg/driver/vz/vz_driver_darwin.go
@@ -87,9 +87,9 @@ func New() *LimaVzDriver {
 	}
 }
 
-func (l *LimaVzDriver) Configure(inst *store.Instance, sshLocalPort int) *driver.ConfiguredDriver {
+func (l *LimaVzDriver) Configure(inst *store.Instance) *driver.ConfiguredDriver {
 	l.Instance = inst
-	l.SSHLocalPort = sshLocalPort
+	l.SSHLocalPort = inst.SSHLocalPort
 
 	return &driver.ConfiguredDriver{
 		Driver: l,
diff --git a/pkg/driver/wsl2/wsl_driver_windows.go b/pkg/driver/wsl2/wsl_driver_windows.go
@@ -68,9 +68,9 @@ func New() *LimaWslDriver {
 	}
 }
 
-func (l *LimaWslDriver) Configure(inst *store.Instance, sshLocalPort int) *driver.ConfiguredDriver {
+func (l *LimaWslDriver) Configure(inst *store.Instance) *driver.ConfiguredDriver {
 	l.Instance = inst
-	l.SSHLocalPort = sshLocalPort
+	l.SSHLocalPort = inst.SSHLocalPort
 
 	return &driver.ConfiguredDriver{
 		Driver: l,
diff --git a/pkg/driverutil/instance.go b/pkg/driverutil/instance.go
@@ -22,6 +22,7 @@ func CreateConfiguredDriver(inst *store.Instance, sshLocalPort int) (*driver.Con
 		return nil, fmt.Errorf("unknown or unsupported VM type: %s", *limaDriver)
 	}
 
+	inst.SSHLocalPort = sshLocalPort
 	if extDriver != nil {
 		extDriver.Logger.Debugf("Using external driver %q", extDriver.Name)
 		if extDriver.Client == nil || extDriver.Command == nil {
@@ -35,9 +36,9 @@ func CreateConfiguredDriver(inst *store.Instance, sshLocalPort int) (*driver.Con
 			extDriver.InstanceName = inst.Name
 		}
 
-		return extDriver.Client.Configure(inst, sshLocalPort), nil
+		return extDriver.Client.Configure(inst), nil
 	}
 
 	logrus.Debugf("Using internal driver %q", intDriver.Info().DriverName)
-	return intDriver.Configure(inst, sshLocalPort), nil
+	return intDriver.Configure(inst), nil
 }
diff --git a/pkg/registry/registry_test.go b/pkg/registry/registry_test.go
@@ -27,24 +27,24 @@ func newMockDriver(name string) *mockDriver {
 
 var _ driver.Driver = (*mockDriver)(nil)
 
-func (m *mockDriver) Validate() error                                             { return nil }
-func (m *mockDriver) Initialize(_ context.Context) error                          { return nil }
-func (m *mockDriver) CreateDisk(_ context.Context) error                          { return nil }
-func (m *mockDriver) Start(_ context.Context) (chan error, error)                 { return nil, nil }
-func (m *mockDriver) Stop(_ context.Context) error                                { return nil }
-func (m *mockDriver) RunGUI() error                                               { return nil }
-func (m *mockDriver) ChangeDisplayPassword(_ context.Context, _ string) error     { return nil }
-func (m *mockDriver) DisplayConnection(_ context.Context) (string, error)         { return "", nil }
-func (m *mockDriver) CreateSnapshot(_ context.Context, _ string) error            { return nil }
-func (m *mockDriver) ApplySnapshot(_ context.Context, _ string) error             { return nil }
-func (m *mockDriver) DeleteSnapshot(_ context.Context, _ string) error            { return nil }
-func (m *mockDriver) ListSnapshots(_ context.Context) (string, error)             { return "", nil }
-func (m *mockDriver) Register(_ context.Context) error                            { return nil }
-func (m *mockDriver) Unregister(_ context.Context) error                          { return nil }
-func (m *mockDriver) ForwardGuestAgent() bool                                     { return false }
-func (m *mockDriver) GuestAgentConn(_ context.Context) (net.Conn, string, error)  { return nil, "", nil }
-func (m *mockDriver) Info() driver.Info                                           { return driver.Info{DriverName: m.Name} }
-func (m *mockDriver) Configure(_ *store.Instance, _ int) *driver.ConfiguredDriver { return nil }
+func (m *mockDriver) Validate() error                                            { return nil }
+func (m *mockDriver) Initialize(_ context.Context) error                         { return nil }
+func (m *mockDriver) CreateDisk(_ context.Context) error                         { return nil }
+func (m *mockDriver) Start(_ context.Context) (chan error, error)                { return nil, nil }
+func (m *mockDriver) Stop(_ context.Context) error                               { return nil }
+func (m *mockDriver) RunGUI() error                                              { return nil }
+func (m *mockDriver) ChangeDisplayPassword(_ context.Context, _ string) error    { return nil }
+func (m *mockDriver) DisplayConnection(_ context.Context) (string, error)        { return "", nil }
+func (m *mockDriver) CreateSnapshot(_ context.Context, _ string) error           { return nil }
+func (m *mockDriver) ApplySnapshot(_ context.Context, _ string) error            { return nil }
+func (m *mockDriver) DeleteSnapshot(_ context.Context, _ string) error           { return nil }
+func (m *mockDriver) ListSnapshots(_ context.Context) (string, error)            { return "", nil }
+func (m *mockDriver) Register(_ context.Context) error                           { return nil }
+func (m *mockDriver) Unregister(_ context.Context) error                         { return nil }
+func (m *mockDriver) ForwardGuestAgent() bool                                    { return false }
+func (m *mockDriver) GuestAgentConn(_ context.Context) (net.Conn, string, error) { return nil, "", nil }
+func (m *mockDriver) Info() driver.Info                                          { return driver.Info{DriverName: m.Name} }
+func (m *mockDriver) Configure(_ *store.Instance) *driver.ConfiguredDriver       { return nil }
 
 func TestRegister(t *testing.T) {
 	BackupRegistry(t)

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ type Driver interface {`
`80`	`80`	`Info() Info`
`81`	`81`
`82`	`82`	`// SetConfig sets the configuration for the instance.`
`83`		`- Configure(inst store.Instance, sshLocalPort int) ConfiguredDriver`
	`83`	`+ Configure(inst store.Instance) ConfiguredDriver`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`type ConfiguredDriver struct {`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,6 @@ message StartResponse {`
`42`	`42`
`43`	`43`	`message SetConfigRequest {`
`44`	`44`	`bytes instance_config_json = 1;`
`45`		`- int64 ssh_local_port = 3;`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`message ChangeDisplayPasswordRequest {`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ func (s DriverServer) SetConfig(_ context.Context, req pb.SetConfigRequest) (*`
`62`	`62`	`return &emptypb.Empty{}, err`
`63`	`63`	`}`
`64`	`64`
`65`		`- _ = s.driver.Configure(&inst, int(req.SshLocalPort))`
	`65`	`+ _ = s.driver.Configure(&inst)`
`66`	`66`
`67`	`67`	`return &emptypb.Empty{}, nil`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,9 +64,9 @@ func New() *LimaQemuDriver {`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`
`67`		`-func (l LimaQemuDriver) Configure(inst store.Instance, sshLocalPort int) *driver.ConfiguredDriver {`
	`67`	`+func (l LimaQemuDriver) Configure(inst store.Instance) *driver.ConfiguredDriver {`
`68`	`68`	`l.Instance = inst`
`69`		`- l.SSHLocalPort = sshLocalPort`
	`69`	`+ l.SSHLocalPort = inst.SSHLocalPort`
`70`	`70`
`71`	`71`	`return &driver.ConfiguredDriver{`
`72`	`72`	`Driver: l,`
Original file line number	Diff line number	Diff line change
`@@ -87,9 +87,9 @@ func New() *LimaVzDriver {`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`
`90`		`-func (l LimaVzDriver) Configure(inst store.Instance, sshLocalPort int) *driver.ConfiguredDriver {`
	`90`	`+func (l LimaVzDriver) Configure(inst store.Instance) *driver.ConfiguredDriver {`
`91`	`91`	`l.Instance = inst`
`92`		`- l.SSHLocalPort = sshLocalPort`
	`92`	`+ l.SSHLocalPort = inst.SSHLocalPort`
`93`	`93`
`94`	`94`	`return &driver.ConfiguredDriver{`
`95`	`95`	`Driver: l,`
Original file line number	Diff line number	Diff line change
`@@ -68,9 +68,9 @@ func New() *LimaWslDriver {`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
`71`		`-func (l LimaWslDriver) Configure(inst store.Instance, sshLocalPort int) *driver.ConfiguredDriver {`
	`71`	`+func (l LimaWslDriver) Configure(inst store.Instance) *driver.ConfiguredDriver {`
`72`	`72`	`l.Instance = inst`
`73`		`- l.SSHLocalPort = sshLocalPort`
	`73`	`+ l.SSHLocalPort = inst.SSHLocalPort`
`74`	`74`
`75`	`75`	`return &driver.ConfiguredDriver{`
`76`	`76`	`Driver: l,`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ func CreateConfiguredDriver(inst store.Instance, sshLocalPort int) (driver.Con`
`22`	`22`	`return nil, fmt.Errorf("unknown or unsupported VM type: %s", *limaDriver)`
`23`	`23`	`}`
`24`	`24`
	`25`	`+ inst.SSHLocalPort = sshLocalPort`
`25`	`26`	`if extDriver != nil {`
`26`	`27`	`extDriver.Logger.Debugf("Using external driver %q", extDriver.Name)`
`27`	`28`	`if extDriver.Client == nil \|\| extDriver.Command == nil {`
`@@ -35,9 +36,9 @@ func CreateConfiguredDriver(inst store.Instance, sshLocalPort int) (driver.Con`
`35`	`36`	`extDriver.InstanceName = inst.Name`
`36`	`37`	`}`
`37`	`38`
`38`		`- return extDriver.Client.Configure(inst, sshLocalPort), nil`
	`39`	`+ return extDriver.Client.Configure(inst), nil`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`logrus.Debugf("Using internal driver %q", intDriver.Info().DriverName)`
`42`		`- return intDriver.Configure(inst, sshLocalPort), nil`
	`43`	`+ return intDriver.Configure(inst), nil`
`43`	`44`	`}`