@@ -23,12 +23,15 @@ import (
2323
2424 "github.com/pkg/errors"
2525 corev1 "k8s.io/api/core/v1"
26+ apierrors "k8s.io/apimachinery/pkg/api/errors"
27+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2628 "k8s.io/apimachinery/pkg/types"
2729 "k8s.io/klog/v2"
2830 ctrl "sigs.k8s.io/controller-runtime"
2931 "sigs.k8s.io/controller-runtime/pkg/client"
3032 "sigs.k8s.io/yaml"
3133
34+ clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
3235 runtimecatalog "sigs.k8s.io/cluster-api/exp/runtime/catalog"
3336 runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
3437)
@@ -42,14 +45,13 @@ type Handler struct {
4245func (h * Handler ) DoBeforeClusterCreate (ctx context.Context , request * runtimehooksv1.BeforeClusterCreateRequest , response * runtimehooksv1.BeforeClusterCreateResponse ) {
4346 log := ctrl .LoggerFrom (ctx )
4447 log .Info ("BeforeClusterCreate is called" )
45- cluster := request .Cluster
4648
47- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterCreate , response ); err != nil {
49+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterCreate , response ); err != nil {
4850 response .Status = runtimehooksv1 .ResponseStatusFailure
4951 response .Message = err .Error ()
5052 return
5153 }
52- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterCreate , response ); err != nil {
54+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterCreate , response ); err != nil {
5355 response .Status = runtimehooksv1 .ResponseStatusFailure
5456 response .Message = err .Error ()
5557 }
@@ -59,15 +61,14 @@ func (h *Handler) DoBeforeClusterCreate(ctx context.Context, request *runtimehoo
5961func (h * Handler ) DoBeforeClusterUpgrade (ctx context.Context , request * runtimehooksv1.BeforeClusterUpgradeRequest , response * runtimehooksv1.BeforeClusterUpgradeResponse ) {
6062 log := ctrl .LoggerFrom (ctx )
6163 log .Info ("BeforeClusterUpgrade is called" )
62- cluster := request .Cluster
6364
64- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterUpgrade , response ); err != nil {
65+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterUpgrade , response ); err != nil {
6566 response .Status = runtimehooksv1 .ResponseStatusFailure
6667 response .Message = err .Error ()
6768 return
6869 }
6970
70- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterUpgrade , response ); err != nil {
71+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterUpgrade , response ); err != nil {
7172 response .Status = runtimehooksv1 .ResponseStatusFailure
7273 response .Message = err .Error ()
7374 }
@@ -77,15 +78,14 @@ func (h *Handler) DoBeforeClusterUpgrade(ctx context.Context, request *runtimeho
7778func (h * Handler ) DoAfterControlPlaneInitialized (ctx context.Context , request * runtimehooksv1.AfterControlPlaneInitializedRequest , response * runtimehooksv1.AfterControlPlaneInitializedResponse ) {
7879 log := ctrl .LoggerFrom (ctx )
7980 log .Info ("AfterControlPlaneInitialized is called" )
80- cluster := request .Cluster
8181
82- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterControlPlaneInitialized , response ); err != nil {
82+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterControlPlaneInitialized , response ); err != nil {
8383 response .Status = runtimehooksv1 .ResponseStatusFailure
8484 response .Message = err .Error ()
8585 return
8686 }
8787
88- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterControlPlaneInitialized , response ); err != nil {
88+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterControlPlaneInitialized , response ); err != nil {
8989 response .Status = runtimehooksv1 .ResponseStatusFailure
9090 response .Message = err .Error ()
9191 }
@@ -95,15 +95,14 @@ func (h *Handler) DoAfterControlPlaneInitialized(ctx context.Context, request *r
9595func (h * Handler ) DoAfterControlPlaneUpgrade (ctx context.Context , request * runtimehooksv1.AfterControlPlaneUpgradeRequest , response * runtimehooksv1.AfterControlPlaneUpgradeResponse ) {
9696 log := ctrl .LoggerFrom (ctx )
9797 log .Info ("AfterControlPlaneUpgrade is called" )
98- cluster := request .Cluster
9998
100- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterControlPlaneUpgrade , response ); err != nil {
99+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterControlPlaneUpgrade , response ); err != nil {
101100 response .Status = runtimehooksv1 .ResponseStatusFailure
102101 response .Message = err .Error ()
103102 return
104103 }
105104
106- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterControlPlaneUpgrade , response ); err != nil {
105+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterControlPlaneUpgrade , response ); err != nil {
107106 response .Status = runtimehooksv1 .ResponseStatusFailure
108107 response .Message = err .Error ()
109108 }
@@ -113,15 +112,14 @@ func (h *Handler) DoAfterControlPlaneUpgrade(ctx context.Context, request *runti
113112func (h * Handler ) DoAfterClusterUpgrade (ctx context.Context , request * runtimehooksv1.AfterClusterUpgradeRequest , response * runtimehooksv1.AfterClusterUpgradeResponse ) {
114113 log := ctrl .LoggerFrom (ctx )
115114 log .Info ("AfterClusterUpgrade is called" )
116- cluster := request .Cluster
117115
118- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterClusterUpgrade , response ); err != nil {
116+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterClusterUpgrade , response ); err != nil {
119117 response .Status = runtimehooksv1 .ResponseStatusFailure
120118 response .Message = err .Error ()
121119 return
122120 }
123121
124- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .AfterClusterUpgrade , response ); err != nil {
122+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .AfterClusterUpgrade , response ); err != nil {
125123 response .Status = runtimehooksv1 .ResponseStatusFailure
126124 response .Message = err .Error ()
127125 }
@@ -131,25 +129,33 @@ func (h *Handler) DoAfterClusterUpgrade(ctx context.Context, request *runtimehoo
131129func (h * Handler ) DoBeforeClusterDelete (ctx context.Context , request * runtimehooksv1.BeforeClusterDeleteRequest , response * runtimehooksv1.BeforeClusterDeleteResponse ) {
132130 log := ctrl .LoggerFrom (ctx )
133131 log .Info ("BeforeClusterDelete is called" )
134- cluster := request .Cluster
135132
136- if err := h .readResponseFromConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterDelete , response ); err != nil {
133+ if err := h .readResponseFromConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterDelete , response ); err != nil {
137134 response .Status = runtimehooksv1 .ResponseStatusFailure
138135 response .Message = err .Error ()
139136 return
140137 }
141- if err := h .recordCallInConfigMap (ctx , cluster . Namespace , runtimehooksv1 .BeforeClusterDelete , response ); err != nil {
138+ if err := h .recordCallInConfigMap (ctx , & request . Cluster , runtimehooksv1 .BeforeClusterDelete , response ); err != nil {
142139 response .Status = runtimehooksv1 .ResponseStatusFailure
143140 response .Message = err .Error ()
144141 }
142+
143+ // TODO: consider if to cleanup the ConfigMap after gating Cluster deletion.
145144}
146145
147- func (h * Handler ) readResponseFromConfigMap (ctx context.Context , namespace string , hook runtimecatalog.Hook , response runtimehooksv1.ResponseObject ) error {
146+ func (h * Handler ) readResponseFromConfigMap (ctx context.Context , cluster * clusterv1. Cluster , hook runtimecatalog.Hook , response runtimehooksv1.ResponseObject ) error {
148147 hookName := runtimecatalog .HookName (hook )
149148 configMap := & corev1.ConfigMap {}
150- configMapName := "test-extension-hookresponses"
151- if err := h .Client .Get (ctx , client.ObjectKey {Namespace : namespace , Name : configMapName }, configMap ); err != nil {
152- return errors .Wrapf (err , "failed to read the ConfigMap %s" , klog .KRef (namespace , configMapName ))
149+ configMapName := fmt .Sprintf ("%s-test-extension-hookresponses" , cluster .Name )
150+ if err := h .Client .Get (ctx , client.ObjectKey {Namespace : cluster .Namespace , Name : configMapName }, configMap ); err != nil {
151+ if apierrors .IsNotFound (err ) {
152+ configMap = responsesConfigMap (cluster )
153+ if err := h .Client .Create (ctx , configMap ); err != nil {
154+ return errors .Wrapf (err , "failed to create the ConfigMap %s" , klog .KRef (cluster .Namespace , configMapName ))
155+ }
156+ } else {
157+ return errors .Wrapf (err , "failed to read the ConfigMap %s" , klog .KRef (cluster .Namespace , configMapName ))
158+ }
153159 }
154160 if err := yaml .Unmarshal ([]byte (configMap .Data [hookName + "-preloadedResponse" ]), response ); err != nil {
155161 return errors .Wrapf (err , "failed to read %q response information from ConfigMap" , hook )
@@ -161,12 +167,34 @@ func (h *Handler) readResponseFromConfigMap(ctx context.Context, namespace strin
161167 return nil
162168}
163169
164- func (h * Handler ) recordCallInConfigMap (ctx context.Context , namespace string , hook runtimecatalog.Hook , response runtimehooksv1.ResponseObject ) error {
170+ // responsesConfigMap generates a ConfigMap with preloaded responses for the test extension.
171+ func responsesConfigMap (cluster * clusterv1.Cluster ) * corev1.ConfigMap {
172+ return & corev1.ConfigMap {
173+ ObjectMeta : metav1.ObjectMeta {
174+ Name : fmt .Sprintf ("%s-test-extension-hookresponses" , cluster .Name ),
175+ Namespace : cluster .Namespace ,
176+ },
177+ // Set the initial preloadedResponses for each of the tested hooks.
178+ Data : map [string ]string {
179+ // Blocking hooks are set to return RetryAfterSeconds initially. These will be changed during the test.
180+ "BeforeClusterCreate-preloadedResponse" : `{"Status": "Success", "RetryAfterSeconds": 5}` ,
181+ "BeforeClusterUpgrade-preloadedResponse" : `{"Status": "Success", "RetryAfterSeconds": 5}` ,
182+ "AfterControlPlaneUpgrade-preloadedResponse" : `{"Status": "Success", "RetryAfterSeconds": 5}` ,
183+ "BeforeClusterDelete-preloadedResponse" : `{"Status": "Success", "RetryAfterSeconds": 5}` ,
184+
185+ // Non-blocking hooks are set to Status:Success.
186+ "AfterControlPlaneInitialized-preloadedResponse" : `{"Status": "Success"}` ,
187+ "AfterClusterUpgrade-preloadedResponse" : `{"Status": "Success"}` ,
188+ },
189+ }
190+ }
191+
192+ func (h * Handler ) recordCallInConfigMap (ctx context.Context , cluster * clusterv1.Cluster , hook runtimecatalog.Hook , response runtimehooksv1.ResponseObject ) error {
165193 hookName := runtimecatalog .HookName (hook )
166194 configMap := & corev1.ConfigMap {}
167- configMapName := " test-extension-hookresponses"
168- if err := h .Client .Get (ctx , client.ObjectKey {Namespace : namespace , Name : configMapName }, configMap ); err != nil {
169- return errors .Wrapf (err , "failed to read the ConfigMap %s" , klog .KRef (namespace , configMapName ))
195+ configMapName := fmt . Sprintf ( "%s- test-extension-hookresponses", cluster . Name )
196+ if err := h .Client .Get (ctx , client.ObjectKey {Namespace : cluster . Namespace , Name : configMapName }, configMap ); err != nil {
197+ return errors .Wrapf (err , "failed to read the ConfigMap %s" , klog .KRef (cluster . Namespace , configMapName ))
170198 }
171199 var patch client.Patch
172200 if r , ok := response .(runtimehooksv1.RetryResponseObject ); ok {
@@ -178,7 +206,7 @@ func (h *Handler) recordCallInConfigMap(ctx context.Context, namespace string, h
178206 []byte (fmt .Sprintf (`{"data":{"%s-actualResponseStatus":"%s"}}` , hookName , response .GetStatus ()))) //nolint:gocritic
179207 }
180208 if err := h .Client .Patch (ctx , configMap , patch ); err != nil {
181- return errors .Wrapf (err , "failed to update the ConfigMap %s" , klog .KRef (namespace , configMapName ))
209+ return errors .Wrapf (err , "failed to update the ConfigMap %s" , klog .KRef (cluster . Namespace , configMapName ))
182210 }
183211 return nil
184212}
0 commit comments