Source code for tests.system.providers.google.cloud.composer.example_cloud_composer_deferrable
#
# 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
import os
from datetime import datetime
from airflow import models
from airflow.models.baseoperator import chain
from airflow.providers.google.cloud.operators.cloud_composer import (
CloudComposerCreateEnvironmentOperator,
CloudComposerDeleteEnvironmentOperator,
CloudComposerUpdateEnvironmentOperator,
)
from airflow.providers.google.cloud.sensors.cloud_composer import CloudComposerEnvironmentSensor
from airflow.utils.trigger_rule import TriggerRule
[docs]ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
[docs]PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT")
[docs]DAG_ID = "example_composer_deferrable"
[docs]ENVIRONMENT_ID = f"test-{DAG_ID}-{ENV_ID}".replace("_", "-")
# [START howto_operator_composer_simple_environment]
[docs]ENVIRONMENT = {
"config": {
"software_config": {"image_version": "composer-2.0.28-airflow-2.2.5"},
}
}
# [END howto_operator_composer_simple_environment]
# [START howto_operator_composer_update_environment]
[docs]UPDATED_ENVIRONMENT = {
"labels": {
"label2": "testing",
}
}
[docs]UPDATE_MASK = {"paths": ["labels.label2"]}
# [END howto_operator_composer_update_environment]
with models.DAG(
DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
tags=["example", "composer"],
) as dag:
# [START howto_operator_create_composer_environment_deferrable_mode]
[docs] defer_create_env = CloudComposerCreateEnvironmentOperator(
task_id="defer_create_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
environment=ENVIRONMENT,
deferrable=True,
)
# [END howto_operator_create_composer_environment_deferrable_mode]
operation_name = defer_create_env.output["operation_id"]
wait_for_execution = CloudComposerEnvironmentSensor(
task_id="wait_for_execution",
operation_name=operation_name,
region=REGION,
project_id=PROJECT_ID,
)
# [START howto_operator_update_composer_environment_deferrable_mode]
defer_update_env = CloudComposerUpdateEnvironmentOperator(
task_id="defer_update_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
update_mask=UPDATE_MASK,
environment=UPDATED_ENVIRONMENT,
deferrable=True,
)
# [END howto_operator_update_composer_environment_deferrable_mode]
# [START howto_operator_delete_composer_environment_deferrable_mode]
defer_delete_env = CloudComposerDeleteEnvironmentOperator(
task_id="defer_delete_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
deferrable=True,
)
# [END howto_operator_delete_composer_environment_deferrable_mode]
defer_delete_env.trigger_rule = TriggerRule.ALL_DONE
chain(
defer_create_env,
wait_for_execution,
defer_update_env,
defer_delete_env,
)
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)