feat: add --version flag for webhook and proxy (#1629)

Signed-off-by: Anish Ramasekar <[email protected]>

Author: aramase

Makefile

@@ -6,7 +6,7 @@ IMAGE_VERSION ?= v1.5.1
 
 ORG_PATH := github.com/Azure
 PROJECT_NAME := azure-workload-identity
-BUILD_COMMIT := $(shell git rev-parse --short HEAD)
+BUILD_COMMIT := $(shell git describe --always --dirty --abbrev=7)
 REPO_PATH := $(ORG_PATH)/$(PROJECT_NAME)
 
 # build variables

cmd/proxy/main.go

@@ -12,12 +12,14 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
 	"github.com/Azure/azure-workload-identity/pkg/proxy"
+	"github.com/Azure/azure-workload-identity/pkg/version"
 )
 
 var (
-	proxyPort int
-	probe     bool
-	logLevel  string
+	proxyPort   int
+	probe       bool
+	logLevel    string
+	versionInfo bool
 )
 
 func main() {
@@ -33,8 +35,13 @@ func mainErr() error {
 	flag.BoolVar(&probe, "probe", false, "Run a readyz probe on the proxy")
 	flag.StringVar(&logLevel, "log-level", "",
 		"In order of increasing verbosity: unset (empty string), info, debug, trace and all.")
+	flag.BoolVar(&versionInfo, "version", false, "Print version information and exit")
 	flag.Parse()
 
+	if versionInfo {
+		return version.PrintVersionToStdout()
+	}
+
 	if err := mlog.ValidateAndSetLogLevelAndFormatGlobally(signals.SetupSignalHandler(), mlog.LogSpec{
 		Level:  mlog.LogLevel(logLevel),
 		Format: mlog.FormatJSON,

cmd/webhook/main.go

@@ -48,6 +48,7 @@ var (
 	disableCertRotation bool
 	metricsBackend      string
 	logLevel            string
+	versionInfo         bool
 
 	// DNSName is <service name>.<namespace>.svc
 	dnsName = fmt.Sprintf("%s.%s.svc", serviceName, util.GetNamespace())
@@ -78,8 +79,13 @@ func mainErr() error {
 	flag.StringVar(&metricsBackend, "metrics-backend", "prometheus", "Backend used for metrics")
 	flag.StringVar(&logLevel, "log-level", "",
 		"In order of increasing verbosity: unset (empty string), info, debug, trace and all.")
+	flag.BoolVar(&versionInfo, "version", false, "Print version information and exit")
 	flag.Parse()
 
+	if versionInfo {
+		return version.PrintVersionToStdout()
+	}
+
 	ctx := signals.SetupSignalHandler()
 
 	if err := mlog.ValidateAndSetLogLevelAndFormatGlobally(ctx, mlog.LogSpec{

pkg/version/version.go

@@ -1,7 +1,10 @@
 package version
 
 import (
+	"encoding/json"
 	"fmt"
+	"io"
+	"os"
 	"runtime"
 )
 
@@ -18,3 +21,32 @@ var (
 func GetUserAgent(component string) string {
 	return fmt.Sprintf("azure-workload-identity/%s/%s (%s/%s) %s/%s", component, BuildVersion, runtime.GOOS, runtime.GOARCH, Vcs, BuildTime)
 }
+
+// PrintVersionToStdout prints the current driver version to stdout
+func PrintVersionToStdout() error {
+	return printVersion(os.Stdout)
+}
+
+func printVersion(w io.Writer) error {
+	pv := struct {
+		BuildVersion string `json:"buildVersion"`
+		GitCommit    string `json:"gitCommit"`
+		BuildDate    string `json:"buildDate"`
+		GoVersion    string `json:"goVersion"`
+		Platform     string `json:"platform"`
+	}{
+		BuildDate:    BuildTime,
+		BuildVersion: BuildVersion,
+		GitCommit:    Vcs,
+		GoVersion:    runtime.Version(),
+		Platform:     fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
+	}
+
+	res, err := json.Marshal(pv)
+	if err != nil {
+		return err
+	}
+
+	_, err = fmt.Fprintf(w, "%s\n", res)
+	return err
+}

pkg/version/version_test.go

@@ -1,6 +1,7 @@
 package version
 
 import (
+	"bytes"
 	"fmt"
 	"runtime"
 	"strings"
@@ -18,3 +19,21 @@ func TestGetUserAgent(t *testing.T) {
 		t.Fatalf("expected: %s, got: %s", expected, actual)
 	}
 }
+
+func TestPrintVersion(t *testing.T) {
+	BuildTime = "Now"
+	BuildVersion = "version"
+	Vcs = "hash"
+
+	var buf bytes.Buffer
+	err := printVersion(&buf)
+	if err != nil {
+		t.Fatalf("PrintVersion() failed: %v", err)
+	}
+
+	out := strings.TrimSpace(buf.String())
+	expected := fmt.Sprintf(`{"buildVersion":"version","gitCommit":"hash","buildDate":"Now","goVersion":"%s","platform":"%s/%s"}`, runtime.Version(), runtime.GOOS, runtime.GOARCH)
+	if out != expected {
+		t.Fatalf("expected %q, got %q", expected, out)
+	}
+}

scripts/ci-e2e.sh

@@ -79,6 +79,9 @@ main() {
     make uninstall-deploy
     test_helm_chart
   fi
+
+  test_version_flag "webhook"
+  test_version_flag "proxy"
 }
 
 test_helm_chart() {
@@ -115,4 +118,56 @@ poll_webhook_readiness() {
   ${KUBECTL} wait --for=condition=available --timeout=5m deployment/azure-wi-webhook-controller-manager -n azure-workload-identity-system
 }
 
+test_version_flag() {
+  echo "Testing version flag for $1 image..."
+  local image_name="$1"
+  message=$(docker run --platform linux/amd64 --quiet "${REGISTRY:-mcr.microsoft.com/oss/azure/workload-identity}/${image_name}:${IMAGE_VERSION}" --version 2>&1)
+
+  # Validate that it's valid JSON
+  if ! echo "$message" | jq empty > /dev/null 2>&1; then
+    echo "Invalid JSON output: $message"
+    return 1
+  fi
+
+  # Extract and validate fields
+  build_version=$(echo "$message" | jq -r .buildVersion)
+  git_commit=$(echo "$message" | jq -r .gitCommit)
+  build_date=$(echo "$message" | jq -r .buildDate)
+  go_version=$(echo "$message" | jq -r .goVersion)
+  platform=$(echo "$message" | jq -r .platform)
+
+  if [[ -z "$build_version" || "$build_version" == "null" ]]; then
+    echo "Missing BuildVersion"
+    return 1
+  fi
+
+  if [[ "$build_version" != "$IMAGE_VERSION" ]]; then
+    echo "BuildVersion does not match IMAGE_VERSION: $build_version != $IMAGE_VERSION"
+    return 1
+  fi
+
+  if [[ -z "$git_commit" || "$git_commit" == "null" ]]; then
+    echo "Missing GitCommit"
+    return 1
+  fi
+
+  if [[ -z "$build_date" || "$build_date" == "null" ]]; then
+    echo "Missing BuildDate"
+    return 1
+  fi
+
+  if [[ -z "$go_version" || "$go_version" == "null" ]]; then
+    echo "Missing GoVersion"
+    return 1
+  fi
+
+  if [[ -z "$platform" || "$platform" == "null" ]]; then
+    echo "Missing Platform"
+    return 1
+  fi
+
+  echo "Version info looks good:"
+  echo "$message"
+}
+
 main