kaxil opened a new pull request, #48439: URL: https://github.com/apache/airflow/pull/48439
As we are replacing BaseOperator usage from Core to Task SDK, we are running into several issues, one of the common one being over-usage of `task.run()`. While some cases can be easily replaced by `task.execute()` others needs execution of the tasks, sharing of XCom's in between, checking task state, correct exception etc. To make this easier I have added `run_task` fixture which I have been using in https://github.com/apache/airflow/pull/48244 and it has worked out well. This also takes care of creating a DAG if not provided. ## Example Usage ### Basic Task Execution ```python def test_basic_task(run_task): class MyTaskOperator(BaseOperator): def execute(self, context): return "hello" task = MyTaskOperator(task_id="test_task") run_task(task) assert run_task.state == TerminalTIState.SUCCESS assert run_task.error is None ``` ### Testing XCom Operations ```python def test_xcom_operations(run_task): class UpstreamTask(BaseOperator): def execute(self, context): context["task_instance"].xcom_push(key="my_value", value=100) return "done" class DownstreamTask(BaseOperator): def execute(self, context): value = context["task_instance"].xcom_pull(key="my_value") assert value == 100 return "done" # Run upstream task upstream = UpstreamTask(task_id="upstream") run_task(upstream) # Verify XCom was pushed run_task.xcom.assert_pushed("my_value", 100) # Run downstream task downstream = DownstreamTask(task_id="downstream") run_task(downstream) # Verify XCom can be retrieved assert run_task.xcom.get("my_value") == 100 ``` ### Testing Task Failures ```python def test_task_failure(run_task): class FailingTask(BaseOperator): def execute(self, context): raise ValueError("Task failed") task = FailingTask(task_id="failing_task") run_task(task) assert run_task.state == TerminalTIState.FAILED assert isinstance(run_task.error, ValueError) ``` ## Migration Guide Replace existing `ti.run()` usage with the new fixture: Before: ```python def test_old_style(): dag = DAG("test_dag") task = MyTaskOperator(task_id="test_task", dag=dag) ti = TaskInstance(task=task, execution_date=datetime.now()) ti.run() assert ti.state == State.SUCCESS ``` After: ```python def test_new_style(run_task): task = MyTaskOperator(task_id="test_task") run_task(task) assert run_task.state == TerminalTIState.SUCCESS ``` <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Thank you for contributing! Please make sure that your code changes are covered with tests. And in case of new features or big changes remember to adjust the documentation. Feel free to ping committers for the review! In case of an existing issue, reference it using one of the following: closes: #ISSUE related: #ISSUE How to write a good git commit message: http://chris.beams.io/posts/git-commit/ --> <!-- Please keep an empty line above the dashes. --> --- **^ Add meaningful description above** Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information. In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed. In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
