Skip to content
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

SQLCheckOperator fails if it returns dict with any Falsy values #36273

Conversation

spencertollefson
Copy link
Contributor

closes: #34794

This PR modifys the SQLCheckOperator's behaviour in how it handles reading a Python dict.

Previously, if a Python dict was returned by the SQL query, the SQLCheckOperator would always pass. As suggested in the linked issue, if a Python dict is returned it is recommended that if any of the dict's values are False-y , then the Operator should fail. This PR makes that change.

For example, if the SQL query being tested returns:

{'DUPLICATE_ID_CHECK': False, 'NULL_VALUES_CHECK': True}

then the operator should return False, since there is a Falsy value present.

The PR also adds an additional unit test and updated the documentation of the Operator.

Question for reviewers: I am concerned that users may be implementing this operator under the assumption that any dict returned means the task should pass. With this change, that would now lead to the task failing.


Copy link

boring-cyborg bot commented Dec 18, 2023

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

Copy link
Member

@hussein-awala hussein-awala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, it's a bug fix, and there is no breaking change. LGTM

cc: @eladkal

generated/provider_dependencies.json Outdated Show resolved Hide resolved
@potiuk potiuk force-pushed the sql-check-operator-fail-on-false-dict-values branch from d6f61c2 to cc125ac Compare December 18, 2023 21:32
@hussein-awala hussein-awala requested a review from potiuk December 19, 2023 22:35
@potiuk potiuk merged commit 5c1d8f4 into apache:main Dec 19, 2023
52 checks passed
Copy link

boring-cyborg bot commented Dec 19, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@spencertollefson spencertollefson deleted the sql-check-operator-fail-on-false-dict-values branch December 20, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SQLCheckOperator returns as success despite Python bool casting evaluating to False
4 participants