Makefile.ubi

# Copyright 2025 Red Hat Inc.
#
# 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.

# ==============================================================================
# OADP VM Data Protection - Multi-Platform Build System
# ==============================================================================
#
# This Makefile builds statically-linked oadp-vmdp CLI binaries for various
# platforms and architectures to support OpenShift Virtualization guest OSes.
#
# Certified/Supported Guest Operating Systems (from Red Hat KB 4234591):
#   - Linux x86_64 (amd64): RHEL, Ubuntu, CentOS, Debian, Fedora, Oracle Linux, SUSE
#   - Linux arm64: RHEL, Ubuntu, CentOS, Debian, Fedora, Oracle Linux
#   - Windows x86_64: Windows 10/11, Windows Server 2016-2025
#
# Usage:
#   make -f Makefile.ubi build-all       # Build all platform binaries
#   make -f Makefile.ubi build-linux     # Build Linux binaries only
#   make -f Makefile.ubi build-windows   # Build Windows binaries only
#   make -f Makefile.ubi container-build # Build multi-arch container image
#

# ==============================================================================
# Configuration Variables
# ==============================================================================

# Binary name
BIN ?= oadp-vmdp

# Version information (can be overridden)
VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
GIT_COMMIT ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
GIT_TREE_STATE ?= $(shell test -n "$$(git status --porcelain 2>/dev/null)" && echo "dirty" || echo "clean")
BUILD_DATE ?= $(shell date -u '+%Y-%m-%dT%H:%M:%SZ')

# Build tags (e.g., for conditional compilation)
BUILDTAGS ?=

# Output directory for built binaries
DIST_DIR ?= dist

# Container image settings
TAG ?= latest
IMAGE ?= quay.io/migtools/oadp-vmdp
IMAGE_REF := $(IMAGE):$(TAG)

# Multi-arch container platforms (Linux only for containers)
CONTAINER_PLATFORMS ?= linux/amd64,linux/arm64

# ==============================================================================
# Build Flags
# ==============================================================================

# Linker flags for version injection
LDFLAGS := -s -w \
	-X github.com/kopia/kopia/repo.BuildVersion=$(VERSION) \
	-X github.com/kopia/kopia/repo.BuildInfo=$(BUILD_DATE)-$(GIT_COMMIT) \
	-X github.com/kopia/kopia/repo.BuildGitHubRepo=github.com/openshift/oadp-vmdp

# Go build flags for static compilation
GO_BUILD_FLAGS := -trimpath -mod=mod

# Build tags if specified
ifneq ($(BUILDTAGS),)
	GO_BUILD_FLAGS += -tags="$(BUILDTAGS)"
endif

# ==============================================================================
# Platform Definitions
# ==============================================================================

# Default platforms to build
# Linux: x86_64 (amd64), arm64 - covers all certified Linux guests
# Windows: x86_64 (amd64), arm64 - covers certified Windows guests + future arm64
DEFAULT_PLATFORMS := linux-amd64 linux-arm64 windows-amd64 windows-arm64

# Platform-specific output names
linux-amd64_OUTPUT := $(DIST_DIR)/$(BIN)_linux_amd64/$(BIN)
linux-arm64_OUTPUT := $(DIST_DIR)/$(BIN)_linux_arm64/$(BIN)
windows-amd64_OUTPUT := $(DIST_DIR)/$(BIN)_windows_amd64/$(BIN).exe
windows-arm64_OUTPUT := $(DIST_DIR)/$(BIN)_windows_arm64/$(BIN).exe

# ==============================================================================
# Container Tool Detection
# ==============================================================================

CONTAINER_TOOL ?= $(shell \
	if command -v docker >/dev/null 2>&1; then echo docker; \
	elif command -v podman >/dev/null 2>&1; then echo podman; \
	else echo ""; \
	fi \
)

ifeq ($(CONTAINER_TOOL),)
  $(warning Container tool (docker/podman) not found - container targets will fail)
endif

# Host platform detection
HOST_OS := $(shell uname -s | tr '[:upper:]' '[:lower:]')
HOST_ARCH := $(shell uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')

$(info Build Configuration:)
$(info   Version: $(VERSION))
$(info   Git Commit: $(GIT_COMMIT))
$(info   Host: $(HOST_OS)/$(HOST_ARCH))
$(info   Container Tool: $(CONTAINER_TOOL))
$(info )

# ==============================================================================
# Phony Targets
# ==============================================================================

.PHONY: all help clean build-all build-linux build-windows \
	build-linux-amd64 build-linux-arm64 \
	build-windows-amd64 build-windows-arm64 \
	container-build container-build-push container-push \
	container-download-build container-download-build-push \
	verify checksums release-binaries

# ==============================================================================
# Default Target
# ==============================================================================

all: build-all

# ==============================================================================
# Help Target
# ==============================================================================

##@ General

help: ## Display this help
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make -f Makefile.ubi \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)

##@ Build Targets

# ==============================================================================
# Build All Platforms
# ==============================================================================

build-all: build-linux build-windows checksums ## Build binaries for all platforms
	@echo ""
	@echo "============================================================"
	@echo "Build complete! Binaries available in $(DIST_DIR)/"
	@echo "============================================================"
	@ls -la $(DIST_DIR)/*/

# ==============================================================================
# Linux Builds
# ==============================================================================

build-linux: build-linux-amd64 build-linux-arm64 ## Build all Linux binaries

build-linux-amd64: $(linux-amd64_OUTPUT) ## Build Linux amd64 binary
$(linux-amd64_OUTPUT):
	@echo "Building $(BIN) for linux/amd64..."
	@mkdir -p $(dir $@)
	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 \
		go build $(GO_BUILD_FLAGS) -ldflags="$(LDFLAGS)" \
		-o $@ .
	@echo "  -> $@"

build-linux-arm64: $(linux-arm64_OUTPUT) ## Build Linux arm64 binary
$(linux-arm64_OUTPUT):
	@echo "Building $(BIN) for linux/arm64..."
	@mkdir -p $(dir $@)
	CGO_ENABLED=0 GOOS=linux GOARCH=arm64 \
		go build $(GO_BUILD_FLAGS) -ldflags="$(LDFLAGS)" \
		-o $@ .
	@echo "  -> $@"

# ==============================================================================
# Windows Builds
# ==============================================================================

build-windows: build-windows-amd64 build-windows-arm64 ## Build all Windows binaries

build-windows-amd64: $(windows-amd64_OUTPUT) ## Build Windows amd64 binary
$(windows-amd64_OUTPUT):
	@echo "Building $(BIN) for windows/amd64..."
	@mkdir -p $(dir $@)
	CGO_ENABLED=0 GOOS=windows GOARCH=amd64 \
		go build $(GO_BUILD_FLAGS) -ldflags="$(LDFLAGS)" \
		-o $@ .
	@echo "  -> $@"

build-windows-arm64: $(windows-arm64_OUTPUT) ## Build Windows arm64 binary (future support)
$(windows-arm64_OUTPUT):
	@echo "Building $(BIN) for windows/arm64..."
	@mkdir -p $(dir $@)
	CGO_ENABLED=0 GOOS=windows GOARCH=arm64 \
		go build $(GO_BUILD_FLAGS) -ldflags="$(LDFLAGS)" \
		-o $@ .
	@echo "  -> $@"

# ==============================================================================
# Checksums
# ==============================================================================

checksums: ## Generate SHA256 checksums for all binaries
	@echo "Generating checksums..."
	@find $(DIST_DIR) -type f \( -name "$(BIN)" -o -name "$(BIN).exe" \) -exec sha256sum {} \; > $(DIST_DIR)/checksums.txt
	@cat $(DIST_DIR)/checksums.txt

# ==============================================================================
# Verification
# ==============================================================================

verify: ## Verify built binaries (show version info)
	@echo "Verifying built binaries..."
	@for binary in $(linux-amd64_OUTPUT) $(linux-arm64_OUTPUT); do \
		if [ -f "$$binary" ]; then \
			echo ""; \
			echo "$$binary:"; \
			file "$$binary"; \
			if [ "$(HOST_OS)" = "linux" ] && [ "$$(echo $$binary | grep -c $(HOST_ARCH))" -gt 0 ]; then \
				"$$binary" --version 2>/dev/null || true; \
			fi; \
		fi; \
	done
	@for binary in $(windows-amd64_OUTPUT) $(windows-arm64_OUTPUT); do \
		if [ -f "$$binary" ]; then \
			echo ""; \
			echo "$$binary:"; \
			file "$$binary"; \
		fi; \
	done

# ==============================================================================
# Clean
# ==============================================================================

clean: ## Remove built binaries and container images
	@echo "Cleaning build artifacts..."
	rm -rf $(DIST_DIR)/$(BIN)_*
	rm -f $(DIST_DIR)/checksums.txt
	-$(CONTAINER_TOOL) image rm -f $(IMAGE_REF) 2>/dev/null || true
	-$(CONTAINER_TOOL) image rm -f $(IMAGE):amd64-$(TAG) 2>/dev/null || true
	-$(CONTAINER_TOOL) image rm -f $(IMAGE):arm64-$(TAG) 2>/dev/null || true

##@ Container Targets

# ==============================================================================
# Container Build (Multi-arch)
# ==============================================================================

container-build: ## Build multi-arch container image locally
ifeq ($(CONTAINER_TOOL),docker)
	@echo "Building multi-arch container with Docker buildx..."
	$(CONTAINER_TOOL) buildx build \
		--platform $(CONTAINER_PLATFORMS) \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		-t $(IMAGE_REF) \
		--load \
		-f Containerfile \
		.
else ifeq ($(CONTAINER_TOOL),podman)
	@echo "Building for amd64 with Podman..."
	$(CONTAINER_TOOL) build --arch amd64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETARCH=amd64 \
		-t $(IMAGE):amd64-$(TAG) \
		-f Containerfile \
		.
	@echo ""
	@echo "Building for arm64 with Podman..."
	$(CONTAINER_TOOL) build --arch arm64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETARCH=arm64 \
		-t $(IMAGE):arm64-$(TAG) \
		-f Containerfile \
		.
else
	$(error No container tool found. Please install docker or podman.)
endif

# ==============================================================================
# Container Build and Push
# ==============================================================================

container-build-push: ## Build and push multi-arch container image
ifeq ($(CONTAINER_TOOL),docker)
	@echo "Building and pushing multi-arch container with Docker buildx..."
	$(CONTAINER_TOOL) buildx build \
		--platform $(CONTAINER_PLATFORMS) \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		-t $(IMAGE_REF) \
		--push \
		-f Containerfile \
		.
else ifeq ($(CONTAINER_TOOL),podman)
	@echo "Building and pushing for amd64 with Podman..."
	$(CONTAINER_TOOL) build --arch amd64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETARCH=amd64 \
		-t $(IMAGE):amd64-$(TAG) \
		-f Containerfile \
		.
	$(CONTAINER_TOOL) push $(IMAGE):amd64-$(TAG)
	@echo ""
	@echo "Building and pushing for arm64 with Podman..."
	$(CONTAINER_TOOL) build --arch arm64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETARCH=arm64 \
		-t $(IMAGE):arm64-$(TAG) \
		-f Containerfile \
		.
	$(CONTAINER_TOOL) push $(IMAGE):arm64-$(TAG)
	@echo ""
	@echo "Creating and pushing manifest..."
	-$(CONTAINER_TOOL) rmi -f $(IMAGE_REF) 2>/dev/null || true
	-$(CONTAINER_TOOL) manifest rm $(IMAGE_REF) 2>/dev/null || true
	$(CONTAINER_TOOL) manifest create $(IMAGE_REF) \
		$(IMAGE):amd64-$(TAG) \
		$(IMAGE):arm64-$(TAG)
	$(CONTAINER_TOOL) manifest push --all $(IMAGE_REF)
else
	$(error No container tool found. Please install docker or podman.)
endif

# ==============================================================================
# Container Push (existing images)
# ==============================================================================

container-push: ## Push existing container images
ifeq ($(CONTAINER_TOOL),podman)
	$(CONTAINER_TOOL) push $(IMAGE):amd64-$(TAG)
	$(CONTAINER_TOOL) push $(IMAGE):arm64-$(TAG)
	-$(CONTAINER_TOOL) rmi -f $(IMAGE_REF) 2>/dev/null || true
	-$(CONTAINER_TOOL) manifest rm $(IMAGE_REF) 2>/dev/null || true
	$(CONTAINER_TOOL) manifest create $(IMAGE_REF) \
		$(IMAGE):amd64-$(TAG) \
		$(IMAGE):arm64-$(TAG)
	$(CONTAINER_TOOL) manifest push --all $(IMAGE_REF)
else
	$(CONTAINER_TOOL) push $(IMAGE_REF)
endif

##@ Archive Targets

# ==============================================================================
# Create Distribution Archives
# ==============================================================================

archives: build-all ## Create tar.gz/zip archives for distribution
	@echo "Creating distribution archives..."
	@# Linux archives (tar.gz)
	@for arch in amd64 arm64; do \
		if [ -f "$(DIST_DIR)/$(BIN)_linux_$${arch}/$(BIN)" ]; then \
			echo "Creating $(BIN)-$(VERSION)-linux-$${arch}.tar.gz..."; \
			tar -czf $(DIST_DIR)/$(BIN)-$(VERSION)-linux-$${arch}.tar.gz \
				-C $(DIST_DIR)/$(BIN)_linux_$${arch} $(BIN); \
		fi; \
	done
	@# Windows archives (zip)
	@for arch in amd64 arm64; do \
		if [ -f "$(DIST_DIR)/$(BIN)_windows_$${arch}/$(BIN).exe" ]; then \
			echo "Creating $(BIN)-$(VERSION)-windows-$${arch}.zip..."; \
			(cd $(DIST_DIR)/$(BIN)_windows_$${arch} && zip -q ../$(BIN)-$(VERSION)-windows-$${arch}.zip $(BIN).exe); \
		fi; \
	done
	@echo "Archives created:"
	@ls -la $(DIST_DIR)/*.tar.gz $(DIST_DIR)/*.zip 2>/dev/null || true

# ==============================================================================
# Release Binaries (used by Containerfile.download)
# ==============================================================================

release-binaries: build-all ## Copy binaries with versioned names for the download server
	@echo "Preparing release binaries..."
	@mkdir -p $(DIST_DIR)/release
	@for arch in amd64 arm64; do \
		if [ -f "$(DIST_DIR)/$(BIN)_linux_$${arch}/$(BIN)" ]; then \
			cp $(DIST_DIR)/$(BIN)_linux_$${arch}/$(BIN) \
				$(DIST_DIR)/release/$(BIN)_$(VERSION)_linux_$${arch}; \
			echo "  -> $(BIN)_$(VERSION)_linux_$${arch}"; \
		fi; \
	done
	@for arch in amd64 arm64; do \
		if [ -f "$(DIST_DIR)/$(BIN)_windows_$${arch}/$(BIN).exe" ]; then \
			cp $(DIST_DIR)/$(BIN)_windows_$${arch}/$(BIN).exe \
				$(DIST_DIR)/release/$(BIN)_$(VERSION)_windows_$${arch}.exe; \
			echo "  -> $(BIN)_$(VERSION)_windows_$${arch}.exe"; \
		fi; \
	done
	@echo "Generating SHA256 checksums..."
	@cd $(DIST_DIR)/release && sha256sum $(BIN)_* > sha256sum.txt
	@cat $(DIST_DIR)/release/sha256sum.txt
	@echo ""
	@echo "Release binaries:"
	@ls -la $(DIST_DIR)/release/

##@ Download Server Targets

# ==============================================================================
# Download Server Container Image Settings
# ==============================================================================

DOWNLOAD_IMAGE ?= quay.io/konveyor/oadp-vmdp-binaries
DOWNLOAD_IMAGE_REF := $(DOWNLOAD_IMAGE):$(TAG)

# ==============================================================================
# Download Server Container Build
# ==============================================================================

container-download-build: ## Build download server container image
ifeq ($(CONTAINER_TOOL),docker)
	@echo "Building download server container with Docker buildx..."
	$(CONTAINER_TOOL) buildx build \
		--platform $(CONTAINER_PLATFORMS) \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		-t $(DOWNLOAD_IMAGE_REF) \
		--load \
		-f Containerfile.download \
		.
else ifeq ($(CONTAINER_TOOL),podman)
	@echo "Building download server for amd64 with Podman..."
	$(CONTAINER_TOOL) build --arch amd64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETOS=linux \
		--build-arg TARGETARCH=amd64 \
		-t $(DOWNLOAD_IMAGE):amd64-$(TAG) \
		-f Containerfile.download \
		.
	@echo ""
	@echo "Building download server for arm64 with Podman..."
	$(CONTAINER_TOOL) build --arch arm64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETOS=linux \
		--build-arg TARGETARCH=arm64 \
		-t $(DOWNLOAD_IMAGE):arm64-$(TAG) \
		-f Containerfile.download \
		.
else
	$(error No container tool found. Please install docker or podman.)
endif

container-download-build-push: ## Build and push download server container image
ifeq ($(CONTAINER_TOOL),docker)
	@echo "Building and pushing download server container with Docker buildx..."
	$(CONTAINER_TOOL) buildx build \
		--platform $(CONTAINER_PLATFORMS) \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		-t $(DOWNLOAD_IMAGE_REF) \
		--push \
		-f Containerfile.download \
		.
else ifeq ($(CONTAINER_TOOL),podman)
	@echo "Building and pushing download server for amd64 with Podman..."
	$(CONTAINER_TOOL) build --arch amd64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETOS=linux \
		--build-arg TARGETARCH=amd64 \
		-t $(DOWNLOAD_IMAGE):amd64-$(TAG) \
		-f Containerfile.download \
		.
	$(CONTAINER_TOOL) push $(DOWNLOAD_IMAGE):amd64-$(TAG)
	@echo ""
	@echo "Building and pushing download server for arm64 with Podman..."
	$(CONTAINER_TOOL) build --arch arm64 \
		--build-arg VERSION="$(VERSION)" \
		--build-arg GIT_COMMIT="$(GIT_COMMIT)" \
		--build-arg BUILD_DATE="$(BUILD_DATE)" \
		--build-arg BUILDTAGS="$(BUILDTAGS)" \
		--build-arg TARGETOS=linux \
		--build-arg TARGETARCH=arm64 \
		-t $(DOWNLOAD_IMAGE):arm64-$(TAG) \
		-f Containerfile.download \
		.
	$(CONTAINER_TOOL) push $(DOWNLOAD_IMAGE):arm64-$(TAG)
	@echo ""
	@echo "Creating and pushing download server manifest..."
	-$(CONTAINER_TOOL) rmi -f $(DOWNLOAD_IMAGE_REF) 2>/dev/null || true
	-$(CONTAINER_TOOL) manifest rm $(DOWNLOAD_IMAGE_REF) 2>/dev/null || true
	$(CONTAINER_TOOL) manifest create $(DOWNLOAD_IMAGE_REF) \
		$(DOWNLOAD_IMAGE):amd64-$(TAG) \
		$(DOWNLOAD_IMAGE):arm64-$(TAG)
	$(CONTAINER_TOOL) manifest push --all $(DOWNLOAD_IMAGE_REF)
else
	$(error No container tool found. Please install docker or podman.)
endif