chore: int64 ID support (#108)

- update hcloud-go to v2
- use int64 for ID flags in driver
- work around lack of int64 in mcnflag

Author: JonasProgrammer

README.md

@@ -15,8 +15,8 @@ You can find sources and pre-compiled binaries [here](https://github.com/JonasPr
 
 ```bash
 # Download the binary (this example downloads the binary for linux amd64)
-$ wget https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/4.1.2/docker-machine-driver-hetzner_4.1.2_linux_amd64.tar.gz
-$ tar -xvf docker-machine-driver-hetzner_4.1.2_linux_amd64.tar.gz
+$ wget https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/5.0.0/docker-machine-driver-hetzner_5.0.0_linux_amd64.tar.gz
+$ tar -xvf docker-machine-driver-hetzner_5.0.0_linux_amd64.tar.gz
 
 # Make it executable and copy the binary in a directory accessible with your $PATH
 $ chmod +x docker-machine-driver-hetzner
@@ -259,16 +259,27 @@ $ docker-machine create --driver hetzner
 
 ### 4.0.0
 
-* **check log output for BREAKING-V5**
+* **check log output for BREAKING-V6** (previously *BREAKING-V5*)
 * `--hetzner-user-data-from-file` will be fully deprecated and its flag description will only read 'DEPRECATED, legacy'; current fallback behaviour will be retained. `--hetzner-flag-user-data-file` should be used instead.
 * `--hetzner-disable-public-4`/`--hetzner-disable-public-6` will be fully deprecated and its flag description will only read 'DEPRECATED, legacy'; current fallback behaviour will be retained. `--hetzner-disable-public-ipv4`/`--hetzner-disable-public-ipv6` should be used instead.
 
 ### 5.0.0
 
+* major update due to #108 ([hetznercloud/hcloud-go#263](https://github.com/hetznercloud/hcloud-go/v2/issues/263))
+* new `hcloud-go` v2 requiring int64 IDs is used for interaction with Hetzner cloud
+* old configs should be forward-compatible
+* newly created machines may now use 64-bit integers in all stored and transmitted data, potentially breaking existing tools supporting 32-bit only
+  - this includes anything interacting with the flags CLI via RPC, as `mcnflags` lacks an int64 flag type, so `StringFlag` and parsing are used now
+* previous changes were moved one version (i.e. 5 -> 6, 6 -> 7)
+
+### 6.0.0
+
+* *moved from 5.0.0*
 * `--hetzner-user-data-from-file` will be removed entirely, including its fallback behavior
 * `--hetzner-disable-public-4`/`--hetzner-disable-public-6` ill be removed entirely, including their fallback behavior
 * not specifying `--hetzner-image` will generate a warning stating 'use of default image is DEPRECATED'
 
-### 6.0.0
+### 7.0.0
 
+* *moved from 6.0.0*
 * specifying `--hetzner-image` will be mandatory, and a default image will no longer be provided

driver/cleanup.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/docker/machine/libmachine/log"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 )
 

driver/driver.go

@@ -4,13 +4,14 @@ import (
 	"context"
 	"fmt"
 	"net"
+	"strconv"
 	"time"
 
 	"github.com/docker/machine/libmachine/drivers"
 	"github.com/docker/machine/libmachine/log"
 	"github.com/docker/machine/libmachine/mcnflag"
 	"github.com/docker/machine/libmachine/state"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 )
 
@@ -20,19 +21,19 @@ type Driver struct {
 
 	AccessToken       string
 	Image             string
-	ImageID           int
+	ImageID           int64
 	ImageArch         hcloud.Architecture
 	cachedImage       *hcloud.Image
 	Type              string
 	cachedType        *hcloud.ServerType
 	Location          string
 	cachedLocation    *hcloud.Location
-	KeyID             int
+	KeyID             int64
 	cachedKey         *hcloud.SSHKey
 	IsExistingKey     bool
 	originalKey       string
 	dangling          []func()
-	ServerID          int
+	ServerID          int64
 	cachedServer      *hcloud.Server
 	userData          string
 	userDataFile      string
@@ -52,7 +53,7 @@ type Driver struct {
 	cachedPGrp        *hcloud.PlacementGroup
 
 	AdditionalKeys       []string
-	AdditionalKeyIDs     []int
+	AdditionalKeyIDs     []int64
 	cachedAdditionalKeys []*hcloud.SSHKey
 
 	WaitOnError           int
@@ -146,7 +147,7 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 			Usage:  "Image to use for server creation",
 			Value:  "",
 		},
-		mcnflag.IntFlag{
+		mcnflag.StringFlag{
 			EnvVar: "HETZNER_IMAGE_ID",
 			Name:   flagImageID,
 			Usage:  "Image to use for server creation",
@@ -168,11 +169,11 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 			Usage:  "Location to create machine at",
 			Value:  "",
 		},
-		mcnflag.IntFlag{
+		mcnflag.StringFlag{
 			EnvVar: "HETZNER_EXISTING_KEY_ID",
 			Name:   flagExKeyID,
 			Usage:  "Existing key ID to use for server; requires --hetzner-existing-key-path",
-			Value:  0,
+			Value:  "0",
 		},
 		mcnflag.StringFlag{
 			EnvVar: "HETZNER_EXISTING_KEY_PATH",
@@ -319,23 +320,45 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 	}
 }
 
+func flagI64(opts drivers.DriverOptions, key string) (int64, error) {
+	raw := opts.String(key)
+	if raw == "" {
+		return 0, nil
+	}
+
+	ret, err := strconv.ParseInt(raw, 10, 64)
+	if err != nil {
+		return 0, errors.Wrapf(err, "could not parse int64 for %v", key)
+	}
+
+	return ret, nil
+}
+
 // SetConfigFromFlags handles additional driver arguments as retrieved by [Driver.GetCreateFlags];
 // see [drivers.Driver.SetConfigFromFlags]
 func (d *Driver) SetConfigFromFlags(opts drivers.DriverOptions) error {
 	return d.setConfigFromFlags(opts)
 }
 
 func (d *Driver) setConfigFromFlagsImpl(opts drivers.DriverOptions) error {
+	var err error
+
 	d.AccessToken = opts.String(flagAPIToken)
 	d.Image = opts.String(flagImage)
-	d.ImageID = opts.Int(flagImageID)
-	err := d.setImageArch(opts.String(flagImageArch))
+	d.ImageID, err = flagI64(opts, flagImageID)
+	if err != nil {
+		return err
+	}
+	err = d.setImageArch(opts.String(flagImageArch))
 	if err != nil {
 		return err
 	}
 	d.Location = opts.String(flagLocation)
 	d.Type = opts.String(flagType)
-	d.KeyID = opts.Int(flagExKeyID)
+	d.KeyID, err = flagI64(opts, flagExKeyID)
+	if err != nil {
+		return err
+	}
 	d.IsExistingKey = d.KeyID != 0
 	d.originalKey = opts.String(flagExKeyPath)
 	err = d.setUserDataFlags(opts)
@@ -390,10 +413,10 @@ func (d *Driver) setConfigFromFlagsImpl(opts drivers.DriverOptions) error {
 	instrumented(d)
 
 	if d.usesDfr {
-		log.Warn("!!!! BREAKING-V5 !!!!")
+		log.Warn("!!!! BREAKING-V6 !!!!")
 		log.Warn("your configuration uses deprecated flags and will stop working as-is from v5 onwards")
 		log.Warn("check preceding output for 'DEPRECATED' log statements")
-		log.Warn("!!!! /BREAKING-V5 !!!!")
+		log.Warn("!!!! /BREAKING-V6 !!!!")
 	}
 
 	return nil

driver/driver_test.go

@@ -3,8 +3,9 @@ package driver
 import (
 	"github.com/docker/machine/commands/commandstest"
 	"github.com/docker/machine/libmachine/drivers"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"os"
+	"strconv"
 	"strings"
 	"testing"
 )
@@ -212,15 +213,15 @@ func TestImageFlagExclusions(t *testing.T) {
 	// both id and name given
 	d := NewDriver("test")
 	err := d.setConfigFromFlagsImpl(makeFlags(map[string]interface{}{
-		flagImageID: 42,
+		flagImageID: "42",
 		flagImage:   "answer",
 	}))
 	assertMutualExclusion(t, err, flagImageID, flagImage)
 
 	// both id and arch given
 	d = NewDriver("test")
 	err = d.setConfigFromFlagsImpl(makeFlags(map[string]interface{}{
-		flagImageID:   42,
+		flagImageID:   "42",
 		flagImageArch: string(hcloud.ArchitectureX86),
 	}))
 	assertMutualExclusion(t, err, flagImageID, flagImageArch)
@@ -255,6 +256,32 @@ func TestImageArch(t *testing.T) {
 	}
 }
 
+func TestBogusId(t *testing.T) {
+	d := NewDriver("test")
+	err := d.setConfigFromFlagsImpl(makeFlags(map[string]interface{}{
+		flagImageID: "answer",
+	}))
+	if err == nil {
+		t.Fatal("expected error, but invalid arch was accepted")
+	}
+}
+
+func TestLongId(t *testing.T) {
+	var testId int64 = 79871865169581
+
+	d := NewDriver("test")
+	err := d.setConfigFromFlagsImpl(makeFlags(map[string]interface{}{
+		flagImageID: strconv.FormatInt(testId, 10),
+	}))
+	if err != nil {
+		t.Fatalf("unexpected error, %v", err)
+	}
+
+	if d.ImageID != testId {
+		t.Errorf("expected %v id, but got %v", testId, d.ImageArch)
+	}
+}
+
 func testArchFlag(t *testing.T, arch hcloud.Architecture) {
 	d := NewDriver("test")
 	err := d.setConfigFromFlagsImpl(makeFlags(map[string]interface{}{

driver/flag_processing.go

@@ -3,7 +3,7 @@ package driver
 import (
 	"github.com/docker/machine/libmachine/drivers"
 	"github.com/docker/machine/libmachine/log"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 	"strings"
 )

driver/hetzner_query.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/docker/machine/libmachine/log"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 	"golang.org/x/crypto/ssh"
 	"time"

driver/networking.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/docker/machine/libmachine/log"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 	"net"
 	"time"

driver/placement_groups.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/docker/machine/libmachine/log"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 )
 
 const (

driver/setup.go

@@ -3,7 +3,7 @@ package driver
 import (
 	"context"
 	"github.com/docker/machine/libmachine/state"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 	"os"
 	"time"

driver/ssh_keys.go

@@ -6,7 +6,7 @@ import (
 	"github.com/docker/machine/libmachine/log"
 	"github.com/docker/machine/libmachine/mcnutils"
 	mcnssh "github.com/docker/machine/libmachine/ssh"
-	"github.com/hetznercloud/hcloud-go/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	"github.com/pkg/errors"
 	"golang.org/x/crypto/ssh"
 	"os"