Skip to content
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

Add exiter to test os.Exit case #729

Merged
merged 1 commit into from
Jan 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 12 additions & 3 deletions runner/engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ import (

// Engine ...
type Engine struct {
config *Config
config *Config

exiter exiter
proxy *Proxy
logger *logger
watcher filenotify.FileWatcher
Expand Down Expand Up @@ -50,6 +52,7 @@ func NewEngineWithConfig(cfg *Config, debugMode bool) (*Engine, error) {
}
e := Engine{
config: cfg,
exiter: defaultExiter{},
proxy: NewProxy(&cfg.Proxy),
logger: logger,
watcher: watcher,
Expand Down Expand Up @@ -655,8 +658,14 @@ func (e *Engine) stopBin() {
close(exitCode)
}
})
if ret := <-exitCode; ret != 0 {
os.Exit(ret)

select {
case ret := <-exitCode:
if ret != 0 {
e.exiter.Exit(ret) // Use exiter instead of direct os.Exit, it's for tests purpose.
}
case <-time.After(5 * time.Second):
e.mainDebug("timed out waiting for process exit")
}
}

Expand Down
85 changes: 84 additions & 1 deletion runner/engine_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1044,7 +1044,7 @@ include_file = ["main.sh"]

t.Logf("start change main.sh")
go func() {
err := os.WriteFile("main.sh", []byte("#!/bin/sh\nprintf modified > output"), 0o755)
err = os.WriteFile("main.sh", []byte("#!/bin/sh\nprintf modified > output"), 0o755)
if err != nil {
log.Fatalf("Error updating file: %s.", err)
}
Expand All @@ -1058,3 +1058,86 @@ include_file = ["main.sh"]
}
assert.Equal(t, []byte("modified"), bytes)
}

type testExiter struct {
t *testing.T
called bool
expectCode int
}

func (te *testExiter) Exit(code int) {
te.called = true
if code != te.expectCode {
te.t.Fatalf("expected exit code %d, got %d", te.expectCode, code)
}
}

func TestEngineExit(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm unsure I get it

You ate no longer calling stopBin, so here you are testing the test exiter behavior?

I mean I don't get you are calling the exiter itself in this method

🤔

Did I miss something?

You had the call to stopBin earlier, no?

tests := []struct {
name string
setup func(*Engine, chan<- int)
expectCode int
wantCalled bool
}{
{
name: "normal exit - no error",
setup: func(_ *Engine, exitCode chan<- int) {
go func() {
exitCode <- 0
}()
},
expectCode: 0,
wantCalled: false,
},
{
name: "error exit - non-zero code",
setup: func(_ *Engine, exitCode chan<- int) {
go func() {
exitCode <- 1
}()
},
expectCode: 1,
wantCalled: true,
},
{
name: "process timeout",
setup: func(_ *Engine, _ chan<- int) {
},
Comment on lines +1104 to +1105
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe adding a time.Sleep here would make it clearer to anyone reading this

expectCode: 0,
wantCalled: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
e, err := NewEngine("", true)
if err != nil {
t.Fatal(err)
}

exiter := &testExiter{
t: t,
expectCode: tt.expectCode,
}
e.exiter = exiter

exitCode := make(chan int)

if tt.setup != nil {
tt.setup(e, exitCode)
}
select {
case ret := <-exitCode:
if ret != 0 {
e.exiter.Exit(ret)
}
case <-time.After(1 * time.Millisecond):
Copy link
Contributor

Choose a reason for hiding this comment

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

10 ms could avoid flakiness on some strange use case

// timeout case
}

if tt.wantCalled != exiter.called {
t.Errorf("Exit() called = %v, want %v", exiter.called, tt.wantCalled)
}
})
}
}
13 changes: 13 additions & 0 deletions runner/exiter.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package runner

import "os"

type exiter interface {
Exit(code int)
}

type defaultExiter struct{}

func (d defaultExiter) Exit(code int) {
os.Exit(code)
}
Loading