Update Makefile targets for consistency

Fixes #226

* Rename the `install` target to `kind-deploy`
* Create a new `install` target that installs CRD; corollary to `uninstall`
* Rename the `kind-cluster-cleanup` target to `kind-clean`
* Remove the `generate` target from `kind-deplpoy`
* Swap `e2e`/`test-e2e` targets
* Update help descriptions
* Add `help-extended`,
* Change e2e workflow to use test-e2e

Signed-off-by: Todd Short <[email protected]>

Author: tmshort

.github/workflows/deploy.yaml

@@ -0,0 +1,31 @@
+name: deploy-test
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+    - main
+
+jobs:
+  deploy-basic:
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-go@v4
+      with:
+        go-version-file: go.mod
+
+    - name: Run basic unit tests
+      run: |
+        make kind-cluster
+        make install
+        kubectl get crds operators.operators.operatorframework.io
+        make uninstall
+        ! kubectl get crds operators.operators.operatorframework.io
+        make deploy
+        kubectl get ns operator-controller-system
+        make undeploy
+        ! kubectl get ns operator-controller-system

.github/workflows/e2e.yaml

@@ -20,4 +20,4 @@ jobs:
 
     - name: Run e2e tests
       run: |
-        make e2e
+        make test-e2e

Makefile

@@ -45,53 +45,68 @@ all: build
 # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
 # More info on the awk command:
 # http://linuxcommand.org/lc3_adv_awk.php
+# The extended-help target uses '###' as the delineator.
 
 .PHONY: help
-help: ## Display this help.
-	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+help: ## Display essential help.
+	@awk 'BEGIN {FS = ":[^#]*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n\n"} /^[a-zA-Z_0-9-]+:[^#]*## / { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } ' $(MAKEFILE_LIST)
+
+.PHONY: help-extended
+help-extended: ## Display extended help.
+	@awk 'BEGIN {FS = ":.*###?"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*###?/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
 ##@ Development
 
 .PHONY: manifests
-manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
+manifests: controller-gen ### Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
 .PHONY: generate
-generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+generate: controller-gen ### Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
 .PHONY: fmt
-fmt: ## Run go fmt against code.
+fmt: ### Run go fmt against code.
 	go fmt ./...
 
 .PHONY: vet
-vet: ## Run go vet against code.
+vet: ### Run go vet against code.
 	go vet ./...
 
-.PHONY: test test-e2e e2e kind-load kind-cluster kind-cluster-cleanup
-test: manifests generate fmt vet test-unit e2e ## Run all tests.
+.PHONY: verify
+verify:	manifests generate fmt vet ## Verify all generated code is up-to-date
+	git diff --quiet
+
+.PHONY: test e2e test-e2e kind-load kind-cluster kind-clean kind-deploy
+test: manifests generate fmt vet test-unit test-e2e ## Run all tests.
 
 FOCUS := $(if $(TEST),-v -focus "$(TEST)")
 E2E_FLAGS ?= ""
-test-e2e: ginkgo ## Run the e2e tests
+e2e: ginkgo ### Run the e2e tests
 	$(GINKGO) --tags $(GO_BUILD_TAGS) $(E2E_FLAGS) -trace -progress $(FOCUS) test/e2e
 
 ENVTEST_VERSION = $(shell go list -m k8s.io/client-go | cut -d" " -f2 | sed 's/^v0\.\([[:digit:]]\{1,\}\)\.[[:digit:]]\{1,\}$$/1.\1.x/')
 UNIT_TEST_DIRS=$(shell go list ./... | grep -v /test/)
 test-unit: envtest ## Run the unit tests
 	eval $$($(ENVTEST) use -p env $(ENVTEST_VERSION)) && go test -tags $(GO_BUILD_TAGS) -count=1 -short $(UNIT_TEST_DIRS) -coverprofile cover.out
 
-e2e: KIND_CLUSTER_NAME=operator-controller-e2e
-e2e: run test-e2e kind-cluster-cleanup ## Run e2e test suite on local kind cluster
+test-e2e: KIND_CLUSTER_NAME=operator-controller-e2e
+test-e2e: run e2e undeploy kind-clean ## Run e2e test suite on local kind cluster
 
-kind-load: kind ## Loads the currently constructed image onto the cluster
+kind-load: kind ### Loads the currently constructed image onto the kind cluster
 	$(KIND) load docker-image $(IMG) --name $(KIND_CLUSTER_NAME)
 
-kind-cluster: kind kind-cluster-cleanup ## Standup a kind cluster
+kind-cluster: kind ### Standup a kind cluster
+	$(KIND) delete cluster --name ${KIND_CLUSTER_NAME}
 	$(KIND) create cluster --name ${KIND_CLUSTER_NAME}
 	$(KIND) export kubeconfig --name ${KIND_CLUSTER_NAME}
 
-kind-cluster-cleanup: kind ## Delete the kind cluster
+kind-deploy: export MANIFEST="./operator-controller.yaml"
+kind-deploy: kind manifests kustomize ### Install controller and dependencies onto the kind cluster
+	kubectl kustomize config/default > operator-controller.yaml
+	envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$RUKPAK_VERSION,$$MANIFEST' < scripts/install.tpl.sh | bash -s
+
+kind-clean: kind ### Delete the kind cluster
 	$(KIND) delete cluster --name ${KIND_CLUSTER_NAME}
 
 ##@ Build
@@ -101,23 +116,23 @@ BUILDDEPS = manifests generate fmt vet goreleaser
 
 .PHONY: build
 build: BUILDBIN = bin
-build: $(BUILDDEPS) ## Build manager binary using goreleaser for current GOOS and GOARCH.
+build: $(BUILDDEPS) ## Build manager binary using goreleaser for current GOOS and GOARCH. Default target.
 	$(BUILDCMD)
 
 .PHONY: build-linux
 build-linux: BUILDBIN = bin/linux
-build-linux: $(BUILDDEPS) ## Build manager binary using goreleaser for GOOS=linux and local GOARCH.
+build-linux: $(BUILDDEPS) ### Build manager binary using goreleaser for GOOS=linux and local GOARCH.
 	GOOS=linux $(BUILDCMD)
 
 .PHONY: run
-run: docker-build kind-cluster kind-load install ## Build the operator-controller then deploy it into a new kind cluster.
+run: docker-build kind-cluster kind-load kind-deploy ## Build the operator-controller then deploy it into a new kind cluster.
 
 .PHONY: wait
 wait:
 	kubectl wait --for=condition=Available --namespace=$(OPERATOR_CONTROLLER_NAMESPACE) deployment/operator-controller-controller-manager --timeout=$(WAIT_TIMEOUT)
 
 .PHONY: docker-build
-docker-build: build-linux ## Build docker image for operator-controller with GOOS=linux and local GOARCH.
+docker-build: build-linux ### Build docker image for operator-controller with GOOS=linux and local GOARCH.
 	docker build -t ${IMG} -f Dockerfile ./bin/linux
 
 ###########
@@ -129,28 +144,30 @@ export ENABLE_RELEASE_PIPELINE ?= false
 export GORELEASER_ARGS ?= --snapshot --clean
 export VERSION ?= $(shell git describe --abbrev=0 --tags)
 
-release: goreleaser ## Runs goreleaser for the operator-controller. By default, this will run only as a snapshot and will not publish any artifacts unless it is run with different arguments. To override the arguments, run with "GORELEASER_ARGS=...". When run as a github action from a tag, this target will publish a full release.
+release: goreleaser ### Runs goreleaser for the operator-controller. By default, this will run only as a snapshot and will not publish any artifacts unless it is run with different arguments. To override the arguments, run with "GORELEASER_ARGS=...". When run as a github action from a tag, this target will publish a full release.
 	$(GORELEASER) $(GORELEASER_ARGS)
 
 quickstart: export MANIFEST="https://github.com/operator-framework/operator-controller/releases/download/$(VERSION)/operator-controller.yaml"
-quickstart: kustomize generate ## Generate the installation release manifests and scripts
+quickstart: kustomize manifests ### Generate the installation release manifests and scripts with dependencies
 	kubectl kustomize config/default | sed "s/:devel/:$(VERSION)/g" > operator-controller.yaml
 	envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$RUKPAK_VERSION,$$MANIFEST' < scripts/install.tpl.sh > install.sh
 
+##############
+# Deployment #
+##############
+
 ##@ Deployment
 
 ifndef ignore-not-found
   ignore-not-found = false
 endif
 
 .PHONY: install
-install: export MANIFEST="./operator-controller.yaml"
-install: manifests kustomize generate ## Install CRDs into the K8s cluster specified in ~/.kube/config.
-	kubectl kustomize config/default > operator-controller.yaml
-	envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$RUKPAK_VERSION,$$MANIFEST' < scripts/install.tpl.sh | bash -s
+install: manifests kustomize ### Install CRDs into the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/crd | kubectl apply -f -
 
 .PHONY: uninstall
-uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
+uninstall: manifests kustomize ### Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
 	$(KUSTOMIZE) build config/crd | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
 
 .PHONY: deploy
@@ -166,6 +183,8 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 # Hack / Tools #
 ################
 
+##@ Tools
+
 ## Location to install dependencies to
 LOCALBIN ?= $(shell pwd)/hack/tools/bin
 $(LOCALBIN):
@@ -184,23 +203,23 @@ KUSTOMIZE_VERSION ?= v4.5.7
 CONTROLLER_TOOLS_VERSION ?= v0.10.0
 
 .PHONY: kind
-kind: $(KIND) ## Download kind locally if necessary.
+kind: $(KIND) ### Download kind locally if necessary.
 $(KIND): $(LOCALBIN)
 	test -s $(LOCALBIN)/kind || GOBIN=$(LOCALBIN) go install sigs.k8s.io/[email protected]
 
 .PHONY: ginkgo
-ginkgo: $(GINKGO) ## Download ginkgo locally if necessary.
+ginkgo: $(GINKGO) ### Download ginkgo locally if necessary.
 $(GINKGO): $(LOCALBIN)
 	test -s $(LOCALBIN)/ginkgo || GOBIN=$(LOCALBIN) go install github.com/onsi/ginkgo/v2/[email protected]
 
 .PHONY: goreleaser
-goreleaser: $(GORELEASER) ## Builds a local copy of goreleaser
+goreleaser: $(GORELEASER) ### Builds a local copy of goreleaser
 $(GORELEASER): $(LOCALBIN)
 	test -s $(LOCALBIN)/goreleaser || GOBIN=$(LOCALBIN) go install github.com/goreleaser/goreleaser@${GORELEASER_VERSION}
 
 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
-kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
+kustomize: $(KUSTOMIZE) ### Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
 $(KUSTOMIZE): $(LOCALBIN)
 	@if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \
 		echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \
@@ -209,12 +228,12 @@ $(KUSTOMIZE): $(LOCALBIN)
 	test -s $(LOCALBIN)/kustomize || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }
 
 .PHONY: controller-gen
-controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
+controller-gen: $(CONTROLLER_GEN) ### Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
 $(CONTROLLER_GEN): $(LOCALBIN)
 	test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \
 	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 
 .PHONY: envtest
-envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
+envtest: $(ENVTEST) ### Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest