Merge pull request #11 from PDOK/PDOK-17803-mapserver-operator-featureinfo-generator-configmap

PDOK-17803 Setup featureinfo generator in configmap

Author: damienmulder

api/v3/wms_types.go

@@ -25,19 +25,20 @@ SOFTWARE.
 package v3
 
 import (
+	"maps"
+	"slices"
+	"sort"
+
 	shared_model "github.com/pdok/smooth-operator/model"
 	autoscalingv2 "k8s.io/api/autoscaling/v2"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"maps"
-	"slices"
-	"sort"
 )
 
 const (
-	topLayer   = "topLayer"
-	dataLayer  = "dataLayer"
-	groupLayer = "groupLayer"
+	TopLayer   = "topLayer"
+	DataLayer  = "dataLayer"
+	GroupLayer = "groupLayer"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -161,16 +162,34 @@ func init() {
 	SchemeBuilder.Register(&WMS{}, &WMSList{})
 }
 
-func (layer *Layer) getAllLayers() (layers []Layer) {
+func (layer *Layer) GetAllLayers() (layers []Layer) {
 	layers = append(layers, *layer)
 	if layer.Layers != nil {
 		for _, childLayer := range *layer.Layers {
-			layers = append(layers, childLayer.getAllLayers()...)
+			layers = append(layers, childLayer.GetAllLayers()...)
 		}
 	}
 	return
 }
 
+func (layer *Layer) GetParent(candidateLayer *Layer) *Layer {
+	if candidateLayer.Layers == nil {
+		return nil
+	}
+
+	for _, childLayer := range *candidateLayer.Layers {
+		if childLayer.Name == layer.Name {
+			return candidateLayer
+		} else {
+			parent := layer.GetParent(&childLayer)
+			if parent != nil {
+				return parent
+			}
+		}
+	}
+	return nil
+}
+
 func (layer *Layer) hasData() bool {
 	switch {
 	case layer.Data == nil:
@@ -193,17 +212,25 @@ func (layer *Layer) hasTIFData() bool {
 	return layer.Data.TIF != nil && layer.Data.TIF.BlobKey != ""
 }
 
-func (layer *Layer) getLayerType(service *WMSService) (layerType string) {
+func (layer *Layer) GetLayerType(service *WMSService) (layerType string) {
 	switch {
 	case layer.hasData() && layer.Layers == nil:
-		return dataLayer
+		return DataLayer
 	case layer.Name == service.Layer.Name:
-		return topLayer
+		return TopLayer
 	default:
-		return groupLayer
+		return GroupLayer
 	}
 }
 
+func (layer *Layer) IsDataLayer(service *WMSService) bool {
+	return layer.GetLayerType(service) == DataLayer
+}
+
+func (layer *Layer) IsGroupLayer(service *WMSService) bool {
+	return layer.GetLayerType(service) == GroupLayer
+}
+
 func (layer *Layer) hasBoundingBoxForCRS(crs string) bool {
 	for _, bbox := range layer.BoundingBoxes {
 		if bbox.CRS == crs {
@@ -237,7 +264,7 @@ func (layer *Layer) IsGroupLayer() bool {
 }
 
 func (wms *WMS) GetAllLayersWithLegend() (layers []Layer) {
-	for _, layer := range wms.Spec.Service.Layer.getAllLayers() {
+	for _, layer := range wms.Spec.Service.Layer.GetAllLayers() {
 		if !layer.hasData() || len(layer.Styles) == 0 {
 			continue
 		}
@@ -253,7 +280,7 @@ func (wms *WMS) GetAllLayersWithLegend() (layers []Layer) {
 
 func (wms *WMS) GetUniqueTiffBlobKeys() []string {
 	blobKeys := map[string]bool{}
-	for _, layer := range wms.Spec.Service.Layer.getAllLayers() {
+	for _, layer := range wms.Spec.Service.Layer.GetAllLayers() {
 		if layer.hasTIFData() {
 			blobKeys[layer.Data.TIF.BlobKey] = true
 		}
@@ -284,7 +311,7 @@ func (wms *WMS) GetAuthority() *Authority {
 }
 
 func (wms *WMS) HasPostgisData() bool {
-	for _, layer := range wms.Spec.Service.Layer.getAllLayers() {
+	for _, layer := range wms.Spec.Service.Layer.GetAllLayers() {
 		if layer.Data != nil && layer.Data.Postgis != nil {
 			return true
 		}

api/v3/wms_types_test.go

@@ -3,6 +3,7 @@ package v3
 import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/pdok/smooth-operator/model"
+	"reflect"
 	"testing"
 )
 
@@ -124,3 +125,39 @@ func TestLayer_setInheritedBoundingBoxes(t *testing.T) {
 		})
 	}
 }
+
+func TestLayer_GetParent(t *testing.T) {
+	childLayer2 := Layer{Name: "childlayer-2"}
+	childLayer1 := Layer{Name: "childlayer-1", Layers: &[]Layer{childLayer2}}
+	topLayer := Layer{Name: "toplayer", Layers: &[]Layer{childLayer1}}
+
+	type args struct {
+		candidateLayer *Layer
+	}
+	tests := []struct {
+		name  string
+		layer Layer
+		args  args
+		want  *Layer
+	}{
+		{
+			name:  "Test GetParent on layer with parent",
+			layer: childLayer2,
+			args:  args{candidateLayer: &topLayer},
+			want:  &childLayer1,
+		},
+		{
+			name:  "Test GetParent on layer without parent",
+			layer: topLayer,
+			args:  args{candidateLayer: &topLayer},
+			want:  nil,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.layer.GetParent(tt.args.candidateLayer); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("GetParent() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

api/v3/wms_validation.go

@@ -93,7 +93,7 @@ func validateWMS(wms *WMS, warnings *[]string, reasons *[]string) {
 	var names []string
 	hasVisibleLayer := false
 	wms.Spec.Service.Layer.setInheritedBoundingBoxes()
-	for _, layer := range wms.Spec.Service.Layer.getAllLayers() {
+	for _, layer := range wms.Spec.Service.Layer.GetAllLayers() {
 		var layerReasons []string
 		if slices.Contains(names, layer.Name) {
 			*reasons = append(*reasons, fmt.Sprintf("layer names must be unique, layer.name '%s' is duplicated", layer.Name))
@@ -162,8 +162,8 @@ func validateWMS(wms *WMS, warnings *[]string, reasons *[]string) {
 				}
 			}
 		}
-		layerType := layer.getLayerType(&service)
-		if layerType == dataLayer {
+
+		if layer.IsDataLayer(&wms.Spec.Service) {
 			for _, style := range layer.Styles {
 				if wms.Spec.Service.Mapfile == nil && style.Visualization == nil {
 					layerReasons = append(layerReasons, fmt.Sprintf("invalid style: '%s': style.visualization must be set on a dataLayer", style.Name))
@@ -173,7 +173,8 @@ func validateWMS(wms *WMS, warnings *[]string, reasons *[]string) {
 				}
 			}
 		}
-		if layerType == groupLayer || layerType == topLayer {
+		layerType := layer.GetLayerType(&service)
+		if layerType == GroupLayer || layerType == TopLayer {
 			if !*layer.Visible {
 				layerReasons = append(layerReasons, layerType+" must be visible")
 			}

cmd/main.go

@@ -49,6 +49,7 @@ const (
 	defaultMultitoolImage             = "docker.io/pdok/docker-multitool:0.9.1"
 	defaultMapfileGeneratorImage      = "docker.io/pdok/mapfile-generator:1.9.3"
 	defaultCapabilitiesGeneratorImage = "docker.io/pdok/ogc-capabilities-generator:1.0.0-beta5"
+	defaultFeatureinfoGeneratorImage  = "docker.io/pdok/featureinfo-generator:v1.4.0-beta1"
 )
 
 var (
@@ -78,6 +79,7 @@ func main() {
 	var multitoolImage string
 	var mapfileGeneratorImage string
 	var capabilitiesGeneratorImage string
+	var featureinfoGeneratorImage string
 	flag.StringVar(&metricsAddr, "metrics-bind-address", "0", "The address the metrics endpoint binds to. "+
 		"Use :8443 for HTTPS or :8080 for HTTP, or leave as 0 to disable the metrics service.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
@@ -99,6 +101,7 @@ func main() {
 	flag.StringVar(&multitoolImage, "multitool-image", defaultMultitoolImage, "The image to use in the blob download init-container.")
 	flag.StringVar(&mapfileGeneratorImage, "mapfile-generator-image", defaultMapfileGeneratorImage, "The image to use in the mapfile generator init-container.")
 	flag.StringVar(&capabilitiesGeneratorImage, "capabilities-generator-image", defaultCapabilitiesGeneratorImage, "The image to use in the capabilities generator init-container.")
+	flag.StringVar(&featureinfoGeneratorImage, "featureinfo-generator-image", defaultFeatureinfoGeneratorImage, "The image to use in the featureinfo generator init-container.")
 
 	opts := zap.Options{
 		Development: true,
@@ -228,8 +231,9 @@ func main() {
 	}
 
 	if err = (&controller.WMSReconciler{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
+		Client:                    mgr.GetClient(),
+		Scheme:                    mgr.GetScheme(),
+		FeatureinfoGeneratorImage: featureinfoGeneratorImage,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "WMS")
 		os.Exit(1)

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/cbroglie/mustache v1.4.0
 	github.com/onsi/ginkgo/v2 v2.22.2
 	github.com/onsi/gomega v1.36.2
+	github.com/pdok/featureinfo-generator v1.4.0-beta1
 	github.com/pdok/ogc-capabilities-generator v1.0.0-beta5
 	github.com/pdok/ogc-specifications v1.0.0-beta5
 	github.com/pdok/smooth-operator v0.0.9
@@ -82,7 +83,7 @@ require (
 	github.com/google/btree v1.1.3 // indirect
 	github.com/google/cel-go v0.22.0 // indirect
 	github.com/google/gnostic-models v0.6.9 // indirect
-	github.com/google/go-cmp v0.7.0 // indirect
+	github.com/google/go-cmp v0.7.0
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/google/pprof v0.0.0-20241210010833-40e02aabc2ad // indirect
 	github.com/google/uuid v1.6.0 // indirect
@@ -135,7 +136,7 @@ require (
 	k8s.io/component-base v0.32.0 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20241212222426-2c72e554b1e7 // indirect
-	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
+	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.0 // indirect
 	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
 	sigs.k8s.io/kustomize/api v0.19.0 // indirect

go.sum

@@ -138,6 +138,8 @@ github.com/onsi/gomega v1.36.2 h1:koNYke6TVk6ZmnyHrCXba/T/MoLBXFjeC1PtvYgw0A8=
 github.com/onsi/gomega v1.36.2/go.mod h1:DdwyADRjrc825LhMEkD76cHR5+pUnjhUN8GlHlRPHzY=
 github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
+github.com/pdok/featureinfo-generator v1.4.0-beta1 h1:ZZO5OtK7yW5ozXFrl1OaxKl0MK3XF5YGFh2692JZVN8=
+github.com/pdok/featureinfo-generator v1.4.0-beta1/go.mod h1:02Ryu7ZRkeha8SCfS6VYWCdKYZh0llskrfFgp6xRCjk=
 github.com/pdok/ogc-capabilities-generator v1.0.0-beta5 h1:nwkIbFcUW4FIYnf6fLfzpkaIdolQoEhH7yyS8KXNt/g=
 github.com/pdok/ogc-capabilities-generator v1.0.0-beta5/go.mod h1:qG2auFy7MDL8Zp1eOfdaUJat+jNW5oLGVd+g7Mbth4Q=
 github.com/pdok/ogc-specifications v1.0.0-beta5 h1:j7JrXUeW55mVU9ZmJ67r8V6DhbKdgTDiGE1YKFpRWx4=

internal/controller/featureinfogenerator/featureinfo_generator.go

@@ -0,0 +1,49 @@
+package featureinfogenerator
+
+import (
+	"encoding/json"
+	"fmt"
+	pdoknlv3 "github.com/pdok/mapserver-operator/api/v3"
+	corev1 "k8s.io/api/core/v1"
+)
+
+const (
+	htmlTemplatesPath                       = "/srv/data/config/templates"
+	ConfigMapFeatureinfoGeneratorVolumeName = "featureinfo-generator-config"
+)
+
+func GetFeatureinfoGeneratorInitContainer(image string, srvDir string) (*corev1.Container, error) {
+	initContainer := corev1.Container{
+		Name:            "featureinfo-generator",
+		Image:           image,
+		ImagePullPolicy: corev1.PullIfNotPresent,
+		Command:         []string{"featureinfo-generator"},
+		Args: []string{
+			"--input-path",
+			"/input/input.json",
+			"--dest-folder",
+			htmlTemplatesPath,
+			"--file-name",
+			"feature-info",
+		},
+		VolumeMounts: []corev1.VolumeMount{
+			{Name: "base", MountPath: srvDir + "/data", ReadOnly: false},
+			{Name: ConfigMapFeatureinfoGeneratorVolumeName, MountPath: "/input", ReadOnly: true},
+		},
+	}
+
+	return &initContainer, nil
+}
+
+func GetInput(wms *pdoknlv3.WMS) (string, error) {
+	input, err := MapWMSToFeatureinfoGeneratorInput(wms)
+	if err != nil {
+		return "", err
+	}
+	jsonInput, err := json.MarshalIndent(input, "", "    ")
+	if err != nil {
+		return "", fmt.Errorf("failed to marshal the featureinfo generator input to json: %w", err)
+	}
+
+	return string(jsonInput), nil
+}