first makefile foo

Author: chrischdi

Makefile

@@ -39,7 +39,7 @@ export GO111MODULE=on
 #
 # Kubebuilder.
 #
-export KUBEBUILDER_ENVTEST_KUBERNETES_VERSION ?= 1.28.0
+export KUBEBUILDER_ENVTEST_KUBERNETES_VERSION ?= 1.27.1
 export KUBEBUILDER_CONTROLPLANE_START_TIMEOUT ?= 60s
 export KUBEBUILDER_CONTROLPLANE_STOP_TIMEOUT ?= 60s
 
@@ -64,6 +64,7 @@ CAPD_DIR := $(TEST_DIR)/infrastructure/docker
 CAPIM_DIR := $(TEST_DIR)/infrastructure/inmemory
 TEST_EXTENSION_DIR := $(TEST_DIR)/extension
 GO_INSTALL := ./scripts/go_install.sh
+GO_TOOLS_BUILD := ./hack/go-tools-build.sh
 OBSERVABILITY_DIR := hack/observability
 
 export PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
@@ -169,6 +170,12 @@ GOVULNCHECK_VER := v1.0.0
 GOVULNCHECK := $(abspath $(TOOLS_BIN_DIR)/$(GOVULNCHECK_BIN)-$(GOVULNCHECK_VER))
 GOVULNCHECK_PKG := golang.org/x/vuln/cmd/govulncheck
 
+METRIC_GEN_VER := v2.9.2
+METRIC_GEN_BIN := metric-gen
+METRIC_GEN := $(abspath $(TOOLS_BIN_DIR)/$(METRIC_GEN_BIN)-$(METRIC_GEN_VER))
+METRIC_GEN_PKG := k8s.io/kube-state-metrics/exp/metric-gen/v2
+METRIC_GEN_MOD_REPLACE := $(METRIC_GEN_PKG)=github.com/chrischdi/kube-state-metrics/exp/metric-gen/v2@$(METRIC_GEN_VER) k8s.io/kube-state-metrics/v2=k8s.io/kube-state-metrics/v2@$(METRIC_GEN_VER)
+
 CONVERSION_VERIFIER_BIN := conversion-verifier
 CONVERSION_VERIFIER := $(abspath $(TOOLS_BIN_DIR)/$(CONVERSION_VERIFIER_BIN))
 
@@ -556,8 +563,9 @@ generate-e2e-templates-main: $(KUSTOMIZE)
 	$(KUSTOMIZE) build $(INMEMORY_TEMPLATES)/main/cluster-template --load-restrictor LoadRestrictionsNone > $(INMEMORY_TEMPLATES)/main/cluster-template.yaml
 
 .PHONY: generate-metrics-config
-generate-metrics-config: $(ENVSUBST_BIN) ## Generate ./hack/observability/kube-state-metrics/crd-config.yaml
-	OUTPUT_FILE="${OBSERVABILITY_DIR}/kube-state-metrics/crd-config.yaml"; \
+generate-metrics-config: $(METRIC_GEN) ## Generate ./hack/observability/kube-state-metrics/crd-config.yaml
+	$(METRIC_GEN) ./apis/... > "${OBSERVABILITY_DIR}/kube-state-metrics/crd-config.yaml"
+
 	METRICS_DIR="${OBSERVABILITY_DIR}/kube-state-metrics/metrics"; \
 	echo "# This file was auto-generated via: make generate-metrics-config" > "$${OUTPUT_FILE}"; \
 	cat "$${METRICS_DIR}/header.yaml" >> "$${OUTPUT_FILE}"; \
@@ -1292,6 +1300,9 @@ $(GOLANGCI_LINT_BIN): $(GOLANGCI_LINT) ## Build a local copy of golangci-lint.
 .PHONY: $(GOVULNCHECK_BIN)
 $(GOVULNCHECK_BIN): $(GOVULNCHECK) ## Build a local copy of govulncheck.
 
+.PHONY: $(METRIC_GEN_BIN)
+$(METRIC_GEN_BIN): $(METRIC_GEN) ## Build a local copy of metric-gen.
+
 $(CONTROLLER_GEN): # Build controller-gen from tools folder.
 	GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(CONTROLLER_GEN_PKG) $(CONTROLLER_GEN_BIN) $(CONTROLLER_GEN_VER)
 
@@ -1346,6 +1357,9 @@ $(GOLANGCI_LINT): # Build golangci-lint from tools folder.
 $(GOVULNCHECK): # Build govulncheck.
 	GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOVULNCHECK_PKG) $(GOVULNCHECK_BIN) $(GOVULNCHECK_VER)
 
+$(METRIC_GEN): # Build metric-gen.
+	GOBIN=$(TOOLS_BIN_DIR) GOMOD_REPLACE="$(METRIC_GEN_MOD_REPLACE)" $(GO_TOOLS_BUILD) $(METRIC_GEN_PKG) $(METRIC_GEN_BIN) $(METRIC_GEN_VER)
+
 ## --------------------------------------
 ## Helpers
 ## --------------------------------------

hack/go-tools-build.sh

@@ -0,0 +1,87 @@
+#!/usr/bin/env bash
+# Copyright 2023 The Kubernetes 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.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+set -x
+
+if [ -z "${1}" ]; then
+  echo "must provide module as first parameter"
+  exit 1
+fi
+
+if [ -z "${2}" ]; then
+  echo "must provide binary name as second parameter"
+  exit 1
+fi
+
+if [ -z "${3}" ]; then
+  echo "must provide version as third parameter"
+  exit 1
+fi
+
+if [ -z "${GOBIN}" ]; then
+  echo "GOBIN is not set. Must set GOBIN to install the bin in a specified directory."
+  exit 1
+fi
+
+GOMOD_REPLACE=${GOMOD_REPLACE:=}
+GOMOD_REQUIRE=${GOMOD_REQUIRE:=}
+
+rm -f "${GOBIN}/${2}"* || true
+
+ORIGINAL_WORKDIR="$(pwd)"
+TMP_MODULE_DIR="${2}.tmp"
+
+# Create TMP_MODULE_DIR to create a go module for building the binary.
+# This is required because CAPI's hack/tools is not compatible to `go install`.
+rm -r "${TMP_MODULE_DIR}" || true
+mkdir -p "${TMP_MODULE_DIR}"
+cd "${TMP_MODULE_DIR}"
+
+# Initialize a go module and place a tools.go file for building the binary.
+go mod init "tools"
+
+for PARAM in ${GOMOD_REPLACE}; do
+  eval go mod edit -replace ${PARAM}
+done
+for PARAM in ${GOMOD_REQUIRE}; do
+  eval go mod edit -require ${PARAM}
+done
+
+# Create go file which imports the required package and resolve dependencies.
+cat << EOF > tools.go
+//go:build tools
+// +build tools
+package tools
+
+import (
+  _ "${1}"
+)
+EOF
+
+go mod tidy
+
+# Build the binary.
+go build -tags=tools -o "${GOBIN}/${2}-${3}" "${1}"
+
+# Get back to the original directory and cleanup the temporary directory.
+cd "${ORIGINAL_WORKDIR}"
+rm -r "${TMP_MODULE_DIR}"
+
+# Link the unversioned name to the versioned binary.
+ln -sf "${GOBIN}/${2}-${3}" "${GOBIN}/${2}"