From 0a6db1e235a2ae2c198525aab6fb59afeb6641e0 Mon Sep 17 00:00:00 2001
From: toby lorne <toby@toby.codes>
Date: Thu, 6 May 2021 20:07:02 +0200
Subject: [PATCH] Set consistently and eventually defaults on init

Closes #434

Signed-off-by: toby lorne <toby@toby.codes>
---
 env.go                                   | 40 ++++++++++++
 internal/defaults/defaults_suite_test.go | 13 ++++
 internal/defaults/env.go                 | 22 +++++++
 internal/defaults/env_test.go            | 81 ++++++++++++++++++++++++
 4 files changed, 156 insertions(+)
 create mode 100644 env.go
 create mode 100644 internal/defaults/defaults_suite_test.go
 create mode 100644 internal/defaults/env.go
 create mode 100644 internal/defaults/env_test.go

diff --git a/env.go b/env.go
new file mode 100644
index 000000000..62fd885a9
--- /dev/null
+++ b/env.go
@@ -0,0 +1,40 @@
+package gomega
+
+import (
+	"os"
+
+	"github.com/onsi/gomega/internal/defaults"
+)
+
+const (
+	ConsistentlyDurationEnvVarName        = "GOMEGA_DEFAULT_CONSISTENTLY_DURATION"
+	ConsistentlyPollingIntervalEnvVarName = "GOMEGA_DEFAULT_CONSISTENTLY_POLLING_INTERVAL"
+	EventuallyTimeoutEnvVarName           = "GOMEGA_DEFAULT_EVENTUALLY_TIMEOUT"
+	EventuallyPollingIntervalEnvVarName   = "GOMEGA_DEFAULT_EVENTUALLY_POLLING_INTERVAL"
+)
+
+func init() {
+	defaults.SetDurationFromEnv(
+		os.Getenv,
+		SetDefaultConsistentlyDuration,
+		ConsistentlyDurationEnvVarName,
+	)
+
+	defaults.SetDurationFromEnv(
+		os.Getenv,
+		SetDefaultConsistentlyPollingInterval,
+		ConsistentlyPollingIntervalEnvVarName,
+	)
+
+	defaults.SetDurationFromEnv(
+		os.Getenv,
+		SetDefaultEventuallyTimeout,
+		EventuallyTimeoutEnvVarName,
+	)
+
+	defaults.SetDurationFromEnv(
+		os.Getenv,
+		SetDefaultEventuallyPollingInterval,
+		EventuallyPollingIntervalEnvVarName,
+	)
+}
diff --git a/internal/defaults/defaults_suite_test.go b/internal/defaults/defaults_suite_test.go
new file mode 100644
index 000000000..004a02b8e
--- /dev/null
+++ b/internal/defaults/defaults_suite_test.go
@@ -0,0 +1,13 @@
+package defaults_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestDefaults(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Gomega Defaults Suite")
+}
diff --git a/internal/defaults/env.go b/internal/defaults/env.go
new file mode 100644
index 000000000..bc29c63d5
--- /dev/null
+++ b/internal/defaults/env.go
@@ -0,0 +1,22 @@
+package defaults
+
+import (
+	"fmt"
+	"time"
+)
+
+func SetDurationFromEnv(getDurationFromEnv func(string) string, varSetter func(time.Duration), name string) {
+	durationFromEnv := getDurationFromEnv(name)
+
+	if len(durationFromEnv) == 0 {
+		return
+	}
+
+	duration, err := time.ParseDuration(durationFromEnv)
+
+	if err != nil {
+		panic(fmt.Sprintf("Expected a duration when using %s!  Parse error %v", name, err))
+	}
+
+	varSetter(duration)
+}
diff --git a/internal/defaults/env_test.go b/internal/defaults/env_test.go
new file mode 100644
index 000000000..138cfe9f9
--- /dev/null
+++ b/internal/defaults/env_test.go
@@ -0,0 +1,81 @@
+package defaults_test
+
+import (
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	d "github.com/onsi/gomega/internal/defaults"
+)
+
+var _ = Describe("Durations", func() {
+	var (
+		duration       *time.Duration
+		envVarGot      string
+		envVarToReturn string
+
+		getDurationFromEnv = func(name string) string {
+			envVarGot = name
+			return envVarToReturn
+		}
+
+		setDuration = func(t time.Duration) {
+			duration = &t
+		}
+
+		setDurationCalled = func() bool {
+			return duration != nil
+		}
+
+		resetDuration = func() {
+			duration = nil
+		}
+	)
+
+	BeforeEach(func() {
+		resetDuration()
+	})
+
+	Context("When the environment has a duration", func() {
+		Context("When the duration is valid", func() {
+			BeforeEach(func() {
+				envVarToReturn = "10m"
+
+				d.SetDurationFromEnv(getDurationFromEnv, setDuration, "MY_ENV_VAR")
+			})
+
+			It("sets the duration", func() {
+				Expect(envVarGot).To(Equal("MY_ENV_VAR"))
+				Expect(setDurationCalled()).To(Equal(true))
+				Expect(*duration).To(Equal(10 * time.Minute))
+			})
+		})
+
+		Context("When the duration is not valid", func() {
+			BeforeEach(func() {
+				envVarToReturn = "10"
+			})
+
+			It("panics with a helpful error message", func() {
+				Expect(func() {
+					d.SetDurationFromEnv(getDurationFromEnv, setDuration, "MY_ENV_VAR")
+				}).To(PanicWith(MatchRegexp("Expected a duration when using MY_ENV_VAR")))
+			})
+		})
+	})
+
+	Context("When the environment does not have a duration", func() {
+		BeforeEach(func() {
+			envVarToReturn = ""
+
+			d.SetDurationFromEnv(getDurationFromEnv, setDuration, "MY_ENV_VAR")
+		})
+
+		It("does not set the duration", func() {
+			Expect(envVarGot).To(Equal("MY_ENV_VAR"))
+			Expect(setDurationCalled()).To(Equal(false))
+			Expect(duration).To(BeNil())
+		})
+	})
+})