Google Drive to local - system tests migrations (AIP-47) (#26798)

apache · Oct 31, 2022 · 896479d · 896479d
1 parent 2641e6e
commit 896479d
Show file tree

Hide file tree

Showing 3 changed files with 119 additions and 51 deletions.
diff --git a/airflow/providers/google/cloud/example_dags/example_gdrive_to_local.py b/airflow/providers/google/cloud/example_dags/example_gdrive_to_local.py
diff --git a/docs/apache-airflow-providers-google/operators/transfer/gdrive_to_local.rst b/docs/apache-airflow-providers-google/operators/transfer/gdrive_to_local.rst
@@ -38,7 +38,7 @@ data from Google Drive to local filesystem.
 
 Below is an example of using this operator to download file from Google Drive to Local Filesystem.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_gdrive_to_local.py
+.. exampleinclude:: /../../tests/system/providers/google/cloud/transfers/example_gdrive_to_local.py
  :language: python
  :dedent: 4
  :start-after: [START download_from_gdrive_to_local]

diff --git a/tests/system/providers/google/cloud/transfers/example_gdrive_to_local.py b/tests/system/providers/google/cloud/transfers/example_gdrive_to_local.py
@@ -0,0 +1,118 @@
+#
+# 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 GoogleDriveToLocalOperator.
+
+Using this operator requires the following additional scopes:
+https://www.googleapis.com/auth/drive
+"""
+from __future__ import annotations
+
+import os
+from datetime import datetime
+from pathlib import Path
+
+from airflow import models
+from airflow.models.baseoperator import chain
+from airflow.providers.google.cloud.operators.gcs import GCSCreateBucketOperator, GCSDeleteBucketOperator
+from airflow.providers.google.cloud.transfers.gdrive_to_local import GoogleDriveToLocalOperator
+from airflow.providers.google.cloud.transfers.local_to_gcs import LocalFilesystemToGCSOperator
+from airflow.providers.google.suite.sensors.drive import GoogleDriveFileExistenceSensor
+from airflow.providers.google.suite.transfers.gcs_to_gdrive import GCSToGoogleDriveOperator
+from airflow.utils.trigger_rule import TriggerRule
+
+ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
+PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT")
+
+FILE_NAME = "empty.txt"
+OUTPUT_FILE = "out_file.txt"
+DAG_ID = "example_gdrive_to_local"
+BUCKET_NAME = f"bucket_{DAG_ID}_{ENV_ID}"
+
+LOCAL_PATH = str(Path(__file__).parent / "resources" / FILE_NAME)
+
+
+with models.DAG(
+ DAG_ID,
+ start_date=datetime(2021, 1, 1),
+ schedule="@once",
+ catchup=False,
+ tags=["example"],
+) as dag:
+
+ create_bucket = GCSCreateBucketOperator(
+ task_id="create_bucket", bucket_name=BUCKET_NAME, project_id=PROJECT_ID
+ )
+
+ upload_file = LocalFilesystemToGCSOperator(
+ task_id="upload_file",
+ src=LOCAL_PATH,
+ dst=FILE_NAME,
+ bucket=BUCKET_NAME,
+ )
+
+ copy_single_file = GCSToGoogleDriveOperator(
+ task_id="copy_single_file",
+ source_bucket=BUCKET_NAME,
+ source_object=FILE_NAME,
+ destination_object=FILE_NAME,
+ )
+
+ # [START detect_file]
+ detect_file = GoogleDriveFileExistenceSensor(
+ task_id="detect_file",
+ folder_id="",
+ file_name=FILE_NAME,
+ )
+ # [END detect_file]
+
+ # [START download_from_gdrive_to_local]
+ download_from_gdrive_to_local = GoogleDriveToLocalOperator(
+ task_id="download_from_gdrive_to_local",
+ folder_id="",
+ file_name=FILE_NAME,
+ output_file=OUTPUT_FILE,
+ )
+ # [END download_from_gdrive_to_local]
+
+ delete_bucket = GCSDeleteBucketOperator(
+ task_id="delete_bucket", bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE
+ )
+
+ chain(
+ # TEST SETUP
+ create_bucket,
+ upload_file,
+ copy_single_file,
+ # TEST BODY
+ detect_file,
+ download_from_gdrive_to_local,
+ # TEST TEARDOWN
+ delete_bucket,
+ )
+
+ 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)
+test_run = get_test_run(dag)