Refine ADO magefile (#480)

* Split magefile into individual pieces

* fix: pre-commit checks

Author: Supreeth Basabattini

magefile.go

@@ -0,0 +1,33 @@
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"fmt"
+	"os/exec"
+	"strings"
+
+	"github.com/mt-sre/devkube/magedeps"
+)
+
+const (
+	module          = "github.com/openshift/addon-operator"
+	defaultImageOrg = "quay.io/app-sre"
+)
+
+var (
+	workDir  string                       // Working directory of the project
+	depsDir  magedeps.DependencyDirectory // Dependency directory
+	cacheDir string
+)
+
+func gnuSed() bool {
+	cmd := exec.Command("sed", "--version")
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println("warning: sed --version returned error. this could mean that 'sed' is not 'gnu sed':", string(output), err)
+		return false
+	}
+	return strings.Contains(string(output), "GNU")
+}

magefiles/build.go

@@ -0,0 +1,47 @@
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path"
+
+	"github.com/go-logr/logr"
+	"github.com/go-logr/stdr"
+	"github.com/mt-sre/devkube/dev"
+	"github.com/mt-sre/devkube/magedeps"
+)
+
+var (
+	logger           logr.Logger = stdr.New(nil)
+	containerRuntime string
+)
+
+func init() {
+	var err error
+	// Directories
+	workDir, err = os.Getwd()
+	if err != nil {
+		panic(fmt.Errorf("getting work dir: %w", err))
+	}
+	cacheDir = path.Join(workDir + "/" + ".cache")
+	depsDir = magedeps.DependencyDirectory(path.Join(workDir, ".deps"))
+	os.Setenv("PATH", depsDir.Bin()+":"+os.Getenv("PATH"))
+
+	logger = stdr.New(nil)
+}
+
+// setupContainerRuntime is a dependency for all targets requiring a container runtime
+func setupContainerRuntime() {
+	containerRuntime = os.Getenv("CONTAINER_RUNTIME")
+	if len(containerRuntime) == 0 || containerRuntime == "auto" {
+		cr, err := dev.DetectContainerRuntime()
+		if err != nil {
+			panic(err)
+		}
+		containerRuntime = string(cr)
+		logger.Info("detected container-runtime", "container-runtime", containerRuntime)
+	}
+}

magefiles/common.go

@@ -0,0 +1,161 @@
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path"
+
+	"github.com/magefile/mage/mg"
+	"github.com/magefile/mage/sh"
+)
+
+// Dependency Versions
+const (
+	controllerGenVersion = "0.6.2"
+	kindVersion          = "0.20.0"
+	yqVersion            = "4.35.1"
+	goimportsVersion     = "0.12.0"
+	golangciLintVersion  = "1.54.2"
+	olmVersion           = "0.20.0"
+	opmVersion           = "1.24.0"
+	pkoCliVersion        = "1.6.1"
+	helmVersion          = "3.12.2"
+)
+
+type Dependency mg.Namespace
+
+func (d Dependency) All() {
+	mg.Deps(
+		Dependency.Kind,
+		Dependency.ControllerGen,
+		Dependency.YQ,
+		Dependency.Goimports,
+		Dependency.GolangciLint,
+		Dependency.Helm,
+		Dependency.Opm,
+	)
+}
+
+// Ensure Kind dependency - Kubernetes in Docker (or Podman)
+func (d Dependency) Kind() error {
+	return depsDir.GoInstall("kind",
+		"sigs.k8s.io/kind", kindVersion)
+}
+
+// Ensure controller-gen - kubebuilder code and manifest generator.
+func (d Dependency) ControllerGen() error {
+	return depsDir.GoInstall("controller-gen",
+		"sigs.k8s.io/controller-tools/cmd/controller-gen", controllerGenVersion)
+}
+
+// Ensure yq - jq but for Yaml, written in Go.
+func (d Dependency) YQ() error {
+	return depsDir.GoInstall("yq",
+		"github.com/mikefarah/yq/v4", yqVersion)
+}
+
+func (d Dependency) Goimports() error {
+	return depsDir.GoInstall("go-imports",
+		"golang.org/x/tools/cmd/goimports", goimportsVersion)
+}
+
+func (d Dependency) GolangciLint() error {
+	return depsDir.GoInstall("golangci-lint",
+		"github.com/golangci/golangci-lint/cmd/golangci-lint", golangciLintVersion)
+}
+
+func (d Dependency) Helm() error {
+	return depsDir.GoInstall("helm", "helm.sh/helm/v3/cmd/helm", helmVersion)
+}
+
+func (d Dependency) Opm() error {
+	// TODO: move this into devkube library, to ensure the depsDir is present, even if you just call "NeedsRebuild"
+	if err := os.MkdirAll(depsDir.Bin(), os.ModePerm); err != nil {
+		return fmt.Errorf("create dependency dir: %w", err)
+	}
+
+	needsRebuild, err := depsDir.NeedsRebuild("opm", opmVersion)
+	if err != nil {
+		return err
+	}
+	if !needsRebuild {
+		return nil
+	}
+
+	// Tempdir
+	tempDir, err := os.MkdirTemp(cacheDir, "")
+	if err != nil {
+		return fmt.Errorf("temp dir: %w", err)
+	}
+	defer os.RemoveAll(tempDir)
+
+	// Download
+	tempOPMBin := path.Join(tempDir, "opm")
+	if err := sh.RunV(
+		"curl", "-L", "--fail",
+		"-o", tempOPMBin,
+		fmt.Sprintf(
+			"https://github.com/operator-framework/operator-registry/releases/download/v%s/linux-amd64-opm",
+			opmVersion,
+		),
+	); err != nil {
+		return fmt.Errorf("downloading opm: %w", err)
+	}
+
+	if err := os.Chmod(tempOPMBin, 0755); err != nil {
+		return fmt.Errorf("make opm executable: %w", err)
+	}
+
+	// Move
+	if err := os.Rename(tempOPMBin, path.Join(depsDir.Bin(), "opm")); err != nil {
+		return fmt.Errorf("move opm: %w", err)
+	}
+	return nil
+}
+
+func (d Dependency) PkoCli() error {
+	if err := os.MkdirAll(depsDir.Bin(), os.ModePerm); err != nil {
+		return fmt.Errorf("create dependency dir: %w", err)
+	}
+
+	needsRebuild, err := depsDir.NeedsRebuild("kubectl-package", pkoCliVersion)
+	if err != nil {
+		return err
+	}
+	if !needsRebuild {
+		return nil
+	}
+
+	// Tempdir
+	tempDir, err := os.MkdirTemp(cacheDir, "")
+	if err != nil {
+		return fmt.Errorf("temp dir: %w", err)
+	}
+	defer os.RemoveAll(tempDir)
+
+	// Download
+	tempPkoCliBin := path.Join(tempDir, "kubectl-package")
+	if err := sh.RunV(
+		"curl", "-L", "--fail",
+		"-o", tempPkoCliBin,
+		fmt.Sprintf(
+			"https://github.com/package-operator/package-operator/releases/download/v%s/kubectl-package_linux_amd64",
+			pkoCliVersion,
+		),
+	); err != nil {
+		return fmt.Errorf("downloading kubectl-package: %w", err)
+	}
+
+	if err := os.Chmod(tempPkoCliBin, 0755); err != nil {
+		return fmt.Errorf("make kubectl-package executable: %w", err)
+	}
+
+	// Move
+	if err := os.Rename(tempPkoCliBin, path.Join(depsDir.Bin(), "kubectl-package")); err != nil {
+		return fmt.Errorf("move kubectl-package: %w", err)
+	}
+	return nil
+}