New design of system tests (#22311)

Migrate BigQuery system tests to new design (See AIP-47 for details)
apache · Mar 25, 2022 · 3c7cd47 · 3c7cd47
1 parent acb1a10
commit 3c7cd47
Show file tree

Hide file tree

Showing 31 changed files with 1,333 additions and 397 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -590,6 +590,14 @@ repos:
  pass_filenames: false
  require_serial: true
  additional_dependencies: ['rich']
+ - id: check-system-tests
+ name: Check if system tests have required segments of code
+ entry: ./scripts/ci/pre_commit/pre_commit_check_system_tests.py
+ language: python
+ files: ^tests/system/.*/example_[^/]*.py$
+ exclude: ^tests/system/providers/google/bigquery/example_bigquery_queries\.py$
+ pass_filenames: true
+ additional_dependencies: ['rich']
  - id: markdownlint
  name: Run markdownlint
  description: Checks the style of Markdown files.

diff --git a/BREEZE.rst b/BREEZE.rst
@@ -2293,9 +2293,9 @@ This is the current syntax for `./breeze <./breeze>`_:
  changelog-duplicates check-apache-license check-builtin-literals
  check-executables-have-shebangs check-extras-order check-hooks-apply
  check-integrations check-merge-conflict check-ti-run-id-in-providers check-xml
- daysago-import-check debug-statements detect-private-key docstring-params doctoc
- dont-use-safe-filter end-of-file-fixer fix-encoding-pragma flake8 flynt
- forbidden-xcom-get-value codespell forbid-tabs helm-lint identity
+ check-system-tests daysago-import-check debug-statements detect-private-key
+ docstring-params doctoc dont-use-safe-filter end-of-file-fixer fix-encoding-pragma
+ flake8 flynt forbidden-xcom-get-value codespell forbid-tabs helm-lint identity
  incorrect-use-of-LoggingMixin insert-license isort json-schema language-matters
  lint-dockerfile lint-openapi markdownlint mermaid migration-reference
  mixed-line-ending mypy mypy-helm no-providers-in-core-examples no-relative-imports

diff --git a/STATIC_CODE_CHECKS.rst b/STATIC_CODE_CHECKS.rst
@@ -168,6 +168,8 @@ require Breeze Docker images to be installed locally.
 ------------------------------------ ---------------------------------------------------------------- ------------
 ``check-xml`` Checks XML files with xmllint
 ------------------------------------ ---------------------------------------------------------------- ------------
+``check-system-tests`` Check if system tests have required segments of code
+------------------------------------ ---------------------------------------------------------------- ------------
 ``daysago-import-check`` Checks if daysago is properly imported
 ------------------------------------ ---------------------------------------------------------------- ------------
 ``debug-statements`` Detects accidentally committed debug statements

diff --git a/breeze-complete b/breeze-complete
@@ -99,6 +99,7 @@ check-integrations
 check-merge-conflict
 check-ti-run-id-in-providers
 check-xml
+check-system-tests
 daysago-import-check
 debug-statements
 detect-private-key

diff --git a/dev/breeze/src/airflow_breeze/pre_commit_ids.py b/dev/breeze/src/airflow_breeze/pre_commit_ids.py
@@ -40,6 +40,7 @@
  'check-hooks-apply',
  'check-integrations',
  'check-merge-conflict',
+ 'check-system-tests',
  'check-ti-run-id-in-providers',
  'check-xml',
  'codespell',

diff --git a/docs/apache-airflow-providers-google/operators/cloud/bigquery.rst b/docs/apache-airflow-providers-google/operators/cloud/bigquery.rst
@@ -29,7 +29,7 @@ data.
 Prerequisite Tasks
 ^^^^^^^^^^^^^^^^^^
 
-.. include::/operators/_partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Manage datasets
 ^^^^^^^^^^^^^^^
@@ -42,7 +42,7 @@ Create dataset
 To create an empty dataset in a BigQuery database you can use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryCreateEmptyDatasetOperator`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_dataset.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_create_dataset]
@@ -58,7 +58,7 @@ To get the details of an existing dataset you can use
 
 This operator returns a `Dataset Resource <https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource>`__.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_dataset.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_get_dataset]
@@ -72,7 +72,7 @@ List tables in dataset
 To retrieve the list of tables in a given dataset use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryGetDatasetTablesOperator`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_get_dataset_tables]
@@ -89,7 +89,7 @@ To update a table in BigQuery you can use
 The update method replaces the entire Table resource, whereas the patch
 method only replaces fields that are provided in the submitted Table resource.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_update_table]
@@ -106,7 +106,7 @@ To update a dataset in BigQuery you can use
 The update method replaces the entire dataset resource, whereas the patch
 method only replaces fields that are provided in the submitted dataset resource.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_dataset.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_update_dataset]
@@ -120,7 +120,7 @@ Delete dataset
 To delete an existing dataset from a BigQuery database you can use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryDeleteDatasetOperator`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_dataset.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_delete_dataset]
@@ -143,15 +143,15 @@ ways. You may either directly pass the schema fields in, or you may point the
 operator to a Google Cloud Storage object name. The object in Google Cloud
 Storage must be a JSON file with the schema fields in it.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_create_table]
  :end-before: [END howto_operator_bigquery_create_table]
 
 You can use this operator to create a view on top of an existing table.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_create_view]
@@ -160,7 +160,7 @@ You can use this operator to create a view on top of an existing table.
 You can also use this operator to create a materialized view that periodically
 cache results of a query for increased performance and efficiency.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_create_materialized_view]
@@ -177,15 +177,22 @@ you can use
 
 Similarly to
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryCreateEmptyTableOperator`
-you may either directly pass the schema fields in, or you may point the operator
-to a Google Cloud Storage object name.
+you can directly pass the schema fields in.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_operations.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_create_external_table]
  :end-before: [END howto_operator_bigquery_create_external_table]
 
+Or you may point the operator to a Google Cloud Storage object name where the schema is stored.
+
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
+ :language: python
+ :dedent: 4
+ :start-after: [START howto_operator_bigquery_create_table_schema_json]
+ :end-before: [END howto_operator_bigquery_create_table_schema_json]
+
 .. _howto/operator:BigQueryGetDataOperator:
 
 Fetch data from table
@@ -201,7 +208,7 @@ returned list will be equal to the number of rows fetched. Each element in the
 list will again be a list where elements would represent the column values for
 that row.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_get_data]
@@ -218,7 +225,7 @@ To upsert a table you can use
 This operator either updates the existing table or creates a new, empty table
 in the given dataset.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_upsert_table]
@@ -235,7 +242,7 @@ To update the schema of a table you can use
 This operator updates the schema field values supplied, while leaving the rest unchanged. This is useful
 for instance to set new field descriptions on an existing table schema.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_update_table_schema]
@@ -249,23 +256,23 @@ Delete table
 To delete an existing table you can use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryDeleteTableOperator`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_delete_table]
  :end-before: [END howto_operator_bigquery_delete_table]
 
 You can also use this operator to delete a view.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_delete_view]
  :end-before: [END howto_operator_bigquery_delete_view]
 
 You can also use this operator to delete a materialized view.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_operations.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_tables.py
  :language: python
  :dedent: 4
  :start-after: [START howto_operator_bigquery_delete_materialized_view]
@@ -278,7 +285,7 @@ Execute BigQuery jobs
 
 Let's say you would like to execute the following query.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 0
  :start-after: [START howto_operator_bigquery_query]
@@ -288,7 +295,7 @@ To execute the SQL query in a specific BigQuery database you can use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryInsertJobOperator` with
 proper query job configuration that can be Jinja templated.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_insert_job]
@@ -300,7 +307,7 @@ For more information on types of BigQuery job please check
 If you want to include some files in your configuration you can use ``include`` clause of Jinja template
 language as follow:
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_select_job]
@@ -329,7 +336,7 @@ This operator expects a sql query that will return a single row. Each value on
 that first row is evaluated using python ``bool`` casting. If any of the values
 return ``False`` the check is failed and errors out.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_check]
@@ -347,7 +354,7 @@ This operator expects a sql query that will return a single row. Each value on
 that first row is evaluated against ``pass_value`` which can be either a string
 or numeric value. If numeric, you can also specify ``tolerance``.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_value_check]
@@ -362,7 +369,7 @@ To check that the values of metrics given as SQL expressions are within a certai
 tolerance of the ones from ``days_back`` before you can use
 :class:`~airflow.providers.google.cloud.operators.bigquery.BigQueryIntervalCheckOperator`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_queries.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_queries.py
  :language: python
  :dedent: 8
  :start-after: [START howto_operator_bigquery_interval_check]
@@ -380,7 +387,7 @@ use the ``{{ ds_nodash }}`` macro as the table name suffix.
 
 :class:`~airflow.providers.google.cloud.sensors.bigquery.BigQueryTableExistenceSensor`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_sensors.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_sensors.py
  :language: python
  :dedent: 4
  :start-after: [START howto_sensor_bigquery_table]
@@ -392,7 +399,7 @@ Check that a Table Partition exists
 To check that a table exists and has a partition you can use.
 :class:`~airflow.providers.google.cloud.sensors.bigquery.BigQueryTablePartitionExistenceSensor`.
 
-.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_bigquery_sensors.py
+.. exampleinclude:: /../../tests/system/providers/google/bigquery/example_bigquery_sensors.py
  :language: python
  :dedent: 4
  :start-after: [START howto_sensor_bigquery_table_partition]

diff --git a/docs/apache-airflow-providers-google/operators/cloud/data_loss_prevention.rst b/docs/apache-airflow-providers-google/operators/cloud/data_loss_prevention.rst
@@ -297,7 +297,7 @@ Configuration information defines how you want the sensitive data de-identified.
 
 This config can either be saved and persisted in de-identification templates or defined in a :class:`~google.cloud.dlp_v2.types.DeidentifyConfig` object:
 
-.. literalinclude:: /../../airflow/providers/google/cloud/example_dags/example_dlp.py
+.. exampleinclude:: /../../airflow/providers/google/cloud/example_dags/example_dlp.py
  :language: python
  :start-after: [START dlp_deidentify_config_example]
  :end-before: [END dlp_deidentify_config_example]