Source code for tests.system.providers.google.cloud.gcs.example_sheets

#
# 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.
from __future__ import annotations

import json
import logging
import os
from datetime import datetime

from airflow.decorators import task
from airflow.models import Connection
from airflow.models.dag import DAG
from airflow.models.xcom_arg import XComArg
from airflow.operators.bash import BashOperator
from airflow.providers.google.cloud.operators.gcs import GCSCreateBucketOperator, GCSDeleteBucketOperator
from airflow.providers.google.cloud.transfers.sheets_to_gcs import GoogleSheetsToGCSOperator
from airflow.providers.google.suite.operators.sheets import GoogleSheetsCreateSpreadsheetOperator
from airflow.providers.google.suite.transfers.gcs_to_sheets import GCSToGoogleSheetsOperator
from airflow.settings import Session
from airflow.utils.trigger_rule import TriggerRule

[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 = "sheets_gcs"
[docs]BUCKET_NAME = f"bucket_{DAG_ID}_{ENV_ID}"
[docs]SPREADSHEET = { "properties": {"title": "Test1"}, "sheets": [{"properties": {"title": "Sheet1"}}], }
[docs]CONNECTION_ID = f"connection_{DAG_ID}_{ENV_ID}"
[docs]log = logging.getLogger(__name__)
with DAG( DAG_ID, schedule="@once", # Override to match your needs, start_date=datetime(2021, 1, 1), catchup=False, tags=["example", "sheets"], ) as dag:
[docs] create_bucket = GCSCreateBucketOperator( task_id="create_bucket", bucket_name=BUCKET_NAME, project_id=PROJECT_ID )
@task def create_connection(connection_id: str): conn = Connection( conn_id=connection_id, conn_type="google_cloud_platform", ) conn_extra = { "scope": "https://www.googleapis.com/auth/spreadsheets,https://www.googleapis.com/auth/cloud-platform", "project": PROJECT_ID, "keyfile_dict": "", # Override to match your needs } conn_extra_json = json.dumps(conn_extra) conn.set_extra(conn_extra_json) session = Session() log.info("Removing connection %s if it exists", connection_id) query = session.query(Connection).filter(Connection.conn_id == connection_id) query.delete() session.add(conn) session.commit() log.info("Connection %s created", connection_id) create_connection_task = create_connection(connection_id=CONNECTION_ID) # [START upload_sheet_to_gcs] upload_sheet_to_gcs = GoogleSheetsToGCSOperator( task_id="upload_sheet_to_gcs", destination_bucket=BUCKET_NAME, spreadsheet_id="{{ task_instance.xcom_pull(task_ids='create_spreadsheet', " "key='spreadsheet_id') }}", gcp_conn_id=CONNECTION_ID, ) # [END upload_sheet_to_gcs] # [START create_spreadsheet] create_spreadsheet = GoogleSheetsCreateSpreadsheetOperator( task_id="create_spreadsheet", spreadsheet=SPREADSHEET, gcp_conn_id=CONNECTION_ID ) # [END create_spreadsheet] # [START print_spreadsheet_url] print_spreadsheet_url = BashOperator( task_id="print_spreadsheet_url", bash_command=f"echo {XComArg(create_spreadsheet, key='spreadsheet_url')}", ) # [END print_spreadsheet_url] # [START upload_gcs_to_sheet] upload_gcs_to_sheet = GCSToGoogleSheetsOperator( task_id="upload_gcs_to_sheet", bucket_name=BUCKET_NAME, object_name="{{ task_instance.xcom_pull('upload_sheet_to_gcs')[0] }}", spreadsheet_id="{{ task_instance.xcom_pull(task_ids='create_spreadsheet', " "key='spreadsheet_id') }}", gcp_conn_id=CONNECTION_ID, ) # [END upload_gcs_to_sheet] @task(task_id="delete_connection") def delete_connection(connection_id: str) -> None: session = Session() log.info("Removing connection %s", connection_id) query = session.query(Connection).filter(Connection.conn_id == connection_id) query.delete() session.commit() delete_connection_task = delete_connection(connection_id=CONNECTION_ID) delete_bucket = GCSDeleteBucketOperator( task_id="delete_bucket", bucket_name=BUCKET_NAME, trigger_rule=TriggerRule.ALL_DONE ) ( # TEST SETUP [create_bucket, create_connection_task] # TEST BODY >> create_spreadsheet >> print_spreadsheet_url >> upload_sheet_to_gcs >> upload_gcs_to_sheet # TEST TEARDOWN >> [delete_bucket, delete_connection_task] ) 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)
[docs]test_run = get_test_run(dag)

Was this entry helpful?