#
# 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 logging
import os
from datetime import datetime, timedelta
from typing import Any
from google.api_core.exceptions import NotFound
from google.cloud.orchestration.airflow.service_v1.types import Environment
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from tests_common.test_utils.version_compat import AIRFLOW_V_3_0_PLUS
if AIRFLOW_V_3_0_PLUS:
from airflow.sdk import task
else:
# Airflow 2 path
from airflow.decorators import task # type: ignore[attr-defined,no-redef]
from airflow.models.baseoperator import chain
from airflow.models.dag import DAG
from airflow.providers.common.compat.sdk import AirflowException
from airflow.providers.google.cloud.hooks.cloud_composer import CloudComposerHook
from airflow.providers.google.cloud.operators.cloud_composer import (
CloudComposerCreateEnvironmentOperator,
CloudComposerDeleteEnvironmentOperator,
CloudComposerGetEnvironmentOperator,
CloudComposerListEnvironmentsOperator,
CloudComposerListImageVersionsOperator,
CloudComposerRunAirflowCLICommandOperator,
CloudComposerTriggerDAGRunOperator,
CloudComposerUpdateEnvironmentOperator,
)
from airflow.providers.google.cloud.sensors.cloud_composer import (
CloudComposerDAGRunSensor,
CloudComposerExternalTaskSensor,
)
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]
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID", "default")
PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT", "default")
PROJECT_NUMBER = "{{ task_instance.xcom_pull('get_project_number') }}"
DAG_ID = "composer"
REGION = "us-central1"
# [START howto_operator_managed_airflow_simple_environment]
ENVIRONMENT_ID = f"test-{DAG_ID}-{ENV_ID}".replace("_", "-")
ENVIRONMENT_ID_ASYNC = f"test-deferrable-{DAG_ID}-{ENV_ID}".replace("_", "-")
ENVIRONMENT = {
"config": {
"software_config": {"image_version": "composer-3-airflow-2"},
"node_config": {
"service_account": f"{PROJECT_NUMBER}-compute@developer.gserviceaccount.com",
},
},
}
# [END howto_operator_managed_airflow_simple_environment]
# [START howto_operator_managed_airflow_update_environment]
UPDATED_ENVIRONMENT = {
"labels": {
"label": "testing",
}
}
UPDATE_MASK = {"paths": ["labels.label"]}
# [END howto_operator_managed_airflow_update_environment]
COMMAND = "dags list -o json --verbose"
log = logging.getLogger(__name__)
@task(task_id="get_project_number")
def get_project_number():
"""Helper function to retrieve the number of the project based on PROJECT_ID"""
try:
with build("cloudresourcemanager", "v1") as service:
response = service.projects().get(projectId=PROJECT_ID).execute()
return response["projectNumber"]
except HttpError as exc:
if exc.status_code == 403:
raise AirflowException(
"No project found with specified name, "
"or caller does not have permissions to read specified project"
)
raise exc
# [START howto_operator_composer_retry_cleanup]
def cleanup_failed_environment_before_retry(context: dict[str, Any]) -> None:
task = context["task"]
hook = CloudComposerHook(
gcp_conn_id=task.gcp_conn_id,
impersonation_chain=task.impersonation_chain,
)
environment_id = task.environment_id
project_id = task.project_id
region = task.region
log.info(
"Retry cleanup started for Composer env. project_id=%s region=%s environment_id=%s",
project_id,
region,
environment_id,
)
try:
environment = hook.get_environment(
project_id=project_id,
region=region,
environment_id=environment_id,
)
except NotFound:
log.info("Environment does not exist. Nothing to clean up.")
return
env_state = Environment.State(environment.state)
log.info(
"Environment exists before retry. state=%s value=%s",
env_state.name,
env_state.value,
)
if env_state != Environment.State.ERROR:
log.info(
"Skipping cleanup before retry because environment is not in ERROR state. current_state=%s",
env_state.name,
)
return
log.info("Deleting Composer environment %s in ERROR state before retry.", environment_id)
delete_operation = hook.delete_environment(
project_id=project_id,
region=region,
environment_id=environment_id,
)
hook.wait_for_operation(operation=delete_operation)
log.info("Environment %s deleted before retry.", environment_id)
# [END howto_operator_composer_retry_cleanup]
with DAG(
DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
tags=["example", "composer"],
) as dag:
# [START howto_operator_managed_airflow_image_list]
image_versions = CloudComposerListImageVersionsOperator(
task_id="image_versions",
project_id=PROJECT_ID,
region=REGION,
)
# [END howto_operator_managed_airflow_image_list]
# [START howto_operator_create_managed_airflow_environment]
create_env = CloudComposerCreateEnvironmentOperator(
task_id="create_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
environment=ENVIRONMENT,
retries=1,
retry_delay=timedelta(minutes=1),
on_retry_callback=cleanup_failed_environment_before_retry,
)
# [END howto_operator_create_managed_airflow_environment]
# [START howto_operator_create_managed_airflow_environment_deferrable_mode]
defer_create_env = CloudComposerCreateEnvironmentOperator(
task_id="defer_create_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
environment=ENVIRONMENT,
deferrable=True,
retries=1,
retry_delay=timedelta(minutes=1),
on_retry_callback=cleanup_failed_environment_before_retry,
)
# [END howto_operator_create_managed_airflow_environment_deferrable_mode]
# [START howto_operator_list_managed_airflow_environments]
list_envs = CloudComposerListEnvironmentsOperator(
task_id="list_envs", project_id=PROJECT_ID, region=REGION
)
# [END howto_operator_list_managed_airflow_environments]
# [START howto_operator_get_managed_airflow_environment]
get_env = CloudComposerGetEnvironmentOperator(
task_id="get_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
)
# [END howto_operator_get_managed_airflow_environment]
# [START howto_operator_update_managed_airflow_environment]
update_env = CloudComposerUpdateEnvironmentOperator(
task_id="update_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
update_mask=UPDATE_MASK,
environment=UPDATED_ENVIRONMENT,
)
# [END howto_operator_update_managed_airflow_environment]
# [START howto_operator_update_managed_airflow_environment_deferrable_mode]
defer_update_env = CloudComposerUpdateEnvironmentOperator(
task_id="defer_update_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
update_mask=UPDATE_MASK,
environment=UPDATED_ENVIRONMENT,
deferrable=True,
)
# [END howto_operator_update_managed_airflow_environment_deferrable_mode]
# [START howto_operator_run_airflow_cli_command]
run_airflow_cli_cmd = CloudComposerRunAirflowCLICommandOperator(
task_id="run_airflow_cli_cmd",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
command=COMMAND,
)
# [END howto_operator_run_airflow_cli_command]
# [START howto_operator_run_airflow_cli_command_deferrable_mode]
defer_run_airflow_cli_cmd = CloudComposerRunAirflowCLICommandOperator(
task_id="defer_run_airflow_cli_cmd",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
command=COMMAND,
deferrable=True,
)
# [END howto_operator_run_airflow_cli_command_deferrable_mode]
# [START howto_sensor_dag_run]
dag_run_sensor = CloudComposerDAGRunSensor(
task_id="dag_run_sensor",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
composer_dag_id="airflow_monitoring",
allowed_states=["success"],
)
# [END howto_sensor_dag_run]
# [START howto_sensor_dag_run_deferrable_mode]
defer_dag_run_sensor = CloudComposerDAGRunSensor(
task_id="defer_dag_run_sensor",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
composer_dag_id="airflow_monitoring",
allowed_states=["success"],
deferrable=True,
)
# [END howto_sensor_dag_run_deferrable_mode]
# [START howto_operator_trigger_dag_run]
trigger_dag_run = CloudComposerTriggerDAGRunOperator(
task_id="trigger_dag_run",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
composer_dag_id="airflow_monitoring",
)
# [END howto_operator_trigger_dag_run]
# [START howto_sensor_external_task]
external_task_sensor = CloudComposerExternalTaskSensor(
task_id="external_task_sensor",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
composer_external_dag_id="airflow_monitoring",
composer_external_task_id="echo",
allowed_states=["success"],
execution_range=timedelta(days=1),
)
# [END howto_sensor_external_task]
# [START howto_sensor_external_task_deferrable_mode]
defer_external_task_sensor = CloudComposerExternalTaskSensor(
task_id="defer_external_task_sensor",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
composer_external_dag_id="airflow_monitoring",
composer_external_task_id="echo",
allowed_states=["success"],
execution_range=timedelta(days=1),
deferrable=True,
)
# [END howto_sensor_external_task_deferrable_mode]
# [START howto_operator_delete_managed_airflow_environment]
delete_env = CloudComposerDeleteEnvironmentOperator(
task_id="delete_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID,
)
# [END howto_operator_delete_managed_airflow_environment]
delete_env.trigger_rule = TriggerRule.ALL_DONE
# [START howto_operator_delete_managed_airflow_environment_deferrable_mode]
defer_delete_env = CloudComposerDeleteEnvironmentOperator(
task_id="defer_delete_env",
project_id=PROJECT_ID,
region=REGION,
environment_id=ENVIRONMENT_ID_ASYNC,
deferrable=True,
)
# [END howto_operator_delete_managed_airflow_environment_deferrable_mode]
defer_delete_env.trigger_rule = TriggerRule.ALL_DONE
chain(
# TEST SETUP
get_project_number(),
image_versions,
# TEST BODY
[create_env, defer_create_env],
list_envs,
get_env,
[update_env, defer_update_env],
[run_airflow_cli_cmd, defer_run_airflow_cli_cmd],
[dag_run_sensor, defer_dag_run_sensor],
trigger_dag_run,
[external_task_sensor, defer_external_task_sensor],
# TEST TEARDOWN
[delete_env, defer_delete_env],
)
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)