feat: add $RYUK_CONNECTION_TIMEOUT to configure connection timeout

README.md

@@ -34,3 +34,7 @@ This project helps you to remove containers/networks/volumes/images by given fil
         2018/01/15 18:38:52 Deleting {"label":{"something_else":true}}
         2018/01/15 18:38:52 Deleting {"health":{"unhealthy":true},"label":{"testing=true":true}}
         2018/01/15 18:38:52 Removed 1 container(s), 0 network(s), 0 volume(s), 0 image(s)
+
+## Ryuk configuration
+
+- `RYUK_CONNECTION_TIMEOUT` - Environment variable that defines the timeout for Ryuk to receive the first connection (default: 60s). Value layout is described in [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) documentation.

main.go

@@ -8,6 +8,7 @@ import (
 	"log"
 	"net"
 	"net/url"
+	"os"
 	"os/signal"
 	"strings"
 	"sync"
@@ -20,22 +21,71 @@ import (
 	"gopkg.in/matryer/try.v1"
 )
 
-const ryukLabel = "org.testcontainers.ryuk"
+const (
+	connectionTimeoutEnv string = "RYUK_CONNECTION_TIMEOUT"
+	ryukLabel            string = "org.testcontainers.ryuk"
+)
 
 var (
-	port                  = flag.Int("p", 8080, "Port to bind at")
-	initialConnectTimeout = 1 * time.Minute
-	reconnectionTimeout   = 10 * time.Second
+	port                int
+	connectionTimeout   time.Duration
+	reconnectionTimeout time.Duration
 )
 
+type config struct {
+	Port                int
+	ConnectionTimeout   time.Duration
+	ReconnectionTimeout time.Duration
+}
+
+// newConfig parses command line flags and returns a parsed config. config.timeout
+// can be set by environment variable, RYUK_CONNECTION_TIMEOUT. If an error occurs
+// while parsing RYUK_CONNECTION_TIMEOUT the error is returned.
+func newConfig(args []string) (*config, error) {
+	cfg := config{
+		ConnectionTimeout:   60 * time.Second,
+		ReconnectionTimeout: 10 * time.Second,
+	}
+
+	fs := flag.NewFlagSet("ryuk", flag.ExitOnError)
+	fs.SetOutput(os.Stdout)
+
+	fs.IntVar(&cfg.Port, "p", 8080, "Port to bind at")
+
+	err := fs.Parse(args)
+	if err != nil {
+		return nil, err
+	}
+
+	if timeout, ok := os.LookupEnv(connectionTimeoutEnv); ok {
+		parsedTimeout, err := time.ParseDuration(timeout)
+		if err != nil {
+			return nil, fmt.Errorf("failed to parse \"%s\": %s", connectionTimeoutEnv, err)
+		}
+
+		cfg.ConnectionTimeout = parsedTimeout
+	}
+
+	return &cfg, nil
+}
+
 func main() {
-	flag.Parse()
+	cfg, err := newConfig(os.Args[1:])
+	if err != nil {
+		panic(err)
+	}
 
-	cli, err := client.NewClientWithOpts()
+	port = cfg.Port
+	connectionTimeout = cfg.ConnectionTimeout
+	reconnectionTimeout = cfg.ReconnectionTimeout
+
+	cli, err := client.NewClientWithOpts(client.FromEnv)
 	if err != nil {
 		panic(err)
 	}
 
+	cli.NegotiateAPIVersion(context.Background())
+
 	pingCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
 	defer cancel()
 
@@ -64,9 +114,9 @@ func main() {
 }
 
 func processRequests(deathNote *sync.Map, connectionAccepted chan<- net.Addr, connectionLost chan<- net.Addr) {
-	log.Printf("Starting on port %d...", *port)
+	log.Printf("Starting on port %d...", port)
 
-	ln, err := net.Listen("tcp", fmt.Sprintf(":%d", *port))
+	ln, err := net.Listen("tcp", fmt.Sprintf(":%d", port))
 	if err != nil {
 		panic(err)
 	}
@@ -139,7 +189,7 @@ func waitForPruneCondition(ctx context.Context, connectionAccepted <-chan net.Ad
 	}
 
 	select {
-	case <-time.After(initialConnectTimeout):
+	case <-time.After(connectionTimeout):
 		panic("Timed out waiting for the first connection")
 	case addr := <-connectionAccepted:
 		handleConnectionAccepted(addr)

main_test.go

@@ -19,7 +19,7 @@ import (
 	"github.com/docker/docker/client"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	testcontainers "github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go"
 )
 
 var addr = &net.TCPAddr{
@@ -28,12 +28,16 @@ var addr = &net.TCPAddr{
 	Zone: "",
 }
 
+var testConnectionTimeout time.Duration = 5 * time.Second
+
 func init() {
-	initialConnectTimeout = 5 * time.Second
 	reconnectionTimeout = 1 * time.Second
 }
 
 func TestReconnectionTimeout(t *testing.T) {
+	// reset connectionTimeout
+	connectionTimeout = testConnectionTimeout
+
 	acc := make(chan net.Addr)
 	lost := make(chan net.Addr)
 
@@ -56,6 +60,9 @@ func TestReconnectionTimeout(t *testing.T) {
 }
 
 func TestInitialTimeout(t *testing.T) {
+	// reset connectionTimeout
+	connectionTimeout = testConnectionTimeout
+
 	acc := make(chan net.Addr)
 	lost := make(chan net.Addr)
 
@@ -80,7 +87,7 @@ func TestInitialTimeout(t *testing.T) {
 }
 
 func TestPrune(t *testing.T) {
-	cli, err := client.NewClientWithOpts()
+	cli, err := client.NewClientWithOpts(client.FromEnv)
 	cli.NegotiateAPIVersion(context.Background())
 
 	if err == nil {
@@ -93,6 +100,7 @@ func TestPrune(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
+	cli.NegotiateAPIVersion(context.Background())
 
 	maxLength := 25
 
@@ -303,3 +311,27 @@ func TestPrune(t *testing.T) {
 		assert.Equal(t, maxLength, di)
 	})
 }
+
+func Test_newConfig(t *testing.T) {
+	t.Run("should return an error when failing to parse the environment variable", func(t *testing.T) {
+		t.Setenv(connectionTimeoutEnv, "bad_value")
+
+		config, err := newConfig([]string{})
+		require.NotNil(t, err)
+		require.Nil(t, config)
+	})
+
+	t.Run("should set connectionTimeout with the environment variable", func(t *testing.T) {
+		t.Setenv(connectionTimeoutEnv, "10s")
+
+		config, err := newConfig([]string{})
+		require.Nil(t, err)
+		assert.Equal(t, 10*time.Second, config.ConnectionTimeout)
+	})
+
+	t.Run("should set port", func(t *testing.T) {
+		config, err := newConfig([]string{"-p", "3000"})
+		require.Nil(t, err)
+		assert.Equal(t, 3000, config.Port)
+	})
+}