nginxinc · vepatel · Jun 12, 2023 · Jun 5, 2023 · Jun 5, 2023 · Jun 5, 2023
diff --git a/Makefile b/Makefile
@@ -74,7 +74,7 @@ lint: ## Run golangci-lint against code
 
 .PHONY: unit-test
 unit-test: ## Run unit tests for the go code
-	go test ./... -race -coverprofile cover.out
+	go test ./... -race -coverprofile cover.out -skip TestConformance
 	go tool cover -html=cover.out -o cover.html
 
 njs-unit-test: ## Run unit tests for the njs httpmatches module

diff --git a/conformance-tests/Dockerfile b/conformance-tests/Dockerfile
@@ -0,0 +1,10 @@
+# syntax=docker/dockerfile:1.5
+
+FROM golang:1.20
+
+WORKDIR /go/src/github.com/nginxinc/nginx-kubernetes-gateway/conformance-tests
+
+COPY --link go.mod 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/
diff --git a/conformance-tests/Makefile b/conformance-tests/Makefile
@@ -0,0 +1,52 @@
+GATEWAY_CLASS = nginx
+SUPPORTED_FEATURES = Gateway,HTTPRoute
+KIND_KUBE_CONFIG_FOLDER = $${HOME}/.kube/kind
+TAG = latest
+PREFIX = conformance-test-runner
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help: Makefile ## Display this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "; printf "Usage:\n\n    make \033[36m<target>\033[0m\n\nTargets:\n\n"}; {printf "    \033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: build-test-image
+build-test-image: ## Build conformance test image
+	docker build -t $(PREFIX):$(TAG) -f Dockerfile ..
+
+.PHONY: create-kind-cluster
+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: install-nkg
+install-nkg: ## Install NKG with provisioner on configured kind cluster
+	kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.0/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
+	kubectl create configmap njs-modules --from-file=../internal/nginx/modules/src/httpmatches.js -n nginx-gateway
+	kubectl apply -f ../deploy/manifests/nginx-conf.yaml
+	kubectl apply -f ../deploy/manifests/rbac.yaml
+	kubectl apply -f ../deploy/manifests/gatewayclass.yaml
+	kubectl apply -f ../deploy/manifests/service/nodeport.yaml
+	kubectl apply -f ../conformance/provisioner/provisioner.yaml
+
+.PHONY: update-test-kind-config 
+update-test-kind-config: ## Update kind config
+	sed -ir "s|server:.*|server: https://kind-control-plane:6443|" $(KIND_KUBE_CONFIG_FOLDER)/config
+
+.PHONY: run-conformance-tests
+run-conformance-tests: update-test-kind-config ## Run conformance tests
+	docker run --network=kind --rm -v $(KIND_KUBE_CONFIG_FOLDER):/root/.kube $(PREFIX):$(TAG) \
+		go test -v . -args --gateway-class=$(GATEWAY_CLASS) --supported-features=$(SUPPORTED_FEATURES)
+
+.PHONY: uninstall-nkg
+uninstall-nkg: ## Uninstall NKG on configured kind cluster
+	kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.0/standard-install.yaml
+	kubectl delete -f ../deploy/manifests/rbac.yaml
+	kubectl delete -f ../deploy/manifests/namespace.yaml
+	kubectl delete clusterrole nginx-gateway-provisioner
+	kubectl delete clusterrolebinding nginx-gateway-provisioner
+
+.PHONY: delete-kind-cluster
+delete-kind-cluster: ## Delete kind cluster
+	kind delete cluster
diff --git a/conformance-tests/README.md b/conformance-tests/README.md
@@ -0,0 +1,54 @@
+# Running [Gateway Conformance Tests](https://gateway-api.sigs.k8s.io/concepts/conformance/#3-conformance-tests) in kind
+
+## Prerequisites:
+
+* [kind](https://kind.sigs.k8s.io/).
+* Docker.
+* Golang.
+
+**Note**: all commands in steps below are executed from the ```conformance-tests``` directory
+
+List available commands:
+
+```bash
+$ make
+
+build-test-image               Build conformance test image
+create-kind-cluster            Create a kind cluster
+delete-kind-cluster            Delete kind cluster
+help                           Display this help
+install-nkg                    Install NKG on configured kind cluster
+run-conformance-tests          Run conformance tests
+uninstall-nkg                  Uninstall NKG from configured kind cluster
+update-test-kind-config        Update kind config
+```
+### Step 1 - Create a kind Cluster
+
+```bash
+$ make create-kind-cluster
+```
+
+### Step 2 - Build conformance test image
+```bash
+$ make build-test-image
+```
+
+### Step 3 - Install Nginx Kubernetes Gateway
+```bash
+$ make install-nkg
+```
+
+### Step 4 - Run Gateway conformance tests
+```bash
+$ make run-conformance-tests
+```
+
+### Step 5 - Uninstall Nginx Kubernetes Gateway
+```bash
+$ make uninstall-nkg
+```
+
+### Step 6 - Delete kind cluster
+```bash
+$ make delete-kind-cluster
+```
diff --git a/conformance-tests/conformance_test.go b/conformance-tests/conformance_test.go
@@ -0,0 +1,58 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tests
+
+import (
+	"testing"
+
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/client/config"
+	"sigs.k8s.io/gateway-api/apis/v1alpha2"
+	"sigs.k8s.io/gateway-api/apis/v1beta1"
+	"sigs.k8s.io/gateway-api/conformance/tests"
+	"sigs.k8s.io/gateway-api/conformance/utils/flags"
+	"sigs.k8s.io/gateway-api/conformance/utils/suite"
+)
+
+func TestConformance(t *testing.T) {
+	cfg, err := config.GetConfig()
+	if err != nil {
+		t.Fatalf("Error loading Kubernetes config: %v", err)
+	}
+	client, err := client.New(cfg, client.Options{})
+	if err != nil {
+		t.Fatalf("Error initializing Kubernetes client: %v", err)
+	}
+	_ = v1alpha2.AddToScheme(client.Scheme())
+	_ = v1beta1.AddToScheme(client.Scheme())
+
+	t.Logf(`Running conformance tests with %s GatewayClass\n cleanup: %t\n`+
+		`debug: %t\n enable all features: %t \n supported features: [%v]\n exempt features: [%v]`,
+		*flags.GatewayClassName, *flags.CleanupBaseResources, *flags.ShowDebug,
+		*flags.EnableAllSupportedFeatures, *flags.SupportedFeatures, *flags.ExemptFeatures)
+
+	cSuite := suite.New(suite.Options{
+		Client:                     client,
+		GatewayClassName:           *flags.GatewayClassName,
+		Debug:                      *flags.ShowDebug,
+		CleanupBaseResources:       *flags.CleanupBaseResources,
+		SupportedFeatures:          nil,
+		EnableAllSupportedFeatures: *flags.EnableAllSupportedFeatures,
+	})
+	cSuite.Setup(t)
+	cSuite.Run(t, tests.ConformanceTests)
+}
@@ -83,10 +83,16 @@ Follow the steps below for manual testing:
    - NGINX proxies traffic successfully (when applicable). 
    - [Examples](/examples) work correctly. This will ensure that your changes have not introduced any regressions.
 
-
 > **Note**
 >  
 > Don't limit yourself to happy path testing. Make an effort to cover various scenarios, including edge cases and potential error conditions. By testing a wide range of scenarios, you can uncover hidden issues and ensure the robustness of your changes.
 
 Performing manual testing helps guarantee the stability, reliability, and effectiveness of your changes before
 submitting them for review and integration into the project.
+
+
+## Gateway API Conformance Testing
+
+To run Gateway API conformance tests, please follow the instructions on [this](/conformance-tests/README.md) page.
+
+
@@ -42,15 +42,18 @@ require (
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
+	github.com/moby/spdystream v0.2.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.15.1 // indirect
 	github.com/prometheus/client_model v0.4.0 // indirect
 	github.com/prometheus/common v0.42.0 // indirect
 	github.com/prometheus/procfs v0.9.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/stretchr/testify v1.8.2 // indirect
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/multierr v1.7.0 // indirect
 	go.uber.org/zap v1.24.0 // indirect

@@ -1,5 +1,6 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
 github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
@@ -75,6 +76,7 @@ github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1 h1:K6RDEckDVWvDI9JAJY
 github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=
 github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
@@ -101,6 +103,8 @@ github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zk
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
 github.com/maxbrunsfeld/counterfeiter/v6 v6.6.1 h1:9XE5ykDiC8eNSqIPkxx0EsV3kMX1oe4kQWRZjIgytUA=
 github.com/maxbrunsfeld/counterfeiter/v6 v6.6.1/go.mod h1:qbKwBR+qQODzH2WD/s53mdgp/xVcXMlJb59GRFOp6Z4=
+github.com/moby/spdystream v0.2.0 h1:cjW1zVyyoiM0T7b6UoySUFqzXMoqRckQtXwGPiBhOM8=
+github.com/moby/spdystream v0.2.0/go.mod h1:f7i0iNDQJ059oMTcWxx8MA/zKFIuD/lY+0GqbN2Wy8c=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
@@ -145,6 +149,7 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=