Reconfigure make commands based on feedback

Author: ciarams87

conformance/Makefile

@@ -1,9 +1,13 @@
 NKG_TAG = edge
 NKG_PREFIX = nginx-kubernetes-gateway
+GATEWAY_CLASS = nginx
+SUPPORTED_FEATURES = HTTPRoute,HTTPRouteQueryParamMatching,HTTPRouteMethodMatching,HTTPRoutePortRedirect,HTTPRouteSchemeRedirect
+EXEMPT_FEATURES = ReferenceGrant
 KIND_KUBE_CONFIG_FOLDER = $${HOME}/.kube/kind
 TAG = latest
 PREFIX = conformance-test-runner
-NGINX_IMAGE=$(shell yq '.spec.template.spec.containers[1].image as $$nginx_ver | $$nginx_ver' ../deploy/manifests/deployment.yaml)
+NKG_DEPLOYMENT_MANIFEST=../deploy/manifests/deployment.yaml
+NGINX_IMAGE=$(shell yq '.spec.template.spec.containers[1].image as $$nginx_ver | $$nginx_ver' $(NKG_DEPLOYMENT_MANIFEST))
 .DEFAULT_GOAL := help
 
 .PHONY: help
@@ -19,23 +23,19 @@ create-kind-cluster: ## Create a kind cluster
 	kind create cluster --image kindest/node:v1.27.1
 	kind export kubeconfig --kubeconfig $(KIND_KUBE_CONFIG_FOLDER)/config
 
-.PHONY: prepare-nkg
-prepare-nkg: ## Build and load NKG and NGINX containers on configured kind cluster
-	cd .. && make PREFIX=$(NKG_PREFIX) TAG=$(NKG_TAG) container
-	kind load docker-image $(NKG_PREFIX):$(NKG_TAG)
+.PHONY: preload-nginx-container
+preload-nginx-container: ## Preload NGINX container on configured kind cluster
 	docker pull $(NGINX_IMAGE)
 	kind load docker-image $(NGINX_IMAGE)
-	yq -i 'with(.spec.template.spec.containers[0]; .image = "$(NKG_PREFIX):$(NKG_TAG)" | .imagePullPolicy = "Never")' ../deploy/manifests/deployment.yaml
 
-.PHONY: prepare-nkg-no-build
-prepare-nkg-no-build: ## Load NKG and NGINX containers on configured kind cluster
+.PHONY: build-and-load-images
+build-and-load-images: preload-nginx-container ## Build NKG container and load it and NGINX container on configured kind cluster
+	yq -i 'with(.spec.template.spec.containers[0]; .image = "$(NKG_PREFIX):$(NKG_TAG)" | .imagePullPolicy = "Never")' $(NKG_DEPLOYMENT_MANIFEST)
+	cd .. && make PREFIX=$(NKG_PREFIX) TAG=$(NKG_TAG) container
 	kind load docker-image $(NKG_PREFIX):$(NKG_TAG)
-	docker pull $(NGINX_IMAGE)
-	kind load docker-image $(NGINX_IMAGE)
-	yq -i 'with(.spec.template.spec.containers[0]; .image = "$(NKG_PREFIX):$(NKG_TAG)" | .imagePullPolicy = "Never")' ../deploy/manifests/deployment.yaml
 
-.PHONY: install-nkg
-install-nkg: ## Install NKG with provisioner on configured kind cluster
+.PHONY: prepare-nkg-dependencies
+prepare-nkg-dependencies: ## Install NKG dependencies on configured kind cluster
 	kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
 	kubectl wait --for=condition=available --timeout=60s deployment gateway-api-admission-server -n gateway-system 
 	kubectl apply -f ../deploy/manifests/namespace.yaml
@@ -44,20 +44,26 @@ install-nkg: ## Install NKG with provisioner on configured kind cluster
 	kubectl apply -f ../deploy/manifests/rbac.yaml
 	kubectl apply -f ../deploy/manifests/gatewayclass.yaml
 	kubectl apply -f ../deploy/manifests/service/nodeport.yaml
+
+.PHONY: install-nkg-local-build
+install-nkg-local-build: build-and-load-images prepare-nkg-dependencies ## Install NKG from local build with provisioner on configured kind cluster
 	yq '(select(di != 3))' provisioner/provisioner.yaml | kubectl apply -f -
 	yq '(select(.spec.template.spec.containers[].image) | .spec.template.spec.containers[].image="$(NKG_PREFIX):$(NKG_TAG)" | .spec.template.spec.containers[].imagePullPolicy = "Never")' provisioner/provisioner.yaml | kubectl apply -f -
 
+.PHONY: install-nkg-edge
+install-nkg-edge: preload-nginx-container prepare-nkg-dependencies ## Install NKG with provisioner from edge on configured kind cluster
+	kubectl apply -f provisioner/provisioner.yaml
+
 .PHONY: run-conformance-tests
 run-conformance-tests: ## Run conformance tests
 	kind load docker-image $(PREFIX):$(TAG)
-	yq '(select(di != 3))' tests/conformance_spec.yaml | kubectl apply -f -
-	yq '(select(.spec.containers[].image) | .spec.containers[].image="$(PREFIX):$(TAG)")' tests/conformance_spec.yaml | kubectl apply -f -
-	kubectl wait --for=condition=ready pod conformance
-	kubectl logs conformance --follow
+	kubectl apply -f tests/conformance_rbac.yaml
+	kubectl run -i conformance --image=$(PREFIX):$(TAG) --image-pull-policy=Never --restart=Never --overrides='{ "spec": { "serviceAccountName": "conformance" }  }' -- go test -v . -tags conformance -args --gateway-class=$(GATEWAY_CLASS) --debug --supported-features=$(SUPPORTED_FEATURES) --exempt-features=$(EXEMPT_FEATURES)
 
 .PHONY: cleanup-conformance-tests
 cleanup-conformance-tests: ## Clean up conformance tests fixtures
-	kubectl delete -f tests/conformance_spec.yaml
+	kubectl delete pod conformance
+	kubectl delete -f tests/conformance_rbac.yaml
 
 .PHONY: uninstall-nkg
 uninstall-nkg: ## Uninstall NKG on configured kind cluster
@@ -69,7 +75,7 @@ uninstall-nkg: ## Uninstall NKG on configured kind cluster
 
 .PHONY: undo-image-update
 undo-image-update: ## Undo the NKG image name and tag in deployment manifest
-	git checkout -- ../deploy/manifests/deployment.yaml
+	git checkout -- $(NKG_DEPLOYMENT_MANIFEST)
 
 .PHONY: delete-kind-cluster
 delete-kind-cluster: ## Delete kind cluster

conformance/README.md

@@ -5,7 +5,7 @@
 * [kind](https://kind.sigs.k8s.io/).
 * Docker.
 * Golang.
-* [yq](https://github.com/mikefarah/yq/#macos--linux-via-homebrew)
+* [yq](https://github.com/mikefarah/yq/#install)
 
 **Note**: all commands in steps below are executed from the ```conformance``` directory
 
@@ -14,63 +14,80 @@ List available commands:
 ```bash
 $ make
 
+build-and-load-images          Build NKG container and load it and NGINX container on configured kind cluster
 build-test-runner-image        Build conformance test runner image
 cleanup-conformance-tests      Clean up conformance tests fixtures
 create-kind-cluster            Create a kind cluster
 delete-kind-cluster            Delete kind cluster
 help                           Display this help
-install-nkg                    Install NKG with provisioner on configured kind cluster
-prepare-nkg-no-build           Load NKG and NGINX containers on configured kind cluster
-prepare-nkg                    Build and load NKG and NGINX containers on configured kind cluster
+install-nkg-edge               Install NKG with provisioner from edge on configured kind cluster
+install-nkg-local-build        Install NKG from local build with provisioner on configured kind cluster
+preload-nginx-container        Preload NGINX container on configured kind cluster
+prepare-nkg-dependencies       Install NKG dependencies on configured kind cluster
 run-conformance-tests          Run conformance tests
 undo-image-update              Undo the NKG image name and tag in deployment manifest
 uninstall-nkg                  Uninstall NKG on configured kind cluster
 ```
+
+**Note:** The following variables are configurable when running the below `make` commands:
+
+| Variable  | Default | Description |
+| ------------- | ------------- | ------------- |
+| TAG | latest  | The tag for the conformance test image |
+| PREFIX | conformance-test-runner | The prefix for the conformance test image |
+| NKG_TAG  | edge  | The tag for the locally built NKG image |
+| NKG_PREFIX | nginx-kubernetes-gateway  | The prefix for the locally built NKG image |
+| KIND_KUBE_CONFIG_FOLDER | ~/.kube/kind  | The location of the kubeconfig folder |
+| GATEWAY_CLASS | nginx | The gateway class that should be used for the tests |
+| SUPPORTED_FEATURES | HTTPRoute,HTTPRouteQueryParamMatching,HTTPRouteMethodMatching,HTTPRoutePortRedirect,HTTPRouteSchemeRedirect | The supported features that should be tested by the conformance tests |
+| EXEMPT_FEATURES | ReferenceGrant | The features that should not be tested by the conformance tests |
+| NGINX_IMAGE | as defined in the ../deploy/manifests/deployment.yaml file  | The NGINX image for the NKG deployments |
+| NKG_DEPLOYMENT_MANIFEST | ../deploy/manifests/deployment.yaml | The location of the NKG deployment manifest |
+
 ### Step 1 - Create a kind Cluster
 
 ```bash
 $ make create-kind-cluster
 ```
+### Step 2 - Install Nginx Kubernetes Gateway to configured kind cluster
 
-### Step 2 - Build Nginx Kubernetes Gateway container and load it and the NGINX container to configured kind cluster
+#### *Option 1* Build and install Nginx Kubernetes Gateway from local to configured kind cluster
 ```bash
-$ make NKG_PREFIX=<repo_name> NKG_TAG=<image_tag> prepare-nkg
-
+$ make install-nkg-local-build
 ```
-**Optional** Instead of the above command, you can skip the build NKG image step by running
 
-```bash
-$ make NKG_PREFIX=<repo_name> NKG_TAG=<image_tag> prepare-nkg-no-build
+#### *Option 2* Install Nginx Kubernetes Gateway from edge to configured kind cluster
+Instead of the above command, you can skip the build NKG image step and prepare the environment to instead
+use the `edge` image
 
-```
-### Step 3 - Build conformance test runner image
 ```bash
-$ make build-test-runner-image
+$ make install-nkg-edge
 ```
 
-### Step 4 - Install Nginx Kubernetes Gateway
+### Step 3 - Build conformance test runner image
 ```bash
-$ make NKG_PREFIX=<repo_name> NKG_TAG=<image_tag> install-nkg
+$ make build-test-runner-image
 ```
 
-### Step 5 - Run Gateway conformance tests
+### Step 4 - Run Gateway conformance tests
 ```bash
-$ make NKG_PREFIX=<repo_name> NKG_TAG=<image_tag> run-conformance-tests
+$ make run-conformance-tests
 ```
 
-### Step 6 - Cleanup the conformance test fixtures and uninstall Nginx Kubernetes Gateway
+### Step 5 - Cleanup the conformance test fixtures and uninstall Nginx Kubernetes Gateway
 ```bash
 $ make cleanup-conformance-tests
 $ make uninstall-nkg
 ```
 
-### Step 7 - Revert changes to the NKG deployment manifest
+### Step 6 - Revert changes to the NKG deployment manifest
+**Optional** Not required if using `edge` image
 **Warning**: `make undo-image-update` will hard reset changes to the deploy/manifests/deployment.yaml file!
 ```bash
 $ make undo-image-update
 ```
 
-### Step 8 - Delete kind cluster
+### Step 7 - Delete kind cluster
 ```bash
 $ make delete-kind-cluster
 ```

conformance/tests/Dockerfile

@@ -9,5 +9,3 @@ COPY --link go.sum /go/src/github.com/nginxinc/nginx-kubernetes-gateway/
 RUN go mod download
 
 COPY --link conformance/tests /go/src/github.com/nginxinc/nginx-kubernetes-gateway/conformance/tests/
-
-CMD go test -timeout 25m -v . -tags conformance -args --gateway-class=${GATEWAY_CLASS} --debug --supported-features=${SUPPORTED_FEATURES} --exempt-features=${EXEMPT_FEATURES}

conformance/tests/conformance_spec.yaml renamed to conformance/tests/conformance_rbac.yaml

@@ -61,22 +61,3 @@ roleRef:
   kind: ClusterRole
   name: conformance
   apiGroup: rbac.authorization.k8s.io
----
-apiVersion: v1
-kind: Pod
-metadata:
-  name: conformance
-spec:
-  containers:
-  - name: conformance
-    image: conformance-test-runner:latest
-    imagePullPolicy: Never
-    env:
-      - name: GATEWAY_CLASS
-        value: nginx
-      - name: SUPPORTED_FEATURES
-        value: HTTPRoute,HTTPRouteQueryParamMatching,HTTPRouteMethodMatching,HTTPRoutePortRedirect,HTTPRouteSchemeRedirect
-      - name: EXEMPT_FEATURES
-        value: ReferenceGrant
-  serviceAccountName: conformance
-  restartPolicy: Never

docs/developer/quickstart.md

@@ -14,6 +14,7 @@ Follow these steps to set up your development environment.
     - [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/)
     - [git](https://git-scm.com/)
     - [GNU Make](https://www.gnu.org/software/software.html)
+    - [yq](https://github.com/mikefarah/yq/#install)
     - [fieldalignment](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/fieldalignment):
 
       ```shell
@@ -92,6 +93,10 @@ make unit-test
 
 For more details on testing, see the [testing](/docs/developer/testing.md) documentation.
 
+## Gateway API Conformance Testing
+
+To run Gateway API conformance tests, please follow the instructions on [this](/conformance/README.md) page.
+
 ## Run the Linter
 
 To lint the code, run the following make command from the project's root directory:

docs/developer/testing.md

@@ -1,9 +1,9 @@
 # Testing
 
 This document provides guidelines for testing, including instructions on running the unit tests, accessing the code
-coverage report, and performing manual testing. By following these guidelines, you will gain a thorough understanding of
-the project's approach to unit testing, enabling you to ensure code quality, validate functionality, and maintain robust
-test coverage.
+coverage report, performing manual testing, and running the conformance tests. By following these guidelines, you will 
+gain a thorough understanding of the project's approach to unit testing, enabling you to ensure code quality, validate
+functionality, and maintain robust test coverage.
 
 ## Unit Test Guidelines