[tests] Add basic GitHub context tests

Author: geropl

test/pkg/integration/integration.go

@@ -51,11 +51,8 @@ var (
 // NewTest produces a new integration test instance
 func NewTest(t *testing.T) *Test {
 	flag.Parse()
-
 	kubeconfig := *cfgFlag
 	namespaceOverride := *namespaceFlag
-	t.Logf("kubeconfig: %s", kubeconfig)
-	t.Logf("namespaceOverride: %s", namespaceOverride)
 
 	if kubeconfig == cfgFlagDefault {
 		home, err := os.UserHomeDir()

test/tests/workspace/contexts_test.go

@@ -0,0 +1,88 @@
+// 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 workspace_test
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/gitpod-io/gitpod/test/pkg/integration"
+	git "github.com/gitpod-io/gitpod/test/tests/workspace/git"
+	wsapi "github.com/gitpod-io/gitpod/ws-manager/api"
+)
+
+type ContextTest struct {
+	Name           string
+	ContextURL     string
+	WorkspaceRoot  string
+	ExpectedBranch string
+}
+
+func TestGitHubContexts(t *testing.T) {
+	tests := []ContextTest{
+		{
+			Name:           "open repository",
+			ContextURL:     "github.com/gitpod-io/gitpod",
+			WorkspaceRoot:  "/workspace/gitpod",
+			ExpectedBranch: "main",
+		},
+		{
+			Name:           "open issue",
+			ContextURL:     "github.com/gitpod-io/gitpod-test-repo/issues/88",
+			WorkspaceRoot:  "/workspace/gitpod-test-repo",
+			ExpectedBranch: "main",
+		},
+		{
+			Name:           "open tag",
+			ContextURL:     "github.com/gitpod-io/gitpod-test-repo/tree/integration-test-context-tag",
+			WorkspaceRoot:  "/workspace/gitpod-test-repo",
+			ExpectedBranch: "HEAD",
+		},
+	}
+	runContextTests(t, tests)
+}
+
+func runContextTests(t *testing.T, tests []ContextTest) {
+	for _, test := range tests {
+		t.Run(test.ContextURL, func(t *testing.T) {
+			t.Parallel()
+
+			it := integration.NewTest(t)
+			defer it.Done()
+
+			nfo := integration.LaunchWorkspaceFromContextURL(it, test.ContextURL)
+
+			ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
+			defer cancel()
+			it.WaitForWorkspace(ctx, nfo.LatestInstance.ID)
+
+			rsa, err := it.Instrument(integration.ComponentWorkspace, "workspace", integration.WithInstanceID(nfo.LatestInstance.ID))
+			if err != nil {
+				t.Fatal(err)
+			}
+			defer rsa.Close()
+
+			// get actual from workspace
+			actBranch := git.GetBranch(t, rsa, test.WorkspaceRoot)
+			rsa.Close()
+
+			ctx, cancel = context.WithTimeout(ctx, 10*time.Second)
+			defer cancel()
+			_, err = it.API().WorkspaceManager().StopWorkspace(ctx, &wsapi.StopWorkspaceRequest{
+				Id: nfo.LatestInstance.ID,
+			})
+			if err != nil {
+				t.Fatal(err)
+				return
+			}
+
+			// perform actual comparion
+			if actBranch != test.ExpectedBranch {
+				t.Fatalf("expected branch '%s', got '%s'!", test.ExpectedBranch, actBranch)
+			}
+		})
+	}
+}

test/tests/workspace/git/git.go

@@ -0,0 +1,48 @@
+// 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 git
+
+import (
+	"fmt"
+	"net/rpc"
+	"testing"
+
+	agent "github.com/gitpod-io/gitpod/test/tests/workspace/workspace_agent/api"
+)
+
+func GetBranch(t *testing.T, rsa *rpc.Client, workspaceRoot string) string {
+	var resp agent.ExecResponse
+	err := rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
+		Dir:     workspaceRoot,
+		Command: "git",
+		Args:    []string{"rev-parse", "--abbrev-ref", "HEAD"},
+	}, &resp)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if resp.ExitCode != 0 {
+		t.Fatal(fmt.Errorf("getBranch returned rc: %d", resp.ExitCode))
+	}
+	return resp.Stdout
+}
+
+func Commit(t *testing.T, rsa *rpc.Client, workspaceRoot string, message string, all bool) {
+	args := []string{"commit", "-m", message}
+	if all {
+		args = append(args, "--all")
+	}
+	var resp agent.ExecResponse
+	err := rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
+		Dir:     workspaceRoot,
+		Command: "git",
+		Args:    args,
+	}, &resp)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if resp.ExitCode != 0 {
+		t.Fatal(fmt.Errorf("commit returned rc: %d", resp.ExitCode))
+	}
+}

test/tests/workspace/workspace_agent/api/api.go

@@ -26,3 +26,15 @@ type WriteFileRequest struct {
 // WriteFileResponse is the response for WriteFile
 type WriteFileResponse struct {
 }
+
+type ExecRequest struct {
+	Dir     string
+	Command string
+	Args    []string
+}
+
+type ExecResponse struct {
+	ExitCode int
+	Stdout   string
+	Stderr   string
+}

test/tests/workspace/workspace_agent/main.go

@@ -5,7 +5,9 @@
 package main
 
 import (
+	"bytes"
 	"io/ioutil"
+	"os/exec"
 
 	"github.com/gitpod-io/gitpod/test/pkg/integration"
 	"github.com/gitpod-io/gitpod/test/tests/workspace/workspace_agent/api"
@@ -43,3 +45,34 @@ func (*WorkspaceAgent) WriteFile(req *api.WriteFileRequest, resp *api.WriteFileR
 	*resp = api.WriteFileResponse{}
 	return
 }
+
+// Exec writes a file in the workspace
+func (*WorkspaceAgent) Exec(req *api.ExecRequest, resp *api.ExecResponse) (err error) {
+	cmd := exec.Command(req.Command, req.Args...)
+	var (
+		stdout bytes.Buffer
+		stderr bytes.Buffer
+	)
+	if req.Dir != "" {
+		cmd.Dir = req.Dir
+	}
+	cmd.Stdout = &stdout
+	cmd.Stderr = &stderr
+	err = cmd.Run()
+
+	var rc int
+	if err != nil {
+		exitError, ok := err.(*exec.ExitError)
+		if !ok {
+			return err
+		}
+		rc = exitError.ExitCode()
+	}
+
+	*resp = api.ExecResponse{
+		ExitCode: rc,
+		Stdout:   stdout.String(),
+		Stderr:   stderr.String(),
+	}
+	return
+}