generated from kyma-project/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* code cleanup Sorting imports. * add label selector for nats-manager Adds a labelselector for nats-manager instance. * add label selector for created-by: nats-manager * add cache options * add client options * add caching rules via client and cache to main * move label package from internal to pkg * add managed-by label * clean up labels * fix unit test * add statefulset * fix unit tests * remove client * use labelselector for more resources * fix comment * remove client
- Loading branch information
1 parent
0aeccd5
commit 6fd3d93
Showing
5 changed files
with
272 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| package cache | ||
|
|
||
| import ( | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| autoscalingv1 "k8s.io/api/autoscaling/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| policyv1 "k8s.io/api/policy/v1" | ||
| rbacv1 "k8s.io/api/rbac/v1" | ||
| "k8s.io/apimachinery/pkg/labels" | ||
| "k8s.io/client-go/rest" | ||
| "sigs.k8s.io/controller-runtime/pkg/cache" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| natslabels "github.com/kyma-project/nats-manager/pkg/labels" | ||
| ) | ||
|
|
||
| // New returns a cache with the cache-options applied, generade form the rest-config. | ||
| func New(config *rest.Config, options cache.Options) (cache.Cache, error) { | ||
| return cache.New(config, applySelectors(options)) | ||
| } | ||
|
|
||
| func applySelectors(options cache.Options) cache.Options { | ||
| // The only objects we allow are the ones with the 'managed-by: nats-manager' label applied. | ||
| managedByNATS := fromLabelSelector(natslabels.SelectorManagedByNATS()) | ||
|
|
||
| // Apply the label selector to all relevant objects. | ||
| options.ByObject = map[client.Object]cache.ByObject{ | ||
| &appsv1.Deployment{}: managedByNATS, | ||
| &appsv1.StatefulSet{}: managedByNATS, | ||
| &corev1.ServiceAccount{}: managedByNATS, | ||
| &corev1.Secret{}: managedByNATS, | ||
| &corev1.Service{}: managedByNATS, | ||
| &corev1.ConfigMap{}: managedByNATS, | ||
| &rbacv1.ClusterRole{}: managedByNATS, | ||
| &rbacv1.ClusterRoleBinding{}: managedByNATS, | ||
| &autoscalingv1.HorizontalPodAutoscaler{}: managedByNATS, | ||
| &policyv1.PodDisruptionBudget{}: managedByNATS, | ||
| } | ||
| return options | ||
| } | ||
|
|
||
| func fromLabelSelector(selector labels.Selector) cache.ByObject { | ||
| return cache.ByObject{Label: selector} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| package cache | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "testing" | ||
| "time" | ||
|
|
||
| natslabels "github.com/kyma-project/nats-manager/pkg/labels" | ||
| "github.com/stretchr/testify/require" | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| autoscalingv1 "k8s.io/api/autoscaling/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| policyv1 "k8s.io/api/policy/v1" | ||
| rbacv1 "k8s.io/api/rbac/v1" | ||
| "k8s.io/apimachinery/pkg/labels" | ||
| "sigs.k8s.io/controller-runtime/pkg/cache" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| func Test_applySelectors(t *testing.T) { | ||
| // given | ||
| syncPeriod := 30 * time.Second | ||
| selector := cache.ByObject{ | ||
| Label: labels.SelectorFromSet( | ||
| map[string]string{ | ||
| natslabels.KeyManagedBy: natslabels.ValueNATSManager, | ||
| }, | ||
| ), | ||
| } | ||
|
|
||
| type args struct { | ||
| options cache.Options | ||
| } | ||
| testCases := []struct { | ||
| name string | ||
| args args | ||
| want cache.Options | ||
| }{ | ||
| { | ||
| name: "should apply the correct selectors", | ||
| args: args{ | ||
| options: cache.Options{}, | ||
| }, | ||
| want: cache.Options{ | ||
| ByObject: map[client.Object]cache.ByObject{ | ||
| &appsv1.Deployment{}: selector, | ||
| &appsv1.StatefulSet{}: selector, | ||
| &corev1.ServiceAccount{}: selector, | ||
| &corev1.Secret{}: selector, | ||
| &corev1.Service{}: selector, | ||
| &corev1.ConfigMap{}: selector, | ||
| &rbacv1.ClusterRole{}: selector, | ||
| &rbacv1.ClusterRoleBinding{}: selector, | ||
| &autoscalingv1.HorizontalPodAutoscaler{}: selector, | ||
| &policyv1.PodDisruptionBudget{}: selector, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "should not remove existing options", | ||
| args: args{ | ||
| options: cache.Options{ | ||
| SyncPeriod: &syncPeriod, | ||
| }, | ||
| }, | ||
| want: cache.Options{ | ||
| SyncPeriod: &syncPeriod, | ||
| ByObject: map[client.Object]cache.ByObject{ | ||
| &appsv1.Deployment{}: selector, | ||
| &appsv1.StatefulSet{}: selector, | ||
| &corev1.ServiceAccount{}: selector, | ||
| &corev1.Secret{}: selector, | ||
| &corev1.Service{}: selector, | ||
| &corev1.ConfigMap{}: selector, | ||
| &rbacv1.ClusterRole{}: selector, | ||
| &rbacv1.ClusterRoleBinding{}: selector, | ||
| &autoscalingv1.HorizontalPodAutoscaler{}: selector, | ||
| &policyv1.PodDisruptionBudget{}: selector, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| // when | ||
| got := applySelectors(tc.args.options) | ||
|
|
||
| // then | ||
| require.True(t, deepEqualOptions(tc.want, got)) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func deepEqualOptions(a, b cache.Options) bool { | ||
| // we only care about the ByObject comparison | ||
| o := deepEqualByObject(a.ByObject, b.ByObject) | ||
| s := a.SyncPeriod == b.SyncPeriod | ||
| return o && s | ||
| } | ||
|
|
||
| func deepEqualByObject(a, b map[client.Object]cache.ByObject) bool { | ||
| if len(a) != len(b) { | ||
| return false | ||
| } | ||
|
|
||
| aTypeMap := make(map[string]cache.ByObject, len(a)) | ||
| bTypeMap := make(map[string]cache.ByObject, len(a)) | ||
| computeTypeMap(a, aTypeMap) | ||
| computeTypeMap(b, bTypeMap) | ||
| return reflect.DeepEqual(aTypeMap, bTypeMap) | ||
| } | ||
|
|
||
| func computeTypeMap(byObjectMap map[client.Object]cache.ByObject, typeMap map[string]cache.ByObject) { | ||
| keyOf := func(i interface{}) string { return fmt.Sprintf(">>> %T", i) } | ||
| for k, v := range byObjectMap { | ||
| if obj, ok := k.(*appsv1.Deployment); ok { | ||
| key := keyOf(obj) | ||
| typeMap[key] = v | ||
| } | ||
| if obj, ok := k.(*corev1.ServiceAccount); ok { | ||
| key := keyOf(obj) | ||
| typeMap[key] = v | ||
| } | ||
| if obj, ok := k.(*rbacv1.ClusterRole); ok { | ||
| key := keyOf(obj) | ||
| typeMap[key] = v | ||
| } | ||
| if obj, ok := k.(*rbacv1.ClusterRoleBinding); ok { | ||
| key := keyOf(obj) | ||
| typeMap[key] = v | ||
| } | ||
| if obj, ok := k.(*autoscalingv1.HorizontalPodAutoscaler); ok { | ||
| key := keyOf(obj) | ||
| typeMap[key] = v | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func Test_fromLabelSelector(t *testing.T) { | ||
| // given | ||
| type args struct { | ||
| label labels.Selector | ||
| } | ||
| tests := []struct { | ||
| name string | ||
| args args | ||
| want cache.ByObject | ||
| }{ | ||
| { | ||
| name: "should return the correct selector", | ||
| args: args{ | ||
| label: labels.SelectorFromSet(map[string]string{"key": "value"}), | ||
| }, | ||
| want: cache.ByObject{ | ||
| Label: labels.SelectorFromSet(map[string]string{"key": "value"}), | ||
| }, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| // when | ||
| got := fromLabelSelector(tt.args.label) | ||
|
|
||
| // then | ||
| require.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| package labels | ||
|
|
||
| import ( | ||
| "k8s.io/apimachinery/pkg/labels" | ||
| ) | ||
|
|
||
| const ( | ||
| // Kubernetes label keys used by nats-manager. | ||
| KeyComponent = "app.kubernetes.io/component" | ||
| KeyCreatedBy = "app.kubernetes.io/created-by" | ||
| KeyInstance = "app.kubernetes.io/instance" | ||
| KeyManagedBy = "app.kubernetes.io/managed-by" | ||
| KeyName = "app.kubernetes.io/name" | ||
| KeyPartOf = "app.kubernetes.io/part-of" | ||
| KeyDashboard = "kyma-project.io/dashboard" | ||
|
|
||
| // Kubernetes label values used by nats-manager. | ||
| ValueNATS = "nats" | ||
| ValueNATSManager = "nats-manager" | ||
| ) | ||
|
|
||
| // SelectorManagedByNATS returns a labelselector for managed-by ("app.kubernetes.io/managed-by") as used | ||
| // by the nats-manager. | ||
| func SelectorManagedByNATS() labels.Selector { | ||
| return labels.SelectorFromSet(map[string]string{KeyManagedBy: ValueNATSManager}) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| package labels | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "k8s.io/apimachinery/pkg/labels" | ||
| ) | ||
|
|
||
| func TestSelectorManagedByNATS(t *testing.T) { | ||
| // arrange | ||
| wantedSelector := labels.SelectorFromSet(map[string]string{"app.kubernetes.io/managed-by": "nats-manager"}) | ||
|
|
||
| // act | ||
| actualSelector := SelectorManagedByNATS() | ||
|
|
||
| // assert | ||
| if !reflect.DeepEqual(wantedSelector, actualSelector) { | ||
| t.Errorf("Expected %v, but got %v", wantedSelector, actualSelector) | ||
| } | ||
| } |