controllers: refactor and add verify checks

- This PR adds verify targets to check if go modules and manifests are up to date - It also refactor the verify targets in peerpodconfig-ctrl and add the checks to the controllers workflow Fixes: #1349 Signed-off-by: Amulyam24 <amulmek1@in.ibm.com>
confidential-containers · Aug 28, 2023 · 53ce2d7 · 53ce2d7
1 parent 7c1c322
commit 53ce2d7
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 5 deletions.
diff --git a/.github/workflows/controllers.yaml b/.github/workflows/controllers.yaml
@@ -27,10 +27,8 @@ jobs:
         uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go_version }}
-      - name: Verify go modules
-        run: make verify-modules
-      - name: Verify go generated code
-        run: make verify-gen
+      - name: Verify go modules and manifests
+        run: make verify
       - name: Build the controller manager
         run: make build
       - name: Run unit tests
@@ -58,7 +56,9 @@ jobs:
         uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go_version }}
-      - name: Verify go modules
+      - name: Verify go modules and manifests
+        run: make verify
+      - name: Build the controller manager
         run: make build
       - name: Run unit tests
         run: make test

diff --git a/peerpod-ctrl/Makefile b/peerpod-ctrl/Makefile
@@ -216,6 +216,35 @@ 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
 
+##@ Verify
+
+ALL_VERIFY_CHECKS = modules gen manifests
+
+.PHONY: verify
+verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) ## Run all verify-* targets
+
+.PHONY: verify-modules
+verify-modules: ## Verify go modules are up to date
+	go mod tidy
+	@if !(git diff --quiet HEAD -- go.sum go.mod); then \
+		git diff; \
+		echo "go module files are out of date"; exit 1; \
+	fi
+
+.PHONY: verify-gen
+verify-gen: generate ## Verfiy go generated files are up to date
+	@if !(git diff --quiet HEAD); then \
+		git diff; \
+		echo "generated files are out of date, run make generate"; exit 1; \
+	fi
+
+.PHONY: verify-manifests
+verify-manifests: manifests ## Verfiy manifests are up to date
+	@if !(git diff --quiet HEAD); then \
+		git diff; \
+		echo "generated files are out of date, run make manifests"; exit 1; \
+	fi
+
 .PHONY: bundle
 bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
 	operator-sdk generate kustomize manifests -q

diff --git a/peerpodconfig-ctrl/Makefile b/peerpodconfig-ctrl/Makefile
@@ -172,6 +172,11 @@ envtest: $(LOCAL_BIN) ## Download envtest-setup locally if necessary.
 
 ##@ Verify
 
+ALL_VERIFY_CHECKS = modules gen manifests
+
+.PHONY: verify
+verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) ## Run all verify-* targets
+
 .PHONY: verify-modules
 verify-modules: ## Verify go modules are up to date
 	go mod tidy
@@ -187,6 +192,13 @@ verify-gen: generate ## Verfiy go generated files are up to date
 		echo "generated files are out of date, run make generate"; exit 1; \
 	fi
 
+.PHONY: verify-manifests
+verify-manifests: manifests ## Verfiy manifests are up to date
+	@if !(git diff --quiet HEAD); then \
+		git diff; \
+		echo "generated files are out of date, run make manifests"; exit 1; \
+	fi
+
 .PHONY: bundle
 bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
 	operator-sdk generate kustomize manifests -q