Merge pull request #241 from cert-manager/go_build_options

Rename and add go build options and make them work for both oci-build and executable modules
cert-manager · Jan 30, 2025 · 30ff09b · 30ff09b
2 parents 4c928b4 + 7666840
commit 30ff09b
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 79 deletions.
diff --git a/modules/executable/00_mod.mk b/modules/executable/00_mod.mk
@@ -0,0 +1,79 @@
+# Copyright 2023 The cert-manager 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.
+
+exe_targets ?= darwin_amd64_v1,darwin_arm64,linux_amd64_v1,linux_arm_7,linux_arm64,linux_ppc64le,linux_s390x,windows_amd64_v1,windows_arm64
+
+# Utility functions
+fatal_if_undefined = $(if $(findstring undefined,$(origin $1)),$(error $1 is not set))
+
+# Validate globals that are required
+$(call fatal_if_undefined,bin_dir)
+$(call fatal_if_undefined,exe_build_names)
+$(call fatal_if_undefined,gorelease_file)
+
+# Set default config values
+CGO_ENABLED ?= 0
+GOEXPERIMENT ?=  # empty by default
+
+# Default variables per exe_build_names entry
+#
+# $1 - build_name
+define default_per_build_variables
+go_$1_cgo_enabled ?= $(CGO_ENABLED)
+go_$1_goexperiment ?= $(GOEXPERIMENT)
+go_$1_flags ?= -tags=
+endef
+
+$(foreach build_name,$(exe_build_names),$(eval $(call default_per_build_variables,$(build_name))))
+
+# Validate variables per exe_build_names entry
+#
+# $1 - build_name
+define check_per_build_variables
+# Validate required config exists
+$(call fatal_if_undefined,go_$1_ldflags)
+$(call fatal_if_undefined,go_$1_main_dir)
+$(call fatal_if_undefined,go_$1_mod_dir)
+
+# Validate the config required to build the golang based executable
+ifneq ($(go_$1_main_dir:.%=.),.)
+$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES start with ".")
+endif
+ifeq ($(go_$1_main_dir:%/=/),/)
+$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES NOT end with "/")
+endif
+ifeq ($(go_$1_main_dir:%.go=.go),.go)
+$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES NOT end with ".go")
+endif
+ifneq ($(go_$1_mod_dir:.%=.),.)
+$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES start with ".")
+endif
+ifeq ($(go_$1_mod_dir:%/=/),/)
+$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES NOT end with "/")
+endif
+ifeq ($(go_$1_mod_dir:%.go=.go),.go)
+$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES NOT end with ".go")
+endif
+ifeq ($(wildcard $(go_$1_mod_dir)/go.mod),)
+$$(error go_$1_mod_dir "$(go_$1_mod_dir)" does not contain a go.mod file)
+endif
+ifeq ($(wildcard $(go_$1_mod_dir)/$(go_$1_main_dir)/main.go),)
+$$(error go_$1_main_dir "$(go_$1_mod_dir)" does not contain a main.go file)
+endif
+endef
+
+$(foreach build_name,$(exe_build_names),$(eval $(call check_per_build_variables,$(build_name))))
+
+# Dryrun release
+RELEASE_DRYRUN ?= false
diff --git a/modules/executable/01_mod.mk b/modules/executable/01_mod.mk
@@ -12,64 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-exe_targets ?= darwin_amd64_v1,darwin_arm64,linux_amd64_v1,linux_arm_7,linux_arm64,linux_ppc64le,linux_s390x,windows_amd64_v1,windows_arm64
-
-ifndef bin_dir
-$(error bin_dir is not set)
-endif
-
-ifndef build_names
-ifndef exe_build_names
-$(error build_names and exe_build_names are not set)
-endif
-build_names := # empty
-endif
-
-all_exe_build_names := $(sort $(build_names) $(exe_build_names))
-
-fatal_if_undefined = $(if $(findstring undefined,$(origin $1)),$(error $1 is not set))
-
-define check_variables
-$(call fatal_if_undefined,go_$1_ldflags)
-$(call fatal_if_undefined,go_$1_main_dir)
-$(call fatal_if_undefined,go_$1_mod_dir)
-
-ifneq ($(go_$1_main_dir:.%=.),.)
-$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES start with ".")
-endif
-ifeq ($(go_$1_main_dir:%/=/),/)
-$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES NOT end with "/")
-endif
-ifeq ($(go_$1_main_dir:%.go=.go),.go)
-$$(error go_$1_main_dir "$(go_$1_main_dir)" should be a directory path that DOES NOT end with ".go")
-endif
-ifneq ($(go_$1_mod_dir:\.%=\.),.)
-$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES start with ".")
-endif
-ifeq ($(go_$1_mod_dir:%/=/),/)
-$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES NOT end with "/")
-endif
-ifeq ($(go_$1_mod_dir:%.go=.go),.go)
-$$(error go_$1_mod_dir "$(go_$1_mod_dir)" should be a directory path that DOES NOT end with ".go")
-endif
-
-endef
-
-$(foreach build_name,$(all_exe_build_names),$(eval $(call check_variables,$(build_name))))
-
-ifdef exe_build_names
-$(call fatal_if_undefined,gorelease_file)
-endif
-
-##########################################
-
-RELEASE_DRYRUN ?= false
-
-CGO_ENABLED ?= 0
-GOEXPERIMENT ?=  # empty by default
-
-run_targets := $(all_exe_build_names:%=run-%)
-build_targets := $(all_exe_build_names:%=$(bin_dir)/bin/%)
+run_targets := $(exe_build_names:%=run-%)
+build_targets := $(exe_build_names:%=$(bin_dir)/bin/%)
 
 $(bin_dir)/bin:
 	mkdir -p $@
@@ -82,9 +26,9 @@ ARGS ?= # default empty
 $(run_targets): run-%: | $(NEEDS_GO)
 	cd $(go_$*_mod_dir) && \
 	GOWORK=off \
-	CGO_ENABLED=$(CGO_ENABLED) \
-	GOEXPERIMENT=$(GOEXPERIMENT) \
-	$(GO) run \
+	CGO_ENABLED=$(go_$*_cgo_enabled) \
+	GOEXPERIMENT=$(go_$*_goexperiment) \
+	$(GO) run $(go_$*_flags) \
 		-ldflags '$(go_$*_ldflags)' \
 		$(go_$*_main_dir) $(ARGS)
 
@@ -94,24 +38,25 @@ $(run_targets): run-%: | $(NEEDS_GO)
 $(build_targets): $(bin_dir)/bin/%: FORCE | $(NEEDS_GO)
 	cd $(go_$*_mod_dir) && \
 	GOWORK=off \
-	CGO_ENABLED=$(CGO_ENABLED) \
-	GOEXPERIMENT=$(GOEXPERIMENT) \
-	$(GO) build \
+	CGO_ENABLED=$(go_$*_cgo_enabled) \
+	GOEXPERIMENT=$(go_$*_goexperiment) \
+	$(GO) build $(go_$*_flags) \
 		-ldflags '$(go_$*_ldflags)' \
 		-o $@ \
 		$(go_$*_main_dir)
 
 define template_for_target
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .binary = "$(1)")' | \
-	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .main = "$(go_$(1)_main_dir)")' | \
-	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .dir = "$(go_$(1)_mod_dir)")' | \
-	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .env[0] = "CGO_ENABLED={{.Env.CGO_ENABLED}}")' | \
-	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .env[1] = "GOEXPERIMENT={{.Env.GOEXPERIMENT}}")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .main = "$(go_$1_main_dir)")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .dir = "$(go_$1_mod_dir)")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .env[0] = "CGO_ENABLED=$(go_$1_cgo_enabled)")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .env[1] = "GOEXPERIMENT=$(go_$1_goexperiment)")' | \
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .mod_timestamp = "{{.Env.SOURCE_DATE_EPOCH}}")' | \
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .flags[0] = "-trimpath")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .flags[1] = "$(go_$1_flags)")' | \
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .ldflags[0] = "-s")' | \
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .ldflags[1] = "-w")' | \
-	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .ldflags[2] = "$(go_$(1)_ldflags)")' | \
+	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .ldflags[2] = "$(go_$1_ldflags)")' | \
 	$(YQ) 'with(.builds[]; select(.id == "$(1)") | .gobinary = "$(GO)")' | \
 	targets=$(exe_targets) $(YQ) 'with(.builds[]; select(.id == "$(1)") | .targets = (env(targets) | split(",")))' |
 endef
@@ -138,8 +83,6 @@ endif
 
 	GOWORK=off \
 	SOURCE_DATE_EPOCH=$(GITEPOCH) \
-	CGO_ENABLED=$(CGO_ENABLED) \
-	GOEXPERIMENT=$(GOEXPERIMENT) \
 	$(GORELEASER) release \
 		$(extra_args) \
 		--fail-fast \

diff --git a/modules/licenses/00_mod.mk b/modules/licenses/00_mod.mk
@@ -50,6 +50,6 @@ oci-license-layer-%: | $(bin_dir)/scratch $$(NEEDS_GO-LICENSES)
 # Add the license layer to every image
 define licences_layer_dependencies
 oci-build-$1: oci-license-layer-$1
-oci_additional_layers_$1 += $(license_layer_path_$1)
+oci_$1_additional_layers += $(license_layer_path_$1)
 endef
 $(foreach build_name,$(build_names),$(eval $(call licences_layer_dependencies,$(build_name))))
diff --git a/modules/oci-build/00_mod.mk b/modules/oci-build/00_mod.mk
@@ -24,6 +24,7 @@ base_image_csi-static := quay.io/jetstack/base-static-csi@sha256:c30595ad2eed496
 
 # Utility functions
 fatal_if_undefined = $(if $(findstring undefined,$(origin $1)),$(error $1 is not set))
+fatal_if_deprecated_defined = $(if $(findstring undefined,$(origin $1)),,$(error $1 is deprecated, use $2 instead))
 
 # Validate globals that are required
 $(call fatal_if_undefined,bin_dir)
@@ -37,9 +38,11 @@ GOEXPERIMENT ?=  # empty by default
 #
 # $1 - build_name
 define default_per_build_variables
-cgo_enabled_$1 ?= $(CGO_ENABLED)
-goexperiment_$1 ?= $(GOEXPERIMENT)
-oci_additional_layers_$1 ?= 
+go_$1_cgo_enabled ?= $(CGO_ENABLED)
+go_$1_goexperiment ?= $(GOEXPERIMENT)
+go_$1_flags ?= -tags=
+oci_$1_additional_layers ?= 
+oci_$1_linux_capabilities ?= 
 endef
 
 $(foreach build_name,$(build_names),$(eval $(call default_per_build_variables,$(build_name))))
@@ -48,6 +51,11 @@ $(foreach build_name,$(build_names),$(eval $(call default_per_build_variables,$(
 #
 # $1 - build_name
 define check_per_build_variables
+# Validate deprecated variables
+$(call fatal_if_deprecated_defined,cgo_enabled_$1,go_$1_cgo_enabled)
+$(call fatal_if_deprecated_defined,goexperiment_$1,go_$1_goexperiment)
+$(call fatal_if_deprecated_defined,oci_additional_layers_$1,oci_$1_additional_layers)
+
 # Validate required config exists
 $(call fatal_if_undefined,go_$1_ldflags)
 $(call fatal_if_undefined,go_$1_main_dir)

diff --git a/modules/oci-build/01_mod.mk b/modules/oci-build/01_mod.mk
@@ -31,11 +31,13 @@ $(ko_config_path_$1:$(CURDIR)/%=%): | $(NEEDS_YQ) $(bin_dir)/scratch/image
 		$(YQ) '.builds[0].id = "$1"' | \
 		$(YQ) '.builds[0].dir = "$(go_$1_mod_dir)"' | \
 		$(YQ) '.builds[0].main = "$(go_$1_main_dir)"' | \
-		$(YQ) '.builds[0].env[0] = "CGO_ENABLED=$(cgo_enabled_$1)"' | \
-		$(YQ) '.builds[0].env[1] = "GOEXPERIMENT=$(goexperiment_$1)"' | \
+		$(YQ) '.builds[0].env[0] = "CGO_ENABLED=$(go_$1_cgo_enabled)"' | \
+		$(YQ) '.builds[0].env[1] = "GOEXPERIMENT=$(go_$1_goexperiment)"' | \
 		$(YQ) '.builds[0].ldflags[0] = "-s"' | \
 		$(YQ) '.builds[0].ldflags[1] = "-w"' | \
-		$(YQ) '.builds[0].ldflags[2] = "{{.Env.LDFLAGS}}"' \
+		$(YQ) '.builds[0].ldflags[2] = "{{.Env.LDFLAGS}}"' | \
+		$(YQ) '.builds[0].flags[0] = "$(go_$1_flags)"' | \
+		$(YQ) '.builds[0].linux_capabilities = "$(oci_$1_linux_capabilities)"' \
 		> $(CURDIR)/$(oci_layout_path_$1).ko_config.yaml
 
 ko-config-$1: $(ko_config_path_$1:$(CURDIR)/%=%)
@@ -66,7 +68,7 @@ $(oci_build_targets): oci-build-%: ko-config-% | $(NEEDS_KO) $(NEEDS_GO) $(NEEDS
 
 	$(IMAGE_TOOL) append-layers \
 		$(CURDIR)/$(oci_layout_path_$*) \
-		$(oci_additional_layers_$*)
+		$(oci_$*_additional_layers)
 
 	$(IMAGE_TOOL) list-digests \
 		$(CURDIR)/$(oci_layout_path_$*) \