amoghrajesh opened a new pull request, #71542:
URL: https://github.com/apache/airflow/pull/71542
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
https://chris.beams.io/posts/git-commit/
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.
For user-facing UI changes, please attach before/after screenshots (or a
short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
Our unit testing docs recommend a pattern that cannot work today. The best
practices doc
tells you to build a Dag in memory and call `dag.test()` on it, but
`dag.test()` creates a real Dag run, which requires the Dag to be serialized in
the metadata database. A Dag built inside a test function is in no Dag bundle,
so nothing
serializes it and the call raises:
```
Cannot create DagRun for DAG my_custom_operator_dag because the dag is
not serialized
```
For someone upgrading 3.1 to 3.2 or 3.3, they can hit above after Airflow
3.2 removed `TaskInstance.run()` and `TaskInstance.render_templates()` (#59835)
and they might go looking for a replacement.
Changes:
* `best-practices.rst`: replace the custom-operator example with direct
`execute()` / `poke()` calls, add `render_template_fields()` and a
deferrable
variant, and name the removed `TaskInstance` methods alongside their
replacements so a search for them lands here.
* `core-concepts/debug.rst`: state the two prerequisites for `dag.test()` (a
migrated database, a Dag file inside a configured bundle) and quote the
error
you get when they are not met.
* `howto/custom-operator.rst`: add a testing section. Someone writing a
custom
operator reads this page, finds nothing about testing, and goes looking
elsewhere.
* `tutorial/fundamentals.rst`: correct the claim that `airflow dags test`
runs
"without registering any state in the database". It creates a Dag run and
records task state.
The underlying confusion the docs never addressed: `dag.test()` is an
integration tool needing a database and a Dag on disk, while `execute()` is the
unit-test tool. The docs blurred the two, so readers reached for the wrong one.
### Verification
Installed 3.1.0 and 3.3.0 in clean venvs and ran a custom operator and sensor
both ways:
| | 3.1.0 | 3.3.0 |
|---|---|---|
| in-memory Dag + `dag.test()` | fails, not serialized | fails, not
serialized |
| Dag in a file + `airflow dags test` | passes | passes |
| `TaskInstance.run` | present | absent |
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
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]
