Add connectivity test example

Signed-off-by: Stefan Prodan <[email protected]>

examples/minimal/cue.mod/pkg/timoni.sh/core/v1alpha1/action.cue

@@ -0,0 +1,24 @@
+// Copyright 2023 Stefan Prodan
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1
+
+// Action holds a list of annotations for controlling
+// Timoni's apply behaviour of Kubernetes resources.
+action: {
+	// Force annotation for recreating immutable resources such as Kubernetes Jobs.
+	force: {
+		"action.timoni.sh/force": enabled
+	}
+	// One-off annotation for appling resources only if they don't exist on the cluster.
+	oneoff: {
+		"action.timoni.sh/one-off": enabled
+	}
+	// Keep annotation for preventing Timoni's garbage collector from deleting resources.
+	keep: {
+		"action.timoni.sh/prune": disabled
+	}
+}
+
+enabled:  "enabled"
+disabled: "disabled"

examples/minimal/debug_tool.cue

@@ -6,11 +6,13 @@ import (
 	"text/tabwriter"
 )
 
+_resources: timoni.apply.app + timoni.apply.test
+
 // The build command generates the Kubernetes manifests and prints the multi-docs YAML to stdout.
 // Example 'cue cmd -t debug -t name=test -t namespace=test -t mv=1.0.0 -t kv=1.28.0 build'.
 command: build: {
 	task: print: cli.Print & {
-		text: yaml.MarshalStream(timoni.apply.all)
+		text: yaml.MarshalStream(_resources)
 	}
 }
 
@@ -20,7 +22,7 @@ command: ls: {
 	task: print: cli.Print & {
 		text: tabwriter.Write([
 			"RESOURCE \tAPI VERSION",
-			for r in timoni.apply.all {
+			for r in _resources {
 				if r.metadata.namespace == _|_ {
 					"\(r.kind)/\(r.metadata.name) \t\(r.apiVersion)"
 				}

examples/minimal/debug_values.cue

@@ -12,4 +12,12 @@ values: {
 		tag:        "1-alpine"
 		digest:     ""
 	}
+	test: {
+		enabled: true
+		image: {
+			repository: "docker.io/curlimages/curl"
+			tag:        "latest"
+			digest:     ""
+		}
+	}
 }

examples/minimal/templates/config.cue

@@ -18,7 +18,7 @@ import (
 	selector: timoniv1.#Selector & {#Name: metadata.name}
 
 	// App settings
-	message: string
+	message!: string
 
 	// Deployment
 	replicas: *1 | int & >0
@@ -32,13 +32,19 @@ import (
 	topologySpreadConstraints?: [...corev1.#TopologySpreadConstraint]
 
 	// Container
-	image:            timoniv1.#Image
+	image!:           timoniv1.#Image
 	imagePullPolicy:  *"IfNotPresent" | string
 	resources?:       corev1.#ResourceRequirements
 	securityContext?: corev1.#SecurityContext
 
 	// Service
 	service: port: *80 | int & >0 & <=65535
+
+	// Test Job
+	test: {
+		enabled: *false | bool
+		image!:  timoniv1.#Image
+	}
 }
 
 // Instance takes the config values and outputs the Kubernetes objects.
@@ -55,4 +61,8 @@ import (
 			_cmName: objects.cm.metadata.name
 		}
 	}
+
+	tests: {
+		"test-svc": #TestJob & {_config: config}
+	}
 }

examples/minimal/templates/job.cue

@@ -0,0 +1,58 @@
+package templates
+
+import (
+	"encoding/yaml"
+	"uuid"
+
+	corev1 "k8s.io/api/core/v1"
+	batchv1 "k8s.io/api/batch/v1"
+	timoniv1 "timoni.sh/core/v1alpha1"
+)
+
+#TestJob: batchv1.#Job & {
+	_config:    #Config
+	apiVersion: "batch/v1"
+	kind:       "Job"
+	metadata: name:        "\(_config.metadata.name)-test"
+	metadata: namespace:   _config.metadata.namespace
+	metadata: labels:      _config.metadata.labels
+	metadata: annotations: timoniv1.action.force
+	spec: batchv1.#JobSpec & {
+		template: corev1.#PodTemplateSpec & {
+			metadata: labels: _config.metadata.labels
+			let _checksum = uuid.SHA1(uuid.ns.DNS, yaml.Marshal(_config))
+			metadata: annotations: "timoni.sh/checksum": "\(_checksum)"
+			spec: {
+				containers: [{
+					name:            "curl"
+					image:           _config.test.image.reference
+					imagePullPolicy: _config.imagePullPolicy
+					command: [
+						"curl",
+						"-v",
+						"-m",
+						"5",
+						"\(_config.metadata.name):\(_config.service.port)",
+					]
+				}]
+				restartPolicy: "Never"
+			}
+		}
+		backoffLimit: 1
+		if _config.podSecurityContext != _|_ {
+			securityContext: _config.podSecurityContext
+		}
+		if _config.topologySpreadConstraints != _|_ {
+			topologySpreadConstraints: _config.topologySpreadConstraints
+		}
+		if _config.affinity != _|_ {
+			affinity: _config.affinity
+		}
+		if _config.tolerations != _|_ {
+			tolerations: _config.tolerations
+		}
+		if _config.imagePullSecrets != _|_ {
+			imagePullSecrets: _config.imagePullSecrets
+		}
+	}
+}

examples/minimal/timoni.cue

@@ -45,5 +45,10 @@ timoni: {
 
 	// Pass Kubernetes resources outputted by the instance
 	// to Timoni's multi-step apply.
-	apply: all: [ for obj in instance.objects {obj}]
+	apply: app: [ for obj in instance.objects {obj}]
+
+	// Conditionally run tests after an install or upgrade.
+	if instance.config.test.enabled {
+		apply: test: [ for obj in instance.tests {obj}]
+	}
 }

examples/minimal/values.cue

@@ -13,4 +13,9 @@ values: {
 		digest:     "sha256:015b0c4d993d85846a15505e66c25ff717261f292d7168c70ab18ac5efbc4f00"
 		tag:        "1.25.2"
 	}
+	test: image: {
+		repository: "cgr.dev/chainguard/curl"
+		digest:     ""
+		tag:        "latest"
+	}
 }