This is an automated email from the ASF dual-hosted git repository.
vincbeck pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 84f70dac4e Respect `soft_fail` argument when running `EcsBaseSensor`
(#34596)
84f70dac4e is described below
commit 84f70dac4e8a7d5472b48a71af78a56ff97bfc5d
Author: Utkarsh Sharma <[email protected]>
AuthorDate: Mon Sep 25 19:32:25 2023 +0530
Respect `soft_fail` argument when running `EcsBaseSensor` (#34596)
---
airflow/providers/amazon/aws/sensors/ecs.py | 18 ++++++++++--------
tests/providers/amazon/aws/sensors/test_ecs.py | 20 +++++++++++++++++++-
2 files changed, 29 insertions(+), 9 deletions(-)
diff --git a/airflow/providers/amazon/aws/sensors/ecs.py
b/airflow/providers/amazon/aws/sensors/ecs.py
index 320ef84b83..ecb1b92ee0 100644
--- a/airflow/providers/amazon/aws/sensors/ecs.py
+++ b/airflow/providers/amazon/aws/sensors/ecs.py
@@ -19,7 +19,7 @@ from __future__ import annotations
from functools import cached_property
from typing import TYPE_CHECKING, Sequence
-from airflow.exceptions import AirflowException
+from airflow.exceptions import AirflowException, AirflowSkipException
from airflow.providers.amazon.aws.hooks.ecs import (
EcsClusterStates,
EcsHook,
@@ -36,11 +36,13 @@ if TYPE_CHECKING:
DEFAULT_CONN_ID: str = "aws_default"
-def _check_failed(current_state, target_state, failure_states):
+def _check_failed(current_state, target_state, failure_states, soft_fail:
bool) -> None:
if (current_state != target_state) and (current_state in failure_states):
- raise AirflowException(
- f"Terminal state reached. Current state: {current_state}, Expected
state: {target_state}"
- )
+ # TODO: remove this if block when min_airflow_version is set to higher
than 2.7.1
+ message = f"Terminal state reached. Current state: {current_state},
Expected state: {target_state}"
+ if soft_fail:
+ raise AirflowSkipException(message)
+ raise AirflowException(message)
class EcsBaseSensor(BaseSensorOperator):
@@ -95,7 +97,7 @@ class EcsClusterStateSensor(EcsBaseSensor):
cluster_state =
EcsClusterStates(self.hook.get_cluster_state(cluster_name=self.cluster_name))
self.log.info("Cluster state: %s, waiting for: %s", cluster_state,
self.target_state)
- _check_failed(cluster_state, self.target_state, self.failure_states)
+ _check_failed(cluster_state, self.target_state, self.failure_states,
self.soft_fail)
return cluster_state == self.target_state
@@ -141,7 +143,7 @@ class EcsTaskDefinitionStateSensor(EcsBaseSensor):
)
self.log.info("Task Definition state: %s, waiting for: %s",
task_definition_state, self.target_state)
- _check_failed(task_definition_state, self.target_state,
[self.failure_states])
+ _check_failed(task_definition_state, self.target_state,
[self.failure_states], self.soft_fail)
return task_definition_state == self.target_state
@@ -181,5 +183,5 @@ class EcsTaskStateSensor(EcsBaseSensor):
task_state =
EcsTaskStates(self.hook.get_task_state(cluster=self.cluster, task=self.task))
self.log.info("Task state: %s, waiting for: %s", task_state,
self.target_state)
- _check_failed(task_state, self.target_state, self.failure_states)
+ _check_failed(task_state, self.target_state, self.failure_states,
self.soft_fail)
return task_state == self.target_state
diff --git a/tests/providers/amazon/aws/sensors/test_ecs.py
b/tests/providers/amazon/aws/sensors/test_ecs.py
index 66d8bc5c54..9480b63b7a 100644
--- a/tests/providers/amazon/aws/sensors/test_ecs.py
+++ b/tests/providers/amazon/aws/sensors/test_ecs.py
@@ -24,7 +24,7 @@ import boto3
import pytest
from slugify import slugify
-from airflow.exceptions import AirflowException
+from airflow.exceptions import AirflowException, AirflowSkipException
from airflow.providers.amazon.aws.sensors.ecs import (
DEFAULT_CONN_ID,
EcsBaseSensor,
@@ -35,6 +35,7 @@ from airflow.providers.amazon.aws.sensors.ecs import (
EcsTaskDefinitionStateSensor,
EcsTaskStates,
EcsTaskStateSensor,
+ _check_failed,
)
from airflow.utils import timezone
from airflow.utils.types import NOTSET
@@ -259,3 +260,20 @@ class TestEcsTaskStateSensor(EcsBaseTestCase):
with pytest.raises(AirflowException, match="Terminal state
reached"):
task.poke({})
m.assert_called_once_with(cluster=TEST_CLUSTER_NAME,
task=TEST_TASK_ARN)
+
+
[email protected](
+ "soft_fail, expected_exception", ((False, AirflowException), (True,
AirflowSkipException))
+)
+def test_fail__check_failed(soft_fail, expected_exception):
+ current_state = "FAILED"
+ target_state = "SUCCESS"
+ failure_states = ["FAILED"]
+ message = f"Terminal state reached. Current state: {current_state},
Expected state: {target_state}"
+ with pytest.raises(expected_exception, match=message):
+ _check_failed(
+ current_state=current_state,
+ target_state=target_state,
+ failure_states=failure_states,
+ soft_fail=soft_fail,
+ )