22This module provides kubernetes functionality based on original kubernetes python library.
33"""
44
5+ from typing import Union
6+ from pathlib import Path
7+
58from kubernetes import client , config , utils
69from kubernetes .client import ApiException
710from kubernetes .watch import watch
811
12+ from commonlib .io_utils import get_k8s_yaml_objects
13+
14+
15+ RESOURCE_POD = 'Pod'
16+ RESOURCE_SERVICE_ACCOUNT = 'ServiceAccount'
917
1018class KubernetesHelper :
1119
@@ -23,9 +31,9 @@ def __init__(self, is_in_cluster_config: bool = False):
2331 self .api_client = client .api_client .ApiClient (configuration = self .config )
2432
2533 self .dispatch_list = {
26- 'Pod' : self .core_v1_client .list_namespaced_pod ,
34+ RESOURCE_POD : self .core_v1_client .list_namespaced_pod ,
2735 'ConfigMap' : self .core_v1_client .list_namespaced_config_map ,
28- 'ServiceAccount' : self .core_v1_client .list_namespaced_service_account ,
36+ RESOURCE_SERVICE_ACCOUNT : self .core_v1_client .list_namespaced_service_account ,
2937 'DaemonSet' : self .app_api .list_namespaced_daemon_set ,
3038 'Role' : self .rbac_api .list_namespaced_role ,
3139 'RoleBinding' : self .rbac_api .list_namespaced_role_binding ,
@@ -36,9 +44,9 @@ def __init__(self, is_in_cluster_config: bool = False):
3644 }
3745
3846 self .dispatch_delete = {
39- 'Pod' : self .core_v1_client .delete_namespaced_pod ,
47+ RESOURCE_POD : self .core_v1_client .delete_namespaced_pod ,
4048 'ConfigMap' : self .core_v1_client .delete_namespaced_config_map ,
41- 'ServiceAccount' : self .core_v1_client .delete_namespaced_service_account ,
49+ RESOURCE_SERVICE_ACCOUNT : self .core_v1_client .delete_namespaced_service_account ,
4250 'DaemonSet' : self .app_api .delete_namespaced_daemon_set ,
4351 'Role' : self .rbac_api .delete_namespaced_role ,
4452 'RoleBinding' : self .rbac_api .delete_namespaced_role_binding ,
@@ -179,7 +187,82 @@ def delete_resources(self, resource_type: str, **kwargs):
179187 def patch_resources (self , resource_type : str , ** kwargs ):
180188 """
181189 """
182- return self .dispatch_patch [resource_type ](** kwargs )
190+ if resource_type != RESOURCE_POD :
191+ return self .dispatch_patch [resource_type ](** kwargs )
192+
193+ patch_body = kwargs .pop ('body' )
194+
195+ pod = self .get_resource (resource_type , ** kwargs )
196+ self .delete_resources (resource_type = resource_type , ** kwargs )
197+ deleted = self .wait_for_resource (resource_type = resource_type , status_list = ['DELETED' ], ** kwargs )
198+
199+ if not deleted :
200+ raise ValueError (f'could not delete Pod: { kwargs } )
201+
202+ return self .create_patched_resource (resource_type , patch_body )
203+
204+ def create_patched_resource (self , patch_resource_type , patch_body ):
205+ """
206+ """
207+ file_path = Path (__file__ ).parent / '../deploy/mock-pod.yml'
208+ k8s_resources = get_k8s_yaml_objects (file_path = file_path )
209+
210+ patch_metadata = patch_body ['metadata' ]
211+ patch_relevant_metadata = {k : patch_metadata [k ] for k in ('name' , 'namespace' ) if k in patch_metadata }
212+
213+ patched_resource = None
214+
215+ for yml_resource in k8s_resources :
216+ resource_type , metadata = yml_resource ['kind' ], yml_resource ['metadata' ]
217+ relevant_metadata = {k : metadata [k ] for k in ('name' , 'namespace' ) if k in metadata }
218+
219+ if resource_type != patch_resource_type or relevant_metadata != patch_relevant_metadata :
220+ continue
221+
222+ patched_body = self .patch_resource_body (yml_resource , patch_body )
223+ created_resource = self .create_from_dict (patched_body , ** relevant_metadata )
224+
225+ done = self .wait_for_resource (resource_type = resource_type , status_list = ["RUNNING" , "ADDED" ], ** relevant_metadata )
226+ if done :
227+ patched_resource = created_resource
228+
229+ break
230+
231+ return patched_resource
232+
233+ def patch_resource_body (self , body : Union [list ,dict ], patch : Union [list ,dict ]) -> Union [list ,dict ]:
234+ """
235+ """
236+ if type (body ) != type (patch ):
237+ raise ValueError (f'Cannot compare { type (body )} { body } { type (patch )} { patch } )
238+
239+ if isinstance (body , dict ):
240+ for key , val in patch .items ():
241+ if key not in body :
242+ body [key ] = val
243+ else :
244+ if isinstance (val , list ) or isinstance (val , dict ):
245+ body [key ] = self .patch_resource_body (body [key ], val )
246+ else :
247+ body [key ] = val
248+
249+ elif isinstance (body , list ):
250+ for i , val in enumerate (body ):
251+ if i >= len (patch ):
252+ break
253+
254+ if isinstance (val , list ) or isinstance (val , dict ):
255+ body [i ] = self .patch_resource_body (body [i ], val )
256+ else :
257+ body [i ] = val
258+
259+ if len (patch ) > len (body ):
260+ body += val [len (patch ):]
261+
262+ else :
263+ raise ValueError (f'Invalid body { body } { type (body )} )
264+
265+ return body
183266
184267 def list_resources (self , resource_type : str , ** kwargs ):
185268 """
@@ -206,16 +289,21 @@ def wait_for_resource(self, resource_type: str, name: str, status_list: list,
206289 watches a resources for a status change
207290 @param resource_type: the resource type
208291 @param name: resource name
209- @param status_list: excepted statuses e.g., RUNNING, DELETED, MODIFIED, ADDED
292+ @param status_list: accepted statuses e.g., RUNNING, DELETED, MODIFIED, ADDED
210293 @param timeout: until wait
211294 @return: True if status reached
212295 """
296+ # When pods are being created, MODIFIED events are also of interest to check if
297+ # they successfully transition from ContainerCreating to Running state.
298+ if (resource_type == RESOURCE_POD ) and ('ADDED' in status_list ) and ('MODIFIED' not in status_list ):
299+ status_list .append ('MODIFIED' )
300+
213301 w = watch .Watch ()
214302 for event in w .stream (func = self .dispatch_list [resource_type ],
215303 timeout_seconds = timeout ,
216304 ** kwargs ):
217305 if name in event ["object" ].metadata .name and event ["type" ] in status_list :
218- if event ['object' ].status .phase == 'Pending' :
306+ if ( resource_type == RESOURCE_POD ) and ( 'ADDED' in status_list ) and ( event ['object' ].status .phase == 'Pending' ) :
219307 continue
220308 w .stop ()
221309 return True
0 commit comments