Source code for tests.system.providers.amazon.aws.example_cloudformation

# 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.
import json
from datetime import datetime

from airflow import DAG
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.operators.cloud_formation import (
    CloudFormationCreateStackOperator,
    CloudFormationDeleteStackOperator,
)
from airflow.providers.amazon.aws.sensors.cloud_formation import (
    CloudFormationCreateStackSensor,
    CloudFormationDeleteStackSensor,
)
from tests.system.providers.amazon.aws.utils import set_env_id

[docs]ENV_ID = set_env_id()
[docs]DAG_ID = 'example_cloudformation'

[docs]CLOUDFORMATION_STACK_NAME = f'{ENV_ID}-stack'
# The CloudFormation template must have at least one resource to
# be usable, this example uses SQS as a free and serverless option.
[docs]CLOUDFORMATION_TEMPLATE = {
    'Description': 'Stack from Airflow CloudFormation example DAG',
    'Resources': {
        'ExampleQueue': {
            'Type': 'AWS::SQS::Queue',
        }
    },
}
[docs]CLOUDFORMATION_CREATE_PARAMETERS = {
    'StackName': CLOUDFORMATION_STACK_NAME,
    'TemplateBody': json.dumps(CLOUDFORMATION_TEMPLATE),
    'TimeoutInMinutes': 2,
    'OnFailure': 'DELETE',  # Don't leave stacks behind if creation fails.
}

with DAG(
    dag_id=DAG_ID,
    schedule_interval='@once',
    start_date=datetime(2021, 1, 1),
    tags=['example'],
    catchup=False,
) as dag:

    # [START howto_operator_cloudformation_create_stack]
[docs]    create_stack = CloudFormationCreateStackOperator(
        task_id='create_stack',
        stack_name=CLOUDFORMATION_STACK_NAME,
        cloudformation_parameters=CLOUDFORMATION_CREATE_PARAMETERS,
    )
    # [END howto_operator_cloudformation_create_stack]

    # [START howto_sensor_cloudformation_create_stack]
    wait_for_stack_create = CloudFormationCreateStackSensor(
        task_id='wait_for_stack_create',
        stack_name=CLOUDFORMATION_STACK_NAME,
    )
    # [END howto_sensor_cloudformation_create_stack]

    # [START howto_operator_cloudformation_delete_stack]
    delete_stack = CloudFormationDeleteStackOperator(
        task_id='delete_stack',
        trigger_rule='all_done',
        stack_name=CLOUDFORMATION_STACK_NAME,
    )
    # [END howto_operator_cloudformation_delete_stack]

    # [START howto_sensor_cloudformation_delete_stack]
    wait_for_stack_delete = CloudFormationDeleteStackSensor(
        task_id='wait_for_stack_delete',
        trigger_rule='all_done',
        stack_name=CLOUDFORMATION_STACK_NAME,
    )
    # [END howto_sensor_cloudformation_delete_stack]

    chain(
        create_stack,
        wait_for_stack_create,
        delete_stack,
        wait_for_stack_delete,
    )

    from tests.system.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.system.utils import get_test_run  # noqa: E402

# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
[docs]test_run = get_test_run(dag)