Set default timeout to 30min and add WithoutTimeout option

Author: SimonBaeumer

README.md

@@ -34,6 +34,7 @@ Default option functions:
 
  - `cmd.WithStandardStreams`
  - `cmd.WithTimeout(time.Duration)`
+ - `cmd.WithoutTimeout`
 
 #### Example
 

command.go

@@ -30,6 +30,7 @@ type Command struct {
 
 // NewCommand creates a new command
 // You can add option with variadic option argument
+// Default timeout is set to 30 minutes
 //
 // Example:
 //      c := cmd.NewCommand("echo hello", function (c *Command) {
@@ -45,7 +46,7 @@ type Command struct {
 func NewCommand(cmd string, options ...func(*Command)) *Command {
 	c := &Command{
 		Command:  cmd,
-		Timeout:  1 * time.Minute,
+		Timeout:  30 * time.Minute,
 		executed: false,
 		Env:      []string{},
 	}
@@ -84,6 +85,11 @@ func WithTimeout(t time.Duration) func(c *Command) {
 	}
 }
 
+// WithoutTimeout disables the timeout for the command
+func WithoutTimeout(c *Command) {
+	c.Timeout = 0
+}
+
 // 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) {
@@ -147,6 +153,12 @@ func (c *Command) Execute() error {
 	cmd.Stderr = c.StderrWriter
 	cmd.Dir = c.WorkingDir
 
+	// Create timer only if timeout was set > 0
+	var timeoutChan = make(<-chan time.Time, 1)
+	if c.Timeout != 0 {
+		timeoutChan = time.After(c.Timeout)
+	}
+
 	err := cmd.Start()
 	if err != nil {
 		return err
@@ -173,15 +185,14 @@ func (c *Command) Execute() error {
 			break
 		}
 		c.exitCode = 0
-	case <-time.After(c.Timeout):
+	case <-timeoutChan:
 		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)
 		}
 		return fmt.Errorf("Command timed out after %v", c.Timeout)
 	}
 
-	//Remove leading and trailing whitespaces
 	c.executed = true
 
 	return nil

command_linux_test.go

@@ -19,7 +19,7 @@ func TestCommand_ExecuteStderr(t *testing.T) {
 }
 
 func TestCommand_WithTimeout(t *testing.T) {
-	cmd := NewCommand("sleep 0.01;", WithTimeout(1*time.Millisecond))
+	cmd := NewCommand("sleep 0.1;", WithTimeout(1*time.Millisecond))
 
 	err := cmd.Execute()
 
@@ -65,3 +65,12 @@ func TestCommand_WithStandardStreams(t *testing.T) {
 	assert.Nil(t, err)
 	assert.Equal(t, "hey\n", string(r))
 }
+
+func TestCommand_WithoutTimeout(t *testing.T) {
+	cmd := NewCommand("sleep 0.001; echo hello", WithoutTimeout)
+
+	err := cmd.Execute()
+
+	assert.Nil(t, err)
+	assert.Equal(t, "hello\n", cmd.Stdout())
+}