chore(sync): Add end to end test case for SyncReplicas feature

Author: atidyshirt

e2e/framework/helper.go

@@ -11,6 +11,7 @@ import (
 	"github.com/loft-sh/devspace/e2e/kube"
 	"github.com/onsi/gomega"
 	"github.com/pkg/errors"
+	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/wait"
 )
@@ -169,6 +170,52 @@ func ExpectRemoteContainerFileContents(labelSelector, container string, namespac
 	ExpectNoErrorWithOffset(1, err)
 }
 
+func ExpectRemoteFileContentsOnAllPods(labelSelector, containerName, namespace, filePath, contents string, wantCount int) {
+	kubeClient, err := kube.NewKubeHelper()
+	ExpectNoErrorWithOffset(1, err)
+
+	want := strings.TrimSpace(contents)
+	err = wait.PollUntilContextTimeout(context.TODO(), time.Second, time.Minute*3, true, func(ctx context.Context) (done bool, err error) {
+		pods, err := kubeClient.RawClient().CoreV1().Pods(namespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelector})
+		if err != nil {
+			return false, nil
+		}
+		readyPods := make([]corev1.Pod, 0, len(pods.Items))
+		for _, p := range pods.Items {
+			if p.Status.Phase != corev1.PodRunning {
+				continue
+			}
+			if !podContainerReady(&p, containerName) {
+				continue
+			}
+			readyPods = append(readyPods, p)
+		}
+		if len(readyPods) < wantCount {
+			return false, nil
+		}
+		for i := range readyPods {
+			out, err := kubeClient.ExecInPod(ctx, &readyPods[i], containerName, []string{"cat", filePath})
+			if err != nil {
+				return false, nil
+			}
+			if strings.TrimSpace(out) != want {
+				return false, nil
+			}
+		}
+		return true, nil
+	})
+	ExpectNoErrorWithOffset(1, err)
+}
+
+func podContainerReady(pod *corev1.Pod, containerName string) bool {
+	for _, cs := range pod.Status.ContainerStatuses {
+		if cs.Name == containerName {
+			return cs.Ready
+		}
+	}
+	return false
+}
+
 func ExpectLocalFileContentsImmediately(filePath string, contents string) {
 	out, err := os.ReadFile(filePath)
 	ExpectNoError(err)

e2e/kube/kube.go

@@ -98,3 +98,12 @@ func (k *KubeHelper) DeleteNamespace(name string) error {
 	}
 	return nil
 }
+
+// ExecInPod runs a command in an existing pod container (used when multiple pods match a selector).
+func (k *KubeHelper) ExecInPod(ctx context.Context, pod *corev1.Pod, containerName string, command []string) (string, error) {
+	stdout, stderr, err := k.client.ExecBuffered(ctx, pod, containerName, command, nil)
+	if err != nil {
+		return "", fmt.Errorf("exec error: %v %s", err, string(stderr))
+	}
+	return string(stdout), nil
+}

e2e/tests/sync/sync.go

@@ -846,4 +846,55 @@ var _ = DevSpaceDescribe("sync", func() {
 		// wait for the command to finish
 		waitGroup.Wait()
 	})
+
+	ginkgo.It("should sync to all replicas when syncReplicas is enabled", func() {
+		tempDir, err := framework.CopyToTempDir("tests/sync/testdata/sync-replicas")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("sync")
+		framework.ExpectNoError(err)
+		defer func() {
+			err := kubeClient.DeleteNamespace(ns)
+			framework.ExpectNoError(err)
+		}()
+
+		cancelCtx, cancel := context.WithCancel(context.Background())
+		defer cancel()
+
+		devCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:    true,
+				Namespace: ns,
+			},
+			Pipeline: "dev",
+			Ctx:      cancelCtx,
+		}
+
+		waitGroup := sync.WaitGroup{}
+		waitGroup.Add(1)
+		go func() {
+			defer ginkgo.GinkgoRecover()
+			defer waitGroup.Done()
+			err = devCmd.RunDefault(f)
+			framework.ExpectNoError(err)
+		}()
+
+		const (
+			podLabel     = "app.kubernetes.io/name=sync-replicas"
+			container    = "app"
+			replicaCount = 2
+		)
+
+		framework.ExpectRemoteFileContentsOnAllPods(podLabel, container, ns, "/app/file1.txt", "Hello World", replicaCount)
+
+		payload := randutil.GenerateRandomString(5000)
+		err = os.WriteFile(filepath.Join(tempDir, "replica-upload.txt"), []byte(payload), 0666)
+		framework.ExpectNoError(err)
+
+		framework.ExpectRemoteFileContentsOnAllPods(podLabel, container, ns, "/app/replica-upload.txt", payload, replicaCount)
+
+		cancel()
+		waitGroup.Wait()
+	})
 })

e2e/tests/sync/testdata/sync-replicas/devspace.yaml

@@ -0,0 +1,19 @@
+version: v2beta1
+vars:
+  IMAGE: alpine:3.20
+deployments:
+  test:
+    kubectl:
+      manifests:
+        - k8s/deployment.yaml
+pipelines:
+  deploy: |-
+    run_dependencies --all
+    create_deployments --all
+dev:
+  test:
+    imageSelector: ${IMAGE}
+    sync:
+      - path: ./:/app
+        waitInitialSync: true
+        syncReplicas: true

e2e/tests/sync/testdata/sync-replicas/file1.txt

@@ -0,0 +1 @@
+Hello World

e2e/tests/sync/testdata/sync-replicas/k8s/deployment.yaml

@@ -0,0 +1,20 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: sync-replicas
+  labels:
+    app.kubernetes.io/name: sync-replicas
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: sync-replicas
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: sync-replicas
+    spec:
+      containers:
+        - name: app
+          image: alpine:3.20
+          command: ["tail", "-f", "/dev/null"]