magefile.go

// Copyright 2023 uwu-tools Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0

//go:build mage

package main

import (
	"errors"
	"fmt"
	"os"

	"github.com/magefile/mage/sh"
	"sigs.k8s.io/release-utils/mage"

	"github.com/uwu-tools/magex/pkg"
)

// Default target to run when none is specified
// If not set, running mage will list available targets
var Default = Verify

const (
	binDir    = "bin"
	scriptDir = "scripts"

	// Module variables.
	orgName  = "uwu-tools"
	toolName = "gh-jira-issue-sync"

	// Versions.
	golangciVersion = "v1.50.1"
	minGoVersion    = "1.20"

	// Environment variables.
	envLDFLAGS      = "GHJIRA_LDFLAGS"
	envMinGoVersion = "MIN_GO_VERSION"

	// Test variables.
	coverMode            = "atomic"
	coverProfileFilename = "unit-coverage.out"
)

var (
	moduleName = fmt.Sprintf(
		"github.com/%s/%s",
		orgName,
		toolName,
	)
)

// All runs all targets for this repository
func All() error {
	if err := Verify(); err != nil {
		return err
	}

	if err := Test(); err != nil {
		return err
	}

	return nil
}

// Test runs various test functions
func Test() error {
	// TODO(mage): Upstream should support setting covermode/coverprofile.
	return sh.RunV(
		"go",
		"test",
		"-v",
		"-covermode", coverMode,
		"-coverprofile", coverProfileFilename,
		"./...",
	)
}

// Verify runs repository verification scripts
func Verify() error {
	fmt.Println("Ensuring mage is available...")
	if err := pkg.EnsureMage(""); err != nil {
		return err
	}

	// TODO(mage): Support verifying headers.
	/*
		fmt.Println("Running copyright header checks...")
		if err := mage.VerifyBoilerplate("v0.2.5", binDir, boilerplateDir, false); err != nil {
			return err
		}
	*/

	// TODO(mage): Support verifying external dependencies.
	/*
		fmt.Println("Running external dependency checks...")
		if err := mage.VerifyDeps("v0.3.0", "", "", true); err != nil {
			return err
		}
	*/

	// TODO(mage): Support verifying go module.
	// TODO(mage): Upstream should support setting minimum version.
	/*
		os.Setenv(envMinGoVersion, minGoVersion)
		fmt.Println("Running go module linter...")
		if err := mage.VerifyGoMod(scriptDir); err != nil {
			return err
		}
	*/

	fmt.Println("Running golangci-lint...")
	if err := mage.RunGolangCILint(golangciVersion, false); err != nil {
		return err
	}

	if err := Build(); err != nil {
		return err
	}

	return nil
}

// Build runs go build
func Build() error {
	fmt.Println("Running go build...")

	ldFlag, err := mage.GenerateLDFlags()
	if err != nil {
		return err
	}

	os.Setenv(envLDFLAGS, ldFlag)

	if err := mage.VerifyBuild(scriptDir); err != nil {
		return err
	}

	fmt.Println("Binaries available in the output directory.")
	return nil
}

func BuildBinaries() error {
	fmt.Println("Building binaries with goreleaser...")

	ldFlag, err := mage.GenerateLDFlags()
	if err != nil {
		return err
	}

	os.Setenv(envLDFLAGS, ldFlag)

	return sh.RunV(
		"goreleaser",
		"release",
		"--clean",
	)
}

func BuildBinariesSnapshot() error {
	fmt.Println("Building binaries with goreleaser in snapshot mode...")

	ldFlag, err := mage.GenerateLDFlags()
	if err != nil {
		return err
	}

	os.Setenv(envLDFLAGS, ldFlag)

	return sh.RunV(
		"goreleaser",
		"release",
		"--clean",
		"--snapshot",
		"--skip-sign",
	)
}

// BuildImages build image using ko
func BuildImages() error {
	fmt.Println("Building images with ko...")

	gitVersion := getVersion()
	gitCommit := getCommit()
	ldFlag, err := mage.GenerateLDFlags()
	if err != nil {
		return err
	}
	os.Setenv(envLDFLAGS, ldFlag)
	os.Setenv("KOCACHE", "/tmp/ko")

	if os.Getenv("KO_DOCKER_REPO") == "" {
		return errors.New("missing KO_DOCKER_REPO environment variable")
	}

	return sh.RunV(
		"ko",
		"build",
		"--bare",
		"--platform=all",
		"--tags", gitVersion,
		"--tags", gitCommit,
		moduleName,
	)
}

// BuildImagesLocal build images locally and not push
func BuildImagesLocal() error {
	fmt.Println("Building image with ko for local test...")
	if err := mage.EnsureKO(""); err != nil {
		return err
	}

	ldFlag, err := mage.GenerateLDFlags()
	if err != nil {
		return err
	}

	os.Setenv(envLDFLAGS, ldFlag)
	os.Setenv("KOCACHE", "/tmp/ko")

	return sh.RunV(
		"ko",
		"build",
		"--bare",
		"--local",
		"--platform=linux/amd64",
		moduleName,
	)
}

func BuildStaging() error {
	fmt.Println("Ensuring mage is available...")
	if err := pkg.EnsureMage(""); err != nil {
		return err
	}

	if err := mage.EnsureKO(""); err != nil {
		return err
	}

	if err := BuildImages(); err != nil {
		return fmt.Errorf("building the images: %w", err)
	}

	return nil
}

func Clean() {
	fmt.Println("Cleaning workspace...")
	toClean := []string{"output"}

	for _, clean := range toClean {
		sh.Rm(clean)
	}

	fmt.Println("Done.")
}

// getCommit gets the hash of the current commit
func getCommit() string {
	commit, _ := sh.Output("git", "rev-parse", "--short", "HEAD")
	return commit
}

// getVersion gets a description of the commit, e.g. v0.30.1 (latest) or v0.30.1-32-gfe72ff73 (canary)
func getVersion() string {
	version, _ := sh.Output("git", "describe", "--tags", "--match=v*")
	if version != "" {
		return version
	}

	// repo without any tags in it
	return "v0.0.0"
}