From c54b9a8f5a82a2a25e6062615afa8674b578146e Mon Sep 17 00:00:00 2001
From: Lance Bragstad <lbragsta@redhat.com>
Date: Tue, 18 Oct 2022 13:20:35 -0500
Subject: [PATCH] Update Testing section in Makefile

This commit applies some conventions to the targets and documentation in
the testing section:

 - Use single spaces before help text (results in shorter lines)
 - Add documentation for prep-e2e
 - Add e2e target to the testing section
---
 Makefile | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Makefile b/Makefile
index bd2b1e986..66fc140c5 100644
--- a/Makefile
+++ b/Makefile
@@ -573,7 +573,7 @@ catalog-push: ## Push a catalog image.
 ##@ Testing
 
 .PHONY: test-unit
-test-unit: fmt ## Run the unit tests
+test-unit: fmt ## Run the unit tests locally.
 ifndef JUNITFILE
 	@$(GO) test $(TEST_OPTIONS) $(PKGS)
 else
@@ -586,7 +586,7 @@ test-coverage: fmt ## Run the unit tests and generate a coverage report
 	@$(GO) tool cover -func coverage.out
 
 .PHONY: test-benchmark
-test-benchmark: ## Run the benchmark tests -- Note that this can only be ran for one package. You can set $BENCHMARK_PKG for this. cpu.prof and mem.prof will be generated
+test-benchmark: ## Run the benchmark tests against a single package using $BENCHMARK_PKG. CPU and memory output will be in cpu.prof and mem.prof files, respectively.
 	@$(GO) test -cpuprofile cpu.prof -memprofile mem.prof -bench . $(TEST_OPTIONS) $(BENCHMARK_PKG)
 	@echo "The pprof files generated are: cpu.prof and mem.prof"
 
@@ -620,7 +620,7 @@ e2e-rosa: e2e-set-image prep-e2e ## Run tests against managed ROSA environment c
 	@$(GO) test ./tests/e2e/rosa $(E2E_GO_TEST_FLAGS) -args $(E2E_ARGS) --platform rosa | tee tests/e2e-test.log
 
 .PHONY: prep-e2e
-prep-e2e: kustomize
+prep-e2e: kustomize ## Build kustomize resources and deploy the operator.
 	rm -rf $(TEST_SETUP_DIR)
 	mkdir -p $(TEST_SETUP_DIR)
 	$(KUSTOMIZE) build config/no-ns | sed -e 's%$(DEFAULT_OPERATOR_IMAGE)%$(OPERATOR_IMAGE)%' -e 's%$(DEFAULT_CONTENT_IMAGE)%$(E2E_CONTENT_IMAGE_PATH)%' -e 's%$(DEFAULT_OPENSCAP_IMAGE)%$(OPENSCAP_IMAGE)%'  > $(TEST_DEPLOY)
@@ -636,10 +636,10 @@ e2e-set-image: kustomize
 endif
 
 .PHONY: e2e-cluster
-e2e-cluster: image-to-cluster e2e  ## Builds and pushes the operator and openscap images to the cluster registry, and starts an e2e test suite against the cluster images.
+e2e-cluster: image-to-cluster e2e ## Builds and pushes the operator and openscap images to the cluster registry, and starts an e2e test suite against the cluster images.
 
 .PHONY: image-to-cluster
-image-to-cluster: image openscap-image namespace openshift-user  ## Builds and pushes the operator and openscap images to the cluster registry.
+image-to-cluster: image openscap-image namespace openshift-user ## Builds and pushes the operator and openscap images to the cluster registry.
 	@echo "Temporarily exposing the default route to the image registry"
 	@oc patch configs.imageregistry.operator.openshift.io/cluster --patch '{"spec":{"defaultRoute":true}}' --type=merge
 	@echo "Pushing image $(OPERATOR_IMAGE) to the image registry"
@@ -654,11 +654,11 @@ image-to-cluster: image openscap-image namespace openshift-user  ## Builds and p
 	$(eval OPENSCAP_IMAGE = image-registry.openshift-image-registry.svc:5000/openshift/$(OPENSCAP_NAME):$(OPENSCAP_TAG))
 
 .PHONY: e2e-content-images
-e2e-content-images:  ## Build the e2e-content-image
+e2e-content-images: ## Build content image for end-to-end testing.
 	RUNTIME=$(RUNTIME) images/testcontent/broken-content.sh build ${E2E_BROKEN_CONTENT_IMAGE_PATH}
 
-.PHONY: push-e2e-content
-push-e2e-content: e2e-content-images  ## Build and push the e2e-content-images
+.PHONY: push-e2e-content-images
+push-e2e-content-images: e2e-content-images ##Push the content image for end-to-end testing to an image repository.
 	RUNTIME=$(RUNTIME) images/testcontent/broken-content.sh push ${E2E_BROKEN_CONTENT_IMAGE_PATH}
 
 .PHONY: must-gather-image
@@ -666,11 +666,11 @@ must-gather-image:  ## Build the must-gather image
 	$(RUNTIME) build -t $(MUST_GATHER_IMAGE_PATH):$(MUST_GATHER_IMAGE_TAG) -f images/must-gather/Dockerfile.ocp .
 
 .PHONY: must-gather-push
-must-gather-push: must-gather-image
+must-gather-push: must-gather-image ## Push the must-gather image to an image repository (default: quay.io/compliance-operator/must-gather).
 	$(RUNTIME) push $(MUST_GATHER_IMAGE_PATH):$(MUST_GATHER_IMAGE_TAG)
 
 .PHONY: must-gather
-must-gather: must-gather-image must-gather-push  ## Build and push the must-gather image
+must-gather: must-gather-image must-gather-push ## Build the must-gather image and push it to an image repository (default: quay.io/compliance-operator/must-gather).
 
 ##@ Release