Revert driver API changes; build on generic opts

Brett Higgins · Brett Higgins · commit 6fe1c31479ee · 2016-05-05T08:38:17.000-04:00
See docker-archive-public#3209 Signed-off-by: Brett Higgins <brhiggins@arbor.net>
diff --git a/cmd/machine.go b/cmd/machine.go
@@ -158,6 +158,17 @@ func main() {
 			Usage:  "BugSnag API token for crash reporting",
 			Value:  "",
 		},
+		cli.StringFlag{
+			EnvVar: "MACHINE_SSH_CONFIG_FILE",
+			Name:   "ssh-config-file",
+			Usage:  "Use the specified SSH config file",
+			Value:  "",
+		},
+		cli.BoolFlag{
+			EnvVar: "MACHINE_USE_USER_SSH_CONFIG",
+			Name:   "use-user-ssh-config",
+			Usage:  "Use the user's SSH config file (~/.ssh/config)",
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
diff --git a/commands/commands.go b/commands/commands.go
@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 	"strings"
 
 	"github.com/codegangsta/cli"
@@ -148,6 +149,7 @@ func runCommand(command func(commandLine CommandLine, api libmachine.API) error)
 		libmachineOpts := &mcnopt.Options{
 			BaseDir:        context.GlobalString("storage-path"),
 			GithubAPIToken: context.GlobalString("github-api-token"),
+			SSHConfigFile:  context.GlobalString("ssh-config-file"),
 		}
 
 		if context.GlobalBool("native-ssh") {
@@ -156,6 +158,14 @@ func runCommand(command func(commandLine CommandLine, api libmachine.API) error)
 			libmachineOpts.SSHClientType = ssh.External
 		}
 
+		if context.GlobalBool("use-user-ssh-config") {
+			if libmachineOpts.SSHConfigFile != "" {
+				log.Error("--ssh-config-file not allowed with --use-user-ssh-config")
+				osExit(1)
+			}
+			libmachineOpts.SSHConfigFile = filepath.Join(os.Getenv("HOME"), ".ssh", "config")
+		}
+
 		mcnopt.SetOpts(libmachineOpts)
 
 		api.Filestore.Path = libmachineOpts.BaseDir
diff --git a/drivers/amazonec2/amazonec2.go b/drivers/amazonec2/amazonec2.go
@@ -713,13 +713,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 func (d *Driver) Start() error {
 	_, err := d.getClient().StartInstances(&ec2.StartInstancesInput{
 		InstanceIds: []*string{&d.InstanceId},
diff --git a/drivers/errdriver/error.go b/drivers/errdriver/error.go
@@ -71,10 +71,6 @@ func (d *Driver) GetSSHUsername() string {
 	return ""
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	return "/dev/null"
-}
-
 func (d *Driver) GetState() (state.State, error) {
 	return state.Error, NotLoadable{d.Name}
 }
diff --git a/drivers/exoscale/exoscale.go b/drivers/exoscale/exoscale.go
@@ -128,13 +128,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // DriverName returns the name of the driver
 func (d *Driver) DriverName() string {
 	return "exoscale"
diff --git a/drivers/fakedriver/fakedriver.go b/drivers/fakedriver/fakedriver.go
@@ -72,10 +72,6 @@ func (d *Driver) GetSSHUsername() string {
 	return ""
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	return "/dev/null"
-}
-
 func (d *Driver) GetState() (state.State, error) {
 	return d.MockState, nil
 }
diff --git a/drivers/generic/generic.go b/drivers/generic/generic.go
@@ -6,7 +6,6 @@ import (
 	"net"
 	"os"
 	"path"
-	"path/filepath"
 	"strconv"
 	"time"
 
@@ -15,13 +14,15 @@ import (
 	"github.com/docker/machine/libmachine/log"
 	"github.com/docker/machine/libmachine/mcnflag"
 	"github.com/docker/machine/libmachine/mcnutils"
+	"github.com/docker/machine/libmachine/ssh"
 	"github.com/docker/machine/libmachine/state"
 )
 
 type Driver struct {
 	*drivers.BaseDriver
-	EnginePort int
-	SSHKey     string
+	EnginePort    int
+	SSHKey        string
+	SSHConfigFile string
 }
 
 const (
@@ -99,13 +100,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 func (d *Driver) GetSSHKeyPath() string {
 	return d.SSHKeyPath
 }
@@ -121,16 +115,6 @@ func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error {
 		return errors.New("generic driver requires the --generic-ip-address option")
 	}
 
-	if flags.Bool("generic-use-user-ssh-config") {
-		if d.SSHConfigFile != "" {
-			return errors.New("--generic-ssh-config-file not allowed with --generic-use-user-ssh-config")
-		}
-
-		d.SSHConfigFile = filepath.Join(os.Getenv("HOME"), ".ssh", "config")
-	} else {
-		d.SSHConfigFile = flags.String("generic-ssh-config-file")
-	}
-
 	return nil
 }
 
@@ -185,8 +169,15 @@ func (d *Driver) GetURL() (string, error) {
 	return fmt.Sprintf("tcp://%s", net.JoinHostPort(ip, strconv.Itoa(d.EnginePort))), nil
 }
 
+func (d *Driver) runSSHCommand(command string) (string, error) {
+	options := &ssh.Options{
+		ConfigFile: d.SSHConfigFile,
+	}
+	return drivers.RunSSHCommandFromDriverWithOptions(d, command, options)
+}
+
 func (d *Driver) GetState() (state.State, error) {
-	_, err := drivers.RunSSHCommandFromDriver(d, "/bin/true")
+	_, err := d.runSSHCommand("/bin/true")
 	if err != nil {
 		return state.Stopped, nil
 	}
@@ -203,7 +194,7 @@ func (d *Driver) Stop() error {
 }
 
 func (d *Driver) Restart() error {
-	_, err := drivers.RunSSHCommandFromDriver(d, "sudo shutdown -r now")
+	_, err := d.runSSHCommand("sudo shutdown -r now")
 	return err
 }
 
diff --git a/drivers/google/google.go b/drivers/google/google.go
@@ -155,13 +155,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // DriverName returns the name of the driver
 func (d *Driver) DriverName() string {
 	return "google"
diff --git a/drivers/none/driver.go b/drivers/none/driver.go
@@ -67,10 +67,6 @@ func (d *Driver) GetSSHUsername() string {
 	return ""
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	return "/dev/null"
-}
-
 func (d *Driver) GetURL() (string, error) {
 	return d.URL, nil
 }
diff --git a/drivers/virtualbox/virtualbox.go b/drivers/virtualbox/virtualbox.go
@@ -188,13 +188,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // DriverName returns the name of the driver
 func (d *Driver) DriverName() string {
 	return "virtualbox"
diff --git a/drivers/vmwarefusion/fusion_darwin.go b/drivers/vmwarefusion/fusion_darwin.go
@@ -140,13 +140,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // DriverName returns the name of the driver
 func (d *Driver) DriverName() string {
 	return "vmwarefusion"
diff --git a/drivers/vmwarevsphere/vsphere.go b/drivers/vmwarevsphere/vsphere.go
@@ -175,13 +175,6 @@ func (d *Driver) GetSSHUsername() string {
 	return d.SSHUser
 }
 
-func (d *Driver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // DriverName returns the name of the driver
 func (d *Driver) DriverName() string {
 	return "vmwarevsphere"
diff --git a/libmachine/drivers/base.go b/libmachine/drivers/base.go
@@ -19,7 +19,6 @@ type BaseDriver struct {
 	SSHUser        string
 	SSHPort        int
 	SSHKeyPath     string
-	SSHConfigFile  string
 	StorePath      string
 	SwarmMaster    bool
 	SwarmHost      string
@@ -52,14 +51,6 @@ func (d *BaseDriver) GetSSHKeyPath() string {
 	return d.SSHKeyPath
 }
 
-// GetSSHConfigFile returns the ssh config file; default is /dev/null
-func (d *BaseDriver) GetSSHConfigFile() string {
-	if d.SSHConfigFile == "" {
-		d.SSHConfigFile = "/dev/null"
-	}
-	return d.SSHConfigFile
-}
-
 // GetSSHPort returns the ssh port, 22 if not specified
 func (d *BaseDriver) GetSSHPort() (int, error) {
 	if d.SSHPort == 0 {
diff --git a/libmachine/drivers/drivers.go b/libmachine/drivers/drivers.go
@@ -41,9 +41,6 @@ type Driver interface {
 	// GetSSHUsername returns username for use with ssh
 	GetSSHUsername() string
 
-	// GetSSHConfigFile returns the ssh config file
-	GetSSHConfigFile() string
-
 	// GetURL returns a Docker compatible host URL for connecting to this host
 	// e.g. tcp://1.2.3.4:2376
 	GetURL() (string, error)
diff --git a/libmachine/drivers/rpc/client_driver.go b/libmachine/drivers/rpc/client_driver.go
@@ -79,7 +79,6 @@ const (
 	GetSSHKeyPathMethod      = `.GetSSHKeyPath`
 	GetSSHPortMethod         = `.GetSSHPort`
 	GetSSHUsernameMethod     = `.GetSSHUsername`
-	GetSSHConfigFileMethod   = `.GetSSHConfigFile`
 	GetStateMethod           = `.GetState`
 	PreCreateCheckMethod     = `.PreCreateCheck`
 	CreateMethod             = `.Create`
@@ -342,15 +341,6 @@ func (c *RPCClientDriver) GetSSHUsername() string {
 	return username
 }
 
-func (c *RPCClientDriver) GetSSHConfigFile() string {
-	configFile, err := c.rpcStringCall(GetSSHConfigFileMethod)
-	if err != nil {
-		log.Warnf("Error attempting call to get SSH config file: %s", err)
-	}
-
-	return configFile
-}
-
 func (c *RPCClientDriver) GetState() (state.State, error) {
 	var s state.State
 
diff --git a/libmachine/drivers/rpc/server_driver.go b/libmachine/drivers/rpc/server_driver.go
@@ -188,11 +188,6 @@ func (r *RPCServerDriver) GetSSHUsername(_ *struct{}, reply *string) error {
 	return nil
 }
 
-func (r *RPCServerDriver) GetSSHConfigFile(_ *struct{}, reply *string) error {
-	*reply = r.ActualDriver.GetSSHConfigFile()
-	return nil
-}
-
 func (r *RPCServerDriver) GetURL(_ *struct{}, reply *string) error {
 	info, err := r.ActualDriver.GetURL()
 	*reply = info
diff --git a/libmachine/drivers/serial.go b/libmachine/drivers/serial.go
@@ -101,12 +101,6 @@ func (d *SerialDriver) GetSSHUsername() string {
 	return d.Driver.GetSSHUsername()
 }
 
-func (d *SerialDriver) GetSSHConfigFile() string {
-	d.Lock()
-	defer d.Unlock()
-	return d.Driver.GetSSHConfigFile()
-}
-
 // GetURL returns a Docker compatible host URL for connecting to this host
 // e.g. tcp://1.2.3.4:2376
 func (d *SerialDriver) GetURL() (string, error) {
diff --git a/libmachine/drivers/serial_test.go b/libmachine/drivers/serial_test.go
@@ -29,18 +29,17 @@ func (l *MockLocker) Unlock() {
 }
 
 type MockDriver struct {
-	calls         *CallRecorder
-	driverName    string
-	flags         []mcnflag.Flag
-	ip            string
-	machineName   string
-	sshHostname   string
-	sshKeyPath    string
-	sshPort       int
-	sshUsername   string
-	sshConfigFile string
-	url           string
-	state         state.State
+	calls       *CallRecorder
+	driverName  string
+	flags       []mcnflag.Flag
+	ip          string
+	machineName string
+	sshHostname string
+	sshKeyPath  string
+	sshPort     int
+	sshUsername string
+	url         string
+	state       state.State
 }
 
 func (d *MockDriver) Create() error {
@@ -88,11 +87,6 @@ func (d *MockDriver) GetSSHUsername() string {
 	return d.sshUsername
 }
 
-func (d *MockDriver) GetSSHConfigFile() string {
-	d.calls.record("GetSSHConfigFile")
-	return d.sshConfigFile
-}
-
 func (d *MockDriver) GetURL() (string, error) {
 	d.calls.record("GetURL")
 	return d.url, nil
diff --git a/libmachine/drivers/utils.go b/libmachine/drivers/utils.go
diff --git a/libmachine/opt/options.go b/libmachine/opt/options.go
diff --git a/libmachine/ssh/client.go b/libmachine/ssh/client.go

Original file line number	Diff line number	Diff line change
`@@ -71,10 +71,6 @@ func (d *Driver) GetSSHUsername() string {`
`71`	`71`	`return ""`
`72`	`72`	`}`
`73`	`73`
`74`		`-func (d *Driver) GetSSHConfigFile() string {`
`75`		`- return "/dev/null"`
`76`		`-}`
`77`		`-`
`78`	`74`	`func (d *Driver) GetState() (state.State, error) {`
`79`	`75`	`return state.Error, NotLoadable{d.Name}`
`80`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,6 @@ func (d *Driver) GetSSHUsername() string {`
`72`	`72`	`return ""`
`73`	`73`	`}`
`74`	`74`
`75`		`-func (d *Driver) GetSSHConfigFile() string {`
`76`		`- return "/dev/null"`
`77`		`-}`
`78`		`-`
`79`	`75`	`func (d *Driver) GetState() (state.State, error) {`
`80`	`76`	`return d.MockState, nil`
`81`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,10 +67,6 @@ func (d *Driver) GetSSHUsername() string {`
`67`	`67`	`return ""`
`68`	`68`	`}`
`69`	`69`
`70`		`-func (d *Driver) GetSSHConfigFile() string {`
`71`		`- return "/dev/null"`
`72`		`-}`
`73`		`-`
`74`	`70`	`func (d *Driver) GetURL() (string, error) {`
`75`	`71`	`return d.URL, nil`
`76`	`72`	`}`