Skip to content

[context parser] Check current ref for Docker image existence #20345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 7, 2024
Merged

[context parser] Check current ref for Docker image existence #20345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bee3be2
[context parser] Check current ref for Docker image existence
filiptronicek Nov 5, 2024
13cf10a
Better builder bob errors from supervisor
filiptronicek Nov 7, 2024
fbcde24
Gently soft-fail when the Dockerfile isn't found
filiptronicek Nov 7, 2024
1594c9b
Add warning to ws metadata when starting workspace
filiptronicek Nov 7, 2024
fbd4b35
Introduce a magic constant instead of empty strings
filiptronicek Nov 7, 2024
d0f46be
Improve supervisor failed reading bob log error
filiptronicek Nov 7, 2024
541e880
Fixup cloning our special SHA
filiptronicek Nov 7, 2024
2af89a5
idk what happened
filiptronicek Nov 7, 2024
672336e
let workspaces start even on invalid docker refs
filiptronicek Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions components/dashboard/src/workspaces/CreateWorkspacePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,11 @@ export function CreateWorkspacePage() {
<span className="text-sm">{warningIde}</span>
</Alert>
)}
{workspaceContext.data?.data.metadata?.warnings.map((warning) => (
<Alert type="warning" key={warning}>
<span className="text-sm">{warning}</span>
</Alert>
)) ?? []}

<InputField>
<RepositoryFinder
Expand Down
2 changes: 2 additions & 0 deletions components/gitpod-protocol/src/protocol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1018,6 +1018,8 @@ export interface WorkspaceContext {
normalizedContextURL?: string;
forceCreateNewWorkspace?: boolean;
forceImageBuild?: boolean;
// The context can have non-blocking warnings that should be displayed to the user.
warnings?: string[];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧡

}

export namespace WorkspaceContext {
Expand Down
15 changes: 15 additions & 0 deletions components/image-builder-bob/cmd/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
package cmd

import (
"errors"
"os"
"strings"
"time"

"github.com/spf13/cobra"
Expand All @@ -32,6 +34,14 @@ var buildCmd = &cobra.Command{

cfg, err := builder.GetConfigFromEnv()
if err != nil {
if errors.Is(err, builder.DockerfilePathNotExists) {
dockerfilePath := strings.TrimPrefix(os.Getenv("BOB_DOCKERFILE_PATH"), "/workspace/")
err = os.WriteFile("/workspace/.gitpod/bob.log", []byte("could not find Dockerfile at \""+dockerfilePath+"\". Please double-check the value specified in image.file in .gitpod.yml"), 0644)
if err != nil {
log.WithError(err).Error("cannot write init message to /workspace/.gitpod/bob.log")
}
}

log.WithError(err).Fatal("cannot get config")
return
}
Expand All @@ -43,6 +53,11 @@ var buildCmd = &cobra.Command{
if err != nil {
log.WithError(err).Error("build failed")

err := os.WriteFile("/workspace/.gitpod/bob.log", []byte(err.Error()), 0644)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧡

if err != nil {
log.WithError(err).Error("cannot write error to /workspace/.gitpod/bob.log")
}

// make sure we're running long enough to have our logs read
if dt := time.Since(t0); dt < 5*time.Second {
time.Sleep(10 * time.Second)
Expand Down
4 changes: 3 additions & 1 deletion components/image-builder-bob/pkg/builder/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ type Config struct {
localCacheImport string
}

var DockerfilePathNotExists = xerrors.Errorf("BOB_DOCKERFILE_PATH does not exist or isn't a file")

// GetConfigFromEnv extracts configuration from environment variables
func GetConfigFromEnv() (*Config, error) {
cfg := &Config{
Expand Down Expand Up @@ -63,7 +65,7 @@ func GetConfigFromEnv() (*Config, error) {
return nil, xerrors.Errorf("BOB_DOCKERFILE_PATH must begin with /workspace")
}
if stat, err := os.Stat(cfg.Dockerfile); err != nil || stat.IsDir() {
return nil, xerrors.Errorf("BOB_DOCKERFILE_PATH does not exist or isn't a file")
return nil, DockerfilePathNotExists
}
}

Expand Down
3 changes: 3 additions & 0 deletions components/public-api/gitpod/v1/workspace.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,9 @@ message WorkspaceMetadata {
// original_context_url is the normalized URL from which the workspace was
// created
string original_context_url = 7;

// warnings are user-facing warnings that should be displayed to the user when trying to start the workspace
repeated string warnings = 8;
}

// WorkspaceSpec specifies the configuration of a workspace for a workspace
Expand Down
1,185 changes: 598 additions & 587 deletions components/public-api/go/v1/workspace.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading