test: fall back to check the init task message and file exits

Signed-off-by: JenTing Hsiao <[email protected]>

Author: jenting

test/tests/components/ws-manager/prebuild_test.go

@@ -7,6 +7,7 @@ package wsmanager
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"path/filepath"
 	"reflect"
@@ -180,8 +181,22 @@ func TestPrebuildWorkspaceTaskFail(t *testing.T) {
 const (
 	prebuildLogPath string = "/workspace/.gitpod"
 	prebuildLog     string = "'🤙 This task ran as a workspace prebuild'"
+	initTask        string = "echo \"some output\" > someFile; sleep 20; exit 0;"
 )
 
+// TestOpenWorkspaceFromPrebuild
+// - create a prebuild
+// - open the workspace from prebuild
+// - make sure the .git/ folder with correct permission
+// - make sure either one of the condition mets
+//   - the prebuild log message exists
+//   - the init task message exists
+//   - the init task generated file exists
+//
+// - write a new file foobar.txt
+// - stop the workspace
+// - relaunch the workspace
+// - make sure the file foobar.txt exists
 func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 	f := features.New("prebuild").
 		WithLabel("component", "ws-manager").
@@ -208,7 +223,7 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 				},
 			}
 
-			ctx, cancel := context.WithTimeout(context.Background(), time.Duration(10*len(tests))*time.Minute)
+			ctx, cancel := context.WithTimeout(context.Background(), time.Duration(15*len(tests))*time.Minute)
 			defer cancel()
 
 			for _, test := range tests {
@@ -223,7 +238,7 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 						req.Type = wsmanapi.WorkspaceType_PREBUILD
 						req.Spec.Envvars = append(req.Spec.Envvars, &wsmanapi.EnvironmentVariable{
 							Name:  "GITPOD_TASKS",
-							Value: `[{ "init": "echo \"some output\" > someFile; sleep 60; exit 0;" }]`,
+							Value: fmt.Sprintf(`[{ "init": %q }]`, initTask),
 						})
 						req.Spec.FeatureFlags = test.FF
 						req.Spec.Initializer = &csapi.WorkspaceInitializer{
@@ -248,6 +263,7 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 					if err != nil {
 						t.Fatalf("stop workspace and find snapshot error: %v", err)
 					}
+					t.Logf("prebuild snapshot: %s, vsName: %s, vsHandle: %s", prebuildSnapshot, vsInfo.VolumeSnapshotName, vsInfo.VolumeSnapshotHandle)
 
 					// launch the workspace from prebuild
 					ws, stopWs, err := integration.LaunchWorkspaceDirectly(t, ctx, api, integration.WithRequestModifier(func(req *wsmanapi.StartWorkspaceRequest) error {
@@ -297,9 +313,32 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 					})
 					integration.DeferCloser(t, closer)
 
-					// check prebuild log message exists
+					// check the files/folders permission under .git/
 					var resp agent.ExecResponse
-					var checkPrebuildSuccess bool
+					var gitDir string = fmt.Sprintf("%s/%s", test.WorkspaceRoot, ".git")
+					err = rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
+						Dir:     gitDir,
+						Command: "find",
+						Args:    []string{"-user", "root"},
+					}, &resp)
+					if err != nil || resp.ExitCode != 0 || strings.Trim(resp.Stdout, " \t\n") != "" {
+						t.Fatalf("incorrect file perimssion under %s folder, err:%v, exitCode:%d, stdout:%s", gitDir, err, resp.ExitCode, resp.Stdout)
+					}
+
+					err = rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
+						Dir:     gitDir,
+						Command: "find",
+						Args:    []string{"-group", "root"},
+					}, &resp)
+					if err != nil || resp.ExitCode != 0 || strings.Trim(resp.Stdout, " \t\n") != "" {
+						t.Fatalf("incorrect group perimssion under %s folder, err:%v, exitCode:%d, stdout:%s", gitDir, err, resp.ExitCode, resp.Stdout)
+					}
+
+					// check prebuild log message exists
+					// since the message '🤙 This task ran as a workspace prebuild' is generated by
+					// a regular workspace supervisor, so we add a retry mechanism to make sure that we
+					// won't check the message too earlier before the supervisor generated it.
+					var checkPrebuildLog bool
 					for i := 0; i < 10; i++ {
 						err = rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
 							Dir:     prebuildLogPath,
@@ -310,16 +349,55 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 							},
 						}, &resp)
 						if err == nil && resp.ExitCode == 0 && strings.Trim(resp.Stdout, " \t\n") != "" {
-							checkPrebuildSuccess = true
+							checkPrebuildLog = true
 							break
 						}
-
-						// wait 3 seconds and check
-						time.Sleep(3 * time.Second)
+						time.Sleep(6 * time.Second)
 					}
 
-					if !checkPrebuildSuccess {
-						t.Fatalf("cannot found the prebuild message %s in %s, err:%v, exitCode:%d, stdout:%s", prebuildLog, prebuildLogPath, err, resp.ExitCode, resp.Stdout)
+					if !checkPrebuildLog {
+						// somehow, the prebuild log message '🤙 This task ran as a workspace prebuild' does not exists
+						// we fall back to check the the init task message within the /workspace/.gitpod/prebuild-log-* or not
+						t.Logf("cannot found the prebuild message %s in %s, err:%v, exitCode:%d, stdout:%s", prebuildLog, prebuildLogPath, err, resp.ExitCode, resp.Stdout)
+
+						// check the init task message exists
+						var checkInitTaskMsg bool
+						err = rsa.Call("WorkspaceAgent.Exec", &agent.ExecRequest{
+							Dir:     prebuildLogPath,
+							Command: "bash",
+							Args: []string{
+								"-c",
+								fmt.Sprintf("grep %q *", initTask),
+							},
+						}, &resp)
+						if err == nil && resp.ExitCode == 0 && strings.Trim(resp.Stdout, " \t\n") != "" {
+							checkInitTaskMsg = true
+						}
+
+						if !checkInitTaskMsg {
+							t.Logf("cannot found the init task message %s in %s, err:%v, exitCode:%d, stdout:%s", initTask, prebuildLogPath, err, resp.ExitCode, resp.Stdout)
+
+							// somehow, the init task message does not exist within the /workspace/.gitpod/prebuild-log-*
+							// we fall back to check the file exists or not
+							var ls agent.ListDirResponse
+							err = rsa.Call("WorkspaceAgent.ListDir", &agent.ListDirRequest{
+								Dir: test.WorkspaceRoot,
+							}, &ls)
+							if err != nil {
+								t.Fatal(err)
+							}
+
+							var found bool
+							for _, f := range ls.Files {
+								if filepath.Base(f) == "someFile" {
+									found = true
+									break
+								}
+							}
+							if !found {
+								t.Fatal("did not find someFile from previous workspace instance")
+							}
+						}
 					}
 
 					// write file foobar.txt and stop the workspace
@@ -343,6 +421,7 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 					if err != nil {
 						t.Fatal(err)
 					}
+					t.Logf("prebuild snapshot: %s, vsName: %s, vsHandle: %s", prebuildSnapshot, vsInfo.VolumeSnapshotName, vsInfo.VolumeSnapshotHandle)
 
 					// reopen the workspace and make sure the file foobar.txt exists
 					ws1, stopWs1, err := integration.LaunchWorkspaceDirectly(t, ctx, api, integration.WithRequestModifier(func(req *wsmanapi.StartWorkspaceRequest) error {
@@ -414,8 +493,8 @@ func stopWorkspaceAndFindSnapshot(StopWorkspaceFunc integration.StopWorkspaceFun
 	if err != nil {
 		return "", nil, err
 	}
-	if lastStatus == nil && lastStatus.Conditions == nil {
-		return "", nil, nil
+	if lastStatus == nil || lastStatus.Conditions == nil || lastStatus.Conditions.VolumeSnapshot == nil {
+		return "", nil, errors.New("cannot find the last snapshot")
 	}
 	return lastStatus.Conditions.Snapshot, lastStatus.Conditions.VolumeSnapshot, nil
 }