#
# 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.
"""
Example DAG using GoogleCloudStorageToGoogleDriveOperator.
Using this operator requires the following additional scopes:
https://www.googleapis.com/auth/drive
"""
from __future__ import annotations
import json
import logging
import os
from datetime import datetime
from pathlib import Path
from typing import Any
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.dag import DAG
from airflow.providers.google.cloud.operators.gcs import GCSCreateBucketOperator, GCSDeleteBucketOperator
from airflow.providers.google.cloud.transfers.gcs_to_gcs import GCSToGCSOperator
from airflow.providers.google.common.utils.get_secret import get_secret
from airflow.providers.google.suite.hooks.drive import GoogleDriveHook
from airflow.providers.google.suite.transfers.gcs_to_gdrive import GCSToGoogleDriveOperator
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]
from system.google import DEFAULT_GCP_SYSTEM_TEST_PROJECT_ID
from system.google.gcp_api_client_helpers import create_airflow_connection, delete_airflow_connection
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID", "default")
PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT") or DEFAULT_GCP_SYSTEM_TEST_PROJECT_ID
FOLDER_ID = os.environ.get("GCP_GDRIVE_FOLDER_ID", "root")
DAG_ID = "gcs_to_gdrive"
IS_COMPOSER = bool(os.environ.get("COMPOSER_ENVIRONMENT", ""))
RESOURCES_BUCKET_NAME = "airflow-system-tests-resources"
BUCKET_NAME = f"bucket_{DAG_ID}_{ENV_ID}"
CONNECTION_ID = f"connection_{DAG_ID}_{ENV_ID}"
TMP_PATH = "tmp"
WORK_DIR = f"folder_{DAG_ID}_{ENV_ID}".replace("-", "_")
CURRENT_FOLDER = Path(__file__).parent
LOCAL_PATH = str(Path("gcs"))
FILE_LOCAL_PATH = str(Path(LOCAL_PATH))
FILE_NAME = "example_upload.txt"
GDRIVE_SECRET_ID = "gdrive_shared_folder_id"
log = logging.getLogger(__name__)
with DAG(
DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
tags=["example", "gcs", "gdrive"],
) as dag:
@task
def get_shared_drive_id() -> str:
return get_secret(secret_id=GDRIVE_SECRET_ID).strip()
get_shared_drive_id_task = get_shared_drive_id()
@task
def create_connection(connection_id: str):
conn_extra_json = json.dumps(
{"scope": "https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/cloud-platform"}
)
connection: dict[str, Any] = {"conn_type": "google_cloud_platform", "extra": conn_extra_json}
create_airflow_connection(
connection_id=connection_id,
connection_conf=connection,
is_composer=IS_COMPOSER,
)
create_connection_task = create_connection(connection_id=CONNECTION_ID)
create_bucket = GCSCreateBucketOperator(
task_id="create_bucket", bucket_name=BUCKET_NAME, project_id=PROJECT_ID
)
upload_file_1 = GCSToGCSOperator(
task_id="upload_file_1",
source_bucket=RESOURCES_BUCKET_NAME,
source_object=f"{FILE_LOCAL_PATH}/{FILE_NAME}",
destination_bucket=BUCKET_NAME,
destination_object=f"{TMP_PATH}/{FILE_NAME}",
exact_match=True,
)
upload_file_2 = GCSToGCSOperator(
task_id="upload_file_2",
source_bucket=RESOURCES_BUCKET_NAME,
source_object=f"{FILE_LOCAL_PATH}/{FILE_NAME}",
destination_bucket=BUCKET_NAME,
destination_object=f"{TMP_PATH}/2_{FILE_NAME}",
exact_match=True,
)
# [START howto_operator_gcs_to_gdrive_copy_single_file]
copy_single_file = GCSToGoogleDriveOperator(
task_id="copy_single_file",
gcp_conn_id=CONNECTION_ID,
source_bucket=BUCKET_NAME,
source_object=f"{TMP_PATH}/{FILE_NAME}",
destination_object=f"{WORK_DIR}/copied_{FILE_NAME}",
destination_folder_id=get_shared_drive_id_task,
)
# [END howto_operator_gcs_to_gdrive_copy_single_file]
# [START howto_operator_gcs_to_gdrive_copy_single_file_into_folder]
copy_single_file_into_folder = GCSToGoogleDriveOperator(
task_id="copy_single_file_into_folder",
gcp_conn_id=CONNECTION_ID,
source_bucket=BUCKET_NAME,
source_object=f"{TMP_PATH}/{FILE_NAME}",
destination_object=f"{WORK_DIR}/copied_{FILE_NAME}",
destination_folder_id=get_shared_drive_id_task,
)
# [END howto_operator_gcs_to_gdrive_copy_single_file_into_folder]
# [START howto_operator_gcs_to_gdrive_copy_files]
copy_files = GCSToGoogleDriveOperator(
task_id="copy_files",
gcp_conn_id=CONNECTION_ID,
source_bucket=BUCKET_NAME,
source_object=f"{TMP_PATH}/*",
destination_object=f"{WORK_DIR}/",
destination_folder_id=get_shared_drive_id_task,
)
# [END howto_operator_gcs_to_gdrive_copy_files]
# [START howto_operator_gcs_to_gdrive_move_files]
move_files = GCSToGoogleDriveOperator(
task_id="move_files",
gcp_conn_id=CONNECTION_ID,
source_bucket=BUCKET_NAME,
source_object=f"{TMP_PATH}/*.txt",
destination_object=f"{WORK_DIR}/",
destination_folder_id=get_shared_drive_id_task,
move_object=True,
)
# [END howto_operator_gcs_to_gdrive_move_files]
@task(trigger_rule=TriggerRule.ALL_DONE)
def remove_files_from_drive(**context):
ti = context["ti"]
service = GoogleDriveHook(gcp_conn_id=CONNECTION_ID).get_conn()
root_path = (
service.files()
.list(
q=f"name = '{WORK_DIR}' and mimeType = 'application/vnd.google-apps.folder'",
corpora="drive",
driveId=ti.xcom_pull("get_shared_drive_id"),
includeItemsFromAllDrives=True,
supportsAllDrives=True,
)
.execute()
)
if files := root_path["files"]:
batch = service.new_batch_http_request()
for file in files:
log.info("Deleting file %s...", file["name"])
batch.add(service.files().delete(fileId=file["id"], supportsAllDrives=True))
batch.execute()
log.info("Selected files removed.")
remove_files_from_drive_task = remove_files_from_drive()
delete_bucket = GCSDeleteBucketOperator(
task_id="delete_bucket", bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE
)
@task(task_id="delete_connection")
def delete_connection(connection_id: str) -> None:
delete_airflow_connection(connection_id=connection_id, is_composer=IS_COMPOSER)
delete_connection_task = delete_connection(connection_id=CONNECTION_ID)
# TEST SETUP
get_shared_drive_id_task >> create_bucket >> [upload_file_1, upload_file_2]
(
[upload_file_1, upload_file_2, create_connection_task]
# TEST BODY
>> copy_single_file
>> copy_single_file_into_folder
>> copy_files
>> move_files
# TEST TEARDOWN
>> remove_files_from_drive_task
>> [delete_bucket, delete_connection_task]
)
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)