feat: support conformance test (#47)

Author: AlinsRan

.github/workflows/conformance-test.yml

@@ -0,0 +1,95 @@
+name: Conformance Test
+
+on:
+  push:
+    branches:
+      - master
+      - release-v2-dev
+  pull_request:
+    branches:
+      - master
+      - release-v2-dev
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  prepare:
+    name: Prepare
+    runs-on: buildjet-2vcpu-ubuntu-2204
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Go Env
+        id: go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.22"
+
+      - name: Install kind
+        run: |
+          go install sigs.k8s.io/[email protected]
+
+  e2e-test:
+    needs: 
+      - prepare
+    runs-on: buildjet-2vcpu-ubuntu-2204
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Go Env
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.22"
+
+      - name: Login to Private Registry
+        uses: docker/login-action@v1
+        with:
+          registry: hkccr.ccs.tencentyun.com
+          username: ${{ secrets.PRIVATE_DOCKER_USERNAME }}
+          password: ${{ secrets.PRIVATE_DOCKER_PASSWORD }}
+
+      - name: Build images
+        env:
+          TAG: dev
+          ARCH: amd64
+          ENABLE_PROXY: "false"
+          BASE_IMAGE_TAG: "debug"
+        run: |
+          echo "building images..."
+          make build-image
+
+      - name: Launch Kind Cluster
+        run: |
+          make kind-up
+
+      - name: Install And Run Cloud Provider KIND
+        run: |
+          go install sigs.k8s.io/cloud-provider-kind@latest
+          nohup cloud-provider-kind > /tmp/kind-loadbalancer.log 2>&1 &
+  
+      - name: Install Gateway API
+        run: |
+          make install-gateway-api
+
+      - name: Loading Docker Image to Kind Cluster
+        run: |
+          make kind-load-images
+
+      - name: Run Conformance Test
+        shell: bash
+        env:
+          API7_EE_LICENSE: ${{ secrets.API7_EE_LICENSE }}
+        run: |
+          make conformance-test
+      
+      - name: Upload Gateway API Conformance Report
+        uses: actions/upload-artifact@v2
+        with:
+          name: api7-ingress-controller-conformance-report.yaml
+          path: api7-ingress-controller-conformance-report.yaml

.gitignore

@@ -29,3 +29,4 @@ go.work
 dist
 .tmp
 api7-ingress-controller
+api7-ingress-controller-conformance-report.yaml

Dockerfile

@@ -16,7 +16,7 @@ FROM gcr.io/distroless/static-debian12:${BASE_IMAGE_TAG}
 WORKDIR /app
 
 COPY --from=builder /bin/api7-ingress-controller .
-COPY conf/config.yaml ./conf/config.yaml
+COPY config/samples/config.yaml ./conf/config.yaml
 
 ENTRYPOINT ["/app/api7-ingress-controller"]
 CMD ["-c", "/app/conf/config.yaml"]

Makefile

@@ -78,7 +78,7 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e | grep -v /conformance) -coverprofile cover.out
 
 .PHONY: kind-e2e-test
 kind-e2e-test: kind-up build-image kind-load-images e2e-test
@@ -88,6 +88,10 @@ kind-e2e-test: kind-up build-image kind-load-images e2e-test
 e2e-test:
 	DASHBOARD_VERSION=$(DASHBOARD_VERSION) go test ./test/e2e/ -v -ginkgo.v
 
+.PHONY: conformance-test
+conformance-test:
+	DASHBOARD_VERSION=v3.2.14.2 go test -v ./test/conformance -tags=conformance
+
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint linter
 	$(GOLANGCI_LINT) run
@@ -184,6 +188,10 @@ endif
 install-gateway-api: ## Install Gateway API CRDs into the K8s cluster specified in ~/.kube/config.
 	kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/$(GATEAY_API_VERSION)/standard-install.yaml
 
+.PHONY: uninstall-gateway-api
+uninstall-gateway-api: ## Uninstall Gateway API CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
+	kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/$(GATEAY_API_VERSION)/standard-install.yaml
+
 .PHONY: install
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
 	$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -

cmd/root/root.go

@@ -40,26 +40,26 @@ import (
 	"github.com/api7/gopkg/pkg/log"
 )
 
-type ControlPlanesFlag struct {
-	ControlPlanes []*config.ControlPlaneConfig
+type GatewayConfigsFlag struct {
+	GatewayConfigs []*config.GatewayConfig
 }
 
-func (f *ControlPlanesFlag) String() string {
-	data, _ := yaml.Marshal(f.ControlPlanes)
+func (f *GatewayConfigsFlag) String() string {
+	data, _ := yaml.Marshal(f.GatewayConfigs)
 	return string(data)
 }
 
-func (f *ControlPlanesFlag) Set(value string) error {
-	var controlPlanes []*config.ControlPlaneConfig
-	if err := yaml.Unmarshal([]byte(value), &controlPlanes); err != nil {
+func (f *GatewayConfigsFlag) Set(value string) error {
+	var gatewayConfigs []*config.GatewayConfig
+	if err := yaml.Unmarshal([]byte(value), &gatewayConfigs); err != nil {
 		return err
 	}
-	f.ControlPlanes = controlPlanes
+	f.GatewayConfigs = gatewayConfigs
 	return nil
 }
 
-func (f *ControlPlanesFlag) Type() string {
-	return "controlPlanes"
+func (f *GatewayConfigsFlag) Type() string {
+	return "gateway_configs"
 }
 
 func NewRootCmd() *cobra.Command {
@@ -91,7 +91,7 @@ func newAPI7IngressController() *cobra.Command {
 	cfg := config.ControllerConfig
 	var configPath string
 
-	var controlPlanesFlag ControlPlanesFlag
+	var controlPlanesFlag GatewayConfigsFlag
 	cmd := &cobra.Command{
 		Use:     "api7-ingress-controller [command]",
 		Long:    "Yet another Ingress controller for Kubernetes using api7ee Gateway as the high performance reverse proxy.",
@@ -105,7 +105,7 @@ func newAPI7IngressController() *cobra.Command {
 				cfg = c
 				config.SetControllerConfig(c)
 			} else {
-				cfg.ControlPlanes = controlPlanesFlag.ControlPlanes
+				cfg.GatewayConfigs = controlPlanesFlag.GatewayConfigs
 			}
 
 			if err := cfg.Validate(); err != nil {

conf/config.yaml

@@ -27,14 +27,15 @@ resources:
 #- ../prometheus
 # [METRICS] Expose the controller manager metrics service.
 - metrics_service.yaml
+- ../samples
 
 # Uncomment the patches line if you enable Metrics, and/or are using webhooks and cert-manager
-patches:
+#patches:
 # [METRICS] The following patch will enable the metrics endpoint using HTTPS and the port :8443.
 # More info: https://book.kubebuilder.io/reference/metrics
-- path: manager_patch.yaml
-  target:
-    kind: Deployment
+#- path: manager_patch.yaml
+#  target:
+#    kind: Deployment
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

config/default/kustomization.yaml

@@ -58,13 +58,12 @@ spec:
         # seccompProfile:
         #   type: RuntimeDefault
       containers:
-      - command:
-        - /manager
-        args:
-          - --leader-elect
-          - --health-probe-bind-address=:8081
-        image: controller:latest
+      - image: controller:latest
         name: manager
+        volumeMounts:
+        - name: config-volume
+          mountPath: /app/conf/config.yaml
+          subPath: config.yaml
         securityContext:
           allowPrivilegeEscalation: false
           capabilities:
@@ -91,5 +90,9 @@ spec:
           requests:
             cpu: 10m
             memory: 64Mi
+      volumes:
+      - name: config-volume
+        configMap:
+          name: controller-config
       serviceAccountName: controller-manager
       terminationGracePeriodSeconds: 10

config/default/manager_patch.yaml

@@ -11,6 +11,22 @@ rules:
   verbs:
   - create
   - patch
+- apiGroups:
+  - ""
+  resources:
+  - namespaces
+  verbs:
+  - get
+  - list
+  - watch
+- apiGroups:
+  - ""
+  resources:
+  - secrets
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - ""
   resources: