tests(stdlib/k8s/helm): test basic helm chart

tests(stdlib/k8s/helm): add verification
style(tests/): rename helper into verify to confirm that deployments works

Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>

examples/kubernetes-app/main.cue

@@ -44,10 +44,10 @@ kubeApply: kubernetes.#Apply & {
 
 // Example of a `helm install` using a local chart
 // Fill using:
-//          --input-dir helmChart.chart=./testdata/mychart
+//          --input-dir helmChart.chartSource=./testdata/mychart
 helmChart: helm.#Chart & {
-	name:       "test-helm"
+	name:        "test-helm"
-	namespace:  "test"
+	namespace:   "test"
-	kubeconfig: cluster.kubeconfig
+	kubeconfig:  cluster.kubeconfig
-	chart:      dagger.#Artifact
+	chartSource: dagger.#Artifact
 }

pkg/buildkitd/buildkitd.go

@@ -106,8 +106,8 @@ func startBuildkit(ctx context.Context) error {
 
 	// FIXME: buildkitd currently runs without network isolation (--net=host)
 	// in order for containers to be able to reach localhost.
-	//This is required for things such as kubectl being able to
+	// This is required for things such as kubectl being able to
-	//reach a KinD/minikube cluster locally
+	// reach a KinD/minikube cluster locally
 	cmd = exec.CommandContext(ctx,
 		"docker",
 		"run",

stdlib/kubernetes/helm/helm.cue

@@ -13,11 +13,11 @@ import (
 	// Helm deployment name
 	name: string
 
-	// Helm chart to install
+	// Helm chart to install from source
-	chart: dagger.#Artifact
+	chartSource: dagger.#Artifact
 
-	// Helm chart to install inlined
+	// Helm chart to install from repository
-	chartInline?: string
+	chart?: string
 
 	// Helm chart repository (defaults to stable)
 	repository: *"https://charts.helm.sh/stable" | string
@@ -89,12 +89,18 @@ import (
 			content: kubeconfig
 			mode:    0o600
 		},
-		if chartInline != _|_ {
+		if chart != _|_ {
 			op.#WriteFile & {
 				dest:    "/helm/chart"
 				content: chart
 			}
 		},
+		if (values & string) != _|_ {
+			op.#WriteFile & {
+				dest:    "/helm/values.yaml"
+				content: values
+			}
+		},
 		op.#Exec & {
 			always: true
 			args: [
@@ -117,11 +123,8 @@ import (
 				HELM_ATOMIC:  strconv.FormatBool(atomic)
 			}
 			mount: {
-				if (values & string) != _|_ {
+				if chartSource != _|_ && chart == _|_ {
-					"/helm/values.yaml": values
+					"/helm/chart": from: chartSource
-				}
-				if chartInline == _|_ {
-					"/helm/chart": from: chart
 				}
 			}
 		},

tests/stdlib/kubernetes/helm/helm.cue

@@ -1,9 +1,11 @@
 package helm
 
 import (
-	"dagger.io/kubernetes/helm"
 	"dagger.io/dagger"
+	"dagger.io/dagger/op"
+	"dagger.io/alpine"
 	"dagger.io/file"
+	"dagger.io/kubernetes/helm"
 )
 
 // We assume that a kinD cluster is running locally
@@ -16,25 +18,50 @@ config: file.#Read & {
 	from:     kubeconfig
 }
 
-// Dagger test k8s namespace
+// Generate random string
-namespace: "dagger-test"
+random: {
+	string
+	#up: [
+		op.#Load & {from: alpine.#Image},
+		op.#Exec & {
+			args: ["sh", "-c", "cat /dev/urandom | tr -dc 'a-z' | fold -w 10 | head -n 1 | tr -d '\n' > /rand"]
+		},
+		op.#Export & {
+			source: "/rand"
+		},
+	]
+}
 
-chartName: "test-helm"
+// Deploy user local chart
-
-// Example of a `helm install` using a local chart
-// Fill using:
-//          --input-dir helmChart.chart=./testdata/mychart
 TestHelmSimpleChart: {
-	helm.#Chart & {
+	// Deploy chart
-		name:        chartName
+	deploy: helm.#Chart & {
-		"namespace": namespace
+		name:        "dagger-test-helm-simple-chart-\(random)"
+		namespace:   "dagger-test"
 		kubeconfig:  config.contents
-		chart:       dagger.#Artifact
+		chartSource: dagger.#Artifact
 	}
 
+	// Verify deployment
 	verify: #VerifyHelm & {
-		"chartName": chartName
+		chartName: deploy.name
+		namespace: deploy.namespace
 	}
 }
 
-result: helmApply: TestHelmSimpleChart.verify
+// Deploy remote chart
+TestHelmRepoChart: {
+	// Deploy chart
+	deploy: helm.#Chart & {
+		name:       "dagger-test-helm-repository-\(random)"
+		namespace:  "dagger-test"
+		kubeconfig: config.contents
+		chart:      "redis"
+	}
+
+	// Verify deployment
+	verify: #VerifyHelm & {
+		chartName: deploy.name
+		namespace: deploy.namespace
+	}
+}

tests/stdlib/kubernetes/helm/testdata/mychart/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

tests/stdlib/kubernetes/helm/testdata/mychart/Chart.yaml

@@ -0,0 +1,21 @@
+apiVersion: v2
+name: mychart
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application.
+appVersion: 1.16.0

tests/stdlib/kubernetes/helm/testdata/mychart/templates/NOTES.txt

@@ -0,0 +1,21 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "mychart.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "mychart.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "mychart.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "mychart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
+{{- end }}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/_helpers.tpl

@@ -0,0 +1,63 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "mychart.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "mychart.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "mychart.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "mychart.labels" -}}
+helm.sh/chart: {{ include "mychart.chart" . }}
+{{ include "mychart.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}
+
+{{/*
+Selector labels
+*/}}
+{{- define "mychart.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "mychart.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "mychart.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+    {{ default (include "mychart.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+    {{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/deployment.yaml

@@ -0,0 +1,55 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "mychart.fullname" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "mychart.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      labels:
+        {{- include "mychart.selectorLabels" . | nindent 8 }}
+    spec:
+    {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      serviceAccountName: {{ include "mychart.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/ingress.yaml

@@ -0,0 +1,41 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "mychart.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+{{- if .Values.ingress.tls }}
+  tls:
+  {{- range .Values.ingress.tls }}
+    - hosts:
+      {{- range .hosts }}
+        - {{ . | quote }}
+      {{- end }}
+      secretName: {{ .secretName }}
+  {{- end }}
+{{- end }}
+  rules:
+  {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+        {{- range .paths }}
+          - path: {{ . }}
+            backend:
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+        {{- end }}
+  {{- end }}
+{{- end }}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/service.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "mychart.fullname" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "mychart.selectorLabels" . | nindent 4 }}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/serviceaccount.yaml

@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "mychart.serviceAccountName" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end -}}

tests/stdlib/kubernetes/helm/testdata/mychart/templates/tests/test-connection.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "{{ include "mychart.fullname" . }}-test-connection"
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  annotations:
+    "helm.sh/hook": test-success
+spec:
+  containers:
+    - name: wget
+      image: busybox
+      command: ['wget']
+      args: ['{{ include "mychart.fullname" . }}:{{ .Values.service.port }}']
+  restartPolicy: Never

tests/stdlib/kubernetes/helm/testdata/mychart/values.yaml

@@ -0,0 +1,68 @@
+# Default values for mychart.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: nginx
+  pullPolicy: IfNotPresent
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name:
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+
+ingress:
+  enabled: false
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths: []
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

tests/stdlib/kubernetes/helm/verify.cue

@@ -0,0 +1,51 @@
+package helm
+
+import (
+	"dagger.io/dagger/op"
+	"dagger.io/kubernetes"
+)
+
+#VerifyHelm: {
+	chartName: string
+
+	namespace: string
+
+	// Verify that pod exist
+	#getHelmPods:
+		"""
+        kubectl get pods --namespace "$KUBE_NAMESPACE" | grep "\(chartName)"
+    """
+
+	#up: [
+		op.#Load & {
+			from: kubernetes.#Kubectl
+		},
+
+		op.#WriteFile & {
+			dest:    "/kubeconfig"
+			content: config.contents
+			mode:    0o600
+		},
+
+		op.#WriteFile & {
+			dest:    "/getHelmPods.sh"
+			content: #getHelmPods
+		},
+
+		op.#Exec & {
+			always: true
+			args: [
+				"/bin/bash",
+				"--noprofile",
+				"--norc",
+				"-eo",
+				"pipefail",
+				"/getHelmPods.sh",
+			]
+			env: {
+				KUBECONFIG:     "/kubeconfig"
+				KUBE_NAMESPACE: namespace
+			}
+		},
+	]
+}

tests/stdlib/kubernetes/kubernetes.cue

@@ -3,6 +3,8 @@ package kubernetes
 import (
 	"encoding/yaml"
 	"dagger.io/dagger"
+	"dagger.io/dagger/op"
+	"dagger.io/alpine"
 	"dagger.io/file"
 	"dagger.io/kubernetes"
 )
@@ -17,36 +19,47 @@ config: file.#Read & {
 	from:     kubeconfig
 }
 
-// Pod uid
+// Generate a random number
-// Can be better if it's a random id in real test
+// It trigger a "cycle error" if I put it in TestKubeApply ?!
-uid: string
+// failed to up deployment: buildkit solve: TestKubeApply.#up: cycle error
-
+random: {
-kubeSrc: {
+	string
-	apiVersion: "v1"
+	#up: [
-	kind:       "Pod"
+		op.#Load & {from: alpine.#Image},
-	metadata: name: "kube-test-\(uid)"
+		op.#Exec & {
-	spec: {
+			args: ["sh", "-c", "cat /dev/urandom | tr -dc 'a-z' | fold -w 10 | head -n 1 | tr -d '\n' > /rand"]
-		restartPolicy: "Never"
+		},
-		containers: [{
+		op.#Export & {
-			name:  "test"
+			source: "/rand"
-			image: "hello-world"
+		},
-		}]
+	]
-	}
 }
 
-// Dagger test k8s namespace
-namespace: "dagger-test"
-
 TestKubeApply: {
-	kubernetes.#Apply & {
+	// Pod spec
+	kubeSrc: {
+		apiVersion: "v1"
+		kind:       "Pod"
+		metadata: name: "kube-test-\(random)"
+		spec: {
+			restartPolicy: "Never"
+			containers: [{
+				name:  "test"
+				image: "hello-world"
+			}]
+		}
+	}
+
+	// Apply deployment
+	apply: kubernetes.#Apply & {
 		kubeconfig:   config.contents
-		"namespace":  namespace
+		namespace:    "dagger-test"
 		sourceInline: yaml.Marshal(kubeSrc)
 	}
 
+	// Verify deployment
 	verify: #VerifyApply & {
-		podname: "kube-test-\(uid)"
+		podname:   kubeSrc.metadata.name
+		namespace: apply.namespace
 	}
 }
-
-result: kubeApply: TestKubeApply.verify

tests/stdlib/kubernetes/verify.cue

@@ -8,6 +8,8 @@ import (
 #VerifyApply: {
 	podname: string
 
+	namespace: string
+
 	// Verify that pod exist
 	#GetPods:
 		"""
@@ -27,7 +29,7 @@ import (
 
 		op.#WriteFile & {
 			dest:    "/kubeconfig"
-			content: Config.contents
+			content: config.contents
 			mode:    0o600
 		},
 

tests/test-stdlib.sh

@@ -17,6 +17,15 @@ test::stdlib(){
       "$dagger" "${DAGGER_BINARY_ARGS[@]}" compute "$d"/stdlib/file
   test::secret "$d"/stdlib/netlify/inputs.yaml "stdlib: netlify" \
       "$dagger" "${DAGGER_BINARY_ARGS[@]}" compute "$d"/stdlib/netlify
-  test::one "stdlib:: kubernetes" \
+
-      "$dagger" "${DAGGER_BINARY_ARGS[@]}" compute "$d"/stdlib/kubernetes --input-dir TestKubeconfig="/home/$USER/.kube"  --input-string uid="dagger-id"
+  # Check if there is a kubeconfig and if it for a kind cluster
+  if [ -f ~/.kube/config ] && grep -q "kind" ~/.kube/config &> /dev/null; then
+      test::one "stdlib: kubernetes" \
+      "$dagger" "${DAGGER_BINARY_ARGS[@]}" compute "$d"/stdlib/kubernetes --input-dir kubeconfig=~/.kube
+      test::one "stdlib: helm" \
+        "$dagger" "${DAGGER_BINARY_ARGS[@]}" compute "$d"/stdlib/kubernetes/helm --input-dir kubeconfig=~/.kube --input-dir TestHelmSimpleChart.deploy.chartSource="$d"/stdlib/kubernetes/helm/testdata/mychart
+  else
+    logger::warning "Skip kubernetes test: local cluster not available"
+  fi
+
 }