Add unit tests to client cache implementation

Author: wongni

pkg/cloud/client.go

@@ -205,6 +205,12 @@ func generateClientCacheKey(conf Config) string {
 
 func newClientCache(clientConfig *corev1.ConfigMap) *ttlcache.Cache {
 	clientCache := ttlcache.NewCache()
+	clientCache.SetTTL(GetClientCacheTTL(clientConfig))
+	clientCache.SkipTtlExtensionOnHit(false)
+	return clientCache
+}
+
+func GetClientCacheTTL(clientConfig *corev1.ConfigMap) time.Duration {
 	var cacheTTL time.Duration
 	if clientConfig != nil {
 		if ttl, exists := clientConfig.Data[ClientCacheTTLKey]; exists {
@@ -214,7 +220,5 @@ func newClientCache(clientConfig *corev1.ConfigMap) *ttlcache.Cache {
 	if cacheTTL == 0 {
 		cacheTTL = DefaultClientCacheTTL
 	}
-	clientCache.SetTTL(cacheTTL)
-	clientCache.SkipTtlExtensionOnHit(false)
-	return clientCache
+	return cacheTTL
 }

pkg/cloud/client_test.go

@@ -18,6 +18,9 @@ package cloud_test
 
 import (
 	"os"
+	"time"
+
+	corev1 "k8s.io/api/core/v1"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -36,17 +39,18 @@ var _ = Describe("Instance", func() {
 	var ()
 
 	BeforeEach(func() {
-		// This test fixture is useful for development, but the actual method of parsing is confinded to the client's
-		// new client method. The parsing used here is more of a schema, and we don't need to test another library's
-		// abilities to parse said schema.
-		Skip("Dev test suite.")
 	})
 
 	AfterEach(func() {
 	})
 
 	Context("When fetching a YAML config.", func() {
 		It("Handles the positive case.", func() {
+			// This test fixture is useful for development, but the actual method of parsing is confinded to the client's
+			// new client method. The parsing used here is more of a schema, and we don't need to test another library's
+			// abilities to parse said schema.
+			Skip("Dev test suite.")
+
 			// Create a real cloud client.
 			var connectionErr error
 			_, connectionErr = helpers.NewCSClient()
@@ -56,4 +60,97 @@ var _ = Describe("Instance", func() {
 			Ω(connectionErr).ShouldNot(HaveOccurred())
 		})
 	})
+
+	Context("GetClientCacheTTL", func() {
+		It("Returns the default TTL when a nil is passed", func() {
+			result := cloud.GetClientCacheTTL(nil)
+			Ω(result).Should(Equal(cloud.DefaultClientCacheTTL))
+		})
+
+		It("Returns the default TTL when an empty config map is passed", func() {
+			clientConfig := &corev1.ConfigMap{}
+			result := cloud.GetClientCacheTTL(clientConfig)
+			Ω(result).Should(Equal(cloud.DefaultClientCacheTTL))
+		})
+
+		It("Returns the default TTL when the TTL key does not exist", func() {
+			clientConfig := &corev1.ConfigMap{}
+			clientConfig.Data = map[string]string{}
+			clientConfig.Data[cloud.ClientCacheTTLKey+"XXXX"] = "1m5s"
+			result := cloud.GetClientCacheTTL(clientConfig)
+			Ω(result).Should(Equal(cloud.DefaultClientCacheTTL))
+		})
+
+		It("Returns the default TTL when the TTL value is invalid", func() {
+			clientConfig := &corev1.ConfigMap{}
+			clientConfig.Data = map[string]string{}
+			clientConfig.Data[cloud.ClientCacheTTLKey] = "5mXXX"
+			result := cloud.GetClientCacheTTL(clientConfig)
+			Ω(result).Should(Equal(cloud.DefaultClientCacheTTL))
+		})
+
+		It("Returns the TTL from the input clientConfig map", func() {
+			clientConfig := &corev1.ConfigMap{}
+			clientConfig.Data = map[string]string{}
+			clientConfig.Data[cloud.ClientCacheTTLKey] = "5m10s"
+			expected, _ := time.ParseDuration("5m10s")
+			result := cloud.GetClientCacheTTL(clientConfig)
+			Ω(result).Should(Equal(expected))
+		})
+	})
+
+	Context("NewClientFromConf", func() {
+		clientConfig := &corev1.ConfigMap{}
+
+		BeforeEach(func() {
+			clientConfig.Data = map[string]string{}
+			clientConfig.Data[cloud.ClientCacheTTLKey] = "100ms"
+		})
+
+		It("Returns a new client", func() {
+			config := cloud.Config{
+				APIUrl: "http://1.1.1.1",
+			}
+			result, err := cloud.NewClientFromConf(config, clientConfig)
+			Ω(err).ShouldNot(HaveOccurred())
+			Ω(result).ShouldNot(BeNil())
+		})
+
+		It("Returns a new client for a different config", func() {
+			config1 := cloud.Config{
+				APIUrl: "http://2.2.2.2",
+			}
+			config2 := cloud.Config{
+				APIUrl: "http://3.3.3.3",
+			}
+			result1, _ := cloud.NewClientFromConf(config1, clientConfig)
+			result2, _ := cloud.NewClientFromConf(config2, clientConfig)
+			Ω(result1).ShouldNot(Equal(result2))
+		})
+
+		It("Returns a cached client for the same config", func() {
+			config1 := cloud.Config{
+				APIUrl: "http://4.4.4.4",
+			}
+			config2 := cloud.Config{
+				APIUrl: "http://4.4.4.4",
+			}
+			result1, _ := cloud.NewClientFromConf(config1, clientConfig)
+			result2, _ := cloud.NewClientFromConf(config2, clientConfig)
+			Ω(result1).Should(Equal(result2))
+		})
+
+		It("Returns a new client after cache expiration", func() {
+			config1 := cloud.Config{
+				APIUrl: "http://5.5.5.5",
+			}
+			config2 := cloud.Config{
+				APIUrl: "http://5.5.5.5",
+			}
+			result1, _ := cloud.NewClientFromConf(config1, clientConfig)
+			time.Sleep(150 * time.Millisecond)
+			result2, _ := cloud.NewClientFromConf(config2, clientConfig)
+			Ω(result1).ShouldNot(Equal(result2))
+		})
+	})
 })