feat: add integration tests for ssh gateway

Author: Andrea Falzetti

.werft/ide-integration-tests-startup.yaml

@@ -177,7 +177,7 @@ pod:
 
           [[ "$USERNAME" != "" ]] && args+=( "-username=$USERNAME" )
 
-          IDE_TEST_LIST=(/workspace/test/tests/ide/vscode /workspace/test/tests/ide/jetbrains)
+          IDE_TEST_LIST=(/workspace/test/tests/ide/ssh /workspace/test/tests/ide/vscode /workspace/test/tests/ide/jetbrains)
           for TEST_PATH in "${IDE_TEST_LIST[@]}"
           do
               TEST_NAME=$(basename "${TEST_PATH}")

.werft/installer-tests.ts

@@ -227,6 +227,12 @@ const WORKSPACES_TESTS: { [name: string]: InfraConfig } = {
 };
 
 const IDE_TESTS: { [name: string]: InfraConfig } = {
+    SSH_TEST: {
+        phase: "run-ssh-tests",
+        makeTarget: "run-ssh-tests",
+        description: "SSH Gateway tests",
+        slackhook: slackHook.get("ide-jobs"),
+    },
     VSCODE_IDE_TEST: {
         phase: "run-vscode-ide-tests",
         makeTarget: "run-vscode-ide-tests",
@@ -238,7 +244,7 @@ const IDE_TESTS: { [name: string]: InfraConfig } = {
         makeTarget: "run-jb-ide-tests",
         description: "jetbrains IDE tests",
         slackhook: slackHook.get("ide-jobs"),
-    }
+    },
 }
 
 

install/tests/Makefile

@@ -470,6 +470,9 @@ run-vscode-ide-tests:
 run-jb-ide-tests:
 	$(call runtests,"test/tests/ide/jetbrains/")
 
+run-ssh-tests:
+	$(call runtests,"test/tests/ide/ssh/")
+
 run-cs-component-tests:
 	$(call runtests,"test/tests/components/content-service/")
 

test/go.mod

@@ -74,6 +74,7 @@ require (
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.11.3 // indirect
 	github.com/hashicorp/golang-lru v0.5.4 // indirect
+	github.com/helloyi/go-sshclient v1.1.1 // indirect
 	github.com/heptiolabs/healthcheck v0.0.0-20211123025425-613501dd5deb // indirect
 	github.com/imdario/mergo v0.3.12 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect

test/go.sum

@@ -20,7 +20,7 @@ FAILURE_COUNT=0
 LOGS_DIR=$(mktemp -d)
 
 WEBAPP_TEST_LIST="$THIS_DIR/tests/components/database $THIS_DIR/tests/components/server"
-IDE_TEST_LIST="$THIS_DIR/tests/ide/vscode $THIS_DIR/tests/ide/jetbrains"
+IDE_TEST_LIST="$THIS_DIR/tests/ide/ssh $THIS_DIR/tests/ide/vscode $THIS_DIR/tests/ide/jetbrains"
 WORKSPACE_TEST_LIST="$THIS_DIR/tests/components/content-service $THIS_DIR/tests/components/image-builder $THIS_DIR/tests/components/ws-daemon $THIS_DIR/tests/components/ws-manager $THIS_DIR/tests/workspace"
 
 case $TEST_SUITE in

test/run.sh

@@ -0,0 +1,26 @@
+// Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package ide
+
+import (
+	"context"
+	"os"
+	"testing"
+
+	"github.com/gitpod-io/gitpod/test/pkg/integration"
+	"sigs.k8s.io/e2e-framework/pkg/env"
+)
+
+var (
+	testEnv    env.Environment
+	username   string
+	namespace  string
+	kubeconfig string
+)
+
+func TestMain(m *testing.M) {
+	username, namespace, testEnv, _, kubeconfig, _ = integration.Setup(context.Background())
+	os.Exit(testEnv.Run(m))
+}

test/tests/ide/ssh/main_test.go

@@ -0,0 +1,116 @@
+// Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package ide
+
+import (
+	"context"
+	"io"
+	"log"
+	"net/url"
+	"os"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/helloyi/go-sshclient"
+	"sigs.k8s.io/e2e-framework/pkg/envconf"
+	"sigs.k8s.io/e2e-framework/pkg/features"
+
+	gitpod "github.com/gitpod-io/gitpod/gitpod-protocol"
+	"github.com/gitpod-io/gitpod/test/pkg/integration"
+)
+
+func TestSSHGatewayConnection(t *testing.T) {
+	userToken, _ := os.LookupEnv("USER_TOKEN")
+	integration.SkipWithoutUsername(t, username)
+	integration.SkipWithoutUserToken(t, userToken)
+
+	f := features.New("TestSSHGatewayConnection").
+		WithLabel("component", "server").
+		Assess("it can connect to a workspace via SSH gateway", func(_ context.Context, t *testing.T, cfg *envconf.Config) context.Context {
+			ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
+			defer cancel()
+
+			api := integration.NewComponentAPI(ctx, cfg.Namespace(), kubeconfig, cfg.Client())
+			t.Cleanup(func() {
+				api.Done(t)
+			})
+
+			_, err := api.CreateUser(username, userToken)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			serverOpts := []integration.GitpodServerOpt{integration.WithGitpodUser(username)}
+			server, err := api.GitpodServer(serverOpts...)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			// This env var caused an incident https://www.gitpodstatus.com/incidents/26gwnhcpvqqx before
+			// Which was introduced by PR https://github.com/gitpod-io/gitpod/pull/13822
+			// And fixed by PR https://github.com/gitpod-io/gitpod/pull/13858
+			_ = server.SetEnvVar(ctx, &gitpod.UserEnvVarValue{
+				Name:              "TEST",
+				RepositoryPattern: "*/*",
+				Value:             "\\\"test space\\\"",
+			})
+
+			_ = server.SetEnvVar(ctx, &gitpod.UserEnvVarValue{
+				Name:              "TEST_MULTIPLE_LINES",
+				RepositoryPattern: "*/*",
+				Value: `Hello
+World`,
+			})
+
+			nfo, stopWs, err := integration.LaunchWorkspaceFromContextURL(t, ctx, "github.com/gitpod-io/empty", username, api)
+			if err != nil {
+				t.Fatal(err)
+			}
+			defer func() {
+				sctx, scancel := context.WithTimeout(context.Background(), 5*time.Minute)
+				defer scancel()
+
+				sapi := integration.NewComponentAPI(sctx, cfg.Namespace(), kubeconfig, cfg.Client())
+				defer sapi.Done(t)
+
+				stopWs(true, sapi)
+			}()
+
+			wsUrl, err := url.Parse(nfo.LatestInstance.IdeURL)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			wId := nfo.Workspace.ID
+			ownerToken, err := server.GetOwnerToken(ctx, wId)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			urlComponents := strings.Split(wsUrl.Host, ".")
+			connUrl := []string{urlComponents[0], "ssh"}
+			connUrl = append(connUrl, urlComponents[1:]...)
+			connUrlStr := strings.Join(connUrl, ".")
+
+			cli, err := sshclient.DialWithPasswd(connUrlStr+":22", wId, ownerToken)
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			output, err := cli.Cmd("gp info").Output()
+			if err != nil && err != io.EOF {
+				log.Println("[error]", err)
+				time.Sleep(1 * time.Second)
+			}
+
+			t.Log(string(output))
+
+			return ctx
+		}).
+		Feature()
+
+	testEnv.Test(t, f)
+}