Fix for docker-archive-public#1737 - Better detect non default VirtualBox Installation Path

jeanlaurent · jeanlaurent · commit b6ca1035bd17 · 2015-11-10T09:52:38.000+01:00
Signed-off-by: Jean-Laurent de Morlhon &lt;jeanlaurent@morlhon.net&gt;
diff --git a/drivers/virtualbox/vbm.go b/drivers/virtualbox/vbm.go
@@ -4,11 +4,8 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	"os"
 	"os/exec"
-	"path/filepath"
 	"regexp"
-	"runtime"
 	"strings"
 
 	"github.com/docker/machine/libmachine/log"
@@ -78,31 +75,3 @@ func (v *VBoxCmdManager) vbmOutErr(args ...string) (string, string, error) {
 
 	return stdout.String(), stderrStr, err
 }
-
-// detectVBoxManageCmd detects the VBoxManage cmd's path if needed
-func detectVBoxManageCmd() string {
-	cmd := "VBoxManage"
-	if path, err := exec.LookPath(cmd); err == nil {
-		return path
-	}
-
-	if runtime.GOOS == "windows" {
-		if p := os.Getenv("VBOX_INSTALL_PATH"); p != "" {
-			if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
-				return path
-			}
-		}
-		if p := os.Getenv("VBOX_MSI_INSTALL_PATH"); p != "" {
-			if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
-				return path
-			}
-		}
-		// look at HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\VirtualBox\InstallDir
-		p := "C:\\Program Files\\Oracle\\VirtualBox"
-		if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
-			return path
-		}
-	}
-
-	return cmd
-}
diff --git a/drivers/virtualbox/virtualbox.go b/drivers/virtualbox/virtualbox.go
@@ -186,21 +186,6 @@ func (d *Driver) PreCreateCheck() error {
 	return d.vbm()
 }
 
-// cmdOutput runs a shell command and returns its output.
-func cmdOutput(name string, args ...string) (string, error) {
-	cmd := exec.Command(name, args...)
-	log.Debugf("COMMAND: %v %v", name, strings.Join(args, " "))
-
-	stdout, err := cmd.Output()
-	if err != nil {
-		return "", err
-	}
-
-	log.Debugf("STDOUT:\n{\n%v}", string(stdout))
-
-	return string(stdout), nil
-}
-
 // IsVTXDisabledInTheVM checks if VT-X is disabled in the started vm.
 func (d *Driver) IsVTXDisabledInTheVM() (bool, error) {
 	logPath := filepath.Join(d.ResolveStorePath(d.MachineName), "Logs", "VBox.log")
@@ -845,3 +830,11 @@ func getRandomIPinSubnet(baseIP net.IP) (net.IP, error) {
 
 	return dhcpAddr, nil
 }
+
+func detectVBoxManageCmdInPath() string {
+	cmd := "VBoxManage"
+	if path, err := exec.LookPath(cmd); err == nil {
+		return path
+	}
+	return cmd
+}
diff --git a/drivers/virtualbox/virtualbox_darwin.go b/drivers/virtualbox/virtualbox_darwin.go
@@ -20,3 +20,7 @@ func (d *Driver) IsVTXDisabled() bool {
 	disabled := !strings.Contains(features, "VMX")
 	return disabled
 }
+
+func detectVBoxManageCmd() string {
+	return detectVBoxManageCmdInPath()
+}
diff --git a/drivers/virtualbox/virtualbox_linux.go b/drivers/virtualbox/virtualbox_linux.go
@@ -5,3 +5,7 @@ package virtualbox
 func (d *Driver) IsVTXDisabled() bool {
 	return false
 }
+
+func detectVBoxManageCmd() string {
+	return detectVBoxManageCmdInPath()
+}
diff --git a/drivers/virtualbox/virtualbox_windows.go b/drivers/virtualbox/virtualbox_windows.go
@@ -3,7 +3,13 @@ package virtualbox
 import (
 	"strings"
 
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+
 	"github.com/docker/machine/libmachine/log"
+	"golang.org/x/sys/windows/registry"
 )
 
 // IsVTXDisabled checks if VT-X is disabled in the BIOS. If it is, the vm will fail to start.
@@ -19,3 +25,67 @@ func (d *Driver) IsVTXDisabled() bool {
 	disabled := strings.Contains(output, "FALSE")
 	return disabled
 }
+
+// cmdOutput runs a shell command and returns its output.
+func cmdOutput(name string, args ...string) (string, error) {
+	cmd := exec.Command(name, args...)
+	log.Debugf("COMMAND: %v %v", name, strings.Join(args, " "))
+
+	stdout, err := cmd.Output()
+	if err != nil {
+		return "", err
+	}
+
+	log.Debugf("STDOUT:\n{\n%v}", string(stdout))
+
+	return string(stdout), nil
+}
+
+func detectVBoxManageCmd() string {
+	cmd := "VBoxManage"
+	if p := os.Getenv("VBOX_INSTALL_PATH"); p != "" {
+		if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
+			return path
+		}
+	}
+
+	if p := os.Getenv("VBOX_MSI_INSTALL_PATH"); p != "" {
+		if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
+			return path
+		}
+	}
+
+	// Look in default installation path for VirtualBox version > 5
+	if path, err := exec.LookPath(filepath.Join("C:\\Program Files\\Oracle\\VirtualBox", cmd)); err == nil {
+		return path
+	}
+
+	// Look in windows registry
+	if p, err := findVBoxInstallDirInRegistry(); err == nil {
+		if path, err := exec.LookPath(filepath.Join(p, cmd)); err == nil {
+			return path
+		}
+	}
+
+	return detectVBoxManageCmdInPath() //fallback to path
+}
+
+func findVBoxInstallDirInRegistry() (string, error) {
+	registryKey, err := registry.OpenKey(registry.LOCAL_MACHINE, `SOFTWARE\Oracle\VirtualBox`, registry.QUERY_VALUE)
+	if err != nil {
+		errorMessage := fmt.Sprintf("Can't find VirtualBox registry entries, is VirtualBox really installed properly? %s", err)
+		log.Debugf(errorMessage)
+		return nil, fmt.Errorf(errorMessage)
+	}
+
+	defer registryKey.Close()
+
+	installDir, _, err := registryKey.GetStringValue("InstallDir")
+	if err != nil {
+		errorMessage := fmt.Sprintf("Can't find InstallDir registry key within VirtualBox registries entries, is VirtualBox really installed properly? %s", err)
+		log.Debugf(errorMessage)
+		return nil, fmt.Errorf(errorMessage)
+	}
+
+	return installDir, nil
+}

Original file line number	Diff line number	Diff line change
`@@ -20,3 +20,7 @@ func (d *Driver) IsVTXDisabled() bool {`
`20`	`20`	`disabled := !strings.Contains(features, "VMX")`
`21`	`21`	`return disabled`
`22`	`22`	`}`
	`23`	`+`
	`24`	`+func detectVBoxManageCmd() string {`
	`25`	`+ return detectVBoxManageCmdInPath()`
	`26`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -5,3 +5,7 @@ package virtualbox`
`5`	`5`	`func (d *Driver) IsVTXDisabled() bool {`
`6`	`6`	`return false`
`7`	`7`	`}`
	`8`	`+`
	`9`	`+func detectVBoxManageCmd() string {`
	`10`	`+ return detectVBoxManageCmdInPath()`
	`11`	`+}`