Source code for tests.system.google.cloud.gcs.example_http_to_gcs
# 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 Airflow DAG for HTTP to Google Cloud Storage transfer operators.
"""
from __future__ import annotations
import os
from datetime import datetime
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.http_to_gcs import HttpToGCSOperator
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 tests_common.test_utils.api_client_helpers import create_airflow_connection, delete_airflow_connection
[docs]
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID", "default")
[docs]
PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT", "default")
[docs]
DAG_ID = "example_http_to_gcs"
[docs]
BUCKET_NAME = f"bucket-{DAG_ID}-{ENV_ID}"
with DAG(
DAG_ID,
schedule="@once",
start_date=datetime(2025, 1, 1),
catchup=False,
tags=["example, http_to_gcs"],
) as dag:
[docs]
conn_id_name = f"{ENV_ID}-http-conn-id"
create_bucket = GCSCreateBucketOperator(task_id="create_bucket", bucket_name=BUCKET_NAME)
@task(task_id="create_connection")
def create_connection(conn_id_name: str):
connection: dict[str, Any] = {"conn_type": "http", "host": "http://airflow.apache.org"}
create_airflow_connection(
connection_id=conn_id_name,
connection_conf=connection,
)
set_up_connection = create_connection(conn_id_name)
# [START howto_transfer_http_to_gcs]
http_to_gcs_task = HttpToGCSOperator(
task_id="http_to_gcs_task",
http_conn_id=conn_id_name,
endpoint="/community",
bucket_name=BUCKET_NAME,
object_name="endpoint_http_content_file",
)
# [END howto_transfer_http_to_gcs]
delete_bucket = GCSDeleteBucketOperator(
task_id="delete_bucket", bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE
)
@task(task_id="delete_connection", trigger_rule=TriggerRule.ALL_DONE)
def delete_connection(connection_id: str) -> None:
delete_airflow_connection(connection_id=connection_id)
delete_connection_task = delete_connection(connection_id=conn_id_name)
(
# TEST SETUP
[create_bucket, set_up_connection]
# TEST BODY
>> http_to_gcs_task
# TEST TEARDOWN
>> [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: tests/system/README.md#run_via_pytest)
[docs]
test_run = get_test_run(dag)