Merge pull request #2050 from tukobadnyanoba/add-e2e-test

Added e2e tests for port forwarding, reverse port forwarding and uploadExcludePaths

Author: FabianKramm

README.md

@@ -1060,7 +1060,7 @@ This project is mainly written in Golang. If you want to contribute code:
 5. Build the project, e.g. via `go build -o devspace[.exe]`
 6. Evaluate and test your changes `./devspace [SOME_COMMAND]`
 
-See [Contributing Guideslines](CONTRIBUTING.md) for more information.
+See [Contributing Guidelines](CONTRIBUTING.md) for more information.
 
 <br>
 

e2e/e2e_suite_test.go

@@ -19,6 +19,7 @@ import (
 	_ "github.com/loft-sh/devspace/e2e/tests/imports"
 	_ "github.com/loft-sh/devspace/e2e/tests/init"
 	_ "github.com/loft-sh/devspace/e2e/tests/pipelines"
+	_ "github.com/loft-sh/devspace/e2e/tests/portforward"
 	_ "github.com/loft-sh/devspace/e2e/tests/proxycommands"
 	_ "github.com/loft-sh/devspace/e2e/tests/pullsecret"
 	_ "github.com/loft-sh/devspace/e2e/tests/render"

e2e/framework/helper.go

@@ -2,15 +2,15 @@ package framework
 
 import (
 	"fmt"
-	"io/ioutil"
-	"os"
-	"strings"
-	"time"
-
+	"github.com/go-resty/resty/v2"
 	"github.com/loft-sh/devspace/e2e/kube"
 	"github.com/onsi/gomega"
 	"github.com/pkg/errors"
+	"io/ioutil"
 	"k8s.io/apimachinery/pkg/util/wait"
+	"os"
+	"strings"
+	"time"
 )
 
 // ExpectEqual expects the specified two are the same, otherwise an exception raises
@@ -28,7 +28,7 @@ func ExpectError(err error, explain ...interface{}) {
 	gomega.ExpectWithOffset(1, err).To(gomega.HaveOccurred(), explain...)
 }
 
-// ExpectMatchError expects an error happens and has a message matching the given string, otherwise an exception raises
+// ExpectErrorMatch ExpectMatchError expects an error happens and has a message matching the given string, otherwise an exception raises
 func ExpectErrorMatch(err error, msg string, explain ...interface{}) {
 	gomega.ExpectWithOffset(1, err).To(gomega.HaveOccurred(), explain...)
 	gomega.ExpectWithOffset(1, err, explain...).To(gomega.MatchError(msg), explain...)
@@ -75,6 +75,30 @@ func ExpectRemoteFileContents(imageSelector string, namespace string, filePath s
 	ExpectNoErrorWithOffset(1, err)
 }
 
+func ExpectLocalCurlContents(urlString string, contents string) {
+	client := resty.New()
+	err := wait.PollImmediate(time.Second, time.Minute*2, func() (done bool, err error) {
+		resp, _ := client.R().
+			EnableTrace().
+			Get(urlString)
+		return strings.TrimSpace(string(resp.Body())) == strings.TrimSpace(contents), nil
+	})
+	ExpectNoErrorWithOffset(1, err)
+}
+
+func ExpectRemoteCurlContents(imageSelector string, namespace string, urlString string, contents string) {
+	kubeClient, err := kube.NewKubeHelper()
+	ExpectNoErrorWithOffset(1, err)
+	err = wait.PollImmediate(time.Second, time.Minute*2, func() (done bool, err error) {
+		out, err := kubeClient.ExecByImageSelector(imageSelector, namespace, []string{"curl", urlString})
+		if err != nil {
+			return false, nil
+		}
+		return strings.TrimSpace(out) == strings.TrimSpace(contents), nil
+	})
+	ExpectNoErrorWithOffset(1, err)
+}
+
 func ExpectRemoteFileNotFound(imageSelector string, namespace string, filePath string) {
 	kubeClient, err := kube.NewKubeHelper()
 	ExpectNoErrorWithOffset(1, err)

e2e/tests/pipelines/pipelines.go

@@ -14,7 +14,7 @@ import (
 	"github.com/onsi/ginkgo"
 )
 
-var _ = DevSpaceDescribe("portforward", func() {
+var _ = DevSpaceDescribe("pipelines", func() {
 	initialDir, err := os.Getwd()
 	if err != nil {
 		panic(err)

e2e/tests/portforward/portforward.go

@@ -1,23 +1,85 @@
 package portforward
 
 import (
+	"context"
+	"fmt"
+	"github.com/loft-sh/devspace/cmd"
+	"github.com/loft-sh/devspace/cmd/flags"
+	"github.com/loft-sh/devspace/e2e/framework"
+	"github.com/loft-sh/devspace/e2e/kube"
+	"github.com/loft-sh/devspace/pkg/util/factory"
 	"github.com/onsi/ginkgo"
+	"net/http"
+	"os"
 )
 
 var _ = DevSpaceDescribe("portforward", func() {
-	ginkgo.It("should forward ports", func() {
-		// TODO
-	})
+	initialDir, err := os.Getwd()
+	if err != nil {
+		panic(err)
+	}
 
-	ginkgo.It("should restart port forwarding", func() {
-		// TODO
-	})
+	// create a new factory
+	var (
+		f          factory.Factory
+		kubeClient *kube.KubeHelper
+	)
+
+	ginkgo.BeforeEach(func() {
+		f = framework.NewDefaultFactory()
 
-	ginkgo.It("should reverse forward ports", func() {
-		// TODO
+		kubeClient, err = kube.NewKubeHelper()
+		framework.ExpectNoError(err)
+
+		go func() {
+			http.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
+				_, _ = fmt.Fprintf(w, "Hello World!")
+			})
+			fmt.Println("Server started at port 8888")
+			err := http.ListenAndServe(":8888", nil)
+			framework.ExpectNoError(err)
+		}()
 	})
 
-	ginkgo.It("should restart reverse forward ports", func() {
-		// TODO
+	ginkgo.It("should forward and reverse forward ports", func() {
+		tempDir, err := framework.CopyToTempDir("tests/portforward/testdata/portforward-simple")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("portforward")
+		framework.ExpectNoError(err)
+		defer framework.ExpectDeleteNamespace(kubeClient, ns)
+
+		// create a new dev command and start it
+		done := make(chan error)
+		cancelCtx, cancel := context.WithCancel(context.Background())
+		defer cancel()
+
+		go func() {
+			defer ginkgo.GinkgoRecover()
+			devCmd := &cmd.RunPipelineCmd{
+				GlobalFlags: &flags.GlobalFlags{
+					NoWarn:     true,
+					Namespace:  ns,
+					ConfigPath: "devspace.yaml",
+				},
+				Pipeline: "dev",
+				Ctx:      cancelCtx,
+			}
+			done <- devCmd.RunDefault(f)
+		}()
+
+		nginxResp := "<!DOCTYPE html>\n<html>\n<head>\n<title>Welcome to nginx!</title>\n<style>\nhtml { color-scheme: light dark; }\nbody { width: 35em; margin: 0 auto;\nfont-family: Tahoma, Verdana, Arial, sans-serif; }\n</style>\n</head>\n<body>\n<h1>Welcome to nginx!</h1>\n<p>If you see this page, the nginx web server is successfully installed and\nworking. Further configuration is required.</p>\n\n<p>For online documentation and support please refer to\n<a href=\"http://nginx.org/\">nginx.org</a>.<br/>\nCommercial support is available at\n<a href=\"http://nginx.com/\">nginx.com</a>.</p>\n\n<p><em>Thank you for using nginx.</em></p>\n</body>\n</html>"
+		framework.ExpectRemoteCurlContents("nginx", ns, "localhost", nginxResp)
+		framework.ExpectLocalCurlContents("http://localhost:3000", nginxResp)
+
+		httpServerResp := "Hello World!"
+		framework.ExpectLocalCurlContents("http://localhost:8888", httpServerResp)
+		framework.ExpectRemoteCurlContents("nginx", ns, "localhost:8888", httpServerResp)
+
+		cancel()
+		err = <-done
+		framework.ExpectNoError(err)
 	})
+
 })

e2e/tests/portforward/testdata/portforward-simple/devspace.yaml

@@ -0,0 +1,17 @@
+version: v2beta1
+name: portforward-ex
+
+deployments:
+  app:
+    helm:
+      values:
+        containers:
+          - image: nginx
+#            imagePullPolicy: Never
+dev:
+  app:
+    imageSelector: nginx
+    ports:
+      - port: "3000:80"
+    reversePorts:
+      - port: "8888:8888"

e2e/tests/sync/sync.go

@@ -551,6 +551,73 @@ var _ = DevSpaceDescribe("sync", func() {
 		waitGroup.Wait()
 	})
 
+	ginkgo.It("should sync to a pod container with uploadExcludePaths configuration", func() {
+		tempDir, err := framework.CopyToTempDir("tests/sync/testdata/sync-exclude-dir")
+		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)
+		}()
+
+		// deploy app to sync
+		deployCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "devspace.yaml",
+			},
+			Pipeline: "deploy",
+		}
+		err = deployCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		cancelCtx, stop := context.WithCancel(context.Background())
+		defer stop()
+
+		// sync command
+		syncCmd := &cmd.SyncCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "devspace.yaml",
+			},
+			Wait: true,
+			Ctx:  cancelCtx,
+		}
+
+		// start the command
+		waitGroup := sync.WaitGroup{}
+		waitGroup.Add(1)
+		go func() {
+			defer ginkgo.GinkgoRecover()
+			defer waitGroup.Done()
+			err = syncCmd.Run(f)
+			framework.ExpectNoError(err)
+		}()
+
+		// check that uploadExcludePaths folder was not synced
+		framework.ExpectRemoteFileNotFound("alpine", ns, "/app/node_modules")
+
+		// check that included file was synced
+		framework.ExpectRemoteFileContents("alpine", ns, "/app/syncme/file.txt", "I will be synced")
+
+		// write a file and check that it got synced
+		payload := randutil.GenerateRandomString(10000)
+		err = ioutil.WriteFile(filepath.Join(tempDir, "watching.txt"), []byte(payload), 0666)
+		framework.ExpectNoError(err)
+		framework.ExpectRemoteFileContents("alpine", ns, "/app/watching.txt", payload)
+
+		// stop command
+		stop()
+
+		// wait for the command to finish
+		waitGroup.Wait()
+	})
+
 	ginkgo.It("should sync to a pod container with excludeFile, downloadExcludeFile, and uploadExcludeFile configuration", func() {
 		tempDir, err := framework.CopyToTempDir("tests/sync/testdata/sync-exclude-file")
 		framework.ExpectNoError(err)

e2e/tests/sync/testdata/sync-exclude-dir/devspace.yaml

@@ -0,0 +1,26 @@
+version: v2beta1
+vars:
+  IMAGE: alpine
+deployments:
+  test:
+    helm:
+      chart:
+        name: component-chart
+        repo: https://charts.devspace.sh
+      values:
+        containers:
+          - image: ${IMAGE}
+            command: ["sleep"]
+            args: ["999999999999"]
+pipelines:
+  deploy: |-
+    run_dependencies --all
+    create_deployments --all
+    echo "dep2" >> out.txt
+dev:
+  test:
+    imageSelector: ${IMAGE}
+    sync:
+      - path: ./:/app
+        uploadExcludePaths:
+          - node_modules/

e2e/tests/sync/testdata/sync-exclude-dir/node_modules/nodemon/nodemon.js

@@ -0,0 +1 @@
+I will be synced