Fix memory leak caused by unclosed go-routine

Author: SimonBaeumer

README.md

@@ -26,25 +26,30 @@ fmt.Println(c.Stdout())
 fmt.Println(c.Stderr())
 ```
 
-### Stream output to stderr and stdout
+### Configure the command
+
+To configure the command a option function will be passed which receives the command object as an argument passed by reference.
+
+Default option functions:
+
+ - `cmd.WithStandardStreams`
+ - `cmd.WithTimeout(time.Duration)`
+
+#### Example
 
 ```go
 c := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
 c.Execute()
 ```
 
-### Set custom options
+#### Set custom options
 
 ```go
-func SetTimeout(c *Command) {
-    c.Timeout = 1 * time.Hour
-}
-
-func SetWorkingDir(c *Command) {
+setWorkingDir := func (c *Command) {
     c.WorkingDir = "/tmp/test"
 }
 
-c := cmd.NewCommand("pwd", SetTimeout, SetWorkingDir)
+c := cmd.NewCommand("pwd", setWorkingDir)
 c.Execute()
 ```
 

command.go

@@ -65,14 +65,25 @@ func NewCommand(cmd string, options ...func(*Command)) *Command {
 //
 // Example:
 //
-//      c := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
-//      c.Execute()
+//     c := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
+//     c.Execute()
 //
 func WithStandardStreams(c *Command) {
 	c.StdoutWriter = os.Stdout
 	c.StderrWriter = os.Stderr
 }
 
+// WithTimeout sets the timeout of the command
+//
+// Example:
+//     cmd.NewCommand("sleep 10;", cmd.WithTimeout(500))
+//
+func WithTimeout(t time.Duration) func(c *Command) {
+	return func(c *Command) {
+		c.Timeout = t
+	}
+}
+
 // AddEnv adds an environment variable to the command
 // If a variable gets passed like ${VAR_NAME} the env variable will be read out by the current shell
 func (c *Command) AddEnv(key string, value string) {
@@ -97,27 +108,6 @@ func parseEnvVariableFromShell(val string) []string {
 	return matches
 }
 
-//SetTimeoutMS sets the timeout in milliseconds
-func (c *Command) SetTimeoutMS(ms int) {
-	if ms == 0 {
-		c.Timeout = 1 * time.Minute
-		return
-	}
-	c.Timeout = time.Duration(ms) * time.Millisecond
-}
-
-// SetTimeout sets the timeout given a time unit
-// Example: SetTimeout("100s") sets the timeout to 100 seconds
-func (c *Command) SetTimeout(timeout string) error {
-	d, err := time.ParseDuration(timeout)
-	if err != nil {
-		return err
-	}
-
-	c.Timeout = d
-	return nil
-}
-
 //Stdout returns the output to stdout
 func (c *Command) Stdout() string {
 	c.isExecuted("Stdout")
@@ -162,9 +152,18 @@ func (c *Command) Execute() error {
 		return err
 	}
 
-	done := make(chan error)
+	done := make(chan error, 1)
+	defer close(done)
+	quit := make(chan bool, 1)
+	defer close(quit)
+
 	go func() {
-		done <- cmd.Wait()
+		select {
+		case <-quit:
+			return
+		case done <- cmd.Wait():
+			return
+		}
 	}()
 
 	select {
@@ -175,6 +174,7 @@ func (c *Command) Execute() error {
 		}
 		c.exitCode = 0
 	case <-time.After(c.Timeout):
+		quit <- true
 		if err := cmd.Process.Kill(); err != nil {
 			return fmt.Errorf("Timeout occurred and can not kill process with pid %v", cmd.Process.Pid)
 		}

command_linux_test.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 )
 
 func TestCommand_ExecuteStderr(t *testing.T) {
@@ -18,8 +19,7 @@ func TestCommand_ExecuteStderr(t *testing.T) {
 }
 
 func TestCommand_WithTimeout(t *testing.T) {
-	cmd := NewCommand("sleep 0.01;")
-	cmd.SetTimeoutMS(1)
+	cmd := NewCommand("sleep 0.01;", WithTimeout(1*time.Millisecond))
 
 	err := cmd.Execute()
 
@@ -30,8 +30,7 @@ func TestCommand_WithTimeout(t *testing.T) {
 }
 
 func TestCommand_WithValidTimeout(t *testing.T) {
-	cmd := NewCommand("sleep 0.01;")
-	cmd.SetTimeoutMS(500)
+	cmd := NewCommand("sleep 0.01;", WithTimeout(500*time.Millisecond))
 
 	err := cmd.Execute()
 

command_test.go

@@ -108,31 +108,6 @@ func getCommand() string {
 	return command
 }
 
-func TestCommand_SetTimeoutMS_DefaultTimeout(t *testing.T) {
-	c := NewCommand("echo test")
-	c.SetTimeoutMS(0)
-	assert.Equal(t, (1 * time.Minute), c.Timeout)
-}
-
-func TestCommand_SetTimeoutMS(t *testing.T) {
-	c := NewCommand("echo test")
-	c.SetTimeoutMS(100)
-	assert.Equal(t, 100*time.Millisecond, c.Timeout)
-}
-
-func TestCommand_SetTimeout(t *testing.T) {
-	c := NewCommand("echo test")
-	_ = c.SetTimeout("100s")
-	duration, _ := time.ParseDuration("100s")
-	assert.Equal(t, duration, c.Timeout)
-}
-
-func TestCommand_SetInvalidTimeout(t *testing.T) {
-	c := NewCommand("echo test")
-	err := c.SetTimeout("1")
-	assert.Equal(t, "time: missing unit in duration 1", err.Error())
-}
-
 func TestCommand_SetOptions(t *testing.T) {
 	writer := &bytes.Buffer{}
 

command_windows_test.go

@@ -4,6 +4,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"strings"
 	"testing"
+	"time"
 )
 
 func TestCommand_ExecuteStderr(t *testing.T) {
@@ -16,8 +17,7 @@ func TestCommand_ExecuteStderr(t *testing.T) {
 }
 
 func TestCommand_WithTimeout(t *testing.T) {
-	cmd := NewCommand("timeout 0.005;")
-	cmd.SetTimeoutMS(5)
+	cmd := NewCommand("timeout 0.005;", WithTimeout(5*time.Millisecond))
 
 	err := cmd.Execute()
 
@@ -28,8 +28,7 @@ func TestCommand_WithTimeout(t *testing.T) {
 }
 
 func TestCommand_WithValidTimeout(t *testing.T) {
-	cmd := NewCommand("timeout 0.01;")
-	cmd.SetTimeoutMS(1000)
+	cmd := NewCommand("timeout 0.01;", WithTimeout(1000*time.Millisecond))
 
 	err := cmd.Execute()