Revert "rewrite operator scaffolding, metrics, and controller coverage"

This reverts commit 547f7c3.

Reason: Wrong branch, should use PR first.

Author: jm-stakater

.github/workflows/pull_request_coverage.yaml

@@ -0,0 +1,36 @@
+name: Check Coverage
+on:
+  push:
+    branches: 
+      - "master"
+  pull_request:
+    branches: 
+      - "master"
+
+jobs:
+  code_coverage:
+    name: "Code Coverage"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+    - name: Set up Go
+      uses: actions/setup-go@v6
+      with:
+        go-version: 1.25.0
+
+    - name: Verify code
+      id: verify
+      uses: stakater/.github/.github/actions/operator/verify@main
+      with:
+        ENABLE_LINTING: false
+        ENABLE_UNIT_TESTS: true
+
+    - name: Check Code Coverage
+      id: coverage
+      uses: stakater/.github/.github/actions/operator/coverage@feature/code-coverage
+      #uses: stakater/.github/.github/workflows/pull_request_coverage.yaml@feature/code-coverage
+      with:
+        TARGET_BRANCH: master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yaml

@@ -13,10 +13,10 @@ For local development and testing, you can build and push the operator image dir
 3. Add a version entry to `catalog/channels.yaml` following OLM upgrade specifications:
    ```yaml
    entries:
-   - name: expiring-secret-operator.v0.0.1
-   - name: expiring-secret-operator.v0.0.2 # This is the next version to be released
+   - name: expiring-secrets.v0.0.1
+   - name: expiring-secrets.v0.0.2 # This is the next version to be released
      skips:
-      - expiring-secret-operator.v0.0.1
+      - expiring-secrets.v0.0.1
       ```
 4. Render, build, and push the catalog index:
    ```sh
@@ -33,10 +33,10 @@ A catalog release is triggered if:
 - A new version entry is specified in `catalog/channels.yaml,` indicating the upcoming release.
   ```yaml
   entries:
-  - name: expiring-secret-operator.v0.0.1
-  - name: expiring-secret-operator.v0.0.2 # This is the next version to be released
+  - name: expiring-secrets.v0.0.1
+  - name: expiring-secrets.v0.0.2 # This is the next version to be released
     skips:
-    - expiring-secret-operator.v0.0.1
+    - expiring-secrets.v0.0.1
   ```
 
 ## Working with Entries in `catalog/channels.yaml`
@@ -61,29 +61,29 @@ Example:
 
 ```yaml
 entries:
-- name: expiring-secret-operator.v0.0.3
+- name: expiring-secrets.v0.0.3
   skips:
-   - expiring-secret-operator.v0.0.1
-   - expiring-secret-operator.v0.0.2
+   - expiring-secrets.v0.0.1
+   - expiring-secrets.v0.0.2
 ```
 #### Breaking API Changes (Use replaces)
 For breaking API changes, the replaces field is used to specify which previous version is being replaced. This indicates to OLM that the older version should be upgraded to the new version.
 Example:
 
 ```yaml
 entries:
-- name: expiring-secret-operator.v0.0.3
-  replaces: expiring-secret-operator.v0.0.1
+- name: expiring-secrets.v0.0.3
+  replaces: expiring-secrets.v0.0.1
 ```
 
 ## Contributing
 1. Add the next version entry in `catalog/channels.yaml`:
    ```yaml
    entries:
-      - name: expiring-secret-operator.v{{CURRENT}}
-      - name: expiring-secret-operator.v{{NEXT}}
+      - name: expiring-secrets.v{{CURRENT}}
+      - name: expiring-secrets.v{{NEXT}}
         skips:
-          - expiring-secret-operator.v0.0.1
+          - expiring-secrets.v0.0.1
    ```
 2. Create a PR and run tests.
 3. Merging the PR will trigger the build and push the releases.

DEPLOY.md

@@ -1,9 +1,8 @@
 VERSION ?= 0.0.1
-OPERATOR_NAME ?= expiring-secret-operator
-#OPERATOR_NAME ?= expiring-secrets
+OPERATOR_NAME ?= expiring-secrets
 PROJECT_NAME ?= expiring-secrets.stakater.com
-#vimTEST_CLUSTER_NAME ?= kind
-#DOCKER_REPO_NAME ?= expiring-secret-operator
+TEST_CLUSTER_NAME ?= kind
+DOCKER_REPO_NAME ?= expiring-secret-operator
 #SUPPRESS_OUTPUT ?= false
 
 TEST_ARGS ?= -v -test.v -ginkgo.v
@@ -14,22 +13,4 @@ TEST_ARGS ?= -v -test.v -ginkgo.v
 .PHONY: pre-commit
 pre-commit: precheck check_license fmt vet lint
 
-.PHONY: e2e
-e2e: undeploy gh-action test-e2e
-
-.PHONY: gh-action
-gh-action:
-#	@{ \
-#		$(MAKE) manifests build docker-build; \
-#		$(MAKE) bundle bundle-build; \
-#		$(MAKE) docker-build bundle-build ; \
-#		$(MAKE) catalog-render catalog-build; \
-#		$(MAKE) deploy; \
-#	};
-	@{ \
-		$(MAKE) manifests build docker-build; \
-		$(MAKE) bundle bundle-build; \
-		$(MAKE) deploy; \
-	}
-
 include Makefile.common

Makefile

@@ -272,27 +272,15 @@ common-test-e2e-dev: ## Run e2e tests locally with guaranteed cleanup even on fa
 		$(MAKE) test-e2e; \
 		exit_code=$$?; \
 		if [ $$exit_code -ne 0 ]; then \
-			$(MAKE) get-pod-logs; \
+			kubectl logs deploy/$(OPERATOR_NAME)-controller-manager -n $(OPERATOR_NS); \
 		fi; \
 		echo "Cleaning up..."; \
 		$(MAKE) post-e2e-test; \
 		exit $$exit_code; \
 	}
 
-# This target is used to print the logs of the operator's pod(s) in the test cluster,
-# which can be helpful for debugging failed e2e tests.
-.PHONY: common-get-pod-logs
-common-get-pod-logs:
-	@{ \
-	echo "$(FG_BLUE)>> $(FG_GREEN)---- Pod logs (last 50 lines, if any) ----$(RESET)"; \
-	for p in $$( $(KUBECTL) -n "$$ns" get pods -l control-plane=controller-manager -o name 2>/dev/null ); do \
-		echo "$(FG_BLUE)>> $(FG_GREEN)-- $$p --$(RESET)"; \
-		kubectl logs "$$p" -n $(OPERATOR_NS) --tail=50 2>/dev/null || true; \
-	done; \
-	}
-
 .PHONY: common-test-scorecard
-common-test-scorecard: operator-sdk cluster bundle ## Run operator-sdk scorecard tests.
+common-test-scorecard: cluster bundle ## Run operator-sdk scorecard tests.
 	@echo "$(FG_BLUE)>> $(FG_GREEN)running operator-sdk scorecard$(RESET)"
 	@failed_tests=$$($(OPERATOR_SDK) scorecard bundle \
 		-c bundle/tests/scorecard/config.yaml --output json | \
@@ -323,6 +311,7 @@ common-lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 .PHONY: common-pre-e2e-test
 common-pre-e2e-test: kustomize docker-build
 	@echo "$(FG_BLUE)>> $(FG_GREEN)Installing CRDs and deploying operator...$(RESET)"
+	$(MAKE) install
 	$(MAKE) deploy
 
 # Uninstall dependencies and undeploy operator after e2e tests.
@@ -454,16 +443,16 @@ common-docker-buildx: ## Build and push docker image for the manager for cross-p
 	rm -f "$$tmp"
 
 .PHONY: common-build-installer
-
 common-build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
 	@echo "$(FG_BLUE)>> $(FG_GREEN)building installer manifests$(RESET)"
 	mkdir -p dist
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
 	$(KUSTOMIZE) build config/default > dist/install.yaml
 
 .PHONY: common-cluster
-common-cluster: setup-cluster ## Setup Kind cluster with specified action (default: cluster). Usage: make cluster ACTION=<action>
+common-cluster: ## Setup Kind cluster with specified action (default: cluster). Usage: make cluster ACTION=<action>
 	@echo "$(FG_BLUE)>> $(FG_GREEN)setting up Kind cluster with action '$(ACTION)'$(RESET)"
+	curl -sSL https://raw.githubusercontent.com/stakater/.github/refs/heads/main/.github/scripts/setup-kind-cluster.sh | \
 	TEST_CLUSTER_NAME=$(TEST_CLUSTER_NAME) \
 	IMG=$(IMG) \
 	CONTAINER_TOOL=$(CONTAINER_TOOL) \
@@ -474,7 +463,7 @@ common-cluster: setup-cluster ## Setup Kind cluster with specified action (defau
 	PULL_SECRET_NAME=$(PULL_SECRET_NAME) \
 	GHCR_USERNAME=$(GHCR_USERNAME) \
 	GHCR_TOKEN=$(GHCR_TOKEN) \
-	bash $(SETUP_CLUSTER) $(ACTION)
+	bash -s $(ACTION)
 
 
 .PHONY: common-load-image
@@ -802,69 +791,34 @@ fi \
 }
 endef
 
-
-# fetch-script will fetch anything and make it executable, if it doesn't exist
-# $1 - url which can be called
-# $2 - local path to save the file
-define fetch-script
-{ \
-set -e; \
-if [ ! -f "$(2)" ]; then \
-	echo "$(FG_BLUE)>> $(FG_GREEN)Fetching: $(2)$(RESET)" ; \
-	curl -sSLo $(2) "$(1)" ;\
-	chmod +x $(2) ;\
-fi \
-}
-endef
-
-
-.PHONY: common-setup-cluster
-SETUP_CLUSTER ?= $(LOCALBIN)/setup-kind-cluster.sh
-common-setup-cluster: ## Download setup-cluster.sh locally if necessary.
-ifeq (,$(wildcard $(SETUP_CLUSTER)))
-ifeq (, $(shell which setup-kind-cluster.sh 2>/dev/null))
-	$(call fetch-script,https://raw.githubusercontent.com/stakater/.github/refs/heads/main/.github/scripts/setup-kind-cluster.sh,$(SETUP_CLUSTER))
-else
-SETUP_CLUSTER = $(shell which setup-kind-cluster.sh)
-endif
-endif
-
-.PHONY: common-generate-catalog-index
-# Script to generate catalog index from bundle images.
-CATALOG_INDEX_SCRIPT ?= $(LOCALBIN)/generate-catalog-index.sh
-common-generate-catalog-index: ## Download generate-catalog-index.sh locally if necessary.
-ifeq (,$(wildcard $(CATALOG_INDEX_SCRIPT)))
-ifeq (, $(shell which generate-catalog-index.sh 2>/dev/null))
-	$(call fetch-script,https://raw.githubusercontent.com/stakater/.github/refs/heads/main/.github/scripts/generate-catalog-index.sh,$(CATALOG_INDEX_SCRIPT))
-else
-CATALOG_INDEX_SCRIPT = $(shell which generate-catalog-index.sh)
-endif
-endif
-
 .PHONY: common-operator-sdk
 OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
 common-operator-sdk: ## Download operator-sdk locally if necessary.
 ifeq (,$(wildcard $(OPERATOR_SDK)))
 ifeq (, $(shell which operator-sdk 2>/dev/null))
 	@{ \
+	set -e ;\
 	mkdir -p $(dir $(OPERATOR_SDK)) ;\
 	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	$(call fetch-script,https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$${OS}_$${ARCH},$(OPERATOR_SDK))
+	curl -sSLo $(OPERATOR_SDK) https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$${OS}_$${ARCH} ;\
+	chmod +x $(OPERATOR_SDK) ;\
 	}
 else
 OPERATOR_SDK = $(shell which operator-sdk)
 endif
 endif
 
 .PHONY: common-opm
-OPM ?= $(LOCALBIN)/opm
+OPM = $(LOCALBIN)/opm
 common-opm: ## Download opm locally if necessary.
 ifeq (,$(wildcard $(OPM)))
 ifeq (,$(shell which opm 2>/dev/null))
 	@{ \
+	set -e ;\
 	mkdir -p $(dir $(OPM)) ;\
 	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	$(call fetch-script,https://github.com/operator-framework/operator-registry/releases/download/$(OPM_VERSION)/$${OS}-$${ARCH}-opm,$(OPM))
+	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/$(OPM_VERSION)/$${OS}-$${ARCH}-opm ;\
+	chmod +x $(OPM) ;\
 	}
 else
 OPM = $(shell which opm)
@@ -878,9 +832,11 @@ common-yq:
 ifeq (,$(wildcard $(YQ_BIN)))
 ifeq (,$(shell which yq 2>/dev/null))
 	@{ \
+	set -e ;\
 	mkdir -p $(dir $(YQ_BIN)) ;\
 	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	$(call fetch-script,https://github.com/mikefarah/yq/releases/download/$(YQ_VERSION)/yq_$${OS}_$${ARCH},$(YQ_BIN))
+	curl -sSLo $(YQ_BIN) https://github.com/mikefarah/yq/releases/download/$(YQ_VERSION)/yq_$${OS}-$${ARCH} ;\
+	chmod +x $(YQ_BIN) ;\
 	}
 else
 YQ_BIN = $(shell which yq)
@@ -922,23 +878,17 @@ common-bundle-push: ## Push the bundle image.
 
 # Render bundle to the catalog index.
 .PHONY: common-catalog-render
-common-catalog-render: opm yq generate-catalog-index ## Render bundle to catalog index.
+common-catalog-render: opm yq ## Render bundle to catalog index.
 	@echo "$(FG_BLUE)>> $(FG_GREEN)Rendering catalog index with bundle images$(RESET)"
-	PATH="$(LOCALBIN):$$PATH" \
-	bash -c $(CATALOG_INDEX_SCRIPT) "$(DOCKER_REPO_BASE)" "$(OPERATOR_NAME)" "$(CATALOG_DIR_PATH)" "$(VERSION)" "$(GIT_TAG)"
+	bash generate-catalog-index.sh $(DOCKER_REPO_BASE) $(OPERATOR_NAME) $(CATALOG_DIR_PATH) $(VERSION) $(GIT_TAG)
 
 # Build a catalog image by adding bundle images to an empty catalog using the operator package manager tool, 'opm'.
 # This recipe invokes 'opm' in 'semver' bundle add mode. For more information on add modes, see:
 # https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
 .PHONY: common-catalog-build
 common-catalog-build: opm ## Build a catalog image.
 	@echo "$(FG_BLUE)>> $(FG_GREEN)Building catalog image $(CATALOG_IMG) with bundles: $(BUNDLE_IMGS)$(RESET)"
-	$(OPM) index add \
-		--container-tool docker \
-		--mode semver \
-		--tag $(CATALOG_IMG) \
-		--bundles $(BUNDLE_IMGS) \
-		$(FROM_INDEX_OPT)
+	$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
 
 # Push the catalog image.
 .PHONY: common-catalog-push

Makefile.common

@@ -8,8 +8,8 @@ layout:
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}
-projectName: expiring-secret-operator
-repo: github.com/stakater/expiring-secret-operator
+projectName: expiring-secrets
+repo: github.com/stakater/expiring-secrets
 resources:
 - api:
     crdVersion: v1
@@ -18,6 +18,6 @@ resources:
   domain: stakater.com
   group: expiring-secrets
   kind: Monitor
-  path: github.com/stakater/expiring-secret-operator/api/v1alpha1
+  path: github.com/stakater/expiring-secrets/api/v1alpha1
   version: v1alpha1
 version: "3"