readme

Author: lucacome

tests/README.md

@@ -1,5 +1,38 @@
 # NGINX Gateway Fabric Testing
 
+## Overview
+
+This directory contains the tests for NGINX Gateway Fabric. The tests are divided into two categories:
+
+1. Conformance Testing. This is to ensure that the NGINX Gateway Fabric conforms to the Gateway API specification.
+2. System Testing. This is to ensure that the NGINX Gateway Fabric works as expected in a real system.
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Common steps for all tests](#common-steps-for-all-tests)
+  - [Step 1 - Create a Kubernetes cluster](#step-1---create-a-kubernetes-cluster)
+  - [Step 2 - Build and Load Images](#step-2---build-and-load-images)
+- [Conformance Testing](#conformance-testing)
+  - [Step 1 - Install NGINX Gateway Fabric to configured kind cluster](#step-1---install-nginx-gateway-fabric-to-configured-kind-cluster)
+    - [_Option 1_ Build and install NGINX Gateway Fabric from local to configured kind cluster](#option-1-build-and-install-nginx-gateway-fabric-from-local-to-configured-kind-cluster)
+    - [_Option 2_ Install NGINX Gateway Fabric from local already built image to configured kind cluster](#option-2-install-nginx-gateway-fabric-from-local-already-built-image-to-configured-kind-cluster)
+    - [_Option 3_ Install NGINX Gateway Fabric from edge to configured kind cluster](#option-3-install-nginx-gateway-fabric-from-edge-to-configured-kind-cluster)
+  - [Step 2 - Build conformance test runner image](#step-2---build-conformance-test-runner-image)
+  - [Step 3 - Run Gateway conformance tests](#step-3---run-gateway-conformance-tests)
+  - [Step 4 - Cleanup the conformance test fixtures and uninstall NGINX Gateway Fabric](#step-4---cleanup-the-conformance-test-fixtures-and-uninstall-nginx-gateway-fabric)
+  - [Step 5 - Revert changes to Go modules](#step-5---revert-changes-to-go-modules)
+  - [Step 6 - Delete kind cluster](#step-6---delete-kind-cluster)
+- [System Testing](#system-testing)
+  - [Step 1 - Run the tests](#step-1---run-the-tests)
+    - [1a - Run the functional tests locally](#1a---run-the-functional-tests-locally)
+    - [1b - Run the tests on a GKE cluster from a GCP VM](#1b---run-the-tests-on-a-gke-cluster-from-a-gcp-vm)
+      - [Functional Tests](#functional-tests)
+      - [NFR tests](#nfr-tests)
+        - [Longevity testing](#longevity-testing)
+  - [Common test amendments](#common-test-amendments)
+  - [Step 2 - Cleanup](#step-2---cleanup)
+
 ## Prerequisites
 
 - Kubernetes cluster.