[gp-cli] support gp validate with default image

Author: mustard-mh

components/gitpod-cli/cmd/validate.go

@@ -18,6 +18,7 @@ import (
 	"time"
 
 	"github.com/gitpod-io/gitpod/common-go/log"
+	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/gitpod"
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/utils"
 	"github.com/sirupsen/logrus"
@@ -88,8 +89,11 @@ func runRebuild(ctx context.Context, supervisorClient *supervisor.SupervisorClie
 	var dockerContext string
 	switch img := gitpodConfig.Image.(type) {
 	case nil:
-		// TODO: GET FROM SERVER
-		image = "gitpod/workspace-full:latest"
+		defaultImage, err := getOrganizationDefaultWorkspaceImage(ctx)
+		if err != nil {
+			return GpError{Err: err, OutCome: utils.Outcome_SystemErr, ErrorCode: utils.RebuildErrorCode_FailedToGetDefaultImage, Silence: true}
+		}
+		image = defaultImage
 	case string:
 		image = img
 	case map[interface{}]interface{}:
@@ -485,6 +489,26 @@ Connect using SSH keys (https://gitpod.io/keys):
 	return nil
 }
 
+func getOrganizationDefaultWorkspaceImage(ctx context.Context) (string, error) {
+	wsInfo, err := gitpod.GetWSInfo(ctx)
+	if err != nil {
+		return "", err
+	}
+	client, err := gitpod.ConnectToServer(ctx, wsInfo, []string{
+		"function:getOrgSettings",
+		"resource:team::" + wsInfo.OrganizationId + "::get",
+	})
+	if err != nil {
+		return "", err
+	}
+	defer client.Close()
+	settings, err := client.GetOrgSettings(ctx, wsInfo.OrganizationId)
+	if err != nil {
+		return "", err
+	}
+	return settings.DefaultWorkspaceImage, nil
+}
+
 func setLoggerFormatter(logger *logrus.Logger) {
 	logger.SetFormatter(&prefixed.TextFormatter{
 		TimestampFormat: "2006-01-02 15:04:05",

components/gitpod-cli/pkg/utils/trackEvent.go

@@ -24,15 +24,16 @@ const (
 	UserErrorCode   = "user_error"
 
 	// Rebuild
-	RebuildErrorCode_ImageBuildFailed    = "rebuild_image_build_failed"
-	RebuildErrorCode_DockerErr           = "rebuild_docker_err"
-	RebuildErrorCode_DockerNotFound      = "rebuild_docker_not_found"
-	RebuildErrorCode_DockerRunFailed     = "rebuild_docker_run_failed"
-	RebuildErrorCode_MalformedGitpodYaml = "rebuild_malformed_gitpod_yaml"
-	RebuildErrorCode_MissingGitpodYaml   = "rebuild_missing_gitpod_yaml"
-	RebuildErrorCode_NoCustomImage       = "rebuild_no_custom_image"
-	RebuildErrorCode_AlreadyInDebug      = "rebuild_already_in_debug"
-	RebuildErrorCode_InvaligLogLevel     = "rebuild_invalid_log_level"
+	RebuildErrorCode_ImageBuildFailed        = "rebuild_image_build_failed"
+	RebuildErrorCode_DockerErr               = "rebuild_docker_err"
+	RebuildErrorCode_DockerNotFound          = "rebuild_docker_not_found"
+	RebuildErrorCode_DockerRunFailed         = "rebuild_docker_run_failed"
+	RebuildErrorCode_MalformedGitpodYaml     = "rebuild_malformed_gitpod_yaml"
+	RebuildErrorCode_MissingGitpodYaml       = "rebuild_missing_gitpod_yaml"
+	RebuildErrorCode_NoCustomImage           = "rebuild_no_custom_image"
+	RebuildErrorCode_AlreadyInDebug          = "rebuild_already_in_debug"
+	RebuildErrorCode_InvaligLogLevel         = "rebuild_invalid_log_level"
+	RebuildErrorCode_FailedToGetDefaultImage = "rebuild_failed_to_get_default_image"
 
 	// UserError
 	UserErrorCode_NeedUpgradePlan  = "plan_upgrade_required"

components/gitpod-protocol/go/gitpod-service.go

@@ -93,6 +93,9 @@ type APIInterface interface {
 	SetTeamMemberRole(ctx context.Context, teamID, userID string, role TeamMemberRole) error
 	RemoveTeamMember(ctx context.Context, teamID, userID string) error
 
+	// Organization
+	GetOrgSettings(ctx context.Context, orgID string) (*OrganizationSettings, error)
+
 	// Projects
 	CreateProject(ctx context.Context, options *CreateProjectOptions) (*Project, error)
 	DeleteProject(ctx context.Context, projectID string) error
@@ -235,6 +238,10 @@ const (
 	// FunctionDeleteTeam is the name of the deleteTeam function
 	FunctionDeleteTeam FunctionName = "deleteTeam"
 
+	// Organizations
+	// FunctionGetOrgSettings is the name of the getOrgSettings function
+	FunctionGetOrgSettings FunctionName = "getOrgSettings"
+
 	// Projects
 	FunctionCreateProject   FunctionName = "createProject"
 	FunctionDeleteProject   FunctionName = "deleteProject"
@@ -1471,6 +1478,16 @@ func (gp *APIoverJSONRPC) DeleteTeam(ctx context.Context, teamID string) (err er
 	return
 }
 
+func (gp *APIoverJSONRPC) GetOrgSettings(ctx context.Context, orgID string) (res *OrganizationSettings, err error) {
+	if gp == nil {
+		err = errNotConnected
+		return
+	}
+	_params := []interface{}{orgID}
+	err = gp.C.Call(ctx, string(FunctionGetOrgSettings), _params, &res)
+	return
+}
+
 func (gp *APIoverJSONRPC) CreateProject(ctx context.Context, options *CreateProjectOptions) (res *Project, err error) {
 	if gp == nil {
 		err = errNotConnected
@@ -2238,6 +2255,11 @@ type TeamMembershipInvite struct {
 	InvitedEmail     string         `json:"invitedEmail,omitempty"`
 }
 
+type OrganizationSettings struct {
+	WorkspaceSharingDisabled bool   `json:"workspaceSharingDisabled,omitempty"`
+	DefaultWorkspaceImage    string `json:"defaultWorkspaceImage,omitempty"`
+}
+
 type Project struct {
 	ID                string           `json:"id,omitempty"`
 	UserID            string           `json:"userId,omitempty"`

components/gitpod-protocol/go/mock.go

@@ -40,6 +40,7 @@ import {
     ImageBuildLogInfo,
     ImageConfigFile,
     NamedWorkspaceFeatureFlag,
+    Organization,
     Permission,
     Project,
     RefType,
@@ -1563,6 +1564,11 @@ export class WorkspaceStarter {
             sysEnvvars.push(ev);
         }
 
+        const orgIdEnv = new EnvironmentVariable();
+        orgIdEnv.setName("GITPOD_ORGANIZATION_ID");
+        orgIdEnv.setValue(workspace.organizationId);
+        sysEnvvars.push(orgIdEnv);
+
         const spec = new StartWorkspaceSpec();
         await createGitpodTokenPromise;
         spec.setEnvvarsList(envvars);
@@ -1634,6 +1640,7 @@ export class WorkspaceStarter {
             "function:setEnvVar",
             "function:deleteEnvVar",
             "function:getTeams",
+            "function:getOrgSettings",
             "function:trackEvent",
             "function:getSupportedWorkspaceClasses",
             // getIDToken is used by Gitpod's OIDC Identity Provider to check for authorisation.
@@ -1678,6 +1685,12 @@ export class WorkspaceStarter {
                     subjectID: "*",
                     operations: ["create", "get"],
                 }),
+            "resource:" +
+                ScopedResourceGuard.marshalResourceScope({
+                    kind: "team",
+                    subjectID: workspace.organizationId,
+                    operations: ["get"],
+                }),
         ];
         if (CommitContext.is(workspace.context)) {
             const subjectID = workspace.context.repository.owner + "/" + workspace.context.repository.name;

components/server/src/workspace/workspace-starter.ts

@@ -100,6 +100,9 @@ message WorkspaceInfoResponse {
 
     // configcat_enabled controls whether configcat is enabled
     bool configcat_enabled = 18;
+
+    // organization_id is the Organization that open this workspace
+    string organization_id = 19;
 }
 
 enum DebugWorkspaceType {