Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option to set the deployment action cache TTL #1414

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pkg/controller/actions/deploy/action_deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ func WithAnnotations(values map[string]string) ActionOpts {
}
}

func WithCache() ActionOpts {
func WithCache(opts ...CacheOpt) ActionOpts {
return func(action *Action) {
action.cache = newCache()
action.cache = newCache(opts...)
}
}

Expand Down
35 changes: 26 additions & 9 deletions pkg/controller/actions/deploy/action_deploy_cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,44 @@ import (
// This code is heavily inspired by https://github.com/kubernetes-sigs/cluster-api/tree/main/internal/util/ssa

const (
// ttl is the duration for which we keep the keys in the cache.
ttl = 10 * time.Minute
DefaultCacheTTL = 10 * time.Minute
)

type Cache struct {
s cache.Store
s cache.Store
ttl time.Duration
}

func newCache() *Cache {
r := &Cache{
s: cache.NewTTLStore(func(obj interface{}) (string, error) {
type CacheOpt func(*Cache)

func WithTTL(ttl time.Duration) CacheOpt {
return func(c *Cache) {
c.ttl = ttl
}
}

func newCache(opts ...CacheOpt) *Cache {
c := Cache{
ttl: DefaultCacheTTL,
}

for i := range opts {
opts[i](&c)
lburgazzoli marked this conversation as resolved.
Show resolved Hide resolved
}

c.s = cache.NewTTLStore(
func(obj interface{}) (string, error) {
s, ok := obj.(string)
if !ok {
return "", errors.New("failed to cast object to string")
}

return s, nil
}, ttl),
}
},
c.ttl,
)

return r
return &c
}

func (r *Cache) Add(key string) {
Expand Down
80 changes: 80 additions & 0 deletions pkg/controller/actions/deploy/action_deploy_cache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"path/filepath"
"testing"
"time"

"github.com/blang/semver/v4"
"github.com/operator-framework/api/pkg/lib/version"
Expand Down Expand Up @@ -102,6 +103,22 @@ func TestDeployWithCacheAction(t *testing.T) {
},
false)
})

t.Run("CacheTTL(", func(t *testing.T) {
testCacheTTL(
t,
cli,
&corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{
APIVersion: gvk.ConfigMap.GroupVersion().String(),
Kind: gvk.ConfigMap.Kind,
},
ObjectMeta: metav1.ObjectMeta{
Name: xid.New().String(),
Namespace: xid.New().String(),
},
})
})
}

func testResourceNotReDeployed(t *testing.T, cli *client.Client, obj ctrlCli.Object, create bool) {
Expand Down Expand Up @@ -182,3 +199,66 @@ func testResourceNotReDeployed(t *testing.T, cli *client.Client, obj ctrlCli.Obj
// check that the resource version has not changed
g.Expect(out1.GetResourceVersion()).Should(Equal(out2.GetResourceVersion()))
}

func testCacheTTL(t *testing.T, cli *client.Client, obj ctrlCli.Object) {
t.Helper()

g := NewWithT(t)
ctx := context.Background()

in, err := resources.ToUnstructured(obj)
g.Expect(err).ShouldNot(HaveOccurred())

err = cli.Create(ctx, &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: in.GetNamespace(),
},
})

g.Expect(err).ShouldNot(HaveOccurred())

rr := types.ReconciliationRequest{
Client: cli,
DSCI: &dsciv1.DSCInitialization{Spec: dsciv1.DSCInitializationSpec{
ApplicationsNamespace: in.GetNamespace()},
},
DSC: &dscv1.DataScienceCluster{},
Instance: &componentsv1.Dashboard{
ObjectMeta: metav1.ObjectMeta{
Generation: 1,
},
},
Release: cluster.Release{
Name: cluster.OpenDataHub,
Version: version.OperatorVersion{Version: semver.Version{
Major: 1, Minor: 2, Patch: 3,
}}},
Resources: []unstructured.Unstructured{
*in.DeepCopy(),
},
}

ttl := 1 * time.Second

action := deploy.NewAction(
deploy.WithCache(deploy.WithTTL(ttl)),
deploy.WithMode(deploy.ModeSSA),
deploy.WithFieldOwner(xid.New().String()),
)

deploy.DeployedResourcesTotal.Reset()

err = action(ctx, &rr)
g.Expect(err).ShouldNot(HaveOccurred())
g.Expect(testutil.ToFloat64(deploy.DeployedResourcesTotal)).Should(BeNumerically("==", 1))

g.Eventually(func() (float64, error) {
if err := action(ctx, &rr); err != nil {
return 0, err
}

return testutil.ToFloat64(deploy.DeployedResourcesTotal), nil
}).WithTimeout(5 * ttl).WithPolling(2 * ttl).Should(
BeNumerically("==", 2),
)
}
Loading