constants: Add ResolveHelperPath() helper

At the moment, helper files (vfkit, crc-admin-helper,
crc-driver-libvirt) are expected to all be found in BinDir().
BinDir() is either the installation directory if we made a release
build, or ~/.crc/bin if  built from git.
However, this is not flexible enough for homebrew where vfkit and
crc-admin-helper will be in 2 different directories.

This commit adds a constants.ResolveHelperPath() function which is very
similar to `BinDir()` except that we can add more logic at a later
point. It's possible to return helper-specific paths as it's passed as
an argument.

This commit removes the use of BinDir() and reexports CrcBinDir for
the code downloading helpers from the net. This code targets
~/.crc/bin and is not run in the 'IsInstaller()' case, so it does not
need BinDir().

Author: cfergeau

pkg/crc/cache/cache.go

@@ -134,7 +134,7 @@ func (c *Cache) cacheExecutable() error {
 
 	// Copy the requested asset into its final destination
 	for _, extractedFilePath := range extractedFiles {
-		finalExecutablePath := filepath.Join(constants.BinDir(), filepath.Base(extractedFilePath))
+		finalExecutablePath := filepath.Join(constants.CrcBinDir, filepath.Base(extractedFilePath))
 		// If the file exists then remove it (ignore error) first before copy because with `0500` permission
 		// it is not possible to overwrite the file.
 		os.Remove(finalExecutablePath)

pkg/crc/constants/constants.go

@@ -75,10 +75,6 @@ func GetAdminHelperExecutableForOs(os string) string {
 	return adminHelperExecutableForOs[os]
 }
 
-func GetAdminHelperExecutable() string {
-	return GetAdminHelperExecutableForOs(runtime.GOOS)
-}
-
 func GetAdminHelperURLForOs(os string) string {
 	return fmt.Sprintf(DefaultAdminHelperURLBase, version.GetAdminHelperVersion(), GetAdminHelperExecutableForOs(os))
 }
@@ -118,9 +114,9 @@ func GetDefaultBundle(preset crcpreset.Preset) string {
 
 var (
 	CrcBaseDir         = filepath.Join(GetHomeDir(), ".crc")
-	crcBinDir          = filepath.Join(CrcBaseDir, "bin")
-	CrcOcBinDir        = filepath.Join(crcBinDir, "oc")
-	CrcSymlinkPath     = filepath.Join(crcBinDir, "crc")
+	CrcBinDir          = filepath.Join(CrcBaseDir, "bin")
+	CrcOcBinDir        = filepath.Join(CrcBinDir, "oc")
+	CrcSymlinkPath     = filepath.Join(CrcBinDir, "crc")
 	ConfigPath         = filepath.Join(CrcBaseDir, ConfigFile)
 	LogFilePath        = filepath.Join(CrcBaseDir, LogFile)
 	DaemonLogFilePath  = filepath.Join(CrcBaseDir, DaemonLogFile)
@@ -135,15 +131,15 @@ func GetDefaultBundlePath(preset crcpreset.Preset) string {
 	return filepath.Join(MachineCacheDir, GetDefaultBundle(preset))
 }
 
-func BinDir() string {
+func ResolveHelperPath(executableName string) string {
 	if version.IsInstaller() {
-		return version.InstallPath()
+		return filepath.Join(version.InstallPath(), executableName)
 	}
-	return crcBinDir
+	return filepath.Join(CrcBinDir, executableName)
 }
 
 func AdminHelperPath() string {
-	return filepath.Join(BinDir(), GetAdminHelperExecutable())
+	return ResolveHelperPath(GetAdminHelperExecutableForOs(runtime.GOOS))
 }
 
 // GetHomeDir returns the home directory for the current user
@@ -157,7 +153,7 @@ func GetHomeDir() string {
 
 // EnsureBaseDirectoriesExist creates ~/.crc, ~/.crc/bin and ~/.crc/cache directories if it is not present
 func EnsureBaseDirectoriesExist() error {
-	baseDirectories := []string{CrcBaseDir, MachineCacheDir, crcBinDir}
+	baseDirectories := []string{CrcBaseDir, MachineCacheDir, CrcBinDir}
 	for _, baseDir := range baseDirectories {
 		err := os.MkdirAll(baseDir, 0750)
 		if err != nil {

pkg/crc/machine/libvirt/constants.go

@@ -5,7 +5,6 @@ package libvirt
 
 import (
 	"fmt"
-	"path/filepath"
 
 	"github.com/crc-org/crc/pkg/crc/constants"
 )
@@ -21,14 +20,14 @@ const (
 )
 
 const (
-	MachineDriverCommand = "crc-driver-libvirt"
+	machineDriverCommand = "crc-driver-libvirt"
 	MachineDriverVersion = "0.13.5"
 )
 
 var (
-	MachineDriverDownloadURL = fmt.Sprintf("https://github.com/crc-org/machine-driver-libvirt/releases/download/%s/%s", MachineDriverVersion, MachineDriverCommand)
+	MachineDriverDownloadURL = fmt.Sprintf("https://github.com/crc-org/machine-driver-libvirt/releases/download/%s/%s", MachineDriverVersion, machineDriverCommand)
 )
 
 func MachineDriverPath() string {
-	return filepath.Join(constants.BinDir(), MachineDriverCommand)
+	return constants.ResolveHelperPath(machineDriverCommand)
 }

pkg/crc/machine/vfkit/constants.go

@@ -5,7 +5,6 @@ package vfkit
 
 import (
 	"fmt"
-	"path/filepath"
 
 	"github.com/crc-org/crc/pkg/crc/constants"
 )
@@ -21,5 +20,5 @@ var (
 )
 
 func ExecutablePath() string {
-	return filepath.Join(constants.BinDir(), vfkitCommand)
+	return constants.ResolveHelperPath(vfkitCommand)
 }