Skip to content

Commit 7a7ca50

Browse files
authored
Migrate Google example DAG s3_to_gcs to new design AIP-47 (#24641)
related: #22447, #22430
1 parent 9b4a053 commit 7a7ca50

3 files changed

Lines changed: 38 additions & 66 deletions

File tree

docs/apache-airflow-providers-google/operators/transfer/s3_to_gcs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Prerequisite Tasks
3232
Use the :class:`~airflow.providers.google.cloud.transfers.s3_to_gcs.S3ToGCSOperator`
3333
to transfer data from Amazon S3 to Google Cloud Storage.
3434

35-
.. exampleinclude::/../airflow/providers/google/cloud/example_dags/example_s3_to_gcs.py
35+
.. exampleinclude::/../tests/system/providers/google/cloud/gcs/example_s3_to_gcs.py
3636
:language: python
3737
:start-after: [START howto_transfer_s3togcs_operator]
3838
:end-before: [END howto_transfer_s3togcs_operator]

tests/providers/google/cloud/transfers/test_s3_to_gcs_system.py

Lines changed: 0 additions & 51 deletions
This file was deleted.

airflow/providers/google/cloud/example_dags/example_s3_to_gcs.py renamed to tests/system/providers/google/cloud/gcs/example_s3_to_gcs.py

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@
2424
from airflow.providers.amazon.aws.operators.s3 import S3CreateBucketOperator, S3DeleteBucketOperator
2525
from airflow.providers.google.cloud.operators.gcs import GCSCreateBucketOperator, GCSDeleteBucketOperator
2626
from airflow.providers.google.cloud.transfers.s3_to_gcs import S3ToGCSOperator
27+
from airflow.utils.trigger_rule import TriggerRule
2728

28-
GCP_PROJECT_ID = os.environ.get('GCP_PROJECT_ID', 'gcp-project-id')
29-
S3BUCKET_NAME = os.environ.get('S3BUCKET_NAME', 'example-s3bucket-name')
30-
GCS_BUCKET = os.environ.get('GCP_GCS_BUCKET', 'example-gcsbucket-name')
31-
GCS_BUCKET_URL = f"gs://{GCS_BUCKET}/"
29+
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
30+
GCP_PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT")
31+
DAG_ID = "example_s3_to_gcs"
32+
33+
BUCKET_NAME = f"bucket_{DAG_ID}_{ENV_ID}"
34+
GCS_BUCKET_URL = f"gs://{BUCKET_NAME}/"
3235
UPLOAD_FILE = '/tmp/example-file.txt'
3336
PREFIX = 'TESTS'
3437

@@ -37,42 +40,62 @@
3740
def upload_file():
3841
"""A callable to upload file to AWS bucket"""
3942
s3_hook = S3Hook()
40-
s3_hook.load_file(filename=UPLOAD_FILE, key=PREFIX, bucket_name=S3BUCKET_NAME)
43+
s3_hook.load_file(filename=UPLOAD_FILE, key=PREFIX, bucket_name=BUCKET_NAME)
4144

4245

4346
with models.DAG(
44-
'example_s3_to_gcs',
47+
DAG_ID,
4548
schedule_interval='@once',
4649
start_date=datetime(2021, 1, 1),
4750
catchup=False,
48-
tags=['example'],
51+
tags=['example', 's3'],
4952
) as dag:
5053
create_s3_bucket = S3CreateBucketOperator(
51-
task_id="create_s3_bucket", bucket_name=S3BUCKET_NAME, region_name='us-east-1'
54+
task_id="create_s3_bucket", bucket_name=BUCKET_NAME, region_name='us-east-1'
5255
)
5356

5457
create_gcs_bucket = GCSCreateBucketOperator(
5558
task_id="create_bucket",
56-
bucket_name=GCS_BUCKET,
59+
bucket_name=BUCKET_NAME,
5760
project_id=GCP_PROJECT_ID,
5861
)
5962
# [START howto_transfer_s3togcs_operator]
6063
transfer_to_gcs = S3ToGCSOperator(
61-
task_id='s3_to_gcs_task', bucket=S3BUCKET_NAME, prefix=PREFIX, dest_gcs=GCS_BUCKET_URL
64+
task_id='s3_to_gcs_task', bucket=BUCKET_NAME, prefix=PREFIX, dest_gcs=GCS_BUCKET_URL
6265
)
6366
# [END howto_transfer_s3togcs_operator]
6467

6568
delete_s3_bucket = S3DeleteBucketOperator(
66-
task_id='delete_s3_bucket', bucket_name=S3BUCKET_NAME, force_delete=True
69+
task_id='delete_s3_bucket',
70+
bucket_name=BUCKET_NAME,
71+
force_delete=True,
72+
trigger_rule=TriggerRule.ALL_DONE,
6773
)
6874

69-
delete_gcs_bucket = GCSDeleteBucketOperator(task_id='delete_gcs_bucket', bucket_name=GCS_BUCKET)
75+
delete_gcs_bucket = GCSDeleteBucketOperator(
76+
task_id='delete_gcs_bucket', bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE
77+
)
7078

7179
(
72-
create_s3_bucket
80+
# TEST SETUP
81+
create_gcs_bucket
82+
>> create_s3_bucket
7383
>> upload_file()
74-
>> create_gcs_bucket
84+
# TEST BODY
7585
>> transfer_to_gcs
86+
# TEST TEARDOWN
7687
>> delete_s3_bucket
7788
>> delete_gcs_bucket
7889
)
90+
91+
from tests.system.utils.watcher import watcher
92+
93+
# This test needs watcher in order to properly mark success/failure
94+
# when "tearDown" task with trigger rule is part of the DAG
95+
list(dag.tasks) >> watcher()
96+
97+
98+
from tests.system.utils import get_test_run # noqa: E402
99+
100+
# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
101+
test_run = get_test_run(dag)

0 commit comments

Comments
 (0)