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

# 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 import DAG
from airflow.decorators import task
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.operators.ecs import EcsRunTaskOperator
from airflow.utils.trigger_rule import TriggerRule
from tests.system.providers.amazon.aws.utils import ENV_ID_KEY, SystemTestContextBuilder

[docs]DAG_ID = "example_ecs_fargate"
# Externally fetched variables:
[docs]SUBNETS_KEY = "SUBNETS" # At least one public subnet is required.
[docs]SECURITY_GROUPS_KEY = "SECURITY_GROUPS"
[docs]sys_test_context_task = ( SystemTestContextBuilder() .add_variable(SUBNETS_KEY, split_string=True) .add_variable(SECURITY_GROUPS_KEY, split_string=True)
.build() ) @task
[docs]def create_cluster(cluster_name: str) -> None: """Creates an ECS cluster.""" boto3.client("ecs").create_cluster(clusterName=cluster_name)
@task
[docs]def register_task_definition(task_name: str, container_name: str) -> str: """Creates a Task Definition.""" response = boto3.client("ecs").register_task_definition( family=task_name, # CPU and Memory are required for Fargate and are set to the lowest currently allowed values. cpu="256", memory="512", containerDefinitions=[ { "name": container_name, "image": "ubuntu", "workingDirectory": "/usr/bin", "entryPoint": ["sh", "-c"], "command": ["ls"], } ], requiresCompatibilities=["FARGATE"], networkMode="awsvpc", ) return response["taskDefinition"]["taskDefinitionArn"]
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]def delete_task_definition(task_definition_arn: str) -> None: """Deletes the Task Definition.""" boto3.client("ecs").deregister_task_definition(taskDefinition=task_definition_arn)
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]def delete_cluster(cluster_name: str) -> None: """Deletes the ECS cluster.""" boto3.client("ecs").delete_cluster(cluster=cluster_name)
with DAG( dag_id=DAG_ID, schedule="@once", start_date=datetime(2021, 1, 1), tags=["example"], catchup=False, ) as dag:
[docs] test_context = sys_test_context_task()
env_id = test_context[ENV_ID_KEY] cluster_name = f"{env_id}-test-cluster" container_name = f"{env_id}-test-container" task_definition_name = f"{env_id}-test-definition" create_task_definition = register_task_definition(task_definition_name, container_name) # [START howto_operator_ecs] hello_world = EcsRunTaskOperator( task_id="hello_world", cluster=cluster_name, task_definition=task_definition_name, launch_type="FARGATE", overrides={ "containerOverrides": [ { "name": container_name, "command": ["echo", "hello", "world"], }, ], }, network_configuration={ "awsvpcConfiguration": { "subnets": test_context[SUBNETS_KEY], "securityGroups": test_context[SECURITY_GROUPS_KEY], "assignPublicIp": "ENABLED", }, }, ) # [END howto_operator_ecs] chain( # TEST SETUP test_context, create_cluster(cluster_name), create_task_definition, # TEST BODY hello_world, # TEST TEARDOWN delete_task_definition(create_task_definition), delete_cluster(cluster_name), ) 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)

Was this entry helpful?