add example dag and system test for GoogleSheetsToGCSOperator (#9056)

* add example dag and system test for sheets_to_gcs * remove sheets_to_gcs in missing example dags
apache · May 29, 2020 · 81b2761 · 81b2761
1 parent decf7e8
commit 81b2761
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 2 deletions.
diff --git a/airflow/providers/google/cloud/example_dags/example_sheets_to_gcs.py b/airflow/providers/google/cloud/example_dags/example_sheets_to_gcs.py
@@ -0,0 +1,42 @@
+#
+# 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.
+
+import os
+
+from airflow import models
+from airflow.providers.google.cloud.operators.sheets_to_gcs import GoogleSheetsToGCSOperator
+from airflow.utils.dates import days_ago
+
+BUCKET = os.environ.get("GCP_GCS_BUCKET", "test28397yeo")
+SPREADSHEET_ID = os.environ.get("SPREADSHEET_ID", "1234567890qwerty")
+
+default_args = {"start_date": days_ago(1)}
+
+with models.DAG(
+ "example_sheets_to_gcs",
+ default_args=default_args,
+ schedule_interval=None, # Override to match your needs
+ tags=["example"],
+) as dag:
+ # [START upload_sheet_to_gcs]
+ upload_sheet_to_gcs = GoogleSheetsToGCSOperator(
+ task_id="upload_sheet_to_gcs",
+ destination_bucket=BUCKET,
+ spreadsheet_id=SPREADSHEET_ID,
+ )
+ # [END upload_sheet_to_gcs]
diff --git a/docs/howto/operator/gcp/sheets_to_gcs.rst b/docs/howto/operator/gcp/sheets_to_gcs.rst
@@ -42,7 +42,7 @@ Upload data from Google Sheets to GCS
 To upload data from Google Spreadsheet to Google Cloud Storage you can use the
 :class:`~airflow.providers.google.cloud.operators.sheets_to_gcs.GoogleSheetsToGCSOperator`.
 
-.. exampleinclude:: ../../../../airflow/providers/google/suite/example_dags/example_sheets.py
+.. exampleinclude:: ../../../../airflow/providers/google/cloud/example_dags/example_sheets_to_gcs.py
  :language: python
  :dedent: 4
  :start-after: [START upload_sheet_to_gcs]

diff --git a/tests/providers/google/cloud/operators/test_sheets_to_gcs_system.py b/tests/providers/google/cloud/operators/test_sheets_to_gcs_system.py
@@ -0,0 +1,41 @@
+#
+# 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.
+import pytest
+
+from airflow.providers.google.cloud.example_dags.example_life_sciences import BUCKET
+from tests.providers.google.cloud.utils.gcp_authenticator import GCP_GCS_KEY
+from tests.test_utils.gcp_system_helpers import CLOUD_DAG_FOLDER, GoogleSystemTest, provide_gcp_context
+
+
+@pytest.mark.backend("mysql", "postgres")
+@pytest.mark.credential_file(GCP_GCS_KEY)
+class GoogleSheetsToGCSExampleDagsSystemTest(GoogleSystemTest):
+
+ @provide_gcp_context(GCP_GCS_KEY)
+ def setUp(self):
+ super().setUp()
+ self.create_gcs_bucket(BUCKET)
+
+ @provide_gcp_context(GCP_GCS_KEY)
+ def test_run_example_dag_function(self):
+ self.run_dag('example_sheets_to_gcs', CLOUD_DAG_FOLDER)
+
+ @provide_gcp_context(GCP_GCS_KEY)
+ def tearDown(self):
+ self.delete_gcs_bucket(BUCKET)
+ super().tearDown()
diff --git a/tests/test_project_structure.py b/tests/test_project_structure.py
@@ -137,7 +137,6 @@ class TestGoogleProviderProjectStructure(unittest.TestCase):
  ('cloud', 'mysql_to_gcs'),
  ('cloud', 'mssql_to_gcs'),
  ('cloud', 'local_to_gcs'),
- ('cloud', 'sheets_to_gcs'),
  ('suite', 'gcs_to_sheets'),
  }