Fix typos, update docs, and remove image builds unless plus

ciarams87 · ciarams87 · commit 37c7ea431735 · 2024-03-05T09:07:55.000Z
diff --git a/.github/workflows/nfr.yml b/.github/workflows/nfr.yml
@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       test_label:
-        description: NFR test to run. Choose between performance, upgrade or all.
+        description: NFR test to run. Choose between performance, upgrade, or all
         required: true
         default: all
         type: choice
@@ -13,7 +13,11 @@ on:
         description: Version of NGF under test
         required: true
         default: edge
-      nginx-plus:
+      image_tag:
+        description: Tag of the NGF and NGINX Docker images
+        required: true
+        default: edge
+      nginx_plus:
         description: Run tests with NGINX Plus
         required: false
         default: false
@@ -51,31 +55,18 @@ jobs:
       run: echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
 
     - name: Docker Buildx
+      if: ${{ inputs.nginx_plus == true }}
       uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
 
-    - name: NGF Docker meta
-      id: ngf-meta
-      uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
-      with:
-        images: |
-          name=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric
-        tags: |
-          type=raw,value=${{ inputs.version }}-${{ github.run_id }}
-
     - name: NGINX Docker meta
       id: nginx-meta
+      if: ${{ inputs.nginx_plus == true }}
       uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
       with:
         images: |
-          name=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric/${{ inputs.nginx-plus == true && 'nginx-plus' || 'nginx' }}
+          name=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric/nginx-plus
         tags: |
-          type=raw,value=${{ inputs.version }}-${{ github.run_id }}
-
-    - name: Build binary
-      uses: goreleaser/goreleaser-action@7ec5c2b0c6cdda6e8bbb49444bc797dd33d74dd8 # v5.0.0
-      with:
-        version: latest
-        args: build --snapshot --clean
+          type=raw,value=${{ inputs.image_tag }}
 
     - name: Authenticate to Google Cloud
       id: auth
@@ -92,24 +83,14 @@ jobs:
         install_components: kubectl
 
     - name: Login to GCR
+      if: ${{ inputs.nginx_plus == true }}
       run: gcloud auth configure-docker gcr.io -q
 
-    - name: Build NGF Docker Image
-      uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5.1.0
-      with:
-        file: build/Dockerfile
-        tags: ${{ steps.ngf-meta.outputs.tags }}
-        context: "."
-        provenance: false
-        platforms: linux/amd64
-        target: goreleaser
-        pull: true
-        push: true
-
-    - name: Build NGINX Docker Image
+    - name: Build NGINX Plus Docker Image
+      if: ${{ inputs.nginx_plus == true }}
       uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5.1.0
       with:
-        file: build/Dockerfile${{ inputs.nginx-plus == true && '.nginxplus' || '.nginx'}}
+        file: build/Dockerfile.nginxplus
         tags: ${{ steps.nginx-meta.outputs.tags }}
         context: "."
         platforms: linux/amd64
@@ -121,16 +102,16 @@ jobs:
           NGINX_CONF_DIR=internal/mode/static/nginx/conf
           BUILD_AGENT=gha
         secrets: |
-          ${{ inputs.nginx-plus == true && format('"nginx-repo.crt={0}"', secrets.NGINX_CRT) || '' }}
-          ${{ inputs.nginx-plus == true && format('"nginx-repo.key={0}"', secrets.NGINX_KEY) || '' }}
+          ${{ format('"nginx-repo.crt={0}"', secrets.NGINX_CRT) }}
+          ${{ format('"nginx-repo.key={0}"', secrets.NGINX_KEY) }}
 
     - name: Setup dotenv file
       working-directory: ./tests/scripts
       run: |
         echo "RESOURCE_NAME=nfr-tests-${{ github.run_id }}" >> vars.env
-        echo "TAG=${{ inputs.version }}-${{ github.run_id }}" >> vars.env
-        echo "PREFIX=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric" >> vars.env
-        echo "NGINX_PREFIX=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric/nginx" >> vars.env
+        echo "TAG=${{ inputs.image_tag }}" >> vars.env
+        echo "PREFIX=ghcr.io/nginxinc/nginx-gateway-fabric" >> vars.env
+        echo "NGINX_PREFIX=ghcr.io/nginxinc/nginx-gateway-fabric/nginx" >> vars.env
         echo "NGINX_PLUS_PREFIX=gcr.io/${{ secrets.GCP_PROJECT_ID }}/ngf-nfr/nginx-gateway-fabric/nginx-plus" >> vars.env
         echo "GKE_CLUSTER_NAME=nfr-tests-${{ github.run_id }}" >> vars.env
         echo "GKE_CLUSTER_ZONE=us-east1-b" >> vars.env
@@ -144,15 +125,16 @@ jobs:
         echo "NGF_BRANCH=${{ github.ref_name }}" >> vars.env
         echo "SOURCE_IP_RANGE=$(curl -sS -4 icanhazip.com)/32" >> vars.env
         echo "ADD_VM_IP_AUTH_NETWORKS=true" >> vars.env
-        echo "PLUS_ENABLED=${{ inputs.nginx-plus }}" >> vars.env
+        echo "PLUS_ENABLED=${{ inputs.nginx_plus }}" >> vars.env
         echo "GINKGO_LABEL=" >> vars.env
+        echo "NGF_VERSION=${{ inputs.version }}" >> vars.env
 
     - name: Create GKE cluster
       working-directory: ./tests
       run:
         make create-gke-cluster
 
-    - name: Setup VM and router
+    - name: Create and setup VM
       working-directory: ./tests
       run:
         make create-and-setup-vm
@@ -185,6 +167,9 @@ jobs:
         body: |
           Update with NFR test results for NGF version ${{ inputs.version }}
           - Auto-generated by the NFR tests workflow run ${{ github.run_id }}
+          - Tests ran using Docker image tag ${{ inputs.image_tag }}
+          - ${{ inputs.test_label }} test(s) ran
+          - NGINX Plus enabled: ${{ inputs.nginx_plus }}
         labels: |
           tests
         assignees: ${{ github.actor }}
diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md
@@ -28,7 +28,9 @@ To create a new release, follow these steps:
    format `Release X.Y.Z`.
 2. Stop merging any new work into the main branch.
 3. Test the main branch for release-readiness. For that, use the `edge` containers, which are built from the main
-   branch, and the [example applications](/examples).
+   branch, and run the following:
+   1. Run the [example applications](/examples) manually and verify their correctness.
+   2. Kick off the [NFR workflow](https://github.com./nginxinc/nginx-gateway-fabric/actions/nfr.yml) in the browser. For `image_tag`, use `edge`, and for  `version`, use the upcoming `X.Y.Z` NGF version. This will run all of the NFR tests which are automated and open a PR with the results files when it is complete. Review this PR and make any necessary changes before merging.
 4. If a problem is found, prepare a fix PR, merge it into the main branch and return to the previous step.
 5. If the supported Gateway API minor version has changed since the last release, test NGINX Gateway Fabric with the previous version of the Gateway API CRDs.
 6. If a compatibility issue is found, add a note to the release notes explaining that the previous version is not supported.
diff --git a/tests/Makefile b/tests/Makefile
@@ -11,6 +11,7 @@ GW_SERVICE_TYPE=NodePort
 GW_SVC_GKE_INTERNAL=false
 GINKGO_LABEL=
 GINKGO_FLAGS=
+NGF_VERSION=
 
 ifneq ($(GINKGO_LABEL),)
     override GINKGO_FLAGS += -ginkgo.label-filter "$(GINKGO_LABEL)"
@@ -48,9 +49,10 @@ load-images-with-plus: ## Load NGF and NGINX Plus images on configured kind clus
 
 test: ## Run the system tests against your default k8s cluster
 	go test -v ./suite $(GINKGO_FLAGS) -args --gateway-api-version=$(GW_API_VERSION) \
-		--gateway-api-prev-version=$(GW_API_PREV_VERSION) --image-tag=$(TAG) --plus-enabled=$(PLUS_ENABLED) \
-		--ngf-image-repo=$(PREFIX) --nginx-image-repo=$(NGINX_PREFIX) --pull-policy=$(PULL_POLICY) \
-		--k8s-version=$(K8S_VERSION) --service-type=$(GW_SERVICE_TYPE) --is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL)
+		--gateway-api-prev-version=$(GW_API_PREV_VERSION) --image-tag=$(TAG) --version-under-test=$(NGF_VERSION) \
+		--plus-enabled=$(PLUS_ENABLED) --ngf-image-repo=$(PREFIX) --nginx-image-repo=$(NGINX_PREFIX) \
+		--pull-policy=$(PULL_POLICY) --k8s-version=$(K8S_VERSION) --service-type=$(GW_SERVICE_TYPE) \
+		--is-gke-internal-lb=$(GW_SVC_GKE_INTERNAL)
 
 .PHONY: delete-kind-cluster
 delete-kind-cluster: ## Delete kind cluster
diff --git a/tests/scripts/remote-scripts/run-tests.sh b/tests/scripts/remote-scripts/run-tests.sh
@@ -6,4 +6,4 @@ source ~/vars.env
 
 echo "export PATH=$PATH:/usr/local/go/bin" >> $HOME/.profile && . $HOME/.profile
 
-cd nginx-gateway-fabric/tests && make test TAG=${TAG} PREFIX=${PREFIX} NGINX_PREFIX=${NGINX_PREFIX} NGINX_PLUS_PREFIX=${NGINX_PLUS_PREFIX} PLUS_ENABLED=${PLUS_ENABLED} GINKGO_LABEL=${GINKGO_LABEL} GINKGO_FLAGS=${GINKGO_FLAGS} PULL_POLICY=Always GW_SERVICE_TYPE=LoadBalancer GW_SVC_GKE_INTERNAL=true
+cd nginx-gateway-fabric/tests && make test TAG=${TAG} PREFIX=${PREFIX} NGINX_PREFIX=${NGINX_PREFIX} NGINX_PLUS_PREFIX=${NGINX_PLUS_PREFIX} PLUS_ENABLED=${PLUS_ENABLED} GINKGO_LABEL=${GINKGO_LABEL} GINKGO_FLAGS=${GINKGO_FLAGS} PULL_POLICY=Always GW_SERVICE_TYPE=LoadBalancer GW_SVC_GKE_INTERNAL=true NGF_VERSION=${NGF_VERSION}
diff --git a/tests/scripts/vars.env-example b/tests/scripts/vars.env-example
@@ -19,3 +19,4 @@ GINKGO_FLAGS=<optional flags to pass to the go test command>
 SOURCE_IP_RANGE=<IPs that should be allowed SSH to the VM, e.g. 1.2.3.4/32 or $(curl -sS -4 icanhazip.com)/32>
 ADD_VM_IP_AUTH_NETWORKS=<if set to true, the script will add the VM IP to the list of the GKE cluster master authorized networks>
 PLUS_ENABLED=<enable nginx plus>
+NGF_VERSION=<version of NGF being tested. Defaults to value of TAG if not set>
diff --git a/tests/suite/system_suite_test.go b/tests/suite/system_suite_test.go
@@ -49,6 +49,7 @@ var (
 	ngfImageRepository   = flag.String("ngf-image-repo", "", "Image repo for NGF control plane")
 	nginxImageRepository = flag.String("nginx-image-repo", "", "Image repo for NGF data plane")
 	imageTag             = flag.String("image-tag", "", "Image tag for NGF images")
+	versionUnderTest     = flag.String("version-under-test", "", "Version of NGF that is being tested")
 	imagePullPolicy      = flag.String("pull-policy", "", "Image pull policy for NGF images")
 	serviceType          = flag.String("service-type", "NodePort", "Type of service fronting NGF to be deployed")
 	isGKEInternalLB      = flag.Bool("is-gke-internal-lb", false, "Is the LB service GKE internal only")
@@ -130,7 +131,9 @@ func setup(cfg setupConfig, extraInstallArgs ...string) {
 		installCfg.ImagePullPolicy = *imagePullPolicy
 	}
 
-	if *imageTag != "" {
+	if *versionUnderTest != "" {
+		version = *versionUnderTest
+	} else if *imageTag != "" {
 		version = *imageTag
 	} else {
 		version = "edge"

Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@ source ~/vars.env`
`6`	`6`
`7`	`7`	`echo "export PATH=$PATH:/usr/local/go/bin" >> $HOME/.profile && . $HOME/.profile`
`8`	`8`
`9`		`-cd nginx-gateway-fabric/tests && make test TAG=${TAG} PREFIX=${PREFIX} NGINX_PREFIX=${NGINX_PREFIX} NGINX_PLUS_PREFIX=${NGINX_PLUS_PREFIX} PLUS_ENABLED=${PLUS_ENABLED} GINKGO_LABEL=${GINKGO_LABEL} GINKGO_FLAGS=${GINKGO_FLAGS} PULL_POLICY=Always GW_SERVICE_TYPE=LoadBalancer GW_SVC_GKE_INTERNAL=true`
	`9`	`+cd nginx-gateway-fabric/tests && make test TAG=${TAG} PREFIX=${PREFIX} NGINX_PREFIX=${NGINX_PREFIX} NGINX_PLUS_PREFIX=${NGINX_PLUS_PREFIX} PLUS_ENABLED=${PLUS_ENABLED} GINKGO_LABEL=${GINKGO_LABEL} GINKGO_FLAGS=${GINKGO_FLAGS} PULL_POLICY=Always GW_SERVICE_TYPE=LoadBalancer GW_SVC_GKE_INTERNAL=true NGF_VERSION=${NGF_VERSION}`