✨ Add framework for makefile (for e2e test prepation)

Makefile

@@ -11,9 +11,13 @@
 # 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.
+SHELL:=/usr/bin/env bash
+
+ROOT_DIR_RELATIVE := .
+
+include $(ROOT_DIR_RELATIVE)/common.mk
 
 # Ensure Make is run with bash shell as some syntax below is bash-specific
-SHELL:=/usr/bin/env bash
 
 .DEFAULT_GOAL:=help
 
@@ -42,6 +46,40 @@ GO_APIDIFF := $(TOOLS_DIR)/$(GO_APIDIFF_BIN)
 ENVSUBST_BIN := bin/envsubst
 ENVSUBST := $(TOOLS_DIR)/$(ENVSUBST_BIN)
 
+
+export GO111MODULE=on
+unexport GOPATH
+
+# Directories.
+ARTIFACTS ?= $(REPO_ROOT)/_artifacts
+TOOLS_DIR_DEPS := $(TOOLS_DIR)/go.sum $(TOOLS_DIR)/go.mod $(TOOLS_DIR)/Makefile
+
+REPO_ROOT := $(shell git rev-parse --show-toplevel)
+GH_REPO ?= kubernetes-sigs/cluster-api-provider-openstack
+TEST_E2E_DIR := test/e2e
+
+# Files
+E2E_DATA_DIR ?= $(REPO_ROOT)/test/e2e/data
+E2E_CONF_PATH  ?= $(E2E_DATA_DIR)/e2e_conf.yaml
+KUBETEST_CONF_PATH ?= $(abspath $(E2E_DATA_DIR)/kubetest/conformance.yaml)
+KUBETEST_FAST_CONF_PATH ?= $(abspath $(E2E_DATA_DIR)/kubetest/conformance-fast.yaml)
+
+# Binaries.
+CONTROLLER_GEN := $(TOOLS_BIN_DIR)/controller-gen
+CONVERSION_GEN := $(TOOLS_BIN_DIR)/conversion-gen
+DEFAULTER_GEN := $(TOOLS_BIN_DIR)/defaulter-gen
+ENVSUBST := $(TOOLS_BIN_DIR)/envsubst
+GINKGO := $(TOOLS_BIN_DIR)/ginkgo
+GOJQ := $(TOOLS_BIN_DIR)/gojq
+GOLANGCI_LINT := $(TOOLS_BIN_DIR)/golangci-lint
+KIND := $(TOOLS_BIN_DIR)/kind
+KUSTOMIZE := $(TOOLS_BIN_DIR)/kustomize
+MOCKGEN := $(TOOLS_BIN_DIR)/mockgen
+RELEASE_NOTES := $(TOOLS_BIN_DIR)/release-notes
+
+
+
+
 export PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
 
 # Binaries.

common.mk

@@ -0,0 +1,57 @@
+# Copyright 2020 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.
+
+include $(ROOT_DIR_RELATIVE)/versions.mk
+
+# Ensure Make is run with bash shell as some syntax below is bash-specific
+SHELL:=bash
+.ONESHELL:
+.EXPORT_ALL_VARIABLES:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --no-builtin-rules
+
+TOOLS_DIR := $(ROOT_DIR_RELATIVE)/hack/tools
+TOOLS_DIR_DEPS := $(TOOLS_DIR)/go.sum $(TOOLS_DIR)/go.mod $(TOOLS_DIR)/Makefile
+TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
+UID := $(shell id -u)
+GID := $(shell id -g)
+
+rwildcard=$(foreach d,$(wildcard $(1:=/*)),$(call rwildcard,$d,$2) $(filter $(subst *,%,$2),$d))
+
+# Hosts running SELinux need :z added to volume mounts
+SELINUX_ENABLED := $(shell cat /sys/fs/selinux/enforce 2> /dev/null || echo 0)
+
+ifeq ($(SELINUX_ENABLED),1)
+  DOCKER_VOL_OPTS?=:z
+endif
+
+.DEFAULT_GOAL:=help
+
+# Use GOPROXY environment variable if set
+GOPROXY := $(shell go env GOPROXY)
+ifeq ($(GOPROXY),)
+GOPROXY := https://proxy.golang.org
+endif
+export GOPROXY
+
+$(TOOLS_BIN_DIR)/%: $(TOOLS_DIR_DEPS)
+	make -C $(TOOLS_DIR) $(subst $(TOOLS_DIR)/,,$@)
+
+## --------------------------------------
+## Help
+## --------------------------------------
+
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

hack/tools/Makefile

@@ -0,0 +1,150 @@
+# Copyright 2021 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.
+
+ROOT_DIR_RELATIVE := ../..
+include $(ROOT_DIR_RELATIVE)/common.mk
+
+UNAME := $(shell uname -s)
+
+# Directories.
+BIN_DIR := bin
+SHARE_DIR := share
+
+OS := $(shell go env GOOS)
+RUST_TARGET := unknown-$(OS)-gnu
+
+ifeq ($(OS), darwin)
+	RUST_TARGET := apple-darwin
+	GH_ARCH_SUFFIX := macOS_amd64
+	GTAR := gtar
+endif
+
+ifeq ($(OS), linux)
+	GH_ARCH_SUFFIX := linux_amd64
+	GTAR := tar
+endif
+
+MDBOOK_EXTRACT_COMMAND := tar xfvz $(SHARE_DIR)/mdbook.tar.gz -C bin
+MDBOOK_ARCHIVE_EXT := .tar.gz
+
+ifeq ($(OS), windows)
+	RUST_TARGET := pc-windows-msvc
+	MDBOOK_ARCHIVE_EXT := .zip
+	MDBOOK_EXTRACT_COMMAND := unzip -d /tmp
+endif
+
+## --------------------------------------
+## Tooling Binaries
+## --------------------------------------
+
+$(BIN_DIR):
+	mkdir -p $@
+
+$(SHARE_DIR):
+	mkdir -p $@
+
+.PHONY: $(GTAR)
+$(GTAR):
+	@$(GTAR) --version > /dev/null || (echo Install GNU Tar with brew install gnu-tar && exit -1)
+
+
+CONTROLLER_GEN := $(BIN_DIR)/controller-gen
+$(CONTROLLER_GEN): $(BIN_DIR) go.mod go.sum # Build controller-gen from tools folder.
+	go build -tags=tools -o $@ sigs.k8s.io/controller-tools/cmd/controller-gen
+
+CONVERSION_GEN := $(BIN_DIR)/conversion-gen
+$(CONVERSION_GEN): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $@ k8s.io/code-generator/cmd/conversion-gen
+
+DEFAULTER_GEN := $(BIN_DIR)/defaulter-gen
+$(DEFAULTER_GEN): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $@ k8s.io/code-generator/cmd/defaulter-gen
+
+ENVSUBST := $(BIN_DIR)/envsubst
+$(ENVSUBST): $(BIN_DIR) go.mod go.sum # Build envsubst from tools folder.
+	go build -tags=tools -o $@ github.com/a8m/envsubst/cmd/envsubst
+
+GH_SHARE := $(SHARE_DIR)/gh
+
+$(GH_SHARE): $(SHARE_DIR)
+	mkdir -p $@
+
+$(GH_SHARE)/gh.tar.gz: $(GH_SHARE)
+	curl -L "https://github.com/cli/cli/releases/download/v$(GH_VERSION)/gh_$(GH_VERSION)_$(GH_ARCH_SUFFIX).tar.gz" -o $@
+
+GH := $(BIN_DIR)/gh
+GH: $(GTAR) $(GH_SHARE)/gh.tar.gz
+	$(GTAR) -xvf share/gh/gh.tar.gz gh_$(GH_VERSION)_$(GH_ARCH_SUFFIX)/bin/gh --strip-components 1 --directory $(BIN_DIR)
+	chmod +x $@
+	touch -m $@
+
+GINKGO := $(BIN_DIR)/ginkgo
+$(GINKGO): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $@ github.com/onsi/ginkgo/ginkgo
+
+GOJQ := $(BIN_DIR)/gojq
+$(GOJQ): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $@ github.com/itchyny/gojq/cmd/gojq
+
+GOLANGCI_LINT := $(BIN_DIR)/golangci-lint
+$(GOLANGCI_LINT): $(BIN_DIR) go.mod go.sum # Build golangci-lint from tools folder.
+	go build -tags=tools -o $@ github.com/golangci/golangci-lint/cmd/golangci-lint
+
+KIND := $(BIN_DIR)/kind
+$(KIND): $(BIN_DIR) go.mod go.sum
+	go build -tags tools -o $@ sigs.k8s.io/kind
+
+KUSTOMIZE := $(BIN_DIR)/kustomize
+$(KUSTOMIZE): $(BIN_DIR) go.mod go.sum # Build kustomize from tools folder.
+	CGO_ENABLED=0 go build -tags=tools -o $@ sigs.k8s.io/kustomize/kustomize/v4
+
+MDBOOK_SHARE := $(SHARE_DIR)/mdbook$(MDBOOK_ARCHIVE_EXT)
+$(MDBOOK_SHARE): ../../versions.mk $(SHARE_DIR)
+	curl -sL -o $(MDBOOK_SHARE) "https://github.com/rust-lang/mdBook/releases/download/$(MDBOOK_VERSION)/mdBook-$(MDBOOK_VERSION)-x86_64-$(RUST_TARGET)$(MDBOOK_ARCHIVE_EXT)"
+
+MDBOOK := $(BIN_DIR)/mdbook
+$(MDBOOK): $(BIN_DIR) $(MDBOOK_SHARE)
+	$(MDBOOK_EXTRACT_COMMAND)
+	chmod +x $@
+	touch -m $@
+
+MDBOOK_EMBED := $(BIN_DIR)/mdbook-embed
+$(MDBOOK_EMBED): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $(BIN_DIR)/mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed
+
+MDBOOK_RELEASELINK := $(BIN_DIR)/mdbook-releaselink
+$(MDBOOK_RELEASELINK): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $(BIN_DIR)/mdbook-releaselink sigs.k8s.io/cluster-api/hack/tools/mdbook/releaselink
+
+MDBOOK_TABULATE := $(BIN_DIR)/mdbook-tabulate
+$(MDBOOK_TABULATE): $(BIN_DIR) go.mod go.sum
+	go build -tags=tools -o $(BIN_DIR)/mdbook-tabulate sigs.k8s.io/cluster-api/hack/tools/mdbook/tabulate
+
+MOCKGEN := $(BIN_DIR)/mockgen
+$(MOCKGEN): $(BIN_DIR) go.mod go.sum # Build mockgen from tools folder.
+	go build -tags=tools -o $@ github.com/golang/mock/mockgen
+
+RELEASE_NOTES := $(BIN_DIR)/release-notes
+$(RELEASE_NOTES): $(BIN_DIR) go.mod go.sum
+	go build -tags tools -o $@ sigs.k8s.io/cluster-api/hack/tools/release
+
+PLANTUML := $(BIN_DIR)/plantuml-sentinal
+$(PLANTUML): plantuml.Dockerfile ../../versions.mk
+	docker build --build-arg PLANTUML_VERSION=$(PLANTUML_VERSION)  . -f plantuml.Dockerfile -t "plantuml-builder"
+	touch $@
+
+.PHONY: clean
+clean: ## Remove all tools
+	rm -rf bin
+	rm -rf share

hack/tools/go.mod

@@ -3,17 +3,18 @@ module sigs.k8s.io/cluster-api/hack/tools
 go 1.16
 
 require (
-	github.com/blang/semver v3.5.1+incompatible
-	github.com/drone/envsubst/v2 v2.0.0-20210305151453-490366e43a3c
+	github.com/drone/envsubst v1.0.3
+	github.com/go-bindata/go-bindata v3.1.2+incompatible
+	github.com/golang/mock v1.4.4
+	github.com/golangci/golangci-lint v1.41.1
 	github.com/joelanford/go-apidiff v0.1.0
+	github.com/mattn/go-isatty v0.0.13 // indirect
 	github.com/onsi/ginkgo v1.16.3
-	github.com/sergi/go-diff v1.1.0 // indirect
-	github.com/stretchr/testify v1.7.0 // indirect
-	golang.org/x/exp v0.0.0-20200331195152-e8c3332aa8e5 // indirect
-	golang.org/x/text v0.3.5 // indirect
-	golang.org/x/tools v0.1.2-0.20210512205948-8287d5da45e4
-	gotest.tools/gotestsum v1.6.3
+	github.com/raviqqe/liche v0.0.0-20201219224045-f9ba5f2c071c
+	golang.org/x/sys v0.0.0-20210601080250-7ecdf8ef093b // indirect
 	k8s.io/code-generator v0.21.1
 	sigs.k8s.io/controller-tools v0.6.0-beta.0
-	sigs.k8s.io/kubebuilder/docs/book/utils v0.0.0-20200226075303-ed8438ec10a4
-)
+	sigs.k8s.io/kind v0.11.1
+	sigs.k8s.io/kustomize/kustomize/v4 v4.2.0
+	sigs.k8s.io/testing_frameworks v0.1.2
+)