-
Notifications
You must be signed in to change notification settings - Fork 2
feat(driver): microsandbox microVM backend #761
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.
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0e82771
feat(driver): add microsandbox microVM provider
skevetter ab229df
fix(credentials): return 200 on the readiness probe path
skevetter 793fc7f
fix(driver): harden microsandbox Find and volume error handling
skevetter 92aa563
refactor(driver): use pkg/flags/names for microsandbox flag refs
skevetter f29aa41
fix(gitsshsigning): preserve CRLF endings when removing signing helper
skevetter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| package up | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "os/exec" | ||
| "runtime" | ||
|
|
||
| "github.com/devsy-org/devsy/e2e/framework" | ||
| "github.com/onsi/ginkgo/v2" | ||
| ) | ||
|
|
||
| const osLinux = "linux" | ||
|
|
||
| // skipIfNoMicrosandbox skips when the microsandbox runtime or hardware | ||
| // virtualization is unavailable, mirroring how other providers guard on their | ||
| // runtime being present. | ||
| func skipIfNoMicrosandbox() { | ||
| if _, err := exec.LookPath("msb"); err != nil { | ||
| ginkgo.Skip("microsandbox runtime (msb) not found on PATH") | ||
| } | ||
| switch { | ||
| case runtime.GOOS == osLinux: | ||
| kvm, err := os.OpenFile("/dev/kvm", os.O_RDWR, 0) | ||
| if err != nil { | ||
| ginkgo.Skip("microsandbox requires KVM (/dev/kvm not accessible)") | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| _ = kvm.Close() | ||
| case runtime.GOOS == "darwin" && runtime.GOARCH == "arm64": | ||
| // Apple silicon supports microsandbox via the hypervisor framework. | ||
| default: | ||
| ginkgo.Skip("microsandbox requires Apple silicon or Linux with KVM") | ||
| } | ||
| } | ||
|
|
||
| var _ = ginkgo.Describe( | ||
| "testing up command for microsandbox provider", | ||
| ginkgo.Label("up-provider-microsandbox"), | ||
| func() { | ||
| var initialDir string | ||
|
|
||
| ginkgo.BeforeEach(func() { | ||
| skipIfNoMicrosandbox() | ||
| var err error | ||
| initialDir, err = os.Getwd() | ||
| framework.ExpectNoError(err) | ||
| }) | ||
|
|
||
| ginkgo.It("runs devsy in a microsandbox microVM", func(ctx context.Context) { | ||
| f := framework.NewDefaultFramework(initialDir + "/bin") | ||
| tempDir, err := framework.CopyToTempDir("tests/up/testdata/microsandbox") | ||
| framework.ExpectNoError(err) | ||
| ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir) | ||
|
|
||
| _ = f.DevsyProviderDelete(ctx, "microsandbox") | ||
| err = f.DevsyProviderAdd(ctx, "microsandbox") | ||
| framework.ExpectNoError(err) | ||
| ginkgo.DeferCleanup(func(cleanupCtx context.Context) { | ||
| err := f.DevsyProviderDelete(cleanupCtx, "microsandbox") | ||
| framework.ExpectNoError(err) | ||
| }) | ||
|
|
||
| // full up: boots the microVM, streams in the agent, opens the tunnel | ||
| err = f.DevsyUp(ctx, tempDir) | ||
| framework.ExpectNoError(err) | ||
| ginkgo.DeferCleanup(f.DevsyWorkspaceDelete, tempDir) | ||
|
|
||
| // the workspace is reachable over SSH | ||
| err = f.DevsySSHEchoTestString(ctx, tempDir) | ||
| framework.ExpectNoError(err) | ||
|
|
||
| // stop, then bring it back up and confirm it is reachable again | ||
| err = f.DevsyWorkspaceStop(ctx, tempDir) | ||
| framework.ExpectNoError(err) | ||
|
|
||
| err = f.DevsyUp(ctx, tempDir) | ||
| framework.ExpectNoError(err) | ||
|
|
||
| err = f.DevsySSHEchoTestString(ctx, tempDir) | ||
| framework.ExpectNoError(err) | ||
| }, ginkgo.SpecTimeout(framework.TimeoutModerate())) | ||
| }, | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "name": "microsandbox", | ||
| "image": "mcr.microsoft.com/devcontainers/base:ubuntu" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package agent | ||
|
|
||
| import ( | ||
| "context" | ||
| "io" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestEnvPathSourceUsesLocalBinary(t *testing.T) { | ||
| dir := t.TempDir() | ||
| binPath := filepath.Join(dir, "devsy-linux-arm64") | ||
| if err := os.WriteFile(binPath, []byte("agent-bytes"), 0o755); err != nil { //nolint:gosec | ||
| t.Fatal(err) | ||
| } | ||
| t.Setenv("DEVSY_TEST_AGENT_BIN", binPath) | ||
|
|
||
| src := &EnvPathSource{EnvVar: "DEVSY_TEST_AGENT_BIN"} | ||
| rc, err := src.GetBinary(context.Background(), "arm64") | ||
| if err != nil { | ||
| t.Fatalf("GetBinary: %v", err) | ||
| } | ||
| defer func() { _ = rc.Close() }() | ||
|
|
||
| data, _ := io.ReadAll(rc) | ||
| if string(data) != "agent-bytes" { | ||
| t.Errorf("got %q, want the local binary contents", data) | ||
| } | ||
| } | ||
|
|
||
| func TestEnvPathSourceUnsetFallsThrough(t *testing.T) { | ||
| src := &EnvPathSource{EnvVar: "DEVSY_TEST_AGENT_BIN_UNSET"} | ||
| if _, err := src.GetBinary(context.Background(), "arm64"); err == nil { | ||
| t.Fatal("expected an error when the env var is unset so later sources are tried") | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Install
msbon the root execution path.The Linux tests run through
sudo(Line 644), whose secure PATH excludes$HOME/.local/bin; the microsandbox driver in the root-run e2e process will therefore fail to locatemsb. Install or symlink it into/usr/local/binafter installation.Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents