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.

Sign up for GitHub

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

Jump to bottom

Set template_fields on RDS operators #26005

Merged
merged 8 commits into from
Sep 5, 2022
Merged

Set template_fields on RDS operators #26005

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e64d020
Add template_fields to operators
hankehly Aug 27, 2022
e82dc6d
Update system tests
hankehly Aug 27, 2022
9974947
Delete unused tasks
hankehly Aug 27, 2022
ff212eb
Add missing imports
hankehly Aug 27, 2022
aacf338
Remove unused imports
hankehly Aug 28, 2022
e64e638
Fix link in documentation
hankehly Aug 28, 2022
4715bfe
Merge branch 'main' into add_template_fields_to_rds_operators
hankehly Aug 28, 2022
00d8f14
Update airflow/providers/amazon/aws/operators/rds.py
hankehly Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions airflow/providers/amazon/aws/operators/rds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,8 @@ class RdsCreateDbInstanceOperator(RdsBaseOperator):
:param wait_for_completion: If True, waits for creation of the DB instance to complete. (default: True)
"""

template_fields = ("db_instance_identifier", "db_instance_class", "rds_kwargs")
hankehly marked this conversation as resolved.
Show resolved Hide resolved

def __init__(
self,
*,
Expand Down Expand Up @@ -637,6 +639,8 @@ class RdsDeleteDbInstanceOperator(RdsBaseOperator):
:param wait_for_completion: If True, waits for deletion of the DB instance to complete. (default: True)
"""

template_fields = ("db_instance_identifier", "rds_kwargs")

def __init__(
self,
*,
Expand Down
57 changes: 26 additions & 31 deletions tests/system/providers/amazon/aws/example_rds_event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.hooks.rds import RdsHook
from airflow.providers.amazon.aws.operators.rds import (
RdsCreateDbInstanceOperator,
RdsCreateEventSubscriptionOperator,
RdsDeleteDbInstanceOperator,
RdsDeleteEventSubscriptionOperator,
)
from airflow.utils.trigger_rule import TriggerRule
Expand All @@ -41,35 +43,6 @@ def create_sns_topic(env_id) -> str:
return boto3.client('sns').create_topic(Name=f'{env_id}-topic')['TopicArn']


@task
def create_rds_instance(db_name, instance_name) -> None:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made the same updates in each system test file

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for this!

rds_client = RdsHook().get_conn()
rds_client.create_db_instance(
DBName=db_name,
DBInstanceIdentifier=instance_name,
AllocatedStorage=20,
DBInstanceClass='db.t3.micro',
Engine='postgres',
MasterUsername='username',
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
MasterUserPassword='rds_password',
)

rds_client.get_waiter('db_instance_available').wait(DBInstanceIdentifier=instance_name)


@task(trigger_rule=TriggerRule.ALL_DONE)
def delete_db_instance(instance_name) -> None:
rds_client = RdsHook().get_conn()
rds_client.delete_db_instance(
DBInstanceIdentifier=instance_name,
SkipFinalSnapshot=True,
)

rds_client.get_waiter('db_instance_deleted').wait(DBInstanceIdentifier=instance_name)


@task(trigger_rule=TriggerRule.ALL_DONE)
def delete_sns_topic(topic_arn) -> None:
boto3.client('sns').delete_topic(TopicArn=topic_arn)
Expand All @@ -90,6 +63,21 @@ def delete_sns_topic(topic_arn) -> None:

sns_topic = create_sns_topic(test_context[ENV_ID_KEY])

create_db_instance = RdsCreateDbInstanceOperator(
task_id="create_db_instance",
db_instance_identifier=rds_instance_name,
db_instance_class="db.t4g.micro",
engine="postgres",
rds_kwargs={
"MasterUsername": "rds_username",
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
"MasterUserPassword": "rds_password",
"AllocatedStorage": 20,
"DBName": rds_db_name,
},
)

# [START howto_operator_rds_create_event_subscription]
create_subscription = RdsCreateEventSubscriptionOperator(
task_id='create_subscription',
Expand All @@ -108,16 +96,23 @@ def delete_sns_topic(topic_arn) -> None:
)
# [END howto_operator_rds_delete_event_subscription]

delete_db_instance = RdsDeleteDbInstanceOperator(
task_id="delete_db_instance",
db_instance_identifier=rds_instance_name,
rds_kwargs={"SkipFinalSnapshot": True},
trigger_rule=TriggerRule.ALL_DONE,
)

chain(
# TEST SETUP
test_context,
sns_topic,
create_rds_instance(rds_db_name, rds_instance_name),
create_db_instance,
# TEST BODY
create_subscription,
delete_subscription,
# TEST TEARDOWN
delete_db_instance(rds_instance_name),
delete_db_instance,
delete_sns_topic(sns_topic),
)

Expand Down
57 changes: 26 additions & 31 deletions tests/system/providers/amazon/aws/example_rds_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
from airflow.providers.amazon.aws.hooks.rds import RdsHook
from airflow.providers.amazon.aws.operators.rds import (
RdsCancelExportTaskOperator,
RdsCreateDbInstanceOperator,
RdsCreateDbSnapshotOperator,
RdsDeleteDbInstanceOperator,
RdsDeleteDbSnapshotOperator,
RdsStartExportTaskOperator,
)
Expand All @@ -44,41 +46,12 @@
)


@task
def create_rds_instance(db_name: str, instance_name: str) -> None:
rds_client = RdsHook().conn
rds_client.create_db_instance(
DBName=db_name,
DBInstanceIdentifier=instance_name,
AllocatedStorage=20,
DBInstanceClass='db.t3.micro',
Engine='postgres',
MasterUsername='username',
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
MasterUserPassword='rds_password',
)

rds_client.get_waiter('db_instance_available').wait(DBInstanceIdentifier=instance_name)


@task
def get_snapshot_arn(snapshot_name: str) -> str:
result = RdsHook().conn.describe_db_snapshots(DBSnapshotIdentifier=snapshot_name)
return result['DBSnapshots'][0]['DBSnapshotArn']


@task(trigger_rule=TriggerRule.ALL_DONE)
def delete_rds_instance(instance_name) -> None:
rds_client = RdsHook().get_conn()
rds_client.delete_db_instance(
DBInstanceIdentifier=instance_name,
SkipFinalSnapshot=True,
)

rds_client.get_waiter('db_instance_deleted').wait(DBInstanceIdentifier=instance_name)


with DAG(
dag_id=DAG_ID,
schedule='@once',
Expand All @@ -101,6 +74,21 @@ def delete_rds_instance(instance_name) -> None:
bucket_name=bucket_name,
)

create_db_instance = RdsCreateDbInstanceOperator(
task_id="create_db_instance",
db_instance_identifier=rds_instance_name,
db_instance_class="db.t4g.micro",
engine="postgres",
rds_kwargs={
"MasterUsername": "rds_username",
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
"MasterUserPassword": "rds_password",
"AllocatedStorage": 20,
"DBName": rds_db_name,
},
)

create_snapshot = RdsCreateDbSnapshotOperator(
task_id='create_snapshot',
db_type='instance',
Expand Down Expand Up @@ -160,11 +148,18 @@ def delete_rds_instance(instance_name) -> None:
force_delete=True,
)

delete_db_instance = RdsDeleteDbInstanceOperator(
task_id="delete_db_instance",
db_instance_identifier=rds_instance_name,
rds_kwargs={"SkipFinalSnapshot": True},
trigger_rule=TriggerRule.ALL_DONE,
)

chain(
# TEST SETUP
test_context,
create_bucket,
create_rds_instance(rds_db_name, rds_instance_name),
create_db_instance,
create_snapshot,
await_snapshot,
snapshot_arn,
Expand All @@ -175,7 +170,7 @@ def delete_rds_instance(instance_name) -> None:
# TEST TEARDOWN
delete_snapshot,
delete_bucket,
delete_rds_instance(rds_instance_name),
delete_db_instance,
)

from tests.system.utils.watcher import watcher
Expand Down
58 changes: 26 additions & 32 deletions tests/system/providers/amazon/aws/example_rds_snapshot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@
from datetime import datetime

from airflow import DAG
from airflow.decorators import task
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.hooks.rds import RdsHook
from airflow.providers.amazon.aws.operators.rds import (
RdsCopyDbSnapshotOperator,
RdsCreateDbInstanceOperator,
RdsCreateDbSnapshotOperator,
RdsDeleteDbInstanceOperator,
RdsDeleteDbSnapshotOperator,
)
from airflow.providers.amazon.aws.sensors.rds import RdsSnapshotExistenceSensor
Expand All @@ -36,35 +37,6 @@
sys_test_context_task = SystemTestContextBuilder().build()


@task
def create_rds_instance(db_name, instance_name) -> None:
rds_client = RdsHook().get_conn()
rds_client.create_db_instance(
DBName=db_name,
DBInstanceIdentifier=instance_name,
AllocatedStorage=20,
DBInstanceClass='db.t3.micro',
Engine='postgres',
MasterUsername='username',
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
MasterUserPassword='rds_password',
)

rds_client.get_waiter('db_instance_available').wait(DBInstanceIdentifier=instance_name)


@task(trigger_rule=TriggerRule.ALL_DONE)
def delete_rds_instance(instance_name) -> None:
rds_client = RdsHook().get_conn()
rds_client.delete_db_instance(
DBInstanceIdentifier=instance_name,
SkipFinalSnapshot=True,
)

rds_client.get_waiter('db_instance_deleted').wait(DBInstanceIdentifier=instance_name)


with DAG(
dag_id=DAG_ID,
schedule='@once',
Expand All @@ -79,6 +51,21 @@ def delete_rds_instance(instance_name) -> None:
rds_snapshot_name = f'{test_context[ENV_ID_KEY]}-snapshot'
rds_snapshot_copy_name = f'{rds_snapshot_name}-copy'

create_db_instance = RdsCreateDbInstanceOperator(
task_id="create_db_instance",
db_instance_identifier=rds_instance_name,
db_instance_class="db.t4g.micro",
engine="postgres",
rds_kwargs={
"MasterUsername": "rds_username",
# NEVER store your production password in plaintext in a DAG like this.
# Use Airflow Secrets or a secret manager for this in production.
"MasterUserPassword": "rds_password",
"AllocatedStorage": 20,
"DBName": rds_db_name,
},
)

# [START howto_operator_rds_create_db_snapshot]
create_snapshot = RdsCreateDbSnapshotOperator(
task_id='create_snapshot',
Expand Down Expand Up @@ -127,10 +114,17 @@ def delete_rds_instance(instance_name) -> None:
db_snapshot_identifier=rds_snapshot_copy_name,
)

delete_db_instance = RdsDeleteDbInstanceOperator(
task_id="delete_db_instance",
db_instance_identifier=rds_instance_name,
rds_kwargs={"SkipFinalSnapshot": True},
trigger_rule=TriggerRule.ALL_DONE,
)

chain(
# TEST SETUP
test_context,
create_rds_instance(rds_db_name, rds_instance_name),
create_db_instance,
# TEST BODY
create_snapshot,
snapshot_sensor,
Expand All @@ -139,7 +133,7 @@ def delete_rds_instance(instance_name) -> None:
# TEST TEARDOWN
snapshot_copy_sensor,
delete_snapshot_copy,
delete_rds_instance(rds_instance_name),
delete_db_instance,
)

from tests.system.utils.watcher import watcher
Expand Down