PDOK-18065 Atom-Operator - validation unit-tests

Author: rahmabPublic

internal/webhook/v3/atom_webhook_test.go

@@ -27,6 +27,8 @@ package v3
 import (
 	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo bdd
 	. "github.com/onsi/gomega"    //nolint:revive // ginkgo bdd
+	"os"
+	"sigs.k8s.io/yaml"
 
 	pdoknlv3 "github.com/pdok/atom-operator/api/v3"
 	// TODO (user): Add any additional imports if needed
@@ -42,11 +44,14 @@ var _ = Describe("Atom Webhook", func() {
 	BeforeEach(func() {
 		obj = &pdoknlv3.Atom{}
 		oldObj = &pdoknlv3.Atom{}
-		validator = AtomCustomValidator{}
+		validator = AtomCustomValidator{
+			Client: k8sClient,
+		}
 		Expect(validator).NotTo(BeNil(), "Expected validator to be initialized")
 		Expect(oldObj).NotTo(BeNil(), "Expected oldObj to be initialized")
 		Expect(obj).NotTo(BeNil(), "Expected obj to be initialized")
 		// TODO (user): Add any setup logic common to all tests
+
 	})
 
 	AfterEach(func() {
@@ -56,12 +61,19 @@ var _ = Describe("Atom Webhook", func() {
 	Context("When creating or updating Atom under Validating Webhook", func() {
 		// TODO (user): Add logic for validating webhooks
 		// Example:
-		// It("Should deny creation if a required field is missing", func() {
-		//     By("simulating an invalid creation scenario")
-		//     obj.SomeRequiredField = ""
-		//     Expect(validator.ValidateCreate(ctx, obj)).Error().To(HaveOccurred())
-		// })
-		//
+		It("Should deny creation if a required field is missing", func() {
+			By("simulating an invalid creation scenario")
+			input, err := os.ReadFile("test_data/input/1-no-error-no-warning.yaml")
+			Expect(err).NotTo(HaveOccurred())
+			atom := &pdoknlv3.Atom{}
+			err = yaml.Unmarshal(input, atom)
+			Expect(err).NotTo(HaveOccurred())
+			println(atom.Spec.Service.OwnerInfoRef)
+			warnings, errors := validator.ValidateCreate(ctx, atom)
+			Expect(errors).To(BeNil())
+			Expect(len(warnings)).To(Equal(0))
+		})
+
 		// It("Should admit creation if all required fields are present", func() {
 		//     By("simulating an invalid creation scenario")
 		//     obj.SomeRequiredField = "valid_value"

internal/webhook/v3/ownerinfo-test/kustomization.yaml

@@ -0,0 +1,4 @@
+## Append samples of your project ##
+resources:
+- v1_ownerinfo.yaml
+# +kubebuilder:scaffold:manifestskustomizesamples

internal/webhook/v3/ownerinfo-test/samples.go

@@ -0,0 +1,16 @@
+package samples
+
+import (
+	_ "embed"
+	v1 "github.com/pdok/smooth-operator/api/v1"
+	"sigs.k8s.io/yaml"
+)
+
+//go:embed v1_ownerinfo.yaml
+var ownerInfoContent string
+
+func OwnerInfoSample() (*v1.OwnerInfo, error) {
+	var sample v1.OwnerInfo
+	err := yaml.Unmarshal([]byte(ownerInfoContent), &sample)
+	return &sample, err
+}

internal/webhook/v3/ownerinfo-test/v1_ownerinfo.yaml

@@ -0,0 +1,68 @@
+apiVersion: pdok.nl/v1
+kind: OwnerInfo
+metadata:
+  name: pdok
+  namespace: services
+  labels:
+    app.kubernetes.io/name: atom-operator
+    app.kubernetes.io/managed-by: kustomize
+spec:
+  metadataUrls:
+    csw:
+      hrefTemplate: "https://www.nationaalgeoregister.nl/geonetwork/srv/dut/csw?service=CSW&version=2.0.2&request=GetRecordById&outputschema=http://www.isotc211.org/2005/gmd&elementsetname=full&id={{identifier}}"
+      type: alternate
+    opensearch:
+      hrefTemplate: "https://www.nationaalgeoregister.nl/geonetwork/opensearch/dut/{{identifier}}/OpenSearchDescription.xml"
+      type: alternate
+    html:
+      hrefTemplate: "https://www.nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/{{identifier}}"
+      type: alternate
+  namespaceTemplate: "http://{{prefix}}.geonovum.nl"
+  atom:
+    defaultStylesheet: https://service.pdok.nl/atom/style/style.xsl
+    author: # author/owner van de dataset
+      name: pdok
+      email: [email protected]
+  wfs:
+    serviceprovider:
+      providername: PDOK
+      providersite:
+        type: simple
+        href: https://pdok.nl
+      servicecontact:
+        individualname: KlantContactCenter PDOK
+        positionname: pointOfContact
+        contactinfo:
+          phone:
+            voice:
+            facsmile:
+          text:
+          address:
+            deliverypoint:
+            city: Apeldoorn
+            administrativearea:
+            postalcode:
+            country: Netherlands
+            electronicmailaddress: [email protected]
+          onlineresource:
+            type:
+            href:
+          hoursofservice:
+          contactinstructions:
+        role:
+  wms:
+    contactinformation:
+      contactpersonprimary:
+        contactperson: KlantContactCenter PDOK
+        contactorganization: PDOK
+      contactposition: pointOfContact
+      contactaddress:
+        addresstype:
+        address:
+        city: Apeldoorn
+        stateorprovince:
+        postcode:
+        country: Netherlands
+      contactvoicetelephone:
+      contactfacsimiletelephone:
+      contactelectronicmailAddress: [email protected]

internal/webhook/v3/test_data/input/1-no-error-no-warning.yaml

@@ -0,0 +1,60 @@
+apiVersion: pdok.nl/v3
+kind: Atom
+metadata:
+  annotations:
+    kangaroo.pdok.nl/lifecycle-phase: prod
+    kangaroo.pdok.nl/service-bundle-ids: 65daed5f-e9e4-5791-a7c9-7e9effcca520
+    kangaroo.pdok.nl/readonly: "true"
+  labels:
+    pdok.nl/dataset-id: wetlands
+    pdok.nl/owner-id: rvo
+    pdok.nl/service-type: atom
+  name: asis-readonly-prod
+  namespace: services
+spec:
+  service:
+    baseUrl: http://localhost:32788/rvo/wetlands/atom
+    datasetFeeds:
+      - author:
+          email: [email protected]
+          name: Ministerie van EL&I - GIS Competence Center
+        datasetMetadataLinks:
+          metadataIdentifier: 07d73b60-dfd6-4c54-9c82-9fac70c6c48e
+          templates:
+            - csw
+            - html
+        entries:
+          - content:
+              Wetlands zijn de natte natuurgebieden in Nederland (44 gebieden).
+              Het Wetland verdrag is op 2 februari 1971 te Ramsar in Iran ondertekend.
+              Nederland was een van de zestien landen die het Verdrag toen ondertekende.
+            downloadlinks:
+              - data: public/rvo/wetlands/65daed5f-e9e4-5791-a7c9-7e9effcca520/3/wetlands.gpkg
+            polygon:
+              bbox:
+                maxx: "7.5553527"
+                maxy: "55.66948"
+                minx: "2.354173"
+                miny: "50.71447"
+            srs:
+              name: Amersfoort / RD New
+              uri: https://www.opengis.net/def/crs/EPSG/0/28992
+            technicalName: wetlands
+            title: wetlands
+            updated: "2025-02-28T09:04:17Z"
+        spatialDatasetIdentifierCode: 07d73b60-dfd6-4c54-9c82-9fac70c6c48e
+        spatialDatasetIdentifierNamespace: http://www.pdok.nl
+        subtitle: wetlands
+        technicalName: wetlands
+        title: wetlands
+    lang: nl
+    ownerInfoRef: pdok
+    rights: https://creativecommons.org/publicdomain/zero/1.0/deed.nl
+    serviceMetadataLinks:
+      metadataIdentifier: 2751ba40-5100-4186-81be-b7fdee95b49c
+      templates:
+        - csw
+        - opensearch
+        - html
+    subtitle: Download Service van wetlands
+    title: Wetlands

internal/webhook/v3/webhook_suite_test.go

@@ -27,9 +27,17 @@ package v3
 import (
 	"context"
 	"crypto/tls"
+	"errors"
 	"fmt"
+	samples "github.com/pdok/atom-operator/internal/webhook/v3/ownerinfo-test"
+	smoothoperatorv1 "github.com/pdok/smooth-operator/api/v1"
+	"golang.org/x/tools/go/packages"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/json"
 	"net"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"testing"
 	"time"
@@ -39,7 +47,9 @@ import (
 
 	admissionv1 "k8s.io/api/admission/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
+
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
@@ -82,17 +92,29 @@ var _ = BeforeSuite(func() {
 
 	err = admissionv1.AddToScheme(scheme)
 	Expect(err).NotTo(HaveOccurred())
+	err = smoothoperatorv1.AddToScheme(scheme)
+	Expect(err).NotTo(HaveOccurred())
 
 	// +kubebuilder:scaffold:scheme
 
 	By("bootstrapping test environment")
+	traefikCRDPath := must(getTraefikCRDPath())
+	ownerInfoCRDPath := must(getOwnerInfoCRDPath())
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "config", "crd", "bases")},
 		ErrorIfCRDPathMissing: false,
 
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
 			Paths: []string{filepath.Join("..", "..", "..", "config", "webhook")},
 		},
+		CRDInstallOptions: envtest.CRDInstallOptions{
+			Scheme: nil,
+			Paths: []string{
+				filepath.Join("..", "..", "..", "config", "crd", "bases", "pdok.nl_atoms.yaml"),
+				traefikCRDPath,
+				ownerInfoCRDPath,
+			},
+			ErrorIfPathMissing: true,
+		},
 	}
 
 	// Retrieve the first found binary directory to allow running tests from IDEs
@@ -109,6 +131,23 @@ var _ = BeforeSuite(func() {
 	Expect(err).NotTo(HaveOccurred())
 	Expect(k8sClient).NotTo(BeNil())
 
+	By("creating manager namespace")
+
+	clientset, err := kubernetes.NewForConfig(cfg)
+	namespace22 := &corev1.Namespace{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "services",
+		},
+	}
+	clientset.CoreV1().Namespaces().Create(ctx, namespace22, metav1.CreateOptions{})
+	Expect(err).NotTo(HaveOccurred(), "Failed to create namespace")
+	ownerInfo, err := samples.OwnerInfoSample()
+	Expect(err).NotTo(HaveOccurred())
+	Expect(ownerInfo).NotTo(BeNil())
+
+	err = k8sClient.Create(ctx, ownerInfo)
+	Expect(err).NotTo(HaveOccurred())
+
 	// start webhook server using Manager.
 	webhookInstallOptions := &testEnv.WebhookInstallOptions
 	mgr, err := ctrl.NewManager(cfg, ctrl.Options{
@@ -176,3 +215,42 @@ func getFirstFoundEnvTestBinaryDir() string {
 	}
 	return ""
 }
+
+func must[T any](t T, err error) T {
+	if err != nil {
+		panic(err)
+	}
+	return t
+}
+
+func getOwnerInfoCRDPath() (string, error) {
+	smoothOperatorModule, err := getModule("github.com/pdok/smooth-operator")
+	if err != nil {
+		return "", err
+	}
+	if smoothOperatorModule.Dir == "" {
+		return "", errors.New("cannot find path for smooth-operator module")
+	}
+	return filepath.Join(smoothOperatorModule.Dir, "config", "crd", "bases", "pdok.nl_ownerinfo.yaml"), nil
+}
+
+func getTraefikCRDPath() (string, error) {
+	traefikModule, err := getModule("github.com/traefik/traefik/v3")
+	if err != nil {
+		return "", err
+	}
+	if traefikModule.Dir == "" {
+		return "", errors.New("cannot find path for traefik module")
+	}
+	return filepath.Join(traefikModule.Dir, "integration", "fixtures", "k8s", "01-traefik-crd.yml"), nil
+}
+
+func getModule(name string) (module *packages.Module, err error) {
+	out, err := exec.Command("go", "list", "-json", "-m", name).Output()
+	if err != nil {
+		return
+	}
+	module = &packages.Module{}
+	err = json.Unmarshal(out, module)
+	return
+}