pkg/testutils: utility functions to facilitate writing Go tests

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <[email protected]> (github: shykes)

engine/remote_test.go

@@ -5,6 +5,7 @@ import (
 	"bytes"
 	"fmt"
 	"github.com/dotcloud/docker/pkg/beam"
+	"github.com/dotcloud/docker/pkg/testutils"
 	"io"
 	"strings"
 	"testing"
@@ -143,21 +144,7 @@ func testRemote(t *testing.T, senderSide, receiverSide func(*Engine)) {
 	receiverSide(receiver.Engine)
 	go receiver.Run()
 
-	timeout(t, func() {
+	testutils.Timeout(t, func() {
 		senderSide(eng)
 	})
 }
-
-func timeout(t *testing.T, f func()) {
-	onTimeout := time.After(100 * time.Millisecond)
-	onDone := make(chan bool)
-	go func() {
-		f()
-		close(onDone)
-	}()
-	select {
-	case <-onTimeout:
-		t.Fatalf("timeout")
-	case <-onDone:
-	}
-}

pkg/testutils/MAINTAINERS

@@ -0,0 +1 @@
+Solomon Hykes <[email protected]> (@shykes)

pkg/testutils/README.md

@@ -0,0 +1,2 @@
+`testutils` is a collection of utility functions to facilitate the writing
+of tests. It is used in various places by the Docker test suite.

pkg/testutils/testutils.go

@@ -0,0 +1,23 @@
+package testutils
+
+import (
+	"testing"
+	"time"
+)
+
+// Timeout calls f and waits for 100ms for it to complete.
+// If it doesn't, it causes the tests to fail.
+// t must be a valid testing context.
+func Timeout(t *testing.T, f func()) {
+	onTimeout := time.After(100 * time.Millisecond)
+	onDone := make(chan bool)
+	go func() {
+		f()
+		close(onDone)
+	}()
+	select {
+	case <-onTimeout:
+		t.Fatalf("timeout")
+	case <-onDone:
+	}
+}