Mark Tests That Generate SQL-Engine-Specific Snapshots

metricflow/test/cli/test_cli.py

@@ -155,6 +155,7 @@ def test_list_entities(capsys: pytest.CaptureFixture, cli_runner: MetricFlowCliR
     assert "host" in resp.output
 
 
+@pytest.mark.sql_engine_snapshot
 def test_saved_query(  # noqa: D
     request: FixtureRequest,
     capsys: pytest.CaptureFixture,
@@ -179,6 +180,7 @@ def test_saved_query(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_saved_query_with_where(  # noqa: D
     request: FixtureRequest,
     capsys: pytest.CaptureFixture,
@@ -211,6 +213,7 @@ def test_saved_query_with_where(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_saved_query_with_limit(  # noqa: D
     request: FixtureRequest,
     capsys: pytest.CaptureFixture,

metricflow/test/dataflow/builder/test_dataflow_plan_builder.py

@@ -28,6 +28,7 @@
 logger = logging.getLogger(__name__)
 
 
+@pytest.mark.sql_engine_snapshot
 def test_simple_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -60,6 +61,7 @@ def test_simple_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_primary_entity_dimension(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -92,6 +94,7 @@ def test_primary_entity_dimension(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_joined_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -129,6 +132,7 @@ def test_joined_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_order_by_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -166,6 +170,7 @@ def test_order_by_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_limit_rows_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -194,6 +199,7 @@ def test_limit_rows_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_multiple_metrics_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -227,6 +233,7 @@ def test_multiple_metrics_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_single_semantic_model_ratio_metrics_plan(
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -260,6 +267,7 @@ def test_single_semantic_model_ratio_metrics_plan(
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_multi_semantic_model_ratio_metrics_plan(
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -293,6 +301,7 @@ def test_multi_semantic_model_ratio_metrics_plan(
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_multihop_join_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -328,6 +337,7 @@ def test_multihop_join_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_where_constrained_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -370,6 +380,7 @@ def test_where_constrained_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_where_constrained_plan_time_dimension(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -412,6 +423,7 @@ def test_where_constrained_plan_time_dimension(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_where_constrained_with_common_linkable_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -454,6 +466,7 @@ def test_where_constrained_with_common_linkable_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_multihop_join_plan_ambiguous_dim(  # noqa: D
     mf_test_session_state: MetricFlowTestSessionState,
     dataflow_plan_builder: DataflowPlanBuilder,
@@ -476,6 +489,7 @@ def test_multihop_join_plan_ambiguous_dim(  # noqa: D
         )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_cumulative_metric_with_window(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -504,6 +518,7 @@ def test_cumulative_metric_with_window(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_cumulative_metric_no_window_or_grain_with_metric_time(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -531,6 +546,7 @@ def test_cumulative_metric_no_window_or_grain_with_metric_time(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_cumulative_metric_no_window_or_grain_without_metric_time(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -558,6 +574,7 @@ def test_cumulative_metric_no_window_or_grain_without_metric_time(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_distinct_values_plan(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -605,6 +622,7 @@ def test_distinct_values_plan(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_distinct_values_plan_with_join(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -653,6 +671,7 @@ def test_distinct_values_plan_with_join(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_measure_constraint_plan(
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -681,6 +700,7 @@ def test_measure_constraint_plan(
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_measure_constraint_with_reused_measure_plan(
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -709,6 +729,7 @@ def test_measure_constraint_with_reused_measure_plan(
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_common_semantic_model(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -739,6 +760,7 @@ def test_common_semantic_model(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_metric_offset_window(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -766,6 +788,7 @@ def test_derived_metric_offset_window(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_metric_offset_to_grain(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -793,6 +816,7 @@ def test_derived_metric_offset_to_grain(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_metric_offset_with_granularity(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -819,6 +843,7 @@ def test_derived_metric_offset_with_granularity(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_offset_cumulative_metric(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,

metricflow/test/dataflow/optimizer/source_scan/test_cm_branch_combiner.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import pytest
 from _pytest.fixtures import FixtureRequest
 
 from metricflow.dag.id_generation import OPTIMIZED_DATAFLOW_PLAN_PREFIX, IdGeneratorRegistry
@@ -28,6 +29,7 @@ def make_dataflow_plan(node: BaseOutput) -> DataflowPlan:  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_read_sql_source_combination(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -56,6 +58,7 @@ def test_read_sql_source_combination(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_filter_combination(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,

metricflow/test/dataflow/optimizer/source_scan/test_source_scan_optimizer.py

@@ -2,6 +2,7 @@
 
 import logging
 
+import pytest
 from _pytest.fixtures import FixtureRequest
 from dbt_semantic_interfaces.implementations.filters.where_filter import PydanticWhereFilter
 from dbt_semantic_interfaces.type_enums.time_granularity import TimeGranularity
@@ -150,6 +151,7 @@ def check_optimization(  # noqa: D
     assert source_counter.count_source_nodes(optimized_dataflow_plan) == expected_num_sources_in_optimized
 
 
+@pytest.mark.sql_engine_snapshot
 def test_2_metrics_from_1_semantic_model(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -175,6 +177,7 @@ def test_2_metrics_from_1_semantic_model(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_2_metrics_from_2_semantic_models(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -194,6 +197,7 @@ def test_2_metrics_from_2_semantic_models(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_3_metrics_from_2_semantic_models(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -217,6 +221,7 @@ def test_3_metrics_from_2_semantic_models(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_constrained_metric_not_combined(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -252,6 +257,7 @@ def test_constrained_metric_not_combined(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_metric(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -274,6 +280,7 @@ def test_derived_metric(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_nested_derived_metric(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -297,6 +304,7 @@ def test_nested_derived_metric(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_derived_metric_with_non_derived_metric(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -328,6 +336,7 @@ def test_derived_metric_with_non_derived_metric(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_2_ratio_metrics_from_1_semantic_model(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,

metricflow/test/dataset/test_convert_semantic_model.py

@@ -2,11 +2,11 @@
 
 import logging
 
+import pytest
 from _pytest.fixtures import FixtureRequest
 from dbt_semantic_interfaces.references import SemanticModelReference
 
 from metricflow.protocols.sql_client import SqlClient
-from metricflow.sql.render.sql_plan_renderer import SqlQueryPlanRenderer
 from metricflow.test.fixtures.model_fixtures import ConsistentIdObjectRepository
 from metricflow.test.fixtures.setup_fixtures import MetricFlowTestSessionState
 from metricflow.test.snapshot_utils import assert_spec_set_snapshot_equal
@@ -15,6 +15,7 @@
 logger = logging.getLogger(__name__)
 
 
+@pytest.mark.sql_engine_snapshot
 def test_convert_table_semantic_model_without_measures(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -40,6 +41,7 @@ def test_convert_table_semantic_model_without_measures(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_convert_table_semantic_model_with_measures(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
@@ -72,11 +74,11 @@ def test_convert_table_semantic_model_with_measures(  # noqa: D
     )
 
 
+@pytest.mark.sql_engine_snapshot
 def test_convert_query_semantic_model(  # noqa: D
     request: FixtureRequest,
     mf_test_session_state: MetricFlowTestSessionState,
     sql_client: SqlClient,
-    default_sql_plan_renderer: SqlQueryPlanRenderer,
     consistent_id_object_repository: ConsistentIdObjectRepository,
 ) -> None:
     bookings_data_set = consistent_id_object_repository.simple_model_data_sets["revenue"]

metricflow/test/fixtures/setup_fixtures.py

@@ -68,6 +68,28 @@ def pytest_addoption(parser: _pytest.config.argparsing.Parser) -> None:
     )
 
 
+# Name of the pytest marker for tests that generate SQL-engine specific snapshots.
+SQL_ENGINE_SNAPSHOT_MARKER_NAME = "sql_engine_snapshot"
+
+
+def pytest_configure(config: _pytest.config.Config) -> None:
+    """Hook as specified by the pytest API for configuration."""
+    config.addinivalue_line(
+        name="markers",
+        line=f"{SQL_ENGINE_SNAPSHOT_MARKER_NAME}: mark tests as generating a snapshot specific to a SQL engine",
+    )
+
+
+def check_sql_engine_snapshot_marker(request: FixtureRequest) -> None:
+    """Raises an error if the given test request does not have the sql-engine-test marker set."""
+    mark_names = set(mark.name for mark in request.node.iter_markers(name=SQL_ENGINE_SNAPSHOT_MARKER_NAME))
+    if SQL_ENGINE_SNAPSHOT_MARKER_NAME not in mark_names:
+        raise ValueError(
+            f"This test needs to be marked with '{SQL_ENGINE_SNAPSHOT_MARKER_NAME}' to keep track of all tests that "
+            f"generate SQL-engine specific snapshots."
+        )
+
+
 @pytest.fixture(scope="session")
 def mf_test_session_state(  # noqa: D
     request: FixtureRequest,