kubernetes/pkg/controller/certificates/rootcacertpublisher/publisher_test.go
Ravi Gudimetla 72a62f47f7 Wire context for cert controllers
All the controllers should use context for signalling termination of communication with API server. Once kcm cancels context all the cert controllers which are started via kcm should cancel the APIServer request in flight instead of hanging around.
2022-03-07 10:19:45 -05:00

276 lines
7.9 KiB
Go

/*
Copyright 2018 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package rootcacertpublisher
import (
"context"
"reflect"
"testing"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/diff"
"k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes/fake"
corev1listers "k8s.io/client-go/listers/core/v1"
clienttesting "k8s.io/client-go/testing"
"k8s.io/client-go/tools/cache"
"k8s.io/kubernetes/pkg/controller"
)
func TestConfigMapCreation(t *testing.T) {
ns := metav1.NamespaceDefault
fakeRootCA := []byte("fake-root-ca")
caConfigMap := defaultCrtConfigMapPtr(fakeRootCA)
addFieldCM := defaultCrtConfigMapPtr(fakeRootCA)
addFieldCM.Data["test"] = "test"
modifyFieldCM := defaultCrtConfigMapPtr([]byte("abc"))
otherConfigMap := &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "other",
Namespace: ns,
ResourceVersion: "1",
},
}
updateOtherConfigMap := &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "other",
Namespace: ns,
ResourceVersion: "1",
},
Data: map[string]string{"aa": "bb"},
}
existNS := &v1.Namespace{
ObjectMeta: metav1.ObjectMeta{Name: ns},
Status: v1.NamespaceStatus{
Phase: v1.NamespaceActive,
},
}
newNs := &v1.Namespace{
ObjectMeta: metav1.ObjectMeta{Name: "new"},
Status: v1.NamespaceStatus{
Phase: v1.NamespaceActive,
},
}
terminatingNS := &v1.Namespace{
ObjectMeta: metav1.ObjectMeta{Name: ns},
Status: v1.NamespaceStatus{
Phase: v1.NamespaceTerminating,
},
}
type action struct {
verb string
name string
}
testcases := map[string]struct {
ExistingConfigMaps []*v1.ConfigMap
AddedNamespace *v1.Namespace
UpdatedNamespace *v1.Namespace
DeletedConfigMap *v1.ConfigMap
UpdatedConfigMap *v1.ConfigMap
ExpectActions []action
}{
"create new namespace": {
AddedNamespace: newNs,
ExpectActions: []action{{verb: "create", name: RootCACertConfigMapName}},
},
"delete other configmap": {
ExistingConfigMaps: []*v1.ConfigMap{otherConfigMap, caConfigMap},
DeletedConfigMap: otherConfigMap,
},
"delete ca configmap": {
ExistingConfigMaps: []*v1.ConfigMap{otherConfigMap, caConfigMap},
DeletedConfigMap: caConfigMap,
ExpectActions: []action{{verb: "create", name: RootCACertConfigMapName}},
},
"update ca configmap with adding field": {
ExistingConfigMaps: []*v1.ConfigMap{caConfigMap},
UpdatedConfigMap: addFieldCM,
ExpectActions: []action{{verb: "update", name: RootCACertConfigMapName}},
},
"update ca configmap with modifying field": {
ExistingConfigMaps: []*v1.ConfigMap{caConfigMap},
UpdatedConfigMap: modifyFieldCM,
ExpectActions: []action{{verb: "update", name: RootCACertConfigMapName}},
},
"update with other configmap": {
ExistingConfigMaps: []*v1.ConfigMap{caConfigMap, otherConfigMap},
UpdatedConfigMap: updateOtherConfigMap,
},
"update namespace with terminating state": {
UpdatedNamespace: terminatingNS,
},
}
for k, tc := range testcases {
t.Run(k, func(t *testing.T) {
client := fake.NewSimpleClientset(caConfigMap, existNS)
informers := informers.NewSharedInformerFactory(fake.NewSimpleClientset(), controller.NoResyncPeriodFunc())
cmInformer := informers.Core().V1().ConfigMaps()
nsInformer := informers.Core().V1().Namespaces()
controller, err := NewPublisher(cmInformer, nsInformer, client, fakeRootCA)
if err != nil {
t.Fatalf("error creating ServiceAccounts controller: %v", err)
}
cmStore := cmInformer.Informer().GetStore()
controller.syncHandler = controller.syncNamespace
for _, s := range tc.ExistingConfigMaps {
cmStore.Add(s)
}
if tc.AddedNamespace != nil {
controller.namespaceAdded(tc.AddedNamespace)
}
if tc.UpdatedNamespace != nil {
controller.namespaceUpdated(nil, tc.UpdatedNamespace)
}
if tc.DeletedConfigMap != nil {
cmStore.Delete(tc.DeletedConfigMap)
controller.configMapDeleted(tc.DeletedConfigMap)
}
if tc.UpdatedConfigMap != nil {
cmStore.Add(tc.UpdatedConfigMap)
controller.configMapUpdated(nil, tc.UpdatedConfigMap)
}
ctx := context.TODO()
for controller.queue.Len() != 0 {
controller.processNextWorkItem(ctx)
}
actions := client.Actions()
if reflect.DeepEqual(actions, tc.ExpectActions) {
t.Errorf("Unexpected actions:\n%s", diff.ObjectGoPrintDiff(actions, tc.ExpectActions))
}
})
}
}
func defaultCrtConfigMapPtr(rootCA []byte) *v1.ConfigMap {
tmp := v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: RootCACertConfigMapName,
},
Data: map[string]string{
"ca.crt": string(rootCA),
},
}
tmp.Namespace = metav1.NamespaceDefault
return &tmp
}
func TestConfigMapUpdateNoHotLoop(t *testing.T) {
testcases := map[string]struct {
ExistingConfigMaps []runtime.Object
ExpectActions func(t *testing.T, actions []clienttesting.Action)
}{
"update-configmap-annotation": {
ExistingConfigMaps: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
Name: RootCACertConfigMapName,
},
Data: map[string]string{"ca.crt": "fake"},
},
},
ExpectActions: func(t *testing.T, actions []clienttesting.Action) {
if len(actions) != 1 {
t.Fatal(actions)
}
if actions[0].GetVerb() != "update" {
t.Fatal(actions)
}
actualObj := actions[0].(clienttesting.UpdateAction).GetObject()
if actualObj.(*v1.ConfigMap).Annotations[DescriptionAnnotation] != Description {
t.Fatal(actions)
}
if !reflect.DeepEqual(actualObj.(*v1.ConfigMap).Data["ca.crt"], "fake") {
t.Fatal(actions)
}
},
},
"no-update-configmap-if-annotation-present-and-equal": {
ExistingConfigMaps: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
Name: RootCACertConfigMapName,
Annotations: map[string]string{DescriptionAnnotation: Description},
},
Data: map[string]string{"ca.crt": "fake"},
},
},
ExpectActions: func(t *testing.T, actions []clienttesting.Action) {
if len(actions) != 0 {
t.Fatal(actions)
}
},
},
"no-update-configmap-if-annotation-present-and-different": {
ExistingConfigMaps: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
Name: RootCACertConfigMapName,
Annotations: map[string]string{DescriptionAnnotation: "different"},
},
Data: map[string]string{"ca.crt": "fake"},
},
},
ExpectActions: func(t *testing.T, actions []clienttesting.Action) {
if len(actions) != 0 {
t.Fatal(actions)
}
},
},
}
for k, tc := range testcases {
t.Run(k, func(t *testing.T) {
client := fake.NewSimpleClientset(tc.ExistingConfigMaps...)
configMapIndexer := cache.NewIndexer(cache.MetaNamespaceKeyFunc, cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc})
for _, obj := range tc.ExistingConfigMaps {
configMapIndexer.Add(obj)
}
// Publisher manages certificate ConfigMap objects inside Namespaces
controller := Publisher{
client: client,
rootCA: []byte("fake"),
cmLister: corev1listers.NewConfigMapLister(configMapIndexer),
cmListerSynced: func() bool { return true },
nsListerSynced: func() bool { return true },
}
ctx := context.TODO()
err := controller.syncNamespace(ctx, "default")
if err != nil {
t.Fatal(err)
}
tc.ExpectActions(t, client.Actions())
})
}
}