backplane-cli/Makefile at main · openshift/backplane-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
unexport GOFLAGS

GOOS?=linux
GOARCH?=amd64
GOENV=GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=0 GOFLAGS=

# These tags make sure we can statically link and avoid shared dependencies
GO_BUILD_FLAGS :=-tags 'include_gcs include_oss containers_image_openpgp gssapi'
GO_BUILD_FLAGS_DARWIN :=-tags 'include_gcs include_oss containers_image_openpgp'
GO_BUILD_FLAGS_LINUX_CROSS :=-tags 'include_gcs include_oss containers_image_openpgp'

# Enforce Go version for the Go toolchains.
GO_VERSION=go1.26.4+auto

GOLANGCI_LINT_VERSION=v2.12.2
GORELEASER_VERSION=v2.15.3
GOVULNCHECK_VERSION=v1.1.4

TESTOPTS ?=

# Temporary lint cache
export GOLANGCI_LINT_CACHE=/tmp

UNAME_S := $(shell uname -s)


CONTAINER_ENGINE:=$(shell command -v podman 2>/dev/null || command -v docker 2>/dev/null)
DOCKER_PRESENT := $(shell basename $$(which docker) 2>/dev/null )
ifeq ($(DOCKER_PRESENT),docker)
	DOCKER_TO_INSTALL := docker.io
endif

PODMAN_PRESENT := $(shell basename $$(which podman) 2>/dev/null  )
ifeq ($(PODMAN_PRESENT),podman)
	DOCKER_TO_INSTALL := podman
endif

ifeq ($(HOST_OS),fedora)
	DOCKER_TO_INSTALL ?= podman
	PACKAGE_MANAGER := yum
endif

RUN_IN_CONTAINER_CMD:=$(CONTAINER_ENGINE) run --platform linux/amd64 --rm -v $(shell pwd):/app -w=/app backplane-cli-builder /bin/bash -c

OUTPUT_DIR :=_output
CROSS_BUILD_BINDIR :=$(OUTPUT_DIR)/bin

build: clean
	env -u GOTOOLCHAIN GOTOOLCHAIN=$(GO_VERSION) go build -o ocm-backplane ./cmd/ocm-backplane || exit 1

build-static: clean
	env -u GOTOOLCHAIN GOTOOLCHAIN=$(GO_VERSION) go build -a -installsuffix cgo -ldflags '-extldflags "-static"' -o ocm-backplane ./cmd/ocm-backplane || exit 1

install:
	GOTOOLCHAIN=$(GO_VERSION) go install ./cmd/ocm-backplane

clean:
	rm -f ocm-backplane

test-in-container: build-image
	$(RUN_IN_CONTAINER_CMD) "make test"

# Installed using instructions from: https://golangci-lint.run/usage/install/#linux-and-windows
getlint:
	@mkdir -p $(GOPATH)/bin
	@echo "Installing golangci-lint $(GOLANGCI_LINT_VERSION)..."
	curl -sSfL https://golangci-lint.run/install.sh | sh -s -- -b $(GOPATH)/bin $(GOLANGCI_LINT_VERSION)
.PHONY: lint
lint: getlint
	$(GOPATH)/bin/golangci-lint run --timeout 5m

ensure-goreleaser:
	@command -v goreleaser >/dev/null 2>&1 || go install github.com/goreleaser/goreleaser/v2@${GORELEASER_VERSION}

release: ensure-goreleaser
	GOTOOLCHAIN=$(GO_VERSION) goreleaser release --clean

release-with-note: ensure-goreleaser
	GOTOOLCHAIN=$(GO_VERSION) goreleaser release --clean --release-notes="$(NOTE)"

test:
	env -u GOTOOLCHAIN GOTOOLCHAIN=$(GO_VERSION) go test -v $(TESTOPTS) ./...

.PHONY: coverage
coverage:
	hack/codecov.sh

cross-build-darwin-amd64:
	+@GOOS=darwin GOARCH=amd64 GOTOOLCHAIN=$(GO_VERSION) go build $(GO_BUILD_FLAGS_DARWIN) -o $(CROSS_BUILD_BINDIR)/ocm-backplane_darwin_amd64 ./cmd/ocm-backplane
.PHONY: cross-build-darwin-amd64

cross-build-linux-amd64:
	+@GOOS=linux GOARCH=amd64 GOTOOLCHAIN=$(GO_VERSION) go build $(GO_BUILD_FLAGS_LINUX_CROSS) -o $(CROSS_BUILD_BINDIR)/ocm-backplane_linux_amd64 ./cmd/ocm-backplane
.PHONY: cross-build-linux-amd64

cross-build: cross-build-darwin-amd64 cross-build-linux-amd64
.PHONY: cross-build

clean-cross-build:
	$(RM) -r '$(CROSS_BUILD_BINDIR)'
	if [ -d '$(OUTPUT_DIR)' ]; then rmdir --ignore-fail-on-non-empty '$(OUTPUT_DIR)'; fi
.PHONY: clean-cross-build

.PHONY: generate
generate:
	GOTOOLCHAIN=$(GO_VERSION) go generate ./...

.PHONY: build-image
build-image:
	$(CONTAINER_ENGINE) build --pull --platform linux/amd64 --build-arg GOLANGCI_LINT_VERSION=$(GOLANGCI_LINT_VERSION) -t backplane-cli-builder -f ./make.Dockerfile .

.PHONY: lint-in-container
lint-in-container: build-image
	$(RUN_IN_CONTAINER_CMD) "go mod download && make lint"

ensure-govulncheck:
	@ls $(GOPATH)/bin/govulncheck 1>/dev/null || go install golang.org/x/vuln/cmd/govulncheck@${GOVULNCHECK_VERSION}

scan: ensure-govulncheck
	@output=$$($(GOPATH)/bin/govulncheck ./... 2>&1); \
	echo "$$output"; \
	if echo "$$output" | grep -q "Vulnerability"; then \
		echo "Note: Detected vulnerabilities (non-blocking for now). Consider updating vulnerable Go packages to their fixed versions."; \
		exit 0; \
	fi

.PHONY: help
help:
	@echo
	@echo "================================================"
	@echo "           ocm-backplane Makefile Help           "
	@echo "================================================"
	@echo
	@echo "Targets:"
	@echo "  lint        Install/Run golangci-lint checks"
	@echo "  clean       Remove compiled binaries and build artifacts"
	@echo "  build       Compile project (set ARCH= for cross-compilation)"
	@echo "  install     Install binary system-wide (set ARCH= for architecture)"
	@echo "  test        Run unit tests"
	@echo "  cross-build Create multi-architecture binaries"
	@echo "  help        Show this help message"
	@echo
	@echo "Variables:"
	@echo "  ARCH        Target architecture (e.g., amd64, arm64 - sets GOARCH)"
	@echo "  GOOS        Target OS (default: linux)"
	@echo
	@echo "Examples:"
	@echo "  make build ARCH=arm64       # Cross-compile for ARM64"
	@echo "  make clean && make install  # Fresh install"
	@echo "  GOOS=darwin make build      # Build for macOS"
	@echo