Source code for tests.system.google.suite.example_local_to_drive
#
# 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 LocalFilesystemToGoogleDriveOperator.
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 airflow.models.dag import DAG
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.providers.google.suite.hooks.drive import GoogleDriveHook
from airflow.providers.google.suite.transfers.local_to_drive import LocalFilesystemToGoogleDriveOperator
from airflow.utils.trigger_rule import TriggerRule
from tests_common.test_utils.api_client_helpers import create_airflow_connection, delete_airflow_connection
[docs]
DAG_ID = "local_to_drive"
[docs]
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID", "default")
[docs]
CONNECTION_ID = f"connection_{DAG_ID}_{ENV_ID}"
[docs]
LOCAL_PATH = str(Path(__file__).parent / "resources")
[docs]
SINGLE_FILE_LOCAL_PATHS = [str(Path(LOCAL_PATH) / FILE_NAME_1)]
[docs]
MULTIPLE_FILES_LOCAL_PATHS = [str(Path(LOCAL_PATH) / FILE_NAME_1), str(Path(LOCAL_PATH) / FILE_NAME_2)]
[docs]
DRIVE_FOLDER = f"test_folder_{DAG_ID}_{ENV_ID}"
[docs]
log = logging.getLogger(__name__)
with DAG(
DAG_ID,
schedule="@once",
start_date=datetime(2021, 1, 1),
catchup=False,
tags=["example", "gdrive"],
) as dag:
@task
[docs]
def create_connection(connection_id: str):
conn_extra_json = json.dumps({"scope": "https://www.googleapis.com/auth/drive"})
connection: dict[str, Any] = {"conn_type": "google_cloud_platform", "extra": conn_extra_json}
create_airflow_connection(
connection_id=connection_id,
connection_conf=connection,
)
create_connection_task = create_connection(connection_id=CONNECTION_ID)
# [START howto_operator_local_to_drive_upload_single_file]
upload_single_file = LocalFilesystemToGoogleDriveOperator(
gcp_conn_id=CONNECTION_ID,
task_id="upload_single_file",
local_paths=SINGLE_FILE_LOCAL_PATHS,
drive_folder=DRIVE_FOLDER,
)
# [END howto_operator_local_to_drive_upload_single_file]
# [START howto_operator_local_to_drive_upload_multiple_files]
upload_multiple_files = LocalFilesystemToGoogleDriveOperator(
gcp_conn_id=CONNECTION_ID,
task_id="upload_multiple_files",
local_paths=MULTIPLE_FILES_LOCAL_PATHS,
drive_folder=DRIVE_FOLDER,
ignore_if_missing=True,
)
# [END howto_operator_local_to_drive_upload_multiple_files]
@task(trigger_rule=TriggerRule.ALL_DONE)
def remove_files_from_drive():
service = GoogleDriveHook(gcp_conn_id=CONNECTION_ID).get_conn()
root_path = (
service.files()
.list(q=f"name = '{DRIVE_FOLDER}' and mimeType = 'application/vnd.google-apps.folder'")
.execute()
)
if files := root_path["files"]:
batch = service.new_batch_http_request()
for file in files:
log.info("Preparing to remove file: {}", file)
batch.add(service.files().delete(fileId=file["id"]))
batch.execute()
log.info("Selected files removed.")
remove_files_from_drive_task = remove_files_from_drive()
@task(task_id="delete_connection")
def delete_connection(connection_id: str) -> None:
delete_airflow_connection(connection_id=connection_id)
delete_connection_task = delete_connection(connection_id=CONNECTION_ID)
(
# TEST SETUP
create_connection_task
# TEST BODY
>> upload_single_file
>> upload_multiple_files
# TEST TEARDOWN
>> remove_files_from_drive_task
>> 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: tests/system/README.md#run_via_pytest)
[docs]
test_run = get_test_run(dag)