feat: fix unsupported overrides and add e2e test (#222)

fix the unsupported overrides feature and adds an e2e test for it.

Author: ricardomaraschini

.github/workflows/e2e.yaml

@@ -17,6 +17,7 @@ jobs:
         - TestMultiNodeInteractiveInstallation
         - TestInstallWithDisabledAddons
         - TestHostPreflight
+        - TestUnsupportedOverrides
     steps:
     - name: Move Docker aside
       run: |

e2e/kots-release/config.yaml

@@ -18,8 +18,9 @@ spec:
         name: xyz
   unsupportedOverrides:
     k0s: |
-      metadata:
-        name: foo
-      spec:
-        telemetry:
-          enabled: false
+      config:
+        metadata:
+          name: foo
+        spec:
+          telemetry:
+            enabled: false

e2e/scripts/unsupported-overrides.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+embedded_cluster_config="
+apiVersion: embeddedcluster.replicated.com/v1beta1
+kind: Config
+spec:
+  unsupportedOverrides:
+    k0s: |
+      config:
+        metadata:
+          name: testing-overrides-k0s-name
+        spec:
+          telemetry:
+            enabled: true
+"
+
+embed_cluster_config() {
+    content="$1"
+    echo "$content" > /root/release.yaml
+    tar -czvf /root/release.tar.gz /root/release.yaml
+    objcopy --input-target binary --output-target binary --rename-section .data=sec_bundle /root/release.tar.gz /root/release.o
+    objcopy --update-section sec_bundle=/root/release.o /usr/local/bin/embedded-cluster
+}
+
+wait_for_healthy_node() {
+    ready=$(kubectl get nodes | grep -v NotReady | grep -c Ready || true)
+    counter=0
+    while [ "$ready" -lt "1" ]; do
+        if [ "$counter" -gt 36 ]; then
+            return 1
+        fi
+        sleep 5
+        counter=$((counter+1))
+        echo "Waiting for node to be ready"
+        ready=$(kubectl get nodes | grep -v NotReady | grep -c Ready || true)
+        kubectl get nodes || true
+    done
+    return 0
+}
+
+override_applied() {
+    grep -A1 telemetry "$K0SCTLCONFIG" > /tmp/telemetry-section
+    if ! grep -q "enabled: true" /tmp/telemetry-section; then
+      echo "override not applied, expected telemetry true, actual config:"
+      cat "$K0SCTLCONFIG"
+      return 1
+    fi
+    if ! grep "testing-overrides-k0s-name" "$K0SCTLCONFIG"; then
+      echo "override not applied, expected name testing-overrides-k0s-name, actual config:"
+      cat "$K0SCTLCONFIG"
+      return 1
+    fi
+}
+
+main() {
+    cp -Rfp /usr/local/bin/embedded-cluster /usr/local/bin/embedded-cluster-copy
+    embed_cluster_config "$embedded_cluster_config"
+    if ! embedded-cluster install --no-prompt 2>&1 | tee /tmp/log ; then
+        echo "Failed to install embedded-cluster"
+        cat /tmp/log
+        exit 1
+    fi
+    if ! grep -q "Admin Console is ready!" /tmp/log; then
+        echo "Failed to install embedded-cluster"
+        exit 1
+    fi
+    if ! override_applied; then
+        echo "Expected override to be applied"
+        exit 1
+    fi
+}
+
+export EMBEDDED_CLUSTER_METRICS_BASEURL="https://staging.replicated.app"
+export KUBECONFIG=/root/.config/.embedded-cluster/etc/kubeconfig
+export K0SCTLCONFIG=/root/.config/.embedded-cluster/etc/k0sctl.yaml
+export PATH=$PATH:/root/.config/.embedded-cluster/bin
+main

e2e/unsupported-overrides_test.go

@@ -0,0 +1,35 @@
+package e2e
+
+import (
+	"testing"
+
+	"github.com/replicatedhq/embedded-cluster/e2e/cluster"
+)
+
+func TestUnsupportedOverrides(t *testing.T) {
+	t.Parallel()
+	tc := cluster.NewTestCluster(&cluster.Input{
+		T:                   t,
+		Nodes:               1,
+		Image:               "ubuntu/jammy",
+		SSHPublicKey:        "../output/tmp/id_rsa.pub",
+		SSHPrivateKey:       "../output/tmp/id_rsa",
+		EmbeddedClusterPath: "../output/bin/embedded-cluster",
+	})
+	defer tc.Destroy()
+	t.Log("installing dependencies on node 0")
+	commands := [][]string{
+		{"apt-get", "update", "-y"},
+		{"apt-get", "install", "openssh-server", "binutils", "-y"},
+	}
+	if err := RunCommandsOnNode(t, tc, 0, commands); err != nil {
+		t.Fatalf("fail to install ssh on node %s: %v", tc.Nodes[0], err)
+	}
+	t.Log("installing embedded-cluster with unsupported overrides on node 0")
+	line := []string{"unsupported-overrides.sh"}
+	if stdout, stderr, err := RunCommandOnNode(t, tc, 0, line); err != nil {
+		t.Log(stdout)
+		t.Log(stderr)
+		t.Fatalf("fail to install embedded-cluster on node %s: %v", tc.Nodes[0], err)
+	}
+}

pkg/config/config.go

@@ -71,7 +71,7 @@ func RenderClusterConfig(ctx context.Context, multi bool) (*v1beta1.Cluster, err
 		return nil, fmt.Errorf("unable to render single-node config: %w", err)
 	}
 	ApplyEmbeddedUnsupportedOverrides(cfg, clusterConfig.Spec.UnsupportedOverrides.K0s)
-	return renderSingleNodeConfig(ctx)
+	return cfg, nil
 }
 
 // listUserSSHKeys returns a list of private SSH keys in the user's ~/.ssh directory.