Source code for tests.system.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__importannotationsfromdatetimeimportdatetimeimportboto3fromairflow.decoratorsimporttaskfromairflow.models.baseoperatorimportchainfromairflow.models.dagimportDAGfromairflow.providers.amazon.aws.hooks.ecsimportEcsTaskStatesfromairflow.providers.amazon.aws.operators.ecsimportEcsRunTaskOperatorfromairflow.providers.amazon.aws.sensors.ecsimportEcsTaskStateSensorfromairflow.utils.trigger_ruleimportTriggerRulefromproviders.tests.system.amazon.aws.utilsimportENV_ID_KEY,SystemTestContextBuilder
[docs]defcreate_cluster(cluster_name:str)->None:"""Creates an ECS cluster."""boto3.client("ecs").create_cluster(clusterName=cluster_name)
@task
[docs]defregister_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",)returnresponse["taskDefinition"]["taskDefinitionArn"]
@task(trigger_rule=TriggerRule.ALL_DONE)
[docs]defdelete_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]defdelete_cluster(cluster_name:str)->None:"""Deletes the ECS cluster."""boto3.client("ecs").delete_cluster(cluster=cluster_name)
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]# EcsRunTaskOperator waits by default, setting as False to test the Sensor below.hello_world.wait_for_completion=False# [START howto_sensor_ecs_task_state]# By default, EcsTaskStateSensor waits until the task has started, but the# demo task runs so fast that the sensor misses it. This sensor instead# demonstrates how to wait until the ECS Task has completed by providing# the target_state and failure_states parameters.await_task_finish=EcsTaskStateSensor(task_id="await_task_finish",cluster=cluster_name,task=hello_world.output["ecs_task_arn"],target_state=EcsTaskStates.STOPPED,failure_states={EcsTaskStates.NONE},)# [END howto_sensor_ecs_task_state]chain(# TEST SETUPtest_context,create_cluster(cluster_name),create_task_definition,# TEST BODYhello_world,await_task_finish,# TEST TEARDOWNdelete_task_definition(create_task_definition),delete_cluster(cluster_name),)fromtests_common.test_utils.watcherimportwatcher# This test needs watcher in order to properly mark success/failure# when "tearDown" task with trigger rule is part of the DAGlist(dag.tasks)>>watcher()fromtests_common.test_utils.system_testsimportget_test_run# noqa: E402# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)