Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rfyiamcool/go-shell
golang easy shell && command lib
https://github.com/rfyiamcool/go-shell
command go shell
Last synced: 19 days ago
JSON representation
golang easy shell && command lib
- Host: GitHub
- URL: https://github.com/rfyiamcool/go-shell
- Owner: rfyiamcool
- Created: 2020-06-29T08:24:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-18T01:55:28.000Z (about 3 years ago)
- Last Synced: 2024-10-12T16:33:03.712Z (about 1 month ago)
- Topics: command, go, shell
- Language: Go
- Homepage:
- Size: 80.1 KB
- Stars: 81
- Watchers: 3
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# go-shell
easy execute shell, better `os/exec`
## Feature
* simple api
* add timeout
* add stop()
* add yum api
* use channel to send stdout and stderr
* merge stdout and stderr to new output
* use sync.pool to reduce alloc buffer
## Usage
😁 **Look at the code for yourself**
```golang
func TestCheckOutput(t *testing.T) {
cmd := NewCommand("echo -n 123123")
cmd.Run() // start and wait
status := cmd.Status
assert.Equal(t, status.Output, "123123")
assert.Equal(t, status.Stdout, "123123")
assert.Equal(t, status.Stderr, "")
}
func TestCheckStderr(t *testing.T) {
cmd := NewCommand("echo -n \"123123\" >&2")
cmd.Run() // start and wait
status := cmd.Status
assert.Equal(t, status.Stdout, "")
assert.Equal(t, status.Output, "123123")
assert.Equal(t, status.Stderr, "123123")
}
func TestDelayStop(t *testing.T) {
start := time.Now()
cmd := NewCommand("sleep 5;echo 123;sleep 123")
cmd.Start() // async start
go func() {
time.Sleep(1 * time.Second)
cmd.Stop()
}()
cmd.Wait() // wait
end := time.Since(start)
assert.Less(t, end.Seconds(), float64(2))
}
func TestRunTimeout(t *testing.T) {
cmd := NewCommand("echo 123; sleep 5", WithTimeout(2))
cmd.Start()
cmd.Wait()
status := cmd.Status
assert.Equal(t, status.Error, ErrProcessTimeout)
assert.Greater(t, status.CostTime.Seconds(), float64(2))
assert.Less(t, status.CostTime.Seconds(), float64(3))
}
func TestCheckStderr(t *testing.T) {
cmd := NewCommand("echo -n \"123123\" >&2") // echo stderr
cmd.Run() // start and wait
status := cmd.Status
assert.Equal(t, status.Stdout, "")
assert.Equal(t, status.Output, "123123")
assert.Equal(t, status.Stderr, "123123")
}
func TestCheckStream(t *testing.T) {
stdoutChan := make(chan string, 100)
incr := 0
go func() {
for line := range stdoutChan {
incr++
fmt.Println(incr, line)
}
}()
cmd := exec.Command("bash", "-c", "echo 123;sleep 1;echo 456; echo 789")
stdout := NewOutputStream(stdoutChan)
cmd.Stdout = stdout
cmd.Run()
assert.Equal(t, incr, 3)
}
func TestCheckBuffer(t *testing.T) {
cmd := exec.Command("bash", "-c", "echo 123")
stdout := NewOutputBuffer()
cmd.Stdout = stdout
cmd.Run()
assert.Equal(t, stdout.buf.String(), "123\n")
assert.Equal(t, stdout.Lines()[0], "123")
}
```