Compare commits

..

No commits in common. "main" and "v1.0.0" have entirely different histories.
main ... v1.0.0

2 changed files with 20 additions and 54 deletions

11
main.go
View File

@ -45,10 +45,9 @@ func NewShellRunnerWithShell(shell string) *ShellRunner {
cmdQueue: make(chan func() *CommandResult), cmdQueue: make(chan func() *CommandResult),
results: make(chan *CommandResult, MAX_RESULTS), results: make(chan *CommandResult, MAX_RESULTS),
stopChan: make(chan struct{}), stopChan: make(chan struct{}),
callbacks: make(chan func()), callbacks: make(chan func(), MAX_RESULTS),
shell: shell, shell: shell,
activeCmds: make(map[*exec.Cmd]struct{}), activeCmds: make(map[*exec.Cmd]struct{}),
isStopped: true,
} }
} }
@ -76,20 +75,16 @@ func (sr *ShellRunner) Start() {
} }
} }
}() }()
sr.isStopped = false
} }
// AddCommand adds a shell command to be executed with an optional callback. // AddCommand adds a shell command to be executed with an optional callback.
// No commands can be added if the runner has been stopped or not yet started. // No commands can be added if the runner has been stopped.
// The callback is executed asynchronously after the command has completed.
// The order of command execution and callback invocation can be expected to be preserved.
func (sr *ShellRunner) AddCommand(command string, callback func(*CommandResult)) error { func (sr *ShellRunner) AddCommand(command string, callback func(*CommandResult)) error {
sr.mu.Lock() sr.mu.Lock()
defer sr.mu.Unlock() defer sr.mu.Unlock()
if sr.isStopped { if sr.isStopped {
return errors.New("runner is stopped, cannot add new commands") return errors.New("runner has been stopped, cannot add new commands")
} }
sr.cmdQueue <- func() *CommandResult { sr.cmdQueue <- func() *CommandResult {

View File

@ -1,7 +1,6 @@
package tortoise_test package tortoise_test
import ( import (
"sync"
"testing" "testing"
"time" "time"
@ -50,55 +49,36 @@ func TestShellRunnerCallback(t *testing.T) {
runner.Start() runner.Start()
// Test command with callback // Test command with callback
outputString := ""
callbackWait := sync.WaitGroup{}
callbackWait.Add(1)
if err := runner.AddCommand("echo callback a", func(result *tortoise.CommandResult) {
if result.Output != "callback a\n" {
t.Fatalf("expected 'callback a', got '%s'", result.Output)
}
outputString = outputString + "a"
callbackWait.Done()
}); err != nil {
t.Fatalf("unexpected error adding command: %v", err)
}
callbackWait.Add(1)
if err := runner.AddCommand("echo callback b", func(result *tortoise.CommandResult) {
if result.Output != "callback b\n" {
t.Fatalf("expected 'callback b', got '%s'", result.Output)
}
outputString = outputString + "b"
callbackWait.Done()
}); err != nil {
t.Fatalf("unexpected error adding command: %v", err)
}
// Timeout waiting for callbacks
done := make(chan struct{}) done := make(chan struct{})
go func() {
callbackWait.Wait()
close(done)
}()
callbackReached := false
if err := runner.AddCommand("echo callback test", func(result *tortoise.CommandResult) {
callbackReached = true
if result.Output != "callback test\n" {
t.Fatalf("expected 'callback test', got '%s'", result.Output)
}
close(done)
}); err != nil {
t.Fatalf("unexpected error adding command: %v", err)
}
// Timeout waiting for callback
select { select {
case <-done: case <-done:
case <-time.After(2 * time.Second): case <-time.After(2 * time.Second):
t.Fatal("callbacks timed out") t.Fatal("callback timed out")
} }
if outputString != "ab" { if !callbackReached {
t.Fatal("callbacks was not reached in order:", outputString) t.Fatal("callback was not reached")
} }
runner.Stop() runner.Stop()
// Make sure stop and kill both exit gracefully after the runner is stopped // Make sure stop and kill both exit gracefully after the runner is stopped
runner.Stop() runner.Stop()
runner.Kill() runner.Stop()
} }
func TestShellRunnerKillWithTimeout(t *testing.T) { func TestShellRunnerKillWithTimeout(t *testing.T) {
@ -142,12 +122,3 @@ func TestStopPreventsNewCommands(t *testing.T) {
t.Fatal("expected error when adding command after stop, but got none") t.Fatal("expected error when adding command after stop, but got none")
} }
} }
func TestAddingPriorToStart(t *testing.T) {
runner := tortoise.NewShellRunner()
err := runner.AddCommand("echo should not run", nil)
if err == nil {
t.Fatal("Should have failed to add prior to starting runner")
}
}