Set expiration for keys in deviceInUse cache. Add unit test.

Author: davis-haba

pkg/gce-pd-csi-driver/device_error_map.go

@@ -15,11 +15,10 @@ limitations under the License.
 package gceGCEDriver
 
 import (
-	"fmt"
 	"sync"
 	"time"
 
-	lru "github.com/hashicorp/golang-lru/v2"
+	"github.com/hashicorp/golang-lru/v2/expirable"
 	"k8s.io/klog/v2"
 )
 
@@ -34,14 +33,11 @@ var currentTime = time.Now
 type deviceErrMap struct {
 	timeout time.Duration
 	mux     sync.Mutex
-	cache   *lru.Cache[string, time.Time]
+	cache   *expirable.LRU[string, time.Time]
 }
 
 func newDeviceErrMap(timeout time.Duration) *deviceErrMap {
-	c, err := lru.New[string, time.Time](maxDeviceCacheSize)
-	if err != nil {
-		panic(fmt.Sprintf("Could not initialize deviceInUse LRU cache: %s", err))
-	}
+	c := expirable.NewLRU[string, time.Time](maxDeviceCacheSize, nil, timeout*2)
 
 	return &deviceErrMap{
 		cache:   c,

pkg/gce-pd-csi-driver/device_error_map_test.go

@@ -0,0 +1,48 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package gceGCEDriver
+
+import (
+	"testing"
+	"time"
+)
+
+func TestDeviceErrorMap(t *testing.T) {
+	timeout := time.Second * 10
+	dName := "fake-device"
+	eMap := newDeviceErrMap(timeout)
+	defer func() { currentTime = time.Now }()
+
+	// Register an error. Checking the timeout right after should return false
+	stubCurrentTime(0)
+	eMap.markDeviceError(dName)
+	isTimedOut := eMap.checkDeviceErrorTimeout(dName)
+	if isTimedOut {
+		t.Errorf("checkDeviceErrorTimeout expected to be false if called immediately after marking an error")
+	}
+
+	// Advance time. Checking the timeout should now return true
+	stubCurrentTime(int64(timeout.Seconds()) + 1)
+	isTimedOut = eMap.checkDeviceErrorTimeout(dName)
+	if !isTimedOut {
+		t.Errorf("checkDeviceErrorTimeout expected to be true after waiting for timeout")
+	}
+}
+
+func stubCurrentTime(unixTime int64) {
+	currentTime = func() time.Time {
+		return time.Unix(unixTime, 0)
+	}
+}