josh-fell commented on a change in pull request #18945: URL: https://github.com/apache/airflow/pull/18945#discussion_r728360759
########## File path: airflow/providers/google/cloud/example_dags/example_dataproc_metastore.py ########## @@ -0,0 +1,202 @@ +# +# 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 that show how to use various Dataproc Metastore +operators to manage a service. +""" + +import os + +from airflow import models +from airflow.providers.google.cloud.operators.dataproc_metastore import ( + DataprocMetastoreCreateBackupOperator, + DataprocMetastoreCreateMetadataImportOperator, + DataprocMetastoreCreateServiceOperator, + DataprocMetastoreDeleteBackupOperator, + DataprocMetastoreDeleteServiceOperator, + DataprocMetastoreExportMetadataOperator, + DataprocMetastoreGetServiceOperator, + DataprocMetastoreListBackupsOperator, + DataprocMetastoreRestoreServiceOperator, + DataprocMetastoreUpdateServiceOperator, +) +from airflow.utils.dates import days_ago + +PROJECT_ID = os.environ.get("GCP_PROJECT_ID", "<PROJECT_ID>") +SERVICE_ID = os.environ.get("GCP_DATAPROC_METASTORE_SERVICE_ID", "dataproc-metastore-system-tests-service-1") +BACKUP_ID = os.environ.get("GCP_DATAPROC_METASTORE_BACKUP_ID", "dataproc-metastore-system-tests-backup-1") +REGION = os.environ.get("GCP_REGION", "<REGION>") +BUCKET = os.environ.get("GCP_DATAPROC_METASTORE_BUCKET", "dataproc-metastore-system-tests") +METADATA_IMPORT_FILE = os.environ.get("GCS_METADATA_IMPORT_FILE", None) +METADATA_IMPORT_ID = "dataproc-metastore-system-tests-metadata-import-1" +TIMEOUT = 1200 +GCS_URI = f"gs://{BUCKET}/{METADATA_IMPORT_FILE}" +DB_TYPE = "MYSQL" +DESTINATION_GCS_FOLDER = "gs://{BUCKET}>" + +# Service definition +# Docs: https://cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services#Service +# [START how_to_cloud_dataproc_metastore_create_service] +SERVICE = { + "name": "test-service", +} +# [END how_to_cloud_dataproc_metastore_create_service] + +# Update service +# [START how_to_cloud_dataproc_metastore_update_service] +SERVICE_TO_UPDATE = { + "labels": { + "mylocalmachine": "mylocalmachine", + "systemtest": "systemtest", + } +} +UPDATE_MASK = {"paths": ["labels"]} +# [END how_to_cloud_dataproc_metastore_update_service] + +# Backup definition +# [START how_to_cloud_dataproc_metastore_create_backup] +BACKUP = { + "name": "test-backup", +} +# [END how_to_cloud_dataproc_metastore_create_backup] + +# Metadata import definition +# [START how_to_cloud_dataproc_metastore_create_metadata_import] +METADATA_IMPORT = { + "name": "test-metadata-import", + "database_dump": { + "gcs_uri": GCS_URI, + "database_type": DB_TYPE, + }, +} +# [END how_to_cloud_dataproc_metastore_create_metadata_import] + + +with models.DAG("example_gcp_dataproc_metastore", start_date=days_ago(1), schedule_interval="@once") as dag: + # [START how_to_cloud_dataproc_metastore_create_service_operator] + create_service = DataprocMetastoreCreateServiceOperator( + task_id="create_service", + region=REGION, + project_id=PROJECT_ID, + service=SERVICE, + service_id=SERVICE_ID, + timeout=TIMEOUT, + ) + # [END how_to_cloud_dataproc_metastore_create_service_operator] + + # [START how_to_cloud_dataproc_metastore_get_service_operator] + get_service_details = DataprocMetastoreGetServiceOperator( + task_id="get_service", + region=REGION, + project_id=PROJECT_ID, + service_id=SERVICE_ID, Review comment: @mik-laj ❤️ the system tests - the Google provider is absolutely impressive - but adding the `default_args` shouldn't break the system test right? The DAG should still execute successfully unless I missing something in the automated testing. Or is some of the documentation/test cases automated as well and not having the full operator definition in the example DAG breaks the automation? I'm thinking the variables that are imported for the system test in the DAG could still be defined where they are (so they remain accessible via import) and add `default_args={"region": REGION, "project_id": PROJECT_ID, "service_id": SERVICE_ID}` in the DAG constructor + the explicit code blocks in the operator docs. > Use default_args makes sense in the examples DAG in the core - airflow/example_dags. The examples in airflow/providers should first of all show how to use operators, not fancy features. Yes I agree. The provider example DAGs should certainly show how to use the operators and ideally in some useful context/use case but should also demo a real-world way of how the DAG _could_ be authored as well. I'll happily defer to whomever is maintaining the providers for this though. Just thought it was an opportunity for some legitimate use around `default_args` and document it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
