Adding test case for params row-filter

clouddq/main.py

@@ -217,7 +217,7 @@ def main(  # noqa: C901
     enable_experimental_bigquery_entity_uris: bool = True,
     enable_experimental_dataplex_gcs_validation: bool = True,
 ) -> None:
-    """Run RULE_BINDING_IDS from a RULE_BINDING_CONFIG_PATH.
+    """Run RULE_BINDING_IDS from a RULE_BINDING_CONFIG_PATH..
 
     RULE_BINDING_IDS:
     comma-separated Rule Binding ID(s) containing the

configs/reference_columns/reference-columns.yml

@@ -22,4 +22,4 @@ reference_columns:
 
   INCLUDE_ALL_REFERENCE_COLUMNS:
     include_reference_columns:
-      - *
+      - "*"

tests/BUILD

@@ -246,3 +246,11 @@ py_test(
     legacy_create_init = 0,
     deps = DEPS,
 )
+
+py_test(
+    name = "test_dq_row_filter_params",
+    srcs = SRCS,
+    data = DATA,
+    legacy_create_init = 0,
+    deps = DEPS,
+)

tests/resources/configs/row_filters/row-filters.yml

@@ -20,3 +20,10 @@ row_filters:
   DATA_TYPE_EMAIL:
     filter_sql_expr: |-
       contact_type = 'email'
+
+  COLUMN_IN_VALUES_SET:
+    params:
+      - column
+      - values
+    filter_sql_expr: |-
+      $column IN ($values)

tests/resources/test_dq_row_filter_params_sql_expected.sql

@@ -0,0 +1,288 @@
+-- Copyright 2022 Google LLC
+--
+-- Licensed 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.
+
+WITH
+zero_record AS (
+SELECT
+'<rule_binding_id>' AS rule_binding_id,
+),
+data AS (
+SELECT
+*,
+'<rule_binding_id>' AS rule_binding_id,
+FROM
+`<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details` d
+WHERE
+contact_type IN ('email')
+),
+last_mod AS (
+SELECT
+project_id || '.' || dataset_id || '.' || table_id AS table_id,
+TIMESTAMP_MILLIS(last_modified_time) AS last_modified
+FROM `<your-gcp-project-id>.<your_bigquery_dataset_id>.__TABLES__`
+),
+validation_results AS (
+SELECT
+CURRENT_TIMESTAMP() AS execution_ts,
+'<rule_binding_id>' AS rule_binding_id,
+'NO_DUPLICATES_IN_COLUMN_GROUPS' AS rule_id,
+'<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details' AS table_id,
+CAST(NULL AS STRING) AS column_id,
+NULL AS column_value,
+CAST(NULL AS STRING) AS dimension,
+CAST(NULL AS BOOLEAN) AS simple_rule_row_is_valid,
+TRUE AS skip_null_count,
+custom_sql_statement_validation_errors.complex_rule_validation_errors_count AS complex_rule_validation_errors_count,
+CASE
+WHEN custom_sql_statement_validation_errors.complex_rule_validation_errors_count IS NULL THEN CAST(NULL AS BOOLEAN)
+WHEN custom_sql_statement_validation_errors.complex_rule_validation_errors_count = 0 THEN TRUE
+ELSE FALSE
+END AS complex_rule_validation_success_flag,
+ r"""
+ WITH
+ zero_record AS (
+ SELECT
+ '<rule_binding_id>' AS rule_binding_id,
+ ),
+ data AS (
+ SELECT
+ *,
+ '<rule_binding_id>' AS rule_binding_id,
+ FROM
+ `<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details` d
+ WHERE
+ contact_type IN ('email')
+ ),
+ last_mod AS (
+ SELECT
+ project_id || '.' || dataset_id || '.' || table_id AS table_id,
+ TIMESTAMP_MILLIS(last_modified_time) AS last_modified
+ FROM `<your-gcp-project-id>.<your_bigquery_dataset_id>.__TABLES__`
+ ),
+ validation_results AS (SELECT
+ '<rule_binding_id>' AS rule_binding_id,
+ 'NO_DUPLICATES_IN_COLUMN_GROUPS' AS rule_id,
+ '<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details' AS table_id,
+ CAST(NULL AS STRING) AS column_id,
+ NULL AS column_value,
+custom_sql_statement_validation_errors,
+ CAST(NULL AS STRING) AS dimension,
+ CAST(NULL AS BOOLEAN) AS simple_rule_row_is_valid,
+ TRUE AS skip_null_count,
+ custom_sql_statement_validation_errors.complex_rule_validation_errors_count AS complex_rule_validation_errors_count,
+ CASE
+ WHEN custom_sql_statement_validation_errors.complex_rule_validation_errors_count IS NULL THEN CAST(NULL AS BOOLEAN)
+ WHEN custom_sql_statement_validation_errors.complex_rule_validation_errors_count = 0 THEN TRUE
+ ELSE FALSE
+ END AS complex_rule_validation_success_flag,
+FROM
+zero_record
+LEFT JOIN
+(
+SELECT
+*,
+'<rule_binding_id>' AS _rule_binding_id,
+COUNT(*) OVER() AS complex_rule_validation_errors_count,
+FROM (
+select a.*
+from data a
+inner join (
+select
+contact_type,value
+from data
+group by contact_type,value
+having count(*) > 1
+) duplicates
+using (contact_type,value)
+) custom_sql
+) custom_sql_statement_validation_errors
+ON
+zero_record.rule_binding_id = custom_sql_statement_validation_errors._rule_binding_id
+ ),
+ all_validation_results AS (
+ SELECT
+ '{{ invocation_id }}' as _dq_validation_invocation_id,
+ r.rule_binding_id AS _dq_validation_rule_binding_id,
+ r.rule_id AS _dq_validation_rule_id,
+ r.column_id AS _dq_validation_column_id,
+ r.column_value AS _dq_validation_column_value,
+ CAST(r.dimension AS STRING) AS _dq_validation_dimension,
+ r.simple_rule_row_is_valid AS _dq_validation_simple_rule_row_is_valid,
+ r.complex_rule_validation_errors_count AS _dq_validation_complex_rule_validation_errors_count,
+ r.complex_rule_validation_success_flag AS _dq_validation_complex_rule_validation_success_flag,
+r.custom_sql_statement_validation_errors,
+ FROM
+ validation_results r
+ )
+ SELECT
+ *
+ FROM
+ all_validation_results
+WHERE
+_dq_validation_simple_rule_row_is_valid is False
+OR
+_dq_validation_complex_rule_validation_success_flag is False
+ORDER BY _dq_validation_rule_id"""
+ AS failed_records_query,
+ FROM
+ zero_record
+ LEFT JOIN
+ (
+ SELECT
+ *,
+ '<rule_binding_id>' AS _rule_binding_id,
+ COUNT(*) OVER() AS complex_rule_validation_errors_count,
+ FROM (
+ select a.*
+ from data a
+ inner join (
+ select
+ contact_type,value
+ from data
+ group by contact_type,value
+ having count(*) > 1
+ ) duplicates
+ using (contact_type,value)
+ ) custom_sql
+ ) custom_sql_statement_validation_errors
+ ON
+ zero_record.rule_binding_id = custom_sql_statement_validation_errors._rule_binding_id
+UNION ALL
+SELECT
+CURRENT_TIMESTAMP() AS execution_ts,
+'<rule_binding_id>' AS rule_binding_id,
+'NOT_NULL_SIMPLE' AS rule_id,
+'<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details' AS table_id,
+'value' AS column_id,
+data.value AS column_value,
+CAST(NULL AS STRING) AS dimension,
+CASE
+WHEN value IS NOT NULL THEN TRUE
+ELSE
+FALSE
+END AS simple_rule_row_is_valid,
+TRUE AS skip_null_count,
+CAST(NULL AS INT64) AS complex_rule_validation_errors_count,
+CAST(NULL AS BOOLEAN) AS complex_rule_validation_success_flag,
+ r"""
+ WITH
+ zero_record AS (
+ SELECT
+ '<rule_binding_id>' AS rule_binding_id,
+ ),
+ data AS (
+ SELECT
+ *,
+ '<rule_binding_id>' AS rule_binding_id,
+ FROM
+ `<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details` d
+ WHERE
+ contact_type IN ('email')
+ ),
+ last_mod AS (
+ SELECT
+ project_id || '.' || dataset_id || '.' || table_id AS table_id,
+ TIMESTAMP_MILLIS(last_modified_time) AS last_modified
+ FROM `<your-gcp-project-id>.<your_bigquery_dataset_id>.__TABLES__`
+ ),
+ validation_results AS (SELECT
+ '<rule_binding_id>' AS rule_binding_id,
+ 'NOT_NULL_SIMPLE' AS rule_id,
+ '<your-gcp-project-id>.<your_bigquery_dataset_id>.contact_details' AS table_id,
+ 'value' AS column_id,
+ data.value AS column_value,
+ data.row_id AS row_id,
+ data.contact_type AS contact_type,
+ data.value AS value,
+ CAST(NULL AS STRING) AS dimension,
+ CASE
+ WHEN value IS NOT NULL THEN TRUE
+ ELSE
+ FALSE
+ END AS simple_rule_row_is_valid,
+ TRUE AS skip_null_count,
+ CAST(NULL AS INT64) AS complex_rule_validation_errors_count,
+ CAST(NULL AS BOOLEAN) AS complex_rule_validation_success_flag,
+ FROM
+ zero_record
+ LEFT JOIN
+ data
+ ON
+ zero_record.rule_binding_id = data.rule_binding_id
+ ),
+ all_validation_results AS (
+ SELECT
+ '{{ invocation_id }}' as _dq_validation_invocation_id,
+ r.rule_binding_id AS _dq_validation_rule_binding_id,
+ r.rule_id AS _dq_validation_rule_id,
+ r.column_id AS _dq_validation_column_id,
+ r.column_value AS _dq_validation_column_value,
+ CAST(r.dimension AS STRING) AS _dq_validation_dimension,
+ r.simple_rule_row_is_valid AS _dq_validation_simple_rule_row_is_valid,
+ r.complex_rule_validation_errors_count AS _dq_validation_complex_rule_validation_errors_count,
+ r.complex_rule_validation_success_flag AS _dq_validation_complex_rule_validation_success_flag,
+ r.row_id AS row_id,
+ r.contact_type AS contact_type,
+ r.value AS value,
+ FROM
+ validation_results r
+ )
+ SELECT
+ *
+ FROM
+ all_validation_results
+WHERE
+_dq_validation_simple_rule_row_is_valid is False
+OR
+_dq_validation_complex_rule_validation_success_flag is False
+ORDER BY _dq_validation_rule_id"""
+ AS failed_records_query,
+FROM
+zero_record
+LEFT JOIN
+data
+ON
+zero_record.rule_binding_id = data.rule_binding_id
+),
+all_validation_results AS (
+SELECT
+r.execution_ts AS execution_ts,
+r.rule_binding_id AS rule_binding_id,
+r.rule_id AS rule_id,
+r.table_id AS table_id,
+r.column_id AS column_id,
+r.column_value AS column_value,
+CAST(r.dimension AS STRING) AS dimension,
+r.skip_null_count AS skip_null_count,
+r.simple_rule_row_is_valid AS simple_rule_row_is_valid,
+r.complex_rule_validation_errors_count AS complex_rule_validation_errors_count,
+r.complex_rule_validation_success_flag AS complex_rule_validation_success_flag,
+(SELECT COUNT(*) FROM data) AS rows_validated,
+last_mod.last_modified,
+'{"brand": "one"}' AS metadata_json_string,
+'' AS configs_hashsum,
+'<your_dataplex_lake_id>' AS dataplex_lake,
+'<your_dataplex_zone_id>' AS dataplex_zone,
+'<your_dataplex_asset_id>' AS dataplex_asset_id,
+CONCAT(r.rule_binding_id, '_', r.rule_id, '_', r.execution_ts, '_', True) AS dq_run_id,
+TRUE AS progress_watermark,
+ failed_records_query AS failed_records_query,
+FROM
+validation_results r
+JOIN last_mod USING(table_id)
+)
+SELECT
+*
+FROM
+all_validation_results