From 15de770ae26a07e72a255fedb863c2d99a671a04 Mon Sep 17 00:00:00 2001 From: constanca Date: Mon, 8 Jan 2024 09:10:56 +0100 Subject: [PATCH] Refactor function name and add comments Signed-off-by: constanca --- metricbeat/module/kubernetes/util/kubernetes.go | 10 ++++++---- metricbeat/module/kubernetes/util/kubernetes_test.go | 6 +++--- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/metricbeat/module/kubernetes/util/kubernetes.go b/metricbeat/module/kubernetes/util/kubernetes.go index ab607865c72a..ecfd80a5e61f 100644 --- a/metricbeat/module/kubernetes/util/kubernetes.go +++ b/metricbeat/module/kubernetes/util/kubernetes.go @@ -243,6 +243,8 @@ func startWatcher( return false, nil } +// addToWhichAreUsing adds resource identified by usingName to the list of resources using the watcher +// identified by resourceName func addToWhichAreUsing(resourceName string, usingName string, resourceWatchers *Watchers) { resourceWatchers.lock.Lock() defer resourceWatchers.lock.Unlock() @@ -263,9 +265,9 @@ func addToWhichAreUsing(resourceName string, usingName string, resourceWatchers } } -// removeToWhichAreUsing returns true if element was removed and new size of array. +// removeFromWhichAreUsing returns true if element was removed and new size of array. // The cache should be locked when called. -func removeToWhichAreUsing(resourceName string, notUsingName string, resourceWatchers *Watchers) (bool, int) { +func removeFromWhichAreUsing(resourceName string, notUsingName string, resourceWatchers *Watchers) (bool, int) { data, ok := resourceWatchers.watchersMap[resourceName] removed := false if ok { @@ -793,7 +795,7 @@ func (e *enricher) Stop(resourceWatchers *Watchers) { resourceWatcher := resourceWatchers.watchersMap[e.resourceName] if resourceWatcher != nil && resourceWatcher.watcher != nil && resourceWatcher.whichAreUsing != nil && resourceWatcher.started { - _, size := removeToWhichAreUsing(e.resourceName, e.resourceName, resourceWatchers) + _, size := removeFromWhichAreUsing(e.resourceName, e.resourceName, resourceWatchers) if size == 0 { resourceWatcher.watcher.Stop() resourceWatcher.started = false @@ -804,7 +806,7 @@ func (e *enricher) Stop(resourceWatchers *Watchers) { for _, extra := range extras { extraWatcher := resourceWatchers.watchersMap[extra] if extraWatcher != nil && extraWatcher.watcher != nil && extraWatcher.whichAreUsing != nil && extraWatcher.started { - _, size := removeToWhichAreUsing(extra, e.resourceName, resourceWatchers) + _, size := removeFromWhichAreUsing(extra, e.resourceName, resourceWatchers) if size == 0 { extraWatcher.watcher.Stop() extraWatcher.started = false diff --git a/metricbeat/module/kubernetes/util/kubernetes_test.go b/metricbeat/module/kubernetes/util/kubernetes_test.go index f87417ab1389..199748f7d801 100644 --- a/metricbeat/module/kubernetes/util/kubernetes_test.go +++ b/metricbeat/module/kubernetes/util/kubernetes_test.go @@ -168,15 +168,15 @@ func TestRemoveToWhichAreUsing(t *testing.T) { resourceWatchers.lock.Lock() defer resourceWatchers.lock.Unlock() - removed, size := removeToWhichAreUsing(DeploymentResource, DeploymentResource, resourceWatchers) + removed, size := removeFromWhichAreUsing(DeploymentResource, DeploymentResource, resourceWatchers) require.True(t, removed) require.Equal(t, 1, size) - removed, size = removeToWhichAreUsing(DeploymentResource, DeploymentResource, resourceWatchers) + removed, size = removeFromWhichAreUsing(DeploymentResource, DeploymentResource, resourceWatchers) require.False(t, removed) require.Equal(t, 1, size) - removed, size = removeToWhichAreUsing(DeploymentResource, PodResource, resourceWatchers) + removed, size = removeFromWhichAreUsing(DeploymentResource, PodResource, resourceWatchers) require.True(t, removed) require.Equal(t, 0, size) }