-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
deprecate KubernetesPodOperatorAsync #1465
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c3e372a
feat(kubernetes): deprecate KubernetesPodOperatorAsync
Lee-W a489ff9
Adjust args and example DAGs
pankajkoti 738fa7f
Deprecate hook and trigger
pankajkoti 95109ba
Merge branch 'main' into deprecate-KubernetesPodOperatorAsync
pankajkoti c09910f
Correct module from kubernetes_pod to pod
pankajkoti File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
|---|---|---|
| @@ -1,163 +1,15 @@ | ||
| from unittest import mock | ||
| from unittest.mock import MagicMock | ||
|
|
||
| import pytest | ||
| from airflow.exceptions import TaskDeferred | ||
| from airflow.providers.cncf.kubernetes.utils.pod_manager import PodLoggingStatus | ||
| from airflow.providers.cncf.kubernetes.operators.pod import KubernetesPodOperator | ||
|
|
||
| from astronomer.providers.cncf.kubernetes.operators.kubernetes_pod import ( | ||
| KubernetesPodOperatorAsync, | ||
| PodNotFoundException, | ||
| ) | ||
| from astronomer.providers.cncf.kubernetes.triggers.wait_container import ( | ||
| PodLaunchTimeoutException, | ||
| ) | ||
| from tests.utils.airflow_util import create_context | ||
|
|
||
| KUBE_POD_MOD = "astronomer.providers.cncf.kubernetes.operators.kubernetes_pod" | ||
|
|
||
|
|
||
| class TestKubernetesPodOperatorAsync: | ||
| def test_raise_for_trigger_status_pending_timeout(self): | ||
| """Assert trigger raise exception in case of timeout""" | ||
| with pytest.raises(PodLaunchTimeoutException): | ||
| KubernetesPodOperatorAsync.raise_for_trigger_status( | ||
| { | ||
| "status": "error", | ||
| "error_type": "PodLaunchTimeoutException", | ||
| "description": "any message", | ||
| } | ||
| ) | ||
|
|
||
| def test_raise_for_trigger_status_done(self): | ||
| """Assert trigger don't raise exception in case of status is done""" | ||
| assert KubernetesPodOperatorAsync.raise_for_trigger_status({"status": "done"}) is None | ||
|
|
||
| @mock.patch("airflow.providers.cncf.kubernetes.operators.kubernetes_pod.KubernetesPodOperator.client") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.cleanup") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.raise_for_trigger_status") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.find_pod") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.await_pod_completion") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.fetch_container_logs") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook._get_default_client") | ||
| def test_get_logs_running( | ||
| self, | ||
| mock_get_default_client, | ||
| fetch_container_logs, | ||
| await_pod_completion, | ||
| find_pod, | ||
| raise_for_trigger_status, | ||
| cleanup, | ||
| mock_client, | ||
| ): | ||
| """When logs fetch exits with status running, raise task deferred""" | ||
| pod = MagicMock() | ||
| find_pod.return_value = pod | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| mock_client.return_value = {} | ||
| context = create_context(op) | ||
| await_pod_completion.return_value = None | ||
| fetch_container_logs.return_value = PodLoggingStatus(True, None) | ||
| with pytest.raises(TaskDeferred): | ||
| op.trigger_reentry(context, None) | ||
| fetch_container_logs.is_called_with(pod, "base") | ||
|
|
||
| @mock.patch("airflow.providers.cncf.kubernetes.operators.kubernetes_pod.KubernetesPodOperator.client") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.cleanup") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.raise_for_trigger_status") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.find_pod") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.await_pod_completion") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.fetch_container_logs") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook._get_default_client") | ||
| def test_get_logs_not_running( | ||
| self, | ||
| mock_get_default_client, | ||
| fetch_container_logs, | ||
| await_pod_completion, | ||
| find_pod, | ||
| raise_for_trigger_status, | ||
| cleanup, | ||
| mock_client, | ||
| ): | ||
| pod = MagicMock() | ||
| find_pod.return_value = pod | ||
| mock_client.return_value = {} | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| context = create_context(op) | ||
| await_pod_completion.return_value = None | ||
| fetch_container_logs.return_value = PodLoggingStatus(False, None) | ||
| op.trigger_reentry(context, None) | ||
| fetch_container_logs.is_called_with(pod, "base") | ||
|
|
||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.cleanup") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.raise_for_trigger_status") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.find_pod") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.await_pod_completion") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.fetch_container_logs") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook._get_default_client") | ||
| def test_no_pod( | ||
| self, | ||
| mock_get_default_client, | ||
| fetch_container_logs, | ||
| await_pod_completion, | ||
| find_pod, | ||
| raise_for_trigger_status, | ||
| cleanup, | ||
| ): | ||
| """Assert if pod not found then raise exception""" | ||
| find_pod.return_value = None | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| context = create_context(op) | ||
| with pytest.raises(PodNotFoundException): | ||
| op.trigger_reentry(context, None) | ||
|
|
||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.cleanup") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.find_pod") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.await_pod_completion") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager.fetch_container_logs") | ||
| @mock.patch("airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook._get_default_client") | ||
| def test_trigger_error( | ||
| self, | ||
| mock_get_default_client, | ||
| fetch_container_logs, | ||
| await_pod_completion, | ||
| find_pod, | ||
| cleanup, | ||
| ): | ||
| """Assert that trigger_reentry raise exception in case of error""" | ||
| find_pod.return_value = MagicMock() | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| with pytest.raises(PodLaunchTimeoutException): | ||
| context = create_context(op) | ||
| op.trigger_reentry( | ||
| context, | ||
| { | ||
| "status": "error", | ||
| "error_type": "PodLaunchTimeoutException", | ||
| "description": "any message", | ||
| }, | ||
| ) | ||
|
|
||
| def test_defer_with_kwargs(self): | ||
| """Assert that with kwargs throw exception""" | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| with pytest.raises(ValueError): | ||
| op.defer(kwargs={"timeout": 10}) | ||
|
|
||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.build_pod_request_obj") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.get_or_create_pod") | ||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.defer") | ||
| def test_execute(self, mock_defer, mock_get_or_create_pod, mock_build_pod_request_obj): | ||
| """Assert that execute succeeded""" | ||
| mock_get_or_create_pod.return_value = {} | ||
| mock_build_pod_request_obj.return_value = {} | ||
| mock_defer.return_value = {} | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| assert op.execute(context=create_context(op)) is None | ||
| def test_init(self): | ||
| task = KubernetesPodOperatorAsync( | ||
| task_id="test_task", name="test-pod", get_logs=True, logging_interval=5 | ||
| ) | ||
|
|
||
| @mock.patch(f"{KUBE_POD_MOD}.KubernetesPodOperatorAsync.trigger_reentry") | ||
| def test_execute_complete(self, mock_trigger_reentry): | ||
| """Assert that execute_complete succeeded""" | ||
| mock_trigger_reentry.return_value = {} | ||
| op = KubernetesPodOperatorAsync(task_id="test_task", name="test-pod", get_logs=True) | ||
| assert op.execute_complete(context=create_context(op), event={}) is None | ||
| assert isinstance(task, KubernetesPodOperator) | ||
| assert task.deferrable is True |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we also need to pass logging_interval
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's present in the kwargs, it will be passed is. The default previous value here for logging_interval was None, and the upstream has default None too, so no additional care needs to be taken.