Skip to content

Fix: Pass SSHLocalPort in Instance to configure driver #3746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Pass SSHLocalPort in Instance to configure driver #3746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/driver/driver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 2 additions & 3 deletions pkg/driver/external/client/methods.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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)
Expand Down
15 changes: 3 additions & 12 deletions pkg/driver/external/driver.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion pkg/driver/external/driver.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ message StartResponse {

message SetConfigRequest {
bytes instance_config_json = 1;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one should remain, I think?

int64 ssh_local_port = 3;
}

message ChangeDisplayPasswordRequest {
Expand Down
2 changes: 1 addition & 1 deletion pkg/driver/external/server/methods.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/driver/qemu/qemu_driver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions pkg/driver/vz/vz_driver_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions pkg/driver/wsl2/wsl_driver_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 3 additions & 2 deletions pkg/driverutil/instance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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
}
36 changes: 18 additions & 18 deletions pkg/registry/registry_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down