Merge pull request #2664 from tamird/tamird/sync-job-delete-status-compat

Align synchronous resource deletion responses

Author: kubernetes-prow[bot]

CHANGELOG.md

@@ -37,9 +37,12 @@ updates:
   `await client.close()` or an async context manager. Interactive
   websocket streams use the generated `_without_preload_content`
   operations.
-- `CoreV1Api.delete_namespace` now returns a decoded dictionary rather
-  than `V1Status`, since a successful deletion can return either a
-  terminating Namespace or a Status.
+- Individual resource-deletion methods that previously returned
+  `V1Status`, including `CoreV1Api.delete_namespace` and
+  `BatchV1Api.delete_namespaced_job`, now return decoded dictionaries in
+  both clients. A successful deletion can return either the deleted
+  resource or a Status; access response fields with dictionary keys
+  instead of model attributes.
 
 See [kubernetes-client/python#2631][python-pr] and
 [kubernetes-client/gen#305][gen-pr].

examples/job_crud.py

@@ -88,7 +88,7 @@ def delete_job(api_instance):
         body=client.V1DeleteOptions(
             propagation_policy='Foreground',
             grace_period_seconds=5))
-    print(f"Job deleted. status='{str(api_response.status)}'")
+    print(f"Job deleted. status='{str(api_response.get('status'))}'")
 
 
 def main():

kubernetes/.openapi-generator/swagger.json-default.sha256

@@ -1 +1 @@
-c3d1f3292b01c5e3297240c5d49a69cd078653cd4a9f3d3482afa516a2d4c429
+fdf8e53487f406c1ebc282797e8c33f290c6ad9bf8df9cd13a776dd6f82eaadd

kubernetes/aio/e2e_test/test_batch.py

@@ -55,4 +55,13 @@ async def test_job_apis(self):
         self.assertEqual(name, resp.metadata.name)
 
         resp = await api.delete_namespaced_job(
-            name=name, body={}, namespace='default')
+            name=name, body={'propagationPolicy': 'Background'},
+            namespace='default')
+        self.assertIsInstance(resp, dict)
+        self.assertIn(resp['kind'], ('Job', 'Status'))
+        if resp['kind'] == 'Job':
+            self.assertEqual(name, resp['metadata']['name'])
+        else:
+            self.assertEqual('Success', resp['status'])
+            if 'details' in resp:
+                self.assertEqual(name, resp['details']['name'])

kubernetes/aio/test/test_generated_api.py

@@ -45,6 +45,7 @@ async def asyncSetUp(self):
             'metadata': {'resourceVersion': '1'},
             'items': [],
         }
+        self.response_status = 200
         app = web.Application()
         app.router.add_route('*', '/{path:.*}', self._handle_request)
         self.runner = web.AppRunner(app)
@@ -90,7 +91,7 @@ async def _handle_request(self, request):
             }).encode() + b'\n')
             await response.write_eof()
             return response
-        return web.json_response(self.response)
+        return web.json_response(self.response, status=self.response_status)
 
     async def test_bearer_alias_supports_synchronous_token_refresh(self):
         self.configuration.api_key['authorization'] = 'expired-token'
@@ -124,34 +125,57 @@ async def refresh(configuration):
 
     async def test_delete_job_accepts_job_and_status_responses(self):
         responses = (
-            {
-                'apiVersion': 'batch/v1',
-                'kind': 'Job',
-                'metadata': {'name': 'sample'},
-                'status': {'ready': 0},
-            },
-            {
-                'apiVersion': 'v1',
-                'kind': 'Status',
-                'status': 'Success',
-                'details': {'name': 'sample', 'kind': 'jobs'},
-            },
+            (
+                {
+                    'apiVersion': 'batch/v1',
+                    'kind': 'Job',
+                    'metadata': {'name': 'sample'},
+                    'status': {'ready': 0},
+                },
+                'Job',
+                {'ready': 0},
+            ),
+            (
+                {
+                    'apiVersion': 'v1',
+                    'kind': 'Status',
+                    'status': 'Success',
+                    'details': {'name': 'sample', 'kind': 'jobs'},
+                },
+                'Status',
+                'Success',
+            ),
         )
 
-        for response in responses:
-            with self.subTest(kind=response['kind']):
-                self.response = response
-                deleted = await BatchV1Api(
-                    self.api_client,
-                ).delete_namespaced_job(
-                    name='sample', namespace='default', body={},
-                )
-
-                self.assertEqual(response, deleted)
-                self.assertEqual(
-                    '/apis/batch/v1/namespaces/default/jobs/sample',
-                    self.requests[-1][0].path,
-                )
+        for response_status in (200, 202):
+            for response, expected_kind, expected_status in responses:
+                with self.subTest(
+                    status=response_status, kind=expected_kind
+                ):
+                    self.response_status = response_status
+                    self.response = response
+                    deleted = await BatchV1Api(
+                        self.api_client,
+                    ).delete_namespaced_job(
+                        name='sample', namespace='default', body={},
+                    )
+
+                    self.assertIsInstance(deleted, dict)
+                    self.assertIsNot(response, deleted)
+                    self.assertEqual(response, deleted)
+                    self.assertEqual(expected_kind, deleted['kind'])
+                    self.assertEqual(expected_status, deleted['status'])
+                    if expected_kind == 'Job':
+                        self.assertIsInstance(deleted['status'], dict)
+                        self.assertIsNot(response['status'], deleted['status'])
+                    else:
+                        self.assertIsInstance(deleted['status'], str)
+                    request, body = self.requests[-1]
+                    self.assertEqual({}, json.loads(body))
+                    self.assertEqual(
+                        '/apis/batch/v1/namespaces/default/jobs/sample',
+                        request.path,
+                    )
 
     async def test_object_patches_use_strategic_merge(self):
         self.response = {

kubernetes/client/api/admissionregistration_v1_api.py

@@ -4304,7 +4304,7 @@ def delete_mutating_admission_policy(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_mutating_admission_policy
 
         delete a MutatingAdmissionPolicy
@@ -4372,8 +4372,8 @@ def delete_mutating_admission_policy(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -4412,7 +4412,7 @@ def delete_mutating_admission_policy_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_mutating_admission_policy
 
         delete a MutatingAdmissionPolicy
@@ -4480,8 +4480,8 @@ def delete_mutating_admission_policy_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -4620,7 +4620,7 @@ def delete_mutating_admission_policy_binding(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_mutating_admission_policy_binding
 
         delete a MutatingAdmissionPolicyBinding
@@ -4688,8 +4688,8 @@ def delete_mutating_admission_policy_binding(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -4728,7 +4728,7 @@ def delete_mutating_admission_policy_binding_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_mutating_admission_policy_binding
 
         delete a MutatingAdmissionPolicyBinding
@@ -4796,8 +4796,8 @@ def delete_mutating_admission_policy_binding_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -4936,7 +4936,7 @@ def delete_mutating_webhook_configuration(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_mutating_webhook_configuration
 
         delete a MutatingWebhookConfiguration
@@ -5004,8 +5004,8 @@ def delete_mutating_webhook_configuration(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5044,7 +5044,7 @@ def delete_mutating_webhook_configuration_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_mutating_webhook_configuration
 
         delete a MutatingWebhookConfiguration
@@ -5112,8 +5112,8 @@ def delete_mutating_webhook_configuration_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5252,7 +5252,7 @@ def delete_validating_admission_policy(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_validating_admission_policy
 
         delete a ValidatingAdmissionPolicy
@@ -5320,8 +5320,8 @@ def delete_validating_admission_policy(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5360,7 +5360,7 @@ def delete_validating_admission_policy_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_validating_admission_policy
 
         delete a ValidatingAdmissionPolicy
@@ -5428,8 +5428,8 @@ def delete_validating_admission_policy_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5568,7 +5568,7 @@ def delete_validating_admission_policy_binding(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_validating_admission_policy_binding
 
         delete a ValidatingAdmissionPolicyBinding
@@ -5636,8 +5636,8 @@ def delete_validating_admission_policy_binding(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5676,7 +5676,7 @@ def delete_validating_admission_policy_binding_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_validating_admission_policy_binding
 
         delete a ValidatingAdmissionPolicyBinding
@@ -5744,8 +5744,8 @@ def delete_validating_admission_policy_binding_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5884,7 +5884,7 @@ def delete_validating_webhook_configuration(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> V1Status:
+    ) -> object:
         """delete_validating_webhook_configuration
 
         delete a ValidatingWebhookConfiguration
@@ -5952,8 +5952,8 @@ def delete_validating_webhook_configuration(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(
@@ -5992,7 +5992,7 @@ def delete_validating_webhook_configuration_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Tuple[V1Status, int, Any]:
+    ) -> Tuple[object, int, Any]:
         """delete_validating_webhook_configuration
 
         delete a ValidatingWebhookConfiguration
@@ -6060,8 +6060,8 @@ def delete_validating_webhook_configuration_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "V1Status",
-            '202': "V1Status",
+            '200': "object",
+            '202': "object",
             '401': None,
         }
         return self.api_client._call_with_legacy_options(