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 CustomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 #11038

Closed
turbaszek opened this issue Sep 21, 2020 · 3 comments · Fixed by #12629
Closed

Create CustomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 #11038

turbaszek opened this issue Sep 21, 2020 · 3 comments · Fixed by #12629
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

turbaszek commented Sep 21, 2020

This issue is part of #8765

Rule

Create CutomOperatorUsesMetaclassRule which corresponds to

BaseOperator uses metaclass

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
@hweecat
Copy link

hweecat commented Oct 2, 2020

First-time contributor here - I'd like to give this a shot if that's okay @turbaszek! :)

@mik-laj
Copy link
Member

mik-laj commented Oct 2, 2020

@hweecat Welcome! I assigned you to this ticket 🐈

@kaxil kaxil added the upgrade-check upgrade-check CLI label Oct 30, 2020
turbaszek pushed a commit to hweecat/airflow that referenced this issue Nov 3, 2020
@turbaszek turbaszek linked a pull request Nov 3, 2020 that will close this issue
@dimberman dimberman self-assigned this Nov 25, 2020
@dimberman dimberman linked a pull request Nov 25, 2020 that will close this issue
@dimberman dimberman changed the title Create CutomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 Create CuStomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 Nov 25, 2020
@dimberman dimberman changed the title Create CuStomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 Create CustomOperatorUsesMetaclassRule to ease upgrade to Airflow 2.0 Nov 25, 2020
@turbaszek
Copy link
Member Author

Done in #12629

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
None yet
6 participants