support IPv6 in AWS EC2 and Digital Ocean node drivers (#351)

Author: jiaqiluo

commands/commands.go

@@ -462,9 +462,15 @@ var Commands = []cli.Command{
 
 func printIP(h *host.Host) func() error {
 	return func() error {
+		// preference: IPv4 address, then IPv6 address
 		ip, err := h.Driver.GetIP()
 		if err != nil {
-			return fmt.Errorf("Error getting IP address: %s", err)
+			log.Warnf("Error getting IPv4 address: %s", err)
+			log.Debug("Getting IPv6 address")
+			ip, err = h.Driver.GetIPv6()
+			if err != nil {
+				return fmt.Errorf("error getting IPv6 address: %s", err)
+			}
 		}
 
 		fmt.Println(ip)

commands/commands_test.go

@@ -138,7 +138,7 @@ func TestPrintIPEmptyGivenLocalEngine(t *testing.T) {
 	assert.Equal(t, "\n", stdoutGetter.Output())
 }
 
-func TestPrintIPPrintsGivenRemoteEngine(t *testing.T) {
+func TestPrintIPPrintsGivenRemoteEngineIpv4(t *testing.T) {
 	stdoutGetter := commandstest.NewStdoutGetter()
 	defer stdoutGetter.Stop()
 
@@ -152,6 +152,21 @@ func TestPrintIPPrintsGivenRemoteEngine(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "1.2.3.4\n", stdoutGetter.Output())
 }
+func TestPrintIPPrintsGivenRemoteEngineIpv6(t *testing.T) {
+	stdoutGetter := commandstest.NewStdoutGetter()
+	defer stdoutGetter.Stop()
+
+	host, _ := hosttest.GetDefaultTestHost()
+	host.Driver = &fakedriver.Driver{
+		MockState: state.Running,
+		MockIPv6:  "2001:db8:85a3::8a2e:370:7334",
+	}
+	err := printIP(host)()
+
+	assert.NoError(t, err)
+	assert.Equal(t, "2001:db8:85a3::8a2e:370:7334\n", stdoutGetter.Output())
+
+}
 
 func TestConsolidateError(t *testing.T) {
 	cases := []struct {

commands/ls_test.go

@@ -1,13 +1,11 @@
 package commands
 
 import (
+	"errors"
 	"os"
 	"testing"
-
 	"time"
 
-	"errors"
-
 	"github.com/rancher/machine/drivers/fakedriver"
 	"github.com/rancher/machine/libmachine/engine"
 	"github.com/rancher/machine/libmachine/host"
@@ -340,7 +338,7 @@ func TestGetHostListItems(t *testing.T) {
 		version string
 		error   string
 	}{
-		{"bar10", state.Error, false, "Unknown", "Unable to get ip"},
+		{"bar10", state.Error, false, "Unknown", "unable to get ip"},
 		{"bar100", state.Stopped, false, "Unknown", ""},
 		{"foo", state.Running, true, "v1.9", ""},
 	}
@@ -490,7 +488,7 @@ func TestGetHostStateError(t *testing.T) {
 	assert.Equal(t, state.Error, hostItem.State)
 	assert.Equal(t, "Driver", hostItem.DriverName)
 	assert.Empty(t, hostItem.URL)
-	assert.Equal(t, "Unable to get ip", hostItem.Error)
+	assert.Equal(t, "unable to get ip", hostItem.Error)
 	assert.Nil(t, hostItem.SwarmOptions)
 }
 

commands/scp.go

@@ -3,6 +3,7 @@ package commands
 import (
 	"errors"
 	"fmt"
+	"net/netip"
 	"os"
 	"os/exec"
 	"strings"
@@ -179,6 +180,13 @@ func generateLocationArg(hostInfo HostInfo, user, path string) (string, error) {
 	if err != nil {
 		return "", err
 	}
+	ipAddr, err := netip.ParseAddr(hostname)
+	if err != nil {
+		return "", err
+	}
+	if ipAddr.Is6() {
+		hostname = fmt.Sprintf("[%s]", hostname)
+	}
 
 	if user == "" {
 		user = hostInfo.GetSSHUsername()

commands/scp_test.go

@@ -11,6 +11,7 @@ import (
 type MockHostInfo struct {
 	name        string
 	ip          string
+	ipv6        string
 	sshPort     int
 	sshUsername string
 	sshKeyPath  string
@@ -21,7 +22,11 @@ func (h *MockHostInfo) GetMachineName() string {
 }
 
 func (h *MockHostInfo) GetSSHHostname() (string, error) {
-	return h.ip, nil
+	// preference: IPv4 address, then IPv6 address
+	if h.ip != "" {
+		return h.ip, nil
+	}
+	return h.ipv6, nil
 }
 
 func (h *MockHostInfo) GetSSHPort() (int, error) {

commands/version.go

@@ -28,15 +28,14 @@ func printVersion(c CommandLine, api libmachine.API, out io.Writer) error {
 		return err
 	}
 
-	if host.HostOptions.AuthOptions != nil {
+	if host != nil && host.HostOptions != nil && host.HostOptions.AuthOptions != nil {
 		version, err := mcndockerclient.DockerVersion(host)
 		if err != nil {
 			return err
 		}
-
-		fmt.Fprintln(out, version)
+		_, _ = fmt.Fprintln(out, version)
 	} else {
-		fmt.Fprintln(out, "Docker was not installed on machine")
+		_, _ = fmt.Fprintln(out, "Docker was not installed on machine")
 	}
 
 	return nil

commands/version_test.go

@@ -1,12 +1,12 @@
 package commands
 
 import (
+	"bytes"
 	"errors"
 	"testing"
 
-	"bytes"
-
 	"github.com/rancher/machine/commands/commandstest"
+	"github.com/rancher/machine/libmachine/auth"
 	"github.com/rancher/machine/libmachine/host"
 	"github.com/rancher/machine/libmachine/libmachinetest"
 	"github.com/rancher/machine/libmachine/mcndockerclient"
@@ -56,6 +56,9 @@ func TestCmdVersionOnHost(t *testing.T) {
 		Hosts: []*host.Host{
 			{
 				Name: "machine",
+				HostOptions: &host.Options{
+					AuthOptions: &auth.Options{},
+				},
 			},
 		},
 	}
@@ -78,6 +81,9 @@ func TestCmdVersionFailure(t *testing.T) {
 		Hosts: []*host.Host{
 			{
 				Name: "machine",
+				HostOptions: &host.Options{
+					AuthOptions: &auth.Options{},
+				},
 			},
 		},
 	}