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.

Sign up for GitHub

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

feat: make cleaner safe for concurrent use #552

Merged
merged 2 commits into from
Feb 10, 2023
Merged

feat: make cleaner safe for concurrent use #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81921a0
feat: make cleaner safe for concurrent use
pmalek Feb 10, 2023
6087e54
Merge branch 'main' into concurrent-cleaner
pmalek Feb 10, 2023
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

- Fix calico manifests URL
[#555](https://github.com/Kong/kubernetes-testing-framework/pull/555)
- `clusters.Cleaner` can be used concurrently
[#552](https://github.com/Kong/kubernetes-testing-framework/pull/552)

## v0.28.1

Expand Down
10 changes: 10 additions & 0 deletions pkg/clusters/cleanup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"strings"
"sync"

"golang.org/x/sync/errgroup"
corev1 "k8s.io/api/core/v1"
Expand All @@ -28,6 +29,7 @@ type Cleaner struct {
objects []client.Object
manifests []string
namespaces []*corev1.Namespace
lock sync.RWMutex
}

// NewCleaner provides a new initialized *Cleaner object.
Expand All @@ -40,18 +42,26 @@ func NewCleaner(cluster Cluster) *Cleaner {
// -----------------------------------------------------------------------------

func (c *Cleaner) Add(obj client.Object) {
c.lock.Lock()
defer c.lock.Unlock()
c.objects = append([]client.Object{obj}, c.objects...)
}

func (c *Cleaner) AddManifest(manifest string) {
c.lock.Lock()
defer c.lock.Unlock()
c.manifests = append(c.manifests, manifest)
}

func (c *Cleaner) AddNamespace(namespace *corev1.Namespace) {
c.lock.Lock()
defer c.lock.Unlock()
c.namespaces = append(c.namespaces, namespace)
}

func (c *Cleaner) Cleanup(ctx context.Context) error {
c.lock.RLock()
defer c.lock.RUnlock()
Comment on lines +63 to +64
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure in practice if this will end up mattering, but it seems a bit odd to make the actual cleanup a "ready only" lock, considering all the mutations it's making.

Actually, it occurs to me now that what we should probably do is lock the object and block all future changes once we've run cleanup. E.g. any Add to the cleaner fails after Cleanup is called.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've create an issue to track this: #563.

This should be OK for now (at least for our internal usage). We might take another approach at this when indeed we use cleaners more than once.

dyn, err := dynamic.NewForConfig(c.cluster.Config())
if err != nil {
return err
Expand Down
22 changes: 22 additions & 0 deletions pkg/clusters/cleanup_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package clusters

import (
"fmt"
"testing"

"github.com/stretchr/testify/assert"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -119,3 +121,23 @@ func TestFixupObjKinds(t *testing.T) {
})
}
}

func TestCleanerCanBeUsedConcurrently(t *testing.T) {
cleaner := NewCleaner(nil)
for i := 0; i < 100; i++ {
i := i
go func() {
cleaner.Add(&v1.Pod{})
}()
go func() {
cleaner.AddManifest(fmt.Sprintf("manifest-%d.yaml", i))
}()
go func() {
cleaner.AddNamespace(&v1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("ns-%d", i),
},
})
}()
}
}