Add retry interval

Author: SimonBaeumer

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v1.2.0
+
+ - Add `interval` option for `retries` which allows to execute a retry after a given period of time. I.e. `interval: 50ms`
+
 # v1.1.0
 
  - Add `not-contains` assertion on `stdout` and `stderr`

commander_unix.yaml

@@ -52,5 +52,7 @@ tests:
     stdout:
       contains:
         - ✗ echo hello, retries 3
-        - ✓ ./integration/unix/_fixtures/retries.sh, retries 2
+        - ✓ it should retry failed commands, retries 2
+        - ✗ it should retry failed commands with an interval, retries 2
+        - "Duration: 0.1" # Assertion that the interval is working
     exit-code: 1

docs/manual.md

@@ -68,5 +68,6 @@ tests:
                 ANOTHER: yeah # Add another env variable
             timeout: 1000 # Overwrite timeout
             retries: 5
+            interval: 30ms
         exit-code: 0
 ```

integration/unix/retries.yaml

@@ -4,7 +4,16 @@ tests:
     config:
       retries: 3
 
-  ./integration/unix/_fixtures/retries.sh:
+  it should retry failed commands:
+    command: ./integration/unix/_fixtures/retries.sh
     exit-code: 0
     config:
+      retries: 2
+
+  it should retry failed commands with an interval:
+    command: echo hello
+    stdout: fail
+    exit-code: 0
+    config:
+      interval: 50ms
       retries: 2

pkg/runtime/runtime.go

@@ -1,11 +1,13 @@
 package runtime
 
 import (
+	"fmt"
 	"github.com/SimonBaeumer/commander/pkg/cmd"
 	"log"
 	"runtime"
 	"strings"
 	"sync"
+	"time"
 )
 
 // Constants for defining the various tested properties
@@ -122,6 +124,14 @@ func Start(tests []TestCase, maxConcurrent int) <-chan TestResult {
 					if result.ValidationResult.Success {
 						break
 					}
+
+					if t.Command.GetRetries() > 1 && t.Command.Interval != "" {
+						interval, err := time.ParseDuration(t.Command.Interval)
+						if err != nil {
+							panic(fmt.Sprintf("'%s' interval error: %s", t.Command.Cmd, err))
+						}
+						time.Sleep(interval)
+					}
 				}
 
 				out <- result

pkg/runtime/runtime_test.go

@@ -5,6 +5,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"runtime"
 	"testing"
+	"time"
 )
 
 const SingleConcurrent = 1
@@ -37,7 +38,29 @@ func TestRuntime_WithRetries(t *testing.T) {
 		assert.False(t, r.ValidationResult.Success)
 		assert.Equal(t, 3, r.Tries)
 	}
+
+	assert.Equal(t, 1, counter)
+}
+
+func TestRuntime_WithRetriesAndInterval(t *testing.T) {
+	s := getExampleTestSuite()
+	s[0].Command.Retries = 3
+	s[0].Command.Cmd = "echo fail"
+	s[0].Command.Interval = "50ms"
+
+	start := time.Now()
+	got := Start(s, 1)
+
+	var counter = 0
+	for r := range got {
+		counter++
+		assert.False(t, r.ValidationResult.Success)
+		assert.Equal(t, 3, r.Tries)
+	}
+	duration := time.Since(start)
+
 	assert.Equal(t, 1, counter)
+	assert.True(t, duration.Seconds() > 0.15, "Retry interval did not work")
 }
 
 func TestRuntime_WithEnvVariables(t *testing.T) {