Sync common Makefile

Makefile

@@ -100,7 +100,7 @@ build-images:
 
 # Install necessary resources into a cluster
 .PHONY: deploy
-deploy:
+deploy: create-ns
 	kubectl apply -f deploy/operator.yaml -n $(KIND_NAMESPACE)
 	kubectl apply -f deploy/crds/ -n $(KIND_NAMESPACE)
 	kubectl set env deployment/$(IMG) -n $(KIND_NAMESPACE) WATCH_NAMESPACE=$(WATCH_NAMESPACE)
@@ -126,7 +126,7 @@ lint-dependencies:
 	$(call go-get-tool,github.com/golangci/golangci-lint/cmd/[email protected])
 
 .PHONY: lint
-lint: lint-dependencies lint-all
+lint:
 
 .PHONY: fmt-dependencies
 fmt-dependencies:

README.md

@@ -73,21 +73,18 @@ Go to the [Contributing guide](CONTRIBUTING.md) to learn how to get involved!
       ```
   - Deploy controller to a cluster
 
-    The controller is deployed to a namespace defined in `KIND_NAMESPACE and monitors the namepace defined in `WATCH_NAMESPACE` for `CertificatePolicy` resources.
+    The controller is deployed to a namespace defined in `KIND_NAMESPACE` and monitors the namepace defined in `WATCH_NAMESPACE` for `CertificatePolicy` resources.
 
-    1. Create the deployment namespaces
+    1. Deploy the controller and related resources
        ```bash
-       make create-ns
+       make deploy
        ```
+
        The deployment namespaces are configurable with:
        ```bash
        export KIND_NAMESPACE=''  # (defaults to 'open-cluster-management-agent-addon')
        export WATCH_NAMESPACE=''       # (defaults to 'managed')
        ```
-    2. Deploy the controller and related resources
-       ```bash
-       make deploy
-       ```
     **NOTE:** Please be aware of the community's [deployment images](https://github.com/stolostron/community#deployment-images) special note.
 
 ### Steps for test

build/common/Makefile.common.mk

@@ -1,63 +1,164 @@
-# Copyright 2019 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.
-
-############################################################
-# GKE section
-############################################################
-PROJECT ?= oceanic-guard-191815
-ZONE    ?= us-west1-a
-CLUSTER ?= prow
-
-activate-serviceaccount:
-ifdef GOOGLE_APPLICATION_CREDENTIALS
-	gcloud auth activate-service-account --key-file="$(GOOGLE_APPLICATION_CREDENTIALS)"
+# Copyright (c) 2022 Red Hat, Inc.
+# Copyright Contributors to the Open Cluster Management project
+
+LOCAL_BIN ?= $(error LOCAL_BIN is not set.)
+ifneq ($(findstring $(LOCAL_BIN), $(PATH)), $(LOCAL_BIN))
+  $(error LOCAL_BIN is not in PATH.)
+endif
+
+# go-get-tool will 'go install' any package $1 and install it to LOCAL_BIN.
+define go-get-tool
+  @set -e ;\
+  echo "Checking installation of $(1)" ;\
+  GOBIN=$(LOCAL_BIN) go install $(1)
+endef
+
+# Handle base64 OS differences
+OS = $(shell uname -s | tr '[:upper:]' '[:lower:]')
+BASE64 = base64 -w 0
+ifeq ($(OS), darwin)
+  BASE64 = base64
 endif
 
-get-cluster-credentials: activate-serviceaccount
-	gcloud container clusters get-credentials "$(CLUSTER)" --project="$(PROJECT)" --zone="$(ZONE)"
+############################################################
+#  Work
+############################################################
+
+$(LOCAL_BIN):
+	@mkdir -p $(LOCAL_BIN)
+
+############################################################
+#  Generate manifests
+############################################################
+CONTROLLER_GEN = $(LOCAL_BIN)/controller-gen
+KUSTOMIZE = $(LOCAL_BIN)/kustomize
 
-config-docker: get-cluster-credentials
-	@build/common/scripts/config_docker.sh
+.PHONY: controller-gen
+controller-gen: ## Download controller-gen locally if necessary.
+	$(call go-get-tool,sigs.k8s.io/controller-tools/cmd/[email protected])
 
+.PHONY: kustomize
+kustomize: ## Download kustomize locally if necessary.
+	$(call go-get-tool,sigs.k8s.io/kustomize/kustomize/[email protected])
+
+############################################################
+#  Lint
+############################################################
 FINDFILES=find . \( -path ./.git -o -path ./.github -o -path ./.go \) -prune -o -type f
 XARGS = xargs -0 ${XARGS_FLAGS}
 CLEANXARGS = xargs ${XARGS_FLAGS}
 
+.PHONY: lint
+lint: lint-dependencies lint-yaml lint-go
 
-lint-dockerfiles:
-	@${FINDFILES} -name 'Dockerfile*' -print0 | ${XARGS} hadolint -c ./build/common/config/.hadolint.yml
-
-lint-scripts:
-	@${FINDFILES} -name '*.sh' -print0 | ${XARGS} shellcheck -e SC2001
+.PHONY: lint-dependencies
+lint-dependencies:
+	$(call go-get-tool,github.com/golangci/golangci-lint/cmd/[email protected])
 
+.PHONY: lint-yaml
 lint-yaml:
-	@${FINDFILES} \( -name '*.yml' -o -name '*.yaml' \) -print0 | ${XARGS} grep -L -e "{{" | ${CLEANXARGS} yamllint -c ./build/common/config/.yamllint.yml
-
-lint-copyright-banner:
-	@${FINDFILES} \( -name '*.go' -o -name '*.cc' -o -name '*.h' -o -name '*.proto' -o -name '*.py' -o -name '*.sh' \) \( ! \( -name '*.gen.go' -o -name '*.pb.go' -o -name '*_pb2.py' \) \) -print0 |\
-		${XARGS} build/common/scripts/lint_copyright_banner.sh
+	# Linting YAML 
+	@$(FINDFILES) \( -name '*.yml' -o -name '*.yaml' \) -print0 | $(XARGS) grep -L -e "{{" | $(CLEANXARGS) yamllint -c ./build/common/config/.yamllint.yml
 
+.PHONY: lint-go
 lint-go:
-	@${FINDFILES} -name '*.go' \( ! \( -name '*.gen.go' -o -name '*.pb.go' \) \) -print0 | ${XARGS} build/common/scripts/lint_go.sh
+	# Linting Golang
+	@$(FINDFILES) -name '*.go' \( ! \( -name '*.gen.go' -o -name '*.pb.go' \) \) -print0 | $(XARGS) build/common/scripts/lint_go.sh
 
-lint-markdown:
-	@${FINDFILES} -name '*.md' -print0 | ${XARGS} mdl --ignore-front-matter --style build/common/config/mdl.rb
-	@${FINDFILES} -name '*.md' -print0 | ${XARGS} awesome_bot --skip-save-results --allow_ssl --allow-timeout --allow-dupe --allow-redirect --white-list ${MARKDOWN_LINT_WHITELIST}
+.PHONY: fmt-dependencies
+fmt-dependencies:
+	$(call go-get-tool,github.com/daixiang0/[email protected])
+	$(call go-get-tool,mvdan.cc/[email protected])
 
-lint-all: lint-yaml lint-go
+.PHONY: fmt
+fmt: fmt-dependencies
+	find . -not \( -path "./.go" -prune \) -name "*.go" | xargs gofmt -s -w
+	find . -not \( -path "./.go" -prune \) -name "*.go" | xargs gofumpt -l -w
+	find . -not \( -path "./.go" -prune \) -name "*.go" | xargs gci write -s standard -s default -s "prefix($(shell cat go.mod | head -1 | cut -d " " -f 2))"
 
-format-go:
-	@${FINDFILES} -name '*.go' \( ! \( -name '*.gen.go' -o -name '*.pb.go' \) \) -print0 | ${XARGS} goimports -w -local "github.com/stolostron"
+############################################################
+#  Unit Test
+############################################################
+GOSEC = $(LOCAL_BIN)/gosec
+KUBEBUILDER = $(LOCAL_BIN)/kubebuilder
+ENVTEST = $(LOCAL_BIN)/setup-envtest
+KBVERSION = 3.12.0
+ENVTEST_K8S_VERSION = 1.26.x
+
+.PHONY: kubebuilder
+kubebuilder:
+	@if [ "$$($(KUBEBUILDER) version 2>/dev/null | grep -o KubeBuilderVersion:\"[0-9]*\.[0-9]\.[0-9]*\")" != "KubeBuilderVersion:\"$(KBVERSION)\"" ]; then \
+		echo "Installing Kubebuilder"; \
+		curl -L https://github.com/kubernetes-sigs/kubebuilder/releases/download/v$(KBVERSION)/kubebuilder_$(GOOS)_$(GOARCH) -o $(KUBEBUILDER); \
+		chmod +x $(KUBEBUILDER); \
+	fi
+
+.PHONY: envtest
+envtest:
+	$(call go-get-tool,sigs.k8s.io/controller-runtime/tools/setup-envtest@latest)
+
+.PHONY: gosec
+gosec:
+	$(call go-get-tool,github.com/securego/gosec/v2/cmd/[email protected])
 
-.PHONY: lint-dockerfiles lint-scripts lint-yaml lint-copyright-banner lint-go lint-markdown lint-all format-go config-docker
+.PHONY: gosec-scan
+gosec-scan: gosec
+	$(GOSEC) -fmt sonarqube -out gosec.json -stdout -exclude-dir=.go -exclude-dir=test ./...
+
+############################################################
+#  E2E Test
+############################################################
+GINKGO = $(LOCAL_BIN)/ginkgo
+CLUSTER_NAME ?= $(error CLUSTER_NAME is not set.)
+CONTROLLER_NAME ?= $(error CONTROLLER_NAME is not set.)
+KIND_NAME ?= test-$(CLUSTER_NAME)
+KIND_CLUSTER_NAME = kind-$(KIND_NAME)
+CONTROLLER_NAMESPACE ?= open-cluster-management-agent-addon
+KIND_VERSION ?= latest
+# Set the Kind version tag
+ifdef KIND_VERSION
+  ifeq ($(KIND_VERSION), minimum)
+    KIND_ARGS = --image kindest/node:v1.19.16
+  else ifneq ($(KIND_VERSION), latest)
+    KIND_ARGS = --image kindest/node:$(KIND_VERSION)
+  endif
+endif
+
+.PHONY: kind-create-cluster
+kind-create-cluster:
+	# Ensuring cluster $(KIND_NAME)
+	-kind create cluster --name $(KIND_NAME) $(KIND_ARGS)
+	kubectl config use-context $(KIND_CLUSTER_NAME)
+	kind get kubeconfig --name $(KIND_NAME) > kubeconfig_$(CLUSTER_NAME)_e2e
+
+.PHONY: kind-ensure-sa
+kind-ensure-sa:
+	@KUBECONFIG_TOKEN="$$(kubectl config view --raw -o jsonpath='{.users[].user.token}')"; \
+	KUBECONFIG_USER="$$(echo "$${KUBECONFIG_TOKEN}" | jq -rR 'split(".") | .[1] | select(. != null) | @base64d | fromjson | .sub')"; \
+	echo "Kubeconfig user detected from token: $${KUBECONFIG_USER}"; \
+	[ "$${KUBECONFIG_USER}" = "system:serviceaccount:$(CONTROLLER_NAMESPACE):$(CONTROLLER_NAME)" ]
+
+.PHONY: kind-controller-kubeconfig
+kind-controller-kubeconfig: install-resources
+	kubectl -n $(CONTROLLER_NAMESPACE) apply -f test/resources/e2e_controller_secret.yaml
+	-rm kubeconfig_$(CLUSTER_NAME)
+	@kubectl config set-cluster $(KIND_CLUSTER_NAME) --kubeconfig=$(PWD)/kubeconfig_$(CLUSTER_NAME) \
+		--server=$(shell kubectl config view --minify -o jsonpath='{.clusters[].cluster.server}' --kubeconfig=kubeconfig_$(CLUSTER_NAME)_e2e) \
+		--insecure-skip-tls-verify=true
+	@kubectl config set-credentials $(KIND_CLUSTER_NAME) --kubeconfig=$(PWD)/kubeconfig_$(CLUSTER_NAME) \
+		--token=$$(kubectl get secret -n $(CONTROLLER_NAMESPACE) $(CONTROLLER_NAME) -o jsonpath='{.data.token}' --kubeconfig=$(PWD)/kubeconfig_$(CLUSTER_NAME)_e2e | $(BASE64) --decode)
+	@kubectl config set-context $(KIND_CLUSTER_NAME) --kubeconfig=$(PWD)/kubeconfig_$(CLUSTER_NAME) \
+		--user=$(KIND_CLUSTER_NAME) --cluster=$(KIND_CLUSTER_NAME)
+	@kubectl config use-context $(KIND_CLUSTER_NAME) --kubeconfig=$(PWD)/kubeconfig_$(CLUSTER_NAME)
+
+.PHONY: e2e-dependencies
+e2e-dependencies:
+	$(call go-get-tool,github.com/onsi/ginkgo/v2/ginkgo@$(shell awk '/github.com\/onsi\/ginkgo\/v2/ {print $$2}' go.mod))
+
+############################################################
+#  Test coverage
+############################################################
+GOCOVMERGE = $(LOCAL_BIN)/gocovmerge
+.PHONY: coverage-dependencies
+coverage-dependencies:
+	$(call go-get-tool,github.com/wadey/[email protected])