Add 'self' install option

Author: Trevor Nierman

pkg/tool/self/self.go

@@ -0,0 +1,162 @@
+package self
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	gogithub "github.com/google/go-github/v51/github"
+	"github.com/openshift/backplane-tools/pkg/source/github"
+	"github.com/openshift/backplane-tools/pkg/utils"
+)
+
+// Tool implements the interface to manage the 'backplane-tools' binary
+type Tool struct {
+	source *github.Source
+}
+
+func NewTool() *Tool {
+	t := &Tool{
+		source: github.NewSource("openshift", "backplane-tools"),
+	}
+	return t
+}
+
+func (t *Tool) Name() string {
+	return "backplane-tools"
+}
+
+func (t *Tool) Install(rootDir, latestDir string) error {
+	// Pull latest release from GH
+	release, err := t.source.FetchLatestRelease()
+	if err != nil {
+		return err
+	}
+
+	// Determine which assets to download
+	var checksumAsset *gogithub.ReleaseAsset
+	var backplaneArchiveAsset *gogithub.ReleaseAsset
+	for _, asset := range release.Assets {
+		if strings.Contains(asset.GetName(), "checksums.txt") {
+			if checksumAsset.GetName() != "" {
+				return fmt.Errorf("detected duplicate backplane-tools checksum assets")
+			}
+			checksumAsset = asset
+			continue
+		}
+		// Exclude assets that do not match system architecture
+		if !strings.Contains(asset.GetName(), runtime.GOARCH) {
+			continue
+		}
+		// Exclude assets that do not match system OS
+		if !strings.Contains(strings.ToLower(asset.GetName()), strings.ToLower(runtime.GOOS)) {
+			continue
+		}
+
+		if backplaneArchiveAsset.GetName() != "" {
+			return fmt.Errorf("detected duplicate backplane-tools binary assets")
+		}
+		backplaneArchiveAsset = asset
+	}
+	// Ensure both checksum and binary were retrieved
+	if backplaneArchiveAsset.GetName() == "" {
+		return fmt.Errorf("failed to find valid backplane-tools binary asset")
+	}
+	if checksumAsset.GetName() == "" {
+		return fmt.Errorf("failed to find valid backplane-tools checksum asset")
+	}
+
+	// Download the arch- & os-specific assets
+	toolDir := t.toolDir(rootDir)
+	versionedDir := filepath.Join(toolDir, release.GetTagName())
+	err = os.MkdirAll(versionedDir, os.FileMode(0755))
+	if err != nil {
+		return fmt.Errorf("failed to create version-specific directory '%s': %w", versionedDir, err)
+	}
+
+	err = t.source.DownloadReleaseAssets([]*gogithub.ReleaseAsset{checksumAsset, backplaneArchiveAsset}, versionedDir)
+	if err != nil {
+		return fmt.Errorf("failed to download one or more assets: %w", err)
+	}
+
+	// Verify checksum of downloaded assets
+	backplaneArchiveFilepath := filepath.Join(versionedDir, backplaneArchiveAsset.GetName())
+	binarySum, err := utils.Sha256sum(backplaneArchiveFilepath)
+	if err != nil {
+		return fmt.Errorf("failed to calculate checksum for '%s': %w", backplaneArchiveFilepath, err)
+	}
+
+	checksumFilePath := filepath.Join(versionedDir, checksumAsset.GetName())
+	checksumLine, err := utils.GetLineInFile(checksumFilePath, backplaneArchiveAsset.GetName())
+	if err != nil {
+		return fmt.Errorf("failed to retrieve checksum from file '%s': %w", checksumFilePath, err)
+	}
+	checksumTokens := strings.Fields(checksumLine)
+	if len(checksumTokens) != 2 {
+			return fmt.Errorf("the checksum file '%s' is invalid: expected 2 fields, got %d", checksumFilePath, len(checksumTokens))
+	}
+	actual := checksumTokens[0]
+
+	if strings.TrimSpace(binarySum) != strings.TrimSpace(actual) {
+		return fmt.Errorf("WARNING: Checksum for backplane-tools does not match the calculated value. Please retry installation. If issue persists, this tool can be downloaded manually at %s\n", backplaneArchiveAsset.GetBrowserDownloadURL())
+	}
+
+	// Untar binary bundle
+	err = utils.Unarchive(backplaneArchiveFilepath, versionedDir)
+	if err != nil {
+		return fmt.Errorf("failed to unarchive the backplane-tools asset file '%s': %w", backplaneArchiveFilepath, err)
+	}
+
+	// Link as latest
+	latestFilePath := t.symlinkPath(latestDir)
+	err = os.Remove(latestFilePath)
+	if err != nil && !os.IsNotExist(err) {
+		return fmt.Errorf("failed to remove existing 'backplane-tools' binary at '%s': %w", latestDir, err)
+	}
+
+	backplaneBinaryFilepath := filepath.Join(versionedDir, "backplane-tools")
+	err = os.Symlink(backplaneBinaryFilepath, latestFilePath)
+	if err != nil {
+		return fmt.Errorf("failed to link new 'backplane-tools' binary to '%s': %w", latestDir, err)
+	}
+	return nil
+}
+
+func (t Tool) Installed(rootDir string) (bool, error) {
+	toolDir := t.toolDir(rootDir)
+	return utils.FileExists(toolDir)
+}
+
+// toolDir returns this tool's specific directory given the root directory all tools are installed in
+func (t *Tool) toolDir(rootDir string) string {
+	return filepath.Join(rootDir, "backplane-tools")
+}
+
+// symlinkPath returns the path to the symlink created by this tool, given the latest directory
+func (t *Tool) symlinkPath(latestDir string) string {
+	return filepath.Join(latestDir, "backplane-tools")
+}
+
+// Remove completely removes this tool from the provided locations
+func (t *Tool) Remove(rootDir, latestDir string) error {
+	// Remove all binaries owned by this tool
+	toolDir := t.toolDir(rootDir)
+	err := os.RemoveAll(toolDir)
+	if err != nil {
+		return fmt.Errorf("failed to remove %s: %w", toolDir, err)
+	}
+
+	// Remove all symlinks owned by this tool
+	latestFilePath := t.symlinkPath(latestDir)
+	err = os.Remove(latestFilePath)
+	if err != nil {
+		return fmt.Errorf("failed to remove symlinked file %s: %w", latestFilePath, err)
+	}
+	return nil
+}
+
+func (t *Tool) Configure() error {
+	return nil
+}

pkg/tool/tool.go

@@ -8,6 +8,7 @@ import (
 
 	awscli "github.com/openshift/backplane-tools/pkg/tool/aws-cli"
 	backplanecli "github.com/openshift/backplane-tools/pkg/tool/backplane-cli"
+	"github.com/openshift/backplane-tools/pkg/tool/self"
 	"github.com/openshift/backplane-tools/pkg/tool/oc"
 	"github.com/openshift/backplane-tools/pkg/tool/ocm"
 	"github.com/openshift/backplane-tools/pkg/tool/osdctl"
@@ -48,6 +49,11 @@ var toolMap Map
 func newMap() Map {
 	toolMap = Map{}
 
+	// Self-management
+	self := self.NewTool()
+	toolMap[self.Name()] = self
+
+	// 3rd party tools
 	awsTool := awscli.NewTool()
 	toolMap[awsTool.Name()] = awsTool