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

Create NoAdditionalArgsInOperatorsRule to ease upgrade to Airflow 2.0 #11042

Closed
turbaszek opened this issue Sep 21, 2020 · 4 comments · Fixed by #12660
Closed

Create NoAdditionalArgsInOperatorsRule to ease upgrade to Airflow 2.0 #11042

turbaszek opened this issue Sep 21, 2020 · 4 comments · Fixed by #12660
Assignees
Labels
area:upgrade Facilitating migration to a newer version of Airflow good first issue kind:feature Feature Requests upgrade-check upgrade-check CLI

Comments

@turbaszek
Copy link
Member

This issue is part of #8765

Rule

Create NoAdditionalArgsInOperatorsRule which corresponds to

Additional arguments passed to BaseOperator cause an exception

entry in UPDATING.md. This rule should allow users to check if their current configuration needs any adjusting
before migration to Airflow 2.0.

How to guide

To implement a new rule, create a class that inherits from airflow.upgrade.rules.base_rule.BaseRule.
It will be auto-registered and used by airflow upgrade-check command. The custom rule class has to have title,
description properties and should implement check method which returns a list of error messages in case of
incompatibility.

For example:

class ConnTypeIsNotNullableRule(BaseRule):
title = "Connection.conn_type is not nullable"
description = """\
The `conn_type` column in the `connection` table must contain content. Previously, this rule was \
enforced by application logic, but was not enforced by the database schema.
If you made any modifications to the table directly, make sure you don't have null in the conn_type column.\
"""
@provide_session
def check(self, session=None):
invalid_connections = session.query(Connection).filter(Connection.conn_type.is_(None))
return (
'Connection<id={}", conn_id={}> have empty conn_type field.'.format(conn.id, conn.conn_id)
for conn in invalid_connections
)

Remember to open the PR against v1-10-test branch.

@turbaszek turbaszek added area:upgrade Facilitating migration to a newer version of Airflow kind:feature Feature Requests good first issue labels Sep 21, 2020
@turbaszek turbaszek added this to the Airflow 1.10.13 milestone Sep 21, 2020
@coopergillan
Copy link
Contributor

@turbaszek - I would like to give this a shot in the next week or two here.

@turbaszek turbaszek moved this from To do to In progress in Airflow upgrade check Sep 28, 2020
@kaxil kaxil added the upgrade-check upgrade-check CLI label Oct 30, 2020
@turbaszek
Copy link
Member Author

Hey @coopergillan any update on this one?

@Dr-Denzy
Copy link
Contributor

I will like to work on this task.

kaxil pushed a commit that referenced this issue Dec 10, 2020
The NoAdditionalArgsInOperatorsRule class ensures that passing an
unrecognized arguments to operators causes an exception.

fixes #11042
@ashb
Copy link
Member

ashb commented Dec 11, 2020

Done in #12660.

@ashb ashb closed this as completed Dec 11, 2020
Airflow upgrade check automation moved this from In progress to Done Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:upgrade Facilitating migration to a newer version of Airflow good first issue kind:feature Feature Requests upgrade-check upgrade-check CLI
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

6 participants