Re-organize hypervisor implementations

Ensures that for each hypervisor implementation, their `config.go` file deals with implementing the `VirtProvider` interface while the `machine.go` file is for implementing the `VM` interface. Moves the `Virtualization` type into a common file and created wrappers for the individual hypervisors. Allows for shared functions that are exactly the same while providing the flexibility to create hypervisor-specific implementations of the functions. [NO NEW TESTS NEEDED] Signed-off-by: Jake Correnti <[email protected]>
rhatdan · Jun 23, 2023 · 5160342 · 5160342
1 parent 49e0bde
commit 5160342
Show file tree

Hide file tree

Showing 13 changed files with 627 additions and 643 deletions.
diff --git a/cmd/podman/machine/platform.go b/cmd/podman/machine/platform.go
@@ -29,7 +29,7 @@ func GetSystemProvider() (machine.VirtProvider, error) {
 	logrus.Debugf("Using Podman machine with `%s` virtualization provider", resolvedVMType.String())
 	switch resolvedVMType {
 	case machine.QemuVirt:
-		return qemu.GetVirtualizationProvider(), nil
+		return qemu.VirtualizationProvider(), nil
 	default:
 		return nil, fmt.Errorf("unsupported virtualization provider: `%s`", resolvedVMType.String())
 	}

diff --git a/cmd/podman/machine/platform_darwin.go b/cmd/podman/machine/platform_darwin.go
@@ -30,9 +30,9 @@ func GetSystemProvider() (machine.VirtProvider, error) {
 	logrus.Debugf("Using Podman machine with `%s` virtualization provider", resolvedVMType.String())
 	switch resolvedVMType {
 	case machine.QemuVirt:
-		return qemu.GetVirtualizationProvider(), nil
+		return qemu.VirtualizationProvider(), nil
 	case machine.AppleHvVirt:
-		return applehv.GetVirtualizationProvider(), nil
+		return applehv.VirtualizationProvider(), nil
 	default:
 		return nil, fmt.Errorf("unsupported virtualization provider: `%s`", resolvedVMType.String())
 	}

diff --git a/cmd/podman/machine/platform_windows.go b/cmd/podman/machine/platform_windows.go
@@ -28,9 +28,9 @@ func GetSystemProvider() (machine.VirtProvider, error) {
 	logrus.Debugf("Using Podman machine with `%s` virtualization provider", resolvedVMType.String())
 	switch resolvedVMType {
 	case machine.WSLVirt:
-		return wsl.GetWSLProvider(), nil
+		return wsl.VirtualizationProvider(), nil
 	case machine.HyperVVirt:
-		return hyperv.GetVirtualizationProvider(), nil
+		return hyperv.VirtualizationProvider(), nil
 	default:
 		return nil, fmt.Errorf("unsupported virtualization provider: `%s`", resolvedVMType.String())
 	}

diff --git a/pkg/machine/applehv/config.go b/pkg/machine/applehv/config.go
@@ -17,10 +17,8 @@ const (
 	defaultVFKitEndpoint = "http://localhost:8081"
 )
 
-type Virtualization struct {
-	artifact    machine.Artifact
-	compression machine.ImageCompression
-	format      machine.ImageFormat
+type AppleHVVirtualization struct {
+	machine.Virtualization
 }
 
 type MMHardwareConfig struct {
@@ -30,11 +28,13 @@ type MMHardwareConfig struct {
 	Memory   int32
 }
 
-func (v Virtualization) Artifact() machine.Artifact {
-	return machine.Metal
+func VirtualizationProvider() machine.VirtProvider {
+	return &AppleHVVirtualization{
+		machine.NewVirtualization(machine.Metal, machine.Xz, machine.Raw),
+	}
 }
 
-func (v Virtualization) CheckExclusiveActiveVM() (bool, string, error) {
+func (v AppleHVVirtualization) CheckExclusiveActiveVM() (bool, string, error) {
 	fsVms, err := getVMInfos()
 	if err != nil {
 		return false, "", err
@@ -48,15 +48,7 @@ func (v Virtualization) CheckExclusiveActiveVM() (bool, string, error) {
 	return false, "", nil
 }
 
-func (v Virtualization) Compression() machine.ImageCompression {
-	return v.compression
-}
-
-func (v Virtualization) Format() machine.ImageFormat {
-	return v.format
-}
-
-func (v Virtualization) IsValidVMName(name string) (bool, error) {
+func (v AppleHVVirtualization) IsValidVMName(name string) (bool, error) {
 	mm := MacMachine{Name: name}
 	configDir, err := machine.GetConfDir(machine.AppleHvVirt)
 	if err != nil {
@@ -68,7 +60,7 @@ func (v Virtualization) IsValidVMName(name string) (bool, error) {
 	return true, nil
 }
 
-func (v Virtualization) List(opts machine.ListOptions) ([]*machine.ListResponse, error) {
+func (v AppleHVVirtualization) List(opts machine.ListOptions) ([]*machine.ListResponse, error) {
 	var (
 		response []*machine.ListResponse
 	)
@@ -108,12 +100,12 @@ func (v Virtualization) List(opts machine.ListOptions) ([]*machine.ListResponse,
 	return response, nil
 }
 
-func (v Virtualization) LoadVMByName(name string) (machine.VM, error) {
+func (v AppleHVVirtualization) LoadVMByName(name string) (machine.VM, error) {
 	m := MacMachine{Name: name}
 	return m.loadFromFile()
 }
 
-func (v Virtualization) NewMachine(opts machine.InitOptions) (machine.VM, error) {
+func (v AppleHVVirtualization) NewMachine(opts machine.InitOptions) (machine.VM, error) {
 	m := MacMachine{Name: opts.Name}
 
 	configDir, err := machine.GetConfDir(machine.AppleHvVirt)
@@ -149,16 +141,16 @@ func (v Virtualization) NewMachine(opts machine.InitOptions) (machine.VM, error)
 	return m.loadFromFile()
 }
 
-func (v Virtualization) RemoveAndCleanMachines() error {
+func (v AppleHVVirtualization) RemoveAndCleanMachines() error {
 	// This can be implemented when host networking is completed.
 	return machine.ErrNotImplemented
 }
 
-func (v Virtualization) VMType() machine.VMType {
+func (v AppleHVVirtualization) VMType() machine.VMType {
 	return vmtype
 }
 
-func (v Virtualization) loadFromLocalJson() ([]*MacMachine, error) {
+func (v AppleHVVirtualization) loadFromLocalJson() ([]*MacMachine, error) {
 	var (
 		jsonFiles []string
 		mms       []*MacMachine

diff --git a/pkg/machine/applehv/machine.go b/pkg/machine/applehv/machine.go
@@ -27,14 +27,6 @@ var (
 	vmtype = machine.AppleHvVirt
 )
 
-func GetVirtualizationProvider() machine.VirtProvider {
-	return &Virtualization{
-		artifact:    machine.None,
-		compression: machine.Xz,
-		format:      machine.Raw,
-	}
-}
-
 // VfkitHelper describes the use of vfkit: cmdline and endpoint
 type VfkitHelper struct {
 	Bootloader        string

diff --git a/pkg/machine/config.go b/pkg/machine/config.go
@@ -48,19 +48,6 @@ const (
 	DefaultMachineName string = "podman-machine-default"
 )
 
-type VirtProvider interface {
-	Artifact() Artifact
-	CheckExclusiveActiveVM() (bool, string, error)
-	Compression() ImageCompression
-	Format() ImageFormat
-	IsValidVMName(name string) (bool, error)
-	List(opts ListOptions) ([]*ListResponse, error)
-	LoadVMByName(name string) (VM, error)
-	NewMachine(opts InitOptions) (VM, error)
-	RemoveAndCleanMachines() error
-	VMType() VMType
-}
-
 type RemoteConnectionType string
 
 var (
@@ -428,3 +415,42 @@ func ParseVMType(input string, emptyFallback VMType) (VMType, error) {
 		return QemuVirt, fmt.Errorf("unknown VMType `%s`", input)
 	}
 }
+
+type VirtProvider interface {
+	Artifact() Artifact
+	CheckExclusiveActiveVM() (bool, string, error)
+	Compression() ImageCompression
+	Format() ImageFormat
+	IsValidVMName(name string) (bool, error)
+	List(opts ListOptions) ([]*ListResponse, error)
+	LoadVMByName(name string) (VM, error)
+	NewMachine(opts InitOptions) (VM, error)
+	RemoveAndCleanMachines() error
+	VMType() VMType
+}
+
+type Virtualization struct {
+	artifact    Artifact
+	compression ImageCompression
+	format      ImageFormat
+}
+
+func (p *Virtualization) Artifact() Artifact {
+	return p.artifact
+}
+
+func (p *Virtualization) Compression() ImageCompression {
+	return p.compression
+}
+
+func (p *Virtualization) Format() ImageFormat {
+	return p.format
+}
+
+func NewVirtualization(artifact Artifact, compression ImageCompression, format ImageFormat) Virtualization {
+	return Virtualization{
+		artifact,
+		compression,
+		format,
+	}
+}
diff --git a/pkg/machine/e2e/machine_test.go b/pkg/machine/e2e/machine_test.go
@@ -44,7 +44,7 @@ func TestMachine(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	qemuVP := qemu.GetVirtualizationProvider()
+	qemuVP := qemu.VirtualizationProvider()
 	fcd, err := machine.GetFCOSDownload(qemuVP, defaultStream)
 	if err != nil {
 		Fail("unable to get virtual machine image")

diff --git a/pkg/machine/hyperv/config.go b/pkg/machine/hyperv/config.go
@@ -17,17 +17,17 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-type Virtualization struct {
-	artifact    machine.Artifact
-	compression machine.ImageCompression
-	format      machine.ImageFormat
+type HyperVVirtualization struct {
+	machine.Virtualization
 }
 
-func (v Virtualization) Artifact() machine.Artifact {
-	return machine.None
+func VirtualizationProvider() machine.VirtProvider {
+	return &HyperVVirtualization{
+		machine.NewVirtualization(machine.HyperV, machine.Zip, machine.Vhdx),
+	}
 }
 
-func (v Virtualization) CheckExclusiveActiveVM() (bool, string, error) {
+func (v HyperVVirtualization) CheckExclusiveActiveVM() (bool, string, error) {
 	vmm := hypervctl.NewVirtualMachineManager()
 	// Use of GetAll is OK here because we do not want to use the same name
 	// as something already *actually* configured in hyperv
@@ -43,15 +43,7 @@ func (v Virtualization) CheckExclusiveActiveVM() (bool, string, error) {
 	return false, "", nil
 }
 
-func (v Virtualization) Compression() machine.ImageCompression {
-	return v.compression
-}
-
-func (v Virtualization) Format() machine.ImageFormat {
-	return v.format
-}
-
-func (v Virtualization) IsValidVMName(name string) (bool, error) {
+func (v HyperVVirtualization) IsValidVMName(name string) (bool, error) {
 	// We check both the local filesystem and hyperv for the valid name
 	mm := HyperVMachine{Name: name}
 	configDir, err := machine.GetConfDir(v.VMType())
@@ -69,7 +61,7 @@ func (v Virtualization) IsValidVMName(name string) (bool, error) {
 	return true, nil
 }
 
-func (v Virtualization) List(opts machine.ListOptions) ([]*machine.ListResponse, error) {
+func (v HyperVVirtualization) List(opts machine.ListOptions) ([]*machine.ListResponse, error) {
 	mms, err := v.loadFromLocalJson()
 	if err != nil {
 		return nil, err
@@ -103,12 +95,12 @@ func (v Virtualization) List(opts machine.ListOptions) ([]*machine.ListResponse,
 	return response, err
 }
 
-func (v Virtualization) LoadVMByName(name string) (machine.VM, error) {
+func (v HyperVVirtualization) LoadVMByName(name string) (machine.VM, error) {
 	m := &HyperVMachine{Name: name}
 	return m.loadFromFile()
 }
 
-func (v Virtualization) NewMachine(opts machine.InitOptions) (machine.VM, error) {
+func (v HyperVVirtualization) NewMachine(opts machine.InitOptions) (machine.VM, error) {
 	m := HyperVMachine{Name: opts.Name}
 	if len(opts.ImagePath) < 1 {
 		return nil, errors.New("must define --image-path for hyperv support")
@@ -180,7 +172,7 @@ func (v Virtualization) NewMachine(opts machine.InitOptions) (machine.VM, error)
 	return v.LoadVMByName(opts.Name)
 }
 
-func (v Virtualization) RemoveAndCleanMachines() error {
+func (v HyperVVirtualization) RemoveAndCleanMachines() error {
 	// Error handling used here is following what qemu did
 	var (
 		prevErr error
@@ -238,11 +230,11 @@ func (v Virtualization) RemoveAndCleanMachines() error {
 	return prevErr
 }
 
-func (v Virtualization) VMType() machine.VMType {
+func (v HyperVVirtualization) VMType() machine.VMType {
 	return vmtype
 }
 
-func (v Virtualization) loadFromLocalJson() ([]*HyperVMachine, error) {
+func (v HyperVVirtualization) loadFromLocalJson() ([]*HyperVMachine, error) {
 	var (
 		jsonFiles []string
 		mms       []*HyperVMachine

diff --git a/pkg/machine/hyperv/machine.go b/pkg/machine/hyperv/machine.go
@@ -30,14 +30,6 @@ var (
 	vmtype = machine.HyperVVirt
 )
 
-func GetVirtualizationProvider() machine.VirtProvider {
-	return &Virtualization{
-		artifact:    machine.HyperV,
-		compression: machine.Zip,
-		format:      machine.Vhdx,
-	}
-}
-
 const (
 	// Some of this will need to change when we are closer to having
 	// working code.