feat: add version command (#35)

add command to show current binary and addons versions.

Author: ricardomaraschini

.github/workflows/pull-request.yaml

@@ -37,19 +37,21 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v3
+    - name: Get short commit hash
+      run: echo "SHORT_SHA=$(git rev-parse --short=7 HEAD)" >> $GITHUB_ENV
     - name: Setup Go
       uses: actions/setup-go@v4
       with:
         go-version: "1.21.0"
     - name: Build Linux AMD64
       run: |
-        make helmvm-linux-amd64
+        make helmvm-linux-amd64 VERSION=dev-$SHORT_SHA
     - name: Build Darwin AMD64
       run: |
         make helmvm-darwin-amd64
-    - name: Build Darwin ARM64
+    - name: Build Darwin ARM64 VERSION=dev-$SHORT_SHA
       run: |
-        make helmvm-darwin-arm64
+        make helmvm-darwin-arm64 VERSION=dev-$SHORT_SHA
     - name: Build HelmVM Builder Server Image
       uses: docker/build-push-action@v4
       with:

.github/workflows/release-prod.yaml

@@ -13,27 +13,25 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-
       - name: Extract tag name
         run: echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
           go-version: "1.20"
       - name: Build linux-amd64
         run: |
-          make helmvm-linux-amd64
+          make helmvm-linux-amd64 VERSION=$TAG_NAME
           tar -C output/bin -czvf helmvm-linux-amd64.tgz helmvm
           make clean
       - name: Build darwin-amd64
         run: |
-          make helmvm-darwin-amd64
+          make helmvm-darwin-amd64 VERSION=$TAG_NAME
           tar -C output/bin -czvf helmvm-darwin-amd64.tgz helmvm
           make clean
       - name: Build darwin-arm64
         run: |
-          make helmvm-darwin-arm64
+          make helmvm-darwin-arm64 VERSION=$TAG_NAME
           tar -C output/bin -czvf helmvm-darwin-arm64.tgz helmvm
           make clean
       - name: Publish release

Makefile

@@ -1,12 +1,13 @@
-BUILDER_NAME=builder
-APP_NAME=helmvm
-ADMIN_CONSOLE_CHART_VERSION=1.100.1
-KUBECTL_VERSION=v1.27.3
-K0SCTL_VERSION=v0.15.2
-TERRAFORM_VERSION=1.5.4
-OPENEBS_VERSION=3.7.0
-K0S_VERSION=v1.27.2+k0s.0
-LD_FLAGS=-X github.com/replicatedhq/helmvm/pkg/defaults.K0sVersion=$(K0S_VERSION)
+VERSION ?= v0.0.0
+BUILDER_NAME = builder
+APP_NAME = helmvm
+ADMIN_CONSOLE_CHART_VERSION = 1.100.1
+KUBECTL_VERSION = v1.27.3
+K0SCTL_VERSION = v0.15.2
+TERRAFORM_VERSION = 1.5.4
+OPENEBS_VERSION = 3.7.0
+K0S_VERSION = v1.27.2+k0s.0
+LD_FLAGS = -X github.com/replicatedhq/helmvm/pkg/defaults.K0sVersion=$(K0S_VERSION) -X main.Version=$(VERSION)
 
 default: helmvm-linux-amd64
 

cmd/helmvm/install.go

@@ -374,7 +374,7 @@ var installCommand = &cli.Command{
 		ccfg := defaults.PathToConfig("k0sctl.yaml")
 		kcfg := defaults.PathToConfig("kubeconfig")
 		os.Setenv("KUBECONFIG", kcfg)
-		if applier, err := addons.NewApplier(prompt); err != nil {
+		if applier, err := addons.NewApplier(prompt, true); err != nil {
 			return fmt.Errorf("unable to create applier: %w", err)
 		} else if err := applier.Apply(c.Context); err != nil {
 			return fmt.Errorf("unable to apply addons: %w", err)

cmd/helmvm/main.go

@@ -20,6 +20,7 @@ func main() {
 			embedCommand,
 			shellCommand,
 			nodeCommands,
+			versionCommand,
 		},
 	}
 	if err := app.Run(os.Args); err != nil {

cmd/helmvm/upgrade.go

@@ -81,7 +81,7 @@ var upgradeCommand = &cli.Command{
 		}
 		os.Setenv("KUBECONFIG", kcfg)
 		logrus.Infof("Upgrading addons")
-		if applier, err := addons.NewApplier(c.Bool("no-prompt")); err != nil {
+		if applier, err := addons.NewApplier(c.Bool("no-prompt"), true); err != nil {
 			return fmt.Errorf("unable to create applier: %w", err)
 		} else if err := applier.Apply(c.Context); err != nil {
 			return fmt.Errorf("unable to apply addons: %w", err)

cmd/helmvm/version.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/jedib0t/go-pretty/table"
+	"github.com/urfave/cli/v2"
+
+	"github.com/replicatedhq/helmvm/pkg/addons"
+	"github.com/replicatedhq/helmvm/pkg/defaults"
+)
+
+var Version = "v0.0.0"
+
+var versionCommand = &cli.Command{
+	Name:  "version",
+	Usage: fmt.Sprintf("Shows the %s installer version", defaults.BinaryName()),
+	Action: func(c *cli.Context) error {
+		applier, err := addons.NewApplier(true, false)
+		if err != nil {
+			return fmt.Errorf("unable to create applier: %w", err)
+		}
+		versions, err := applier.Versions()
+		if err != nil {
+			return fmt.Errorf("unable to get versions: %w", err)
+		}
+		writer := table.NewWriter()
+		writer.AppendHeader(table.Row{"component", "version"})
+		writer.AppendRow(table.Row{"Installer", Version})
+		writer.AppendRow(table.Row{"Kubernetes", defaults.K0sVersion})
+		for name, version := range versions {
+			if !strings.HasPrefix(version, "v") {
+				version = fmt.Sprintf("v%s", version)
+			}
+			writer.AppendRow(table.Row{name, version})
+		}
+		fmt.Printf("%s\n", writer.Render())
+		return nil
+	},
+}

pkg/addons/adminconsole/adminconsole.go

@@ -58,6 +58,14 @@ func (a *AdminConsole) askPassword() (string, error) {
 	return pass, nil
 }
 
+func (a *AdminConsole) Version() (map[string]string, error) {
+	latest, err := a.Latest()
+	if err != nil {
+		return nil, fmt.Errorf("unable to get latest version: %w", err)
+	}
+	return map[string]string{"AdminConsole": latest}, nil
+}
+
 func (a *AdminConsole) Apply(ctx context.Context) error {
 	version, err := a.Latest()
 	if err != nil {

pkg/addons/applier.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/sirupsen/logrus"
+	"helm.sh/helm/v3/pkg/action"
 	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
@@ -27,9 +28,21 @@ type Applier struct {
 	addons     map[string]AddOn
 }
 
+// DoNotLog is a helper function to disable logging for addons.
+func DoNotLog(format string, v ...interface{}) {}
+
+// getLogger creates a logger to be used in an addon.
+func getLogger(addon string, verbose bool) action.DebugLog {
+	if !verbose {
+		return DoNotLog
+	}
+	return logrus.WithField("addon", addon).Infof
+}
+
 // AddOn is the interface that all addons must implement.
 type AddOn interface {
 	Apply(ctx context.Context) error
+	Version() (map[string]string, error)
 }
 
 // Apply applies all registered addons to the cluster. Simply calls Apply on
@@ -48,6 +61,21 @@ func (a *Applier) Apply(ctx context.Context) error {
 	return nil
 }
 
+// Version returns a map with the version of each addon that will be applied.
+func (a *Applier) Versions() (map[string]string, error) {
+	versions := map[string]string{}
+	for name, addon := range a.addons {
+		version, err := addon.Version()
+		if err != nil {
+			return nil, fmt.Errorf("unable to get version (%s): %w", name, err)
+		}
+		for k, v := range version {
+			versions[k] = v
+		}
+	}
+	return versions, nil
+}
+
 // waitForKubernetes waits until we manage to make a successful connection to the
 // Kubernetes API server.
 func (a *Applier) waitForKubernetes(ctx context.Context) error {
@@ -77,7 +105,7 @@ func (a *Applier) waitForKubernetes(ctx context.Context) error {
 }
 
 // NewApplier creates a new Applier instance with all addons registered.
-func NewApplier(prompt bool) (*Applier, error) {
+func NewApplier(prompt, verbose bool) (*Applier, error) {
 	k8slogger := zap.New(func(o *zap.Options) {
 		o.DestWriter = io.Discard
 	})
@@ -90,24 +118,18 @@ func NewApplier(prompt bool) (*Applier, error) {
 	if err != nil {
 		return nil, fmt.Errorf("unable to create kubernetes client: %w", err)
 	}
-	applier := &Applier{
-		addons:     map[string]AddOn{},
-		kubeclient: kubecli,
-	}
-	logger := logrus.WithField("addon", "openebs")
-	obs, err := openebs.New("helmvm", logger.Infof)
+	applier := &Applier{addons: map[string]AddOn{}, kubeclient: kubecli}
+	obs, err := openebs.New("helmvm", getLogger("openebs", verbose))
 	if err != nil {
 		return nil, fmt.Errorf("unable to create admin console addon: %w", err)
 	}
 	applier.addons["openebs"] = obs
-	logger = logrus.WithField("addon", "adminconsole")
-	aconsole, err := adminconsole.New("helmvm", prompt, kubecli, logger.Infof)
+	aconsole, err := adminconsole.New("helmvm", prompt, kubecli, getLogger("adminconsole", verbose))
 	if err != nil {
 		return nil, fmt.Errorf("unable to create admin console addon: %w", err)
 	}
 	applier.addons["adminconsole"] = aconsole
-	logger = logrus.WithField("addon", "custom")
-	custom, err := custom.New("helmvm", logger.Infof)
+	custom, err := custom.New("helmvm", getLogger("custom", verbose))
 	if err != nil {
 		return nil, fmt.Errorf("unable to create admin console addon: %w", err)
 	}

pkg/addons/custom/custom.go

@@ -24,6 +24,28 @@ type Custom struct {
 	namespace string
 }
 
+func (c *Custom) Version() (map[string]string, error) {
+	exe, err := os.Executable()
+	if err != nil {
+		return nil, fmt.Errorf("unable to get executable path: %w", err)
+	}
+	opts, err := hembed.ReadEmbedOptionsFromBinary(exe)
+	if err != nil {
+		return nil, fmt.Errorf("unable to read embed options: %w", err)
+	} else if opts == nil {
+		return nil, nil
+	}
+	infos := make(map[string]string)
+	for _, raw := range opts.Charts {
+		chart, err := loader.LoadArchive(raw.ChartReader())
+		if err != nil {
+			return nil, fmt.Errorf("unable to load chart archive: %w", err)
+		}
+		infos[chart.Name()] = chart.Metadata.Version
+	}
+	return infos, nil
+}
+
 func (c *Custom) Apply(ctx context.Context) error {
 	exe, err := os.Executable()
 	if err != nil {

pkg/addons/openebs/openebs.go

@@ -40,6 +40,14 @@ type OpenEBS struct {
 	namespace string
 }
 
+func (o *OpenEBS) Version() (map[string]string, error) {
+	latest, err := o.latest()
+	if err != nil {
+		return nil, fmt.Errorf("unable to get latest version: %w", err)
+	}
+	return map[string]string{"OpenEBS": latest}, nil
+}
+
 func (o *OpenEBS) Apply(ctx context.Context) error {
 	version, err := o.latest()
 	if err != nil {