build: add a makefile (#2)

Also, add a version command.

Author: leafty

.gitignore

@@ -0,0 +1 @@
+build/

Makefile

@@ -0,0 +1,54 @@
+SHELL = bash
+# Current git branch
+BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
+# Current git commit hash
+GIT_COMMIT_HASH := $(shell git show --no-patch --no-notes --pretty='%h' HEAD)
+VERSION := $(BRANCH).$(GIT_COMMIT_HASH)
+ifeq ($(shell git status --porcelain),)
+DIRTY :=
+else
+DIRTY := "dev"
+endif
+LDFLAGS=--ldflags "-s -X github.com/SwissDataScienceCenter/renku-dev-utils/pkg/version.Version=$(VERSION) -X github.com/SwissDataScienceCenter/renku-dev-utils/pkg/version.VersionSuffix=$(DIRTY)"
+
+.PHONY: all
+all: help
+
+.PHONY: vars
+vars:  ## Show the Makefile vars
+	@echo SHELL="'$(SHELL)'"
+	@echo BRANCH="'$(BRANCH)'"
+	@echo GIT_COMMIT_HASH="'$(GIT_COMMIT_HASH)'"
+	@echo VERSION="'$(VERSION)'"
+	@echo DIRTY="'$(DIRTY)'"
+
+.PHONY: rdu
+rdu: build/renku-dev-utils  ## Build and install renku-dev-utils
+	mkdir -p `go env GOPATH`/bin/
+	cp -av build/renku-dev-utils`go env GOEXE` `go env GOPATH`/bin/rdu`go env GOEXE`.new
+	mv -v `go env GOPATH`/bin/rdu`go env GOEXE`.new `go env GOPATH`/bin/rdu`go env GOEXE`
+
+.PHONY: build/renku-dev-utils
+build/renku-dev-utils:
+	go build -v -o build/ $(LDFLAGS)
+
+# From the operator sdk Makefile
+# The help target prints out all targets with their descriptions organized
+# beneath their categories. The categories are represented by '##@' and the
+# target descriptions by '##'. The awk command is responsible for reading the
+# entire set of makefiles included in this invocation, looking for lines of the
+# file as xyz: ## something, and then pretty-format the target and help. Then,
+# if there's a line with ##@ something, that gets pretty-printed as a category.
+# More info on the usage of ANSI control characters for terminal formatting:
+# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
+# More info on the awk command:
+# http://linuxcommand.org/lc3_adv_awk.php
+.PHONY: help
+help:  ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Development
+
+.PHONY: format
+format:  ## Format source files
+	gofmt -l -w .

README.md

@@ -1,3 +1,18 @@
 # Renku Dev Utils
 
 Miscellanous utilities for the @SwissDataScienceCenter/renku team.
+
+## Installation
+
+Installing `renku-dev-utils` requires go version `>= v1.24.1` and `make`.
+
+```bash
+make rdu
+```
+
+
+## Usage
+
+```bash
+rdu
+```

build/.gitkeep

@@ -3,6 +3,7 @@ package cmd
 import (
 	"context"
 	"fmt"
+	"os"
 
 	"github.com/SwissDataScienceCenter/renku-dev-utils/pkg/k8s"
 	"github.com/spf13/cobra"
@@ -20,36 +21,38 @@ var copyKeycloakAdminPasswordCmd = &cobra.Command{
 	Use:     "copy-keycloak-admin-password",
 	Aliases: []string{"ckap"},
 	Short:   "Copy the Keycloak admin password to the clipboard",
-	RunE:    runCopyKeycloakAdminPassword,
+	Run:     runCopyKeycloakAdminPassword,
 }
 
-func runCopyKeycloakAdminPassword(cmd *cobra.Command, args []string) error {
+func runCopyKeycloakAdminPassword(cmd *cobra.Command, args []string) {
 	ctx := context.Background()
 
 	clients, err := k8s.GetClientset()
 	if err != nil {
-		return err
+		fmt.Println(err)
+		os.Exit(1)
 	}
 
 	secret, err := clients.CoreV1().Secrets(namespace).Get(ctx, secretName, v1.GetOptions{})
 	if err != nil {
-		return err
+		fmt.Println(err)
+		os.Exit(1)
 	}
 
 	secretValue, found := secret.Data[secretKey]
 	if !found {
-		return fmt.Errorf("The secret did not contain '%s'", secretKey)
+		fmt.Printf("The secret did not contain '%s'\n", secretKey)
+		os.Exit(1)
 	}
 
 	if err := clipboard.Init(); err != nil {
-		return err
+		fmt.Println(err)
+		os.Exit(1)
 	}
 
 	clipboard.Write(clipboard.FmtText, secretValue)
 	fmt.Printf("Copied Keycloak admin password into the clipboard")
 	fmt.Println()
-
-	return nil
 }
 
 func init() {

cmd/renku-dev-utils/main.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"os"
+
 	"github.com/spf13/cobra"
 )
 
@@ -20,4 +22,12 @@ func runRoot(cmd *cobra.Command, args []string) error {
 
 func init() {
 	rootCmd.AddCommand(copyKeycloakAdminPasswordCmd)
+	rootCmd.AddCommand(versionCmd)
+}
+
+func Main() {
+	if err := Execute(); err != nil {
+		os.Exit(2)
+	}
+	os.Exit(0)
 }

pkg/cmd/copykeycloakadminpassword.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/SwissDataScienceCenter/renku-dev-utils/pkg/version"
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Print the version of renku-dev-utils",
+	Run:   runVersion,
+}
+
+func runVersion(cmd *cobra.Command, args []string) {
+	fmt.Printf("renku-dev-utils %s\n", version.Version)
+}

pkg/cmd/root.go

@@ -0,0 +1,13 @@
+package version
+
+// Version of renku-dev-utils
+var Version string = "DEV"
+
+// Version suffix of renku-dev-utils
+var VersionSuffix string = ""
+
+func init() {
+	if VersionSuffix != "" {
+		Version = Version + "-" + VersionSuffix
+	}
+}

pkg/cmd/version.go

@@ -0,0 +1,7 @@
+package main
+
+import "github.com/SwissDataScienceCenter/renku-dev-utils/pkg/cmd"
+
+func main() {
+	cmd.Main()
+}