-
Notifications
You must be signed in to change notification settings - Fork 359
fix(orchestrator): enforce sandbox TTL on the node via WaitForExit #3194
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
Open
AdaAibaby
wants to merge
2
commits into
e2b-dev:main
Choose a base branch
from
AdaAibaby:fix/orchestrator-sandbox-timeout-enforcement
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−13
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
137 changes: 137 additions & 0 deletions
137
packages/orchestrator/pkg/sandbox/wait_for_exit_test.go
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,137 @@ | ||
| //go:build linux | ||
|
|
||
| package sandbox | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/e2b-dev/infra/packages/shared/pkg/utils" | ||
| ) | ||
|
|
||
| func newTestSandboxForExit(endAt time.Time) *Sandbox { | ||
| sbx := &Sandbox{ | ||
| Metadata: &Metadata{}, | ||
| exit: utils.NewErrorOnce(), | ||
| } | ||
| sbx.SetEndAt(endAt) | ||
|
|
||
| return sbx | ||
| } | ||
|
|
||
| // TestWaitForExit_AlreadyExpired verifies that WaitForExit returns an error | ||
| // immediately when endAt is already in the past. | ||
| func TestWaitForExit_AlreadyExpired(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| sbx := newTestSandboxForExit(time.Now().Add(-1 * time.Second)) | ||
|
|
||
| err := sbx.WaitForExit(context.Background()) | ||
|
|
||
| require.Error(t, err) | ||
| } | ||
|
|
||
| // TestWaitForExit_ExitBeforeTTL verifies that WaitForExit returns nil when | ||
| // the sandbox exits cleanly before its TTL expires. | ||
| func TestWaitForExit_ExitBeforeTTL(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| sbx := newTestSandboxForExit(time.Now().Add(2 * time.Second)) | ||
|
|
||
| go func() { | ||
| time.Sleep(50 * time.Millisecond) | ||
| sbx.exit.SetSuccess() | ||
| }() | ||
|
|
||
| err := sbx.WaitForExit(context.Background()) | ||
|
|
||
| require.NoError(t, err) | ||
| } | ||
|
|
||
| // TestWaitForExit_ExitWithError verifies that WaitForExit returns a wrapped | ||
| // error when the Firecracker process exits with an error before the TTL. | ||
| func TestWaitForExit_ExitWithError(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| sbx := newTestSandboxForExit(time.Now().Add(2 * time.Second)) | ||
|
|
||
| fcErr := errors.New("firecracker process killed") | ||
| go func() { | ||
| time.Sleep(50 * time.Millisecond) | ||
| sbx.exit.SetError(fcErr) | ||
| }() | ||
|
|
||
| err := sbx.WaitForExit(context.Background()) | ||
|
|
||
| require.Error(t, err) | ||
| assert.ErrorContains(t, err, "fc process exited prematurely") | ||
| assert.ErrorContains(t, err, fcErr.Error()) | ||
| } | ||
|
|
||
| // TestWaitForExit_KeepAliveExtendsTTL verifies that a KeepAlive call that | ||
| // extends endAt via SetEndAt resets the node-side timer. Without this, the | ||
| // sandbox would be killed at the original TTL even though it was extended. | ||
| func TestWaitForExit_KeepAliveExtendsTTL(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // Short initial TTL — would fire after 80 ms without the fix. | ||
| sbx := newTestSandboxForExit(time.Now().Add(80 * time.Millisecond)) | ||
|
|
||
| done := make(chan error, 1) | ||
| go func() { | ||
| done <- sbx.WaitForExit(context.Background()) | ||
| }() | ||
|
|
||
| // Simulate KeepAlive: extend endAt before the original TTL fires. | ||
| time.Sleep(40 * time.Millisecond) | ||
| sbx.SetEndAt(time.Now().Add(2 * time.Second)) | ||
|
|
||
| // Wait past the original TTL; WaitForExit must NOT have returned yet. | ||
| time.Sleep(100 * time.Millisecond) | ||
| select { | ||
| case err := <-done: | ||
| t.Fatalf("WaitForExit returned early after KeepAlive extension: %v", err) | ||
| default: | ||
| // Good — still waiting. | ||
| } | ||
|
|
||
| // Now signal a clean exit; WaitForExit should return nil. | ||
| sbx.exit.SetSuccess() | ||
|
|
||
| select { | ||
| case err := <-done: | ||
| require.NoError(t, err) | ||
| case <-time.After(time.Second): | ||
| t.Fatal("WaitForExit did not return after exit signal") | ||
| } | ||
| } | ||
|
|
||
| // TestWaitForExit_ContextCancelled verifies that WaitForExit returns nil when | ||
| // the context is cancelled before either TTL expiry or process exit. | ||
| func TestWaitForExit_ContextCancelled(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| sbx := newTestSandboxForExit(time.Now().Add(10 * time.Second)) | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| done := make(chan error, 1) | ||
| go func() { | ||
| done <- sbx.WaitForExit(ctx) | ||
| }() | ||
|
|
||
| time.Sleep(20 * time.Millisecond) | ||
| cancel() | ||
|
|
||
| select { | ||
| case err := <-done: | ||
| require.NoError(t, err) | ||
| case <-time.After(time.Second): | ||
| t.Fatal("WaitForExit did not return after context cancellation") | ||
| } | ||
| } |
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
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.
Uh oh!
There was an error while loading. Please reload this page.