Refactor internal package organization (#839)

Problem: After the merge of the provisioner-mode code into 
the main branch, our codebase now consists of three distinct 
components or groups: provisioner-mode, static-mode, and framework. 
However, our current internal package structure does not align with 
these components.

Solution: Align the internal package structure with our three main 
components by introducing the following internal packages:
- framework: code shared between provisioner and static modes
- mode/provisioner: all code related to provisioner-mode
- mode/static: all code related to static mode

In addition, some packages were refactored/split so the framework
package would not have any dependencies on the mode/static package.

Author: kate-osborn

.github/workflows/ci.yml

@@ -87,7 +87,7 @@ jobs:
         uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3.7.0
         with:
           node-version: 18
-      - run: npm --prefix ${{ github.workspace }}/internal/nginx/modules install-ci-test
+      - run: npm --prefix ${{ github.workspace }}/internal/mode/static/nginx/modules install-ci-test
 
   release:
     name: Release

.gitignore

@@ -31,4 +31,4 @@ dist/
 node_modules/
 
 # JS test coverage
-internal/nginx/modules/coverage
+internal/mode/static/nginx/modules/coverage

Makefile

@@ -80,7 +80,7 @@ unit-test: ## Run unit tests for the go code
 
 njs-unit-test: ## Run unit tests for the njs httpmatches module
 	docker run --rm -w /modules \
-		-v $(PWD)/internal/nginx/modules:/modules/ \
+		-v $(PWD)/internal/mode/static/nginx/modules:/modules/ \
 		node:18 \
 		/bin/bash -c "npm install && npm test && npm run clean"
 

cmd/gateway/commands.go

@@ -9,9 +9,9 @@ import (
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	"github.com/nginxinc/nginx-kubernetes-gateway/internal/config"
-	"github.com/nginxinc/nginx-kubernetes-gateway/internal/manager"
-	"github.com/nginxinc/nginx-kubernetes-gateway/internal/provisioner"
+	"github.com/nginxinc/nginx-kubernetes-gateway/internal/mode/provisioner"
+	"github.com/nginxinc/nginx-kubernetes-gateway/internal/mode/static"
+	"github.com/nginxinc/nginx-kubernetes-gateway/internal/mode/static/config"
 )
 
 const (
@@ -149,7 +149,7 @@ func createStaticModeCommand() *cobra.Command {
 				UpdateGatewayClassStatus: updateGCStatus,
 			}
 
-			if err := manager.Start(conf); err != nil {
+			if err := static.StartManager(conf); err != nil {
 				return fmt.Errorf("failed to start control loop: %w", err)
 			}
 

conformance/Makefile

@@ -45,7 +45,7 @@ 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
-	kubectl create configmap njs-modules --from-file=../internal/nginx/modules/src/httpmatches.js -n nginx-gateway
+	kubectl create configmap njs-modules --from-file=../internal/mode/static/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

docs/installation.md

@@ -0,0 +1,48 @@
+package conditions
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/gateway-api/apis/v1beta1"
+)
+
+const (
+	// GatewayClassReasonGatewayClassConflict indicates there are multiple GatewayClass resources
+	// that reference this controller, and we ignored the resource in question and picked the
+	// GatewayClass that is referenced in the command-line argument.
+	// This reason is used with GatewayClassConditionAccepted (false).
+	GatewayClassReasonGatewayClassConflict v1beta1.GatewayClassConditionReason = "GatewayClassConflict"
+
+	// GatewayClassMessageGatewayClassConflict is a message that describes GatewayClassReasonGatewayClassConflict.
+	GatewayClassMessageGatewayClassConflict = "The resource is ignored due to a conflicting GatewayClass resource"
+)
+
+// Condition defines a condition to be reported in the status of resources.
+type Condition struct {
+	Type    string
+	Status  metav1.ConditionStatus
+	Reason  string
+	Message string
+}
+
+// NewDefaultGatewayClassConditions returns the default Conditions that must be present in the status of a GatewayClass.
+func NewDefaultGatewayClassConditions() []Condition {
+	return []Condition{
+		{
+			Type:    string(v1beta1.GatewayClassConditionStatusAccepted),
+			Status:  metav1.ConditionTrue,
+			Reason:  string(v1beta1.GatewayClassReasonAccepted),
+			Message: "GatewayClass is accepted",
+		},
+	}
+}
+
+// NewGatewayClassConflict returns a Condition that indicates that the GatewayClass is not accepted
+// due to a conflict with another GatewayClass.
+func NewGatewayClassConflict() Condition {
+	return Condition{
+		Type:    string(v1beta1.GatewayClassConditionStatusAccepted),
+		Status:  metav1.ConditionFalse,
+		Reason:  string(GatewayClassReasonGatewayClassConflict),
+		Message: GatewayClassMessageGatewayClassConflict,
+	}
+}

internal/events/handler.go

@@ -9,5 +9,5 @@ import (
 
 func TestControllers(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Reconciler Suite")
+	RunSpecs(t, "Controller Suite")
 }