expiration_cache_fakes.go

Documentation: k8s.io/client-go/tools/cache

     1  /*
     2  Copyright 2014 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package cache
    18  
    19  import (
    20  	"k8s.io/apimachinery/pkg/util/sets"
    21  	"k8s.io/utils/clock"
    22  )
    23  
    24  type fakeThreadSafeMap struct {
    25  	ThreadSafeStore
    26  	deletedKeys chan<- string
    27  }
    28  
    29  func (c *fakeThreadSafeMap) Delete(key string) {
    30  	if c.deletedKeys != nil {
    31  		c.ThreadSafeStore.Delete(key)
    32  		c.deletedKeys <- key
    33  	}
    34  }
    35  
    36  // FakeExpirationPolicy keeps the list for keys which never expires.
    37  type FakeExpirationPolicy struct {
    38  	NeverExpire     sets.String
    39  	RetrieveKeyFunc KeyFunc
    40  }
    41  
    42  // IsExpired used to check if object is expired.
    43  func (p *FakeExpirationPolicy) IsExpired(obj *TimestampedEntry) bool {
    44  	key, _ := p.RetrieveKeyFunc(obj)
    45  	return !p.NeverExpire.Has(key)
    46  }
    47  
    48  // NewFakeExpirationStore creates a new instance for the ExpirationCache.
    49  func NewFakeExpirationStore(keyFunc KeyFunc, deletedKeys chan<- string, expirationPolicy ExpirationPolicy, cacheClock clock.Clock) Store {
    50  	cacheStorage := NewThreadSafeStore(Indexers{}, Indices{})
    51  	return &ExpirationCache{
    52  		cacheStorage:     &fakeThreadSafeMap{cacheStorage, deletedKeys},
    53  		keyFunc:          keyFunc,
    54  		clock:            cacheClock,
    55  		expirationPolicy: expirationPolicy,
    56  	}
    57  }
    58
View as plain text