Add K0sBinaryVersion(...) as a Configurer method (#361)

Introduce K0sBinaryVersion and use it in places where the k0s version
was retrieved manually. Also switch from string to *version.Version for
versions, so that we cannot forget to add or strip the "v" prefix when
processing version numbers.

Signed-off-by: Tom Wieczorek <[email protected]>

Author: twz123

configurer/linux.go

@@ -10,6 +10,7 @@ import (
 	"github.com/alessio/shellescape"
 	"github.com/k0sproject/rig/exec"
 	"github.com/k0sproject/rig/os"
+	"github.com/k0sproject/version"
 )
 
 // Static Constants Interface for overriding by distro-specific structs
@@ -61,6 +62,21 @@ func (l Linux) K0sBinaryPath() string {
 	return "/usr/local/bin/k0s"
 }
 
+func (l Linux) K0sBinaryVersion(h os.Host) (*version.Version, error) {
+	k0sVersionCmd := l.K0sCmdf("version")
+	output, err := h.ExecOutput(k0sVersionCmd, exec.Sudo(h))
+	if err != nil {
+		return nil, err
+	}
+
+	version, err := version.NewVersion(output)
+	if err != nil {
+		return nil, err
+	}
+
+	return version, nil
+}
+
 // K0sConfigPath returns the location of k0s configuration file
 func (l Linux) K0sConfigPath() string {
 	return "/etc/k0s/k0s.yaml"
@@ -87,14 +103,14 @@ func (l Linux) DownloadURL(h os.Host, url, destination string, opts ...exec.Opti
 }
 
 // DownloadK0s performs k0s binary download from github on the host
-func (l Linux) DownloadK0s(h os.Host, version, arch string) error {
+func (l Linux) DownloadK0s(h os.Host, version *version.Version, arch string) error {
 	tmp, err := l.TempFile(h)
 	if err != nil {
 		return err
 	}
 	defer func() { _ = h.Execf(`rm -f "%s"`, tmp) }()
 
-	url := fmt.Sprintf("https://github.com/k0sproject/k0s/releases/download/v%s/k0s-v%s-%s", version, version, arch)
+	url := fmt.Sprintf("https://github.com/k0sproject/k0s/releases/download/%s/k0s-%s-%s", version, version, arch)
 	if err := l.DownloadURL(h, url, tmp); err != nil {
 		return err
 	}

phase/download_k0s.go

@@ -2,11 +2,10 @@ package phase
 
 import (
 	"fmt"
-	"strings"
 
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1/cluster"
-	"github.com/k0sproject/rig/exec"
+	"github.com/k0sproject/version"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -41,25 +40,28 @@ func (p *DownloadK0s) Run() error {
 }
 
 func (p *DownloadK0s) downloadK0s(h *cluster.Host) error {
-	target := p.Config.Spec.K0s.Version
-	log.Infof("%s: downloading k0s %s", h, target)
-	if err := h.Configurer.DownloadK0s(h, target, h.Metadata.Arch); err != nil {
+	targetVersion, err := version.NewVersion(p.Config.Spec.K0s.Version)
+	if err != nil {
+		return err
+	}
+
+	log.Infof("%s: downloading k0s %s", h, targetVersion)
+	if err := h.Configurer.DownloadK0s(h, targetVersion, h.Metadata.Arch); err != nil {
 		return err
 	}
 
-	output, err := h.ExecOutput(h.Configurer.K0sCmdf("version"), exec.Sudo(h))
+	downloadedVersion, err := h.Configurer.K0sBinaryVersion(h)
 	if err != nil {
 		if err := h.Configurer.DeleteFile(h, h.Configurer.K0sBinaryPath()); err != nil {
 			log.Warnf("%s: failed to remove %s: %s", h, h.Configurer.K0sBinaryPath(), err.Error())
 		}
-		return fmt.Errorf("downloaded k0s binary is invalid: %s", err.Error())
+		return fmt.Errorf("failed to get downloaded k0s binary version: %w", err)
 	}
-	output = strings.TrimPrefix(output, "v")
-	if output != target {
-		return fmt.Errorf("downloaded k0s binary version is %s not %s", output, target)
+	if !targetVersion.Equal(downloadedVersion) {
+		return fmt.Errorf("downloaded k0s binary version is %s not %s", downloadedVersion, targetVersion)
 	}
 
-	h.Metadata.K0sBinaryVersion = target
+	h.Metadata.K0sBinaryVersion = p.Config.Spec.K0s.Version
 
 	return nil
 }

phase/upgrade_controllers.go

@@ -7,6 +7,7 @@ import (
 	"github.com/Masterminds/semver"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1/cluster"
+	"github.com/k0sproject/version"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -67,7 +68,11 @@ func (p *UpgradeControllers) Run() error {
 		if err := h.WaitK0sServiceStopped(); err != nil {
 			return err
 		}
-		if err := h.UpdateK0sBinary(p.Config.Spec.K0s.Version); err != nil {
+		version, err := version.NewVersion(p.Config.Spec.K0s.Version)
+		if err != nil {
+			return err
+		}
+		if err := h.UpdateK0sBinary(version); err != nil {
 			return err
 		}
 

phase/upgrade_workers.go

@@ -7,6 +7,7 @@ import (
 	"github.com/gammazero/workerpool"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1/cluster"
+	"github.com/k0sproject/version"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -101,7 +102,11 @@ func (p *UpgradeWorkers) upgradeWorker(h *cluster.Host) error {
 	if err := h.WaitK0sServiceStopped(); err != nil {
 		return err
 	}
-	if err := h.UpdateK0sBinary(p.Config.Spec.K0s.Version); err != nil {
+	version, err := version.NewVersion(p.Config.Spec.K0s.Version)
+	if err != nil {
+		return err
+	}
+	if err := h.UpdateK0sBinary(version); err != nil {
 		return err
 	}
 

phase/upload_binaries.go

@@ -7,6 +7,7 @@ import (
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1"
 	"github.com/k0sproject/k0sctl/pkg/apis/k0sctl.k0sproject.io/v1beta1/cluster"
 	"github.com/k0sproject/rig/exec"
+	"github.com/k0sproject/version"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -63,7 +64,17 @@ func (p *UploadBinaries) uploadBinary(h *cluster.Host) error {
 		return fmt.Errorf("failed to touch %s: %w", h.Configurer.K0sBinaryPath(), err)
 	}
 
-	h.Metadata.K0sBinaryVersion = p.Config.Spec.K0s.Version
+	uploadedVersion, err := h.Configurer.K0sBinaryVersion(h)
+	if err != nil {
+		return fmt.Errorf("failed to get uploaded k0s binary version: %w", err)
+	}
+
+	h.Metadata.K0sBinaryVersion = uploadedVersion.String()
+	log.Debugf("%s: has k0s binary version %s", h, h.Metadata.K0sBinaryVersion)
+
+	if version, err := version.NewVersion(p.Config.Spec.K0s.Version); err == nil && !version.Equal(uploadedVersion) {
+		return fmt.Errorf("uploaded k0s binary version is %s not %s", uploadedVersion, version)
+	}
 
 	return nil
 }

pkg/apis/k0sctl.k0sproject.io/v1beta1/cluster/host.go

@@ -18,6 +18,7 @@ import (
 	"github.com/k0sproject/rig/exec"
 	"github.com/k0sproject/rig/os"
 	"github.com/k0sproject/rig/os/registry"
+	"github.com/k0sproject/version"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -83,6 +84,7 @@ type configurer interface {
 	Arch(os.Host) (string, error)
 	K0sCmdf(string, ...interface{}) string
 	K0sBinaryPath() string
+	K0sBinaryVersion(os.Host) (*version.Version, error)
 	K0sConfigPath() string
 	K0sJoinTokenPath() string
 	WriteFile(os.Host, string, string, string) error
@@ -93,7 +95,7 @@ type configurer interface {
 	ReadFile(os.Host, string) (string, error)
 	FileExist(os.Host, string) bool
 	Chmod(os.Host, string, string, ...exec.Option) error
-	DownloadK0s(os.Host, string, string) error
+	DownloadK0s(os.Host, *version.Version, string) error
 	DownloadURL(os.Host, string, string, ...exec.Option) error
 	InstallPackage(os.Host, ...string) error
 	FileContains(os.Host, string, string) bool
@@ -296,7 +298,7 @@ func (h *Host) K0sServiceName() string {
 }
 
 // UpdateK0sBinary updates the binary on the host either by downloading or uploading, based on the config
-func (h *Host) UpdateK0sBinary(version string) error {
+func (h *Host) UpdateK0sBinary(version *version.Version) error {
 	if h.UploadBinaryPath != "" {
 		if err := h.Upload(h.UploadBinaryPath, h.Configurer.K0sBinaryPath(), exec.Sudo(h)); err != nil {
 			return err
@@ -308,17 +310,18 @@ func (h *Host) UpdateK0sBinary(version string) error {
 		if err := h.Configurer.DownloadK0s(h, version, h.Metadata.Arch); err != nil {
 			return err
 		}
+	}
 
-		output, err := h.ExecOutput(h.Configurer.K0sCmdf("version"), exec.Sudo(h))
-		if err != nil {
-			return fmt.Errorf("downloaded k0s binary is invalid: %s", err.Error())
-		}
-		output = strings.TrimPrefix(output, "v")
-		if output != version {
-			return fmt.Errorf("downloaded k0s binary version is %s not %s", output, version)
-		}
+	updatedVersion, err := h.Configurer.K0sBinaryVersion(h)
+	if err != nil {
+		return fmt.Errorf("failed to get updated k0s binary version: %w", err)
 	}
-	h.Metadata.K0sBinaryVersion = version
+	if !version.Equal(updatedVersion) {
+		return fmt.Errorf("updated k0s binary version is %s not %s", updatedVersion, version)
+	}
+
+	h.Metadata.K0sBinaryVersion = version.String()
+
 	return nil
 }