# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
from datetime import datetime
import boto3
from airflow.providers.amazon.aws.sensors.dynamodb import DynamoDBValueSensor
from tests_common.test_utils.version_compat import AIRFLOW_V_3_0_PLUS
if AIRFLOW_V_3_0_PLUS:
from airflow.sdk import DAG, chain, task
else:
# Airflow 2 path
from airflow.decorators import task # type: ignore[attr-defined,no-redef]
from airflow.models.baseoperator import chain # type: ignore[attr-defined,no-redef]
from airflow.models.dag import DAG # type: ignore[attr-defined,no-redef,assignment]
try:
from airflow.sdk import TriggerRule
except ImportError:
# Compatibility for Airflow < 3.1
from airflow.utils.trigger_rule import TriggerRule # type: ignore[no-redef,attr-defined]
from system.amazon.aws.utils import ENV_ID_KEY, SystemTestContextBuilder
DAG_ID = "example_dynamodb"
sys_test_context_task = SystemTestContextBuilder().build()
PK_ATTRIBUTE_NAME = "PK"
SK_ATTRIBUTE_NAME = "SK"
TABLE_ATTRIBUTES = [
{"AttributeName": PK_ATTRIBUTE_NAME, "AttributeType": "S"},
{"AttributeName": SK_ATTRIBUTE_NAME, "AttributeType": "S"},
]
TABLE_KEY_SCHEMA = [
{"AttributeName": "PK", "KeyType": "HASH"},
{"AttributeName": "SK", "KeyType": "RANGE"},
]
TABLE_THROUGHPUT = {"ReadCapacityUnits": 10, "WriteCapacityUnits": 10}
@task
def create_table(table_name: str):
ddb = boto3.resource("dynamodb")
table = ddb.create_table(
AttributeDefinitions=TABLE_ATTRIBUTES,
TableName=table_name,
KeySchema=TABLE_KEY_SCHEMA,
ProvisionedThroughput=TABLE_THROUGHPUT,
)
boto3.client("dynamodb").get_waiter("table_exists").wait(TableName=table_name)
table.put_item(Item={"PK": "Test", "SK": "2022-07-12T11:11:25-0400", "Value": "Testing"})
@task(trigger_rule=TriggerRule.ALL_DONE)
def delete_table(table_name: str):
client = boto3.client("dynamodb")
client.delete_table(TableName=table_name)
client.get_waiter("table_not_exists").wait(TableName=table_name)
with DAG(
dag_id=DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
) as dag:
test_context = sys_test_context_task()
env_id = test_context[ENV_ID_KEY]
table_name = f"{env_id}-dynamodb-table"
create_table_task = create_table(table_name=table_name)
delete_table_task = delete_table(table_name)
# [START howto_sensor_dynamodb_value]
dynamodb_sensor = DynamoDBValueSensor(
task_id="waiting_for_dynamodb_item_value",
table_name=table_name,
partition_key_name=PK_ATTRIBUTE_NAME,
partition_key_value="Test",
sort_key_name=SK_ATTRIBUTE_NAME,
sort_key_value="2022-07-12T11:11:25-0400",
attribute_name="Value",
attribute_value="Testing",
)
# [END howto_sensor_dynamodb_value]
# [START howto_sensor_dynamodb_any_value]
dynamodb_sensor_any_value = DynamoDBValueSensor(
task_id="waiting_for_dynamodb_item_any_value",
table_name=table_name,
partition_key_name=PK_ATTRIBUTE_NAME,
partition_key_value="Test",
sort_key_name=SK_ATTRIBUTE_NAME,
sort_key_value="2022-07-12T11:11:25-0400",
attribute_name="Value",
attribute_value=["Foo", "Testing", "Bar"],
)
# [END howto_sensor_dynamodb_any_value]
chain(
# TEST SETUP
test_context,
create_table_task,
# TEST BODY
dynamodb_sensor,
dynamodb_sensor_any_value,
# TEST TEARDOWN
delete_table_task,
)
from tests_common.test_utils.watcher import watcher
# This test needs watcher in order to properly mark success/failure
# when "tearDown" task with trigger rule is part of the DAG
list(dag.tasks) >> watcher()
from tests_common.test_utils.system_tests import get_test_run # noqa: E402
# Needed to run the example DAG with pytest (see: contributing-docs/testing/system_tests.rst)
test_run = get_test_run(dag)