chore: add blueprint model to sushi (#4537)

Author: benfdking

examples/sushi/models/blueprint.sql

@@ -0,0 +1,21 @@
+MODEL (
+    name @name,
+    kind FULL,
+    description "Count of customers by status, done with a fancy unnecessary blueprint",
+    grain status,
+    blueprints (
+        (
+            name := sushi.count_customers_active,
+            blueprint_status := 'active',
+        ),
+        (
+            name := sushi.count_customers_inactive,
+            blueprint_status := 'inactive',
+        )
+    )
+);
+
+SELECT 
+   COUNT(customer_id) AS count_customers
+FROM sushi.customers
+WHERE status = @blueprint_status;

tests/core/analytics/test_collector.py

@@ -183,7 +183,7 @@ def test_on_plan_apply(
                 {
                     "seq_num": 0,
                     "event_type": "PLAN_APPLY_START",
-                    "event": f'{{"plan_id": "{plan_id}", "engine_type": "bigquery", "state_sync_type": "mysql", "scheduler_type": "builtin", "is_dev": false, "skip_backfill": false, "no_gaps": false, "forward_only": false, "ensure_finalized_snapshots": false, "has_restatements": false, "directly_modified_count": 19, "indirectly_modified_count": 0, "environment_name_hash": "d6e4a9b6646c62fc48baa6dd6150d1f7"}}',
+                    "event": f'{{"plan_id": "{plan_id}", "engine_type": "bigquery", "state_sync_type": "mysql", "scheduler_type": "builtin", "is_dev": false, "skip_backfill": false, "no_gaps": false, "forward_only": false, "ensure_finalized_snapshots": false, "has_restatements": false, "directly_modified_count": 21, "indirectly_modified_count": 0, "environment_name_hash": "d6e4a9b6646c62fc48baa6dd6150d1f7"}}',
                     **common_fields,
                 }
             ),

tests/core/test_context.py

@@ -818,7 +818,7 @@ def test_janitor(sushi_context, mocker: MockerFixture) -> None:
     )
     # Assert that the views are dropped for each snapshot just once and make sure that the name used is the
     # view name with the environment as a suffix
-    assert adapter_mock.drop_view.call_count == 14
+    assert adapter_mock.drop_view.call_count == 16
     adapter_mock.drop_view.assert_has_calls(
         [
             call(

tests/core/test_integration.py

@@ -476,10 +476,16 @@ def test_full_history_restatement_model_regular_plan_preview_enabled(
     waiter_as_customer_snapshot = context.get_snapshot(
         "sushi.waiter_as_customer_by_day", raise_if_missing=True
     )
+    count_customers_active_snapshot = context.get_snapshot(
+        "sushi.count_customers_active", raise_if_missing=True
+    )
+    count_customers_inactive_snapshot = context.get_snapshot(
+        "sushi.count_customers_inactive", raise_if_missing=True
+    )
 
     plan = context.plan_builder("dev", skip_tests=True, enable_preview=True).build()
 
-    assert len(plan.new_snapshots) == 4
+    assert len(plan.new_snapshots) == 6
     assert (
         plan.context_diff.snapshots[snapshot.snapshot_id].change_category
         == SnapshotChangeCategory.FORWARD_ONLY
@@ -505,6 +511,18 @@ def test_full_history_restatement_model_regular_plan_preview_enabled(
                 (to_timestamp("2023-01-07"), to_timestamp("2023-01-08")),
             ],
         ),
+        SnapshotIntervals(
+            snapshot_id=count_customers_active_snapshot.snapshot_id,
+            intervals=[
+                (to_timestamp("2023-01-07"), to_timestamp("2023-01-08")),
+            ],
+        ),
+        SnapshotIntervals(
+            snapshot_id=count_customers_inactive_snapshot.snapshot_id,
+            intervals=[
+                (to_timestamp("2023-01-07"), to_timestamp("2023-01-08")),
+            ],
+        ),
         SnapshotIntervals(
             snapshot_id=customers_snapshot.snapshot_id,
             intervals=[
@@ -1517,6 +1535,8 @@ def test_run_with_select_models(
             "assert_item_price_above_zero": to_timestamp("2023-01-08"),
             '"memory"."sushi"."active_customers"': to_timestamp("2023-01-08"),
             '"memory"."sushi"."customers"': to_timestamp("2023-01-08"),
+            '"memory"."sushi"."count_customers_active"': to_timestamp("2023-01-08"),
+            '"memory"."sushi"."count_customers_inactive"': to_timestamp("2023-01-08"),
         }
 
 
@@ -1555,6 +1575,8 @@ def test_plan_with_run(
             "assert_item_price_above_zero": to_timestamp("2023-01-09"),
             '"memory"."sushi"."active_customers"': to_timestamp("2023-01-09"),
             '"memory"."sushi"."customers"': to_timestamp("2023-01-09"),
+            '"memory"."sushi"."count_customers_active"': to_timestamp("2023-01-09"),
+            '"memory"."sushi"."count_customers_inactive"': to_timestamp("2023-01-09"),
         }
 
 
@@ -1592,6 +1614,8 @@ def test_run_with_select_models_no_auto_upstream(
             "assert_item_price_above_zero": to_timestamp("2023-01-08"),
             '"memory"."sushi"."active_customers"': to_timestamp("2023-01-08"),
             '"memory"."sushi"."customers"': to_timestamp("2023-01-08"),
+            '"memory"."sushi"."count_customers_active"': to_timestamp("2023-01-08"),
+            '"memory"."sushi"."count_customers_inactive"': to_timestamp("2023-01-08"),
         }
 
 
@@ -5185,7 +5209,7 @@ def test_environment_suffix_target_table(init_and_plan_context: t.Callable):
     assert set(metadata.schemas) - starting_schemas == {"raw"}
     prod_views = {x for x in metadata.qualified_views if x.db in environments_schemas}
     # Make sure that all models are present
-    assert len(prod_views) == 14
+    assert len(prod_views) == 16
     apply_to_environment(context, "dev")
     # Make sure no new schemas are created
     assert set(metadata.schemas) - starting_schemas == {"raw"}
@@ -5243,9 +5267,9 @@ def get_default_catalog_and_non_tables(
         user_default_tables,
         non_default_tables,
     ) = get_default_catalog_and_non_tables(metadata, context.default_catalog)
-    assert len(prod_views) == 14
+    assert len(prod_views) == 16
     assert len(dev_views) == 0
-    assert len(user_default_tables) == 17
+    assert len(user_default_tables) == 21
     assert state_metadata.schemas == ["sqlmesh"]
     assert {x.sql() for x in state_metadata.qualified_tables}.issuperset(
         {
@@ -5262,9 +5286,9 @@ def get_default_catalog_and_non_tables(
         user_default_tables,
         non_default_tables,
     ) = get_default_catalog_and_non_tables(metadata, context.default_catalog)
-    assert len(prod_views) == 14
-    assert len(dev_views) == 14
-    assert len(user_default_tables) == 17
+    assert len(prod_views) == 16
+    assert len(dev_views) == 16
+    assert len(user_default_tables) == 21
     assert len(non_default_tables) == 0
     assert state_metadata.schemas == ["sqlmesh"]
     assert {x.sql() for x in state_metadata.qualified_tables}.issuperset(
@@ -5282,9 +5306,9 @@ def get_default_catalog_and_non_tables(
         user_default_tables,
         non_default_tables,
     ) = get_default_catalog_and_non_tables(metadata, context.default_catalog)
-    assert len(prod_views) == 14
-    assert len(dev_views) == 28
-    assert len(user_default_tables) == 17
+    assert len(prod_views) == 16
+    assert len(dev_views) == 32
+    assert len(user_default_tables) == 21
     assert len(non_default_tables) == 0
     assert state_metadata.schemas == ["sqlmesh"]
     assert {x.sql() for x in state_metadata.qualified_tables}.issuperset(
@@ -5303,9 +5327,9 @@ def get_default_catalog_and_non_tables(
         user_default_tables,
         non_default_tables,
     ) = get_default_catalog_and_non_tables(metadata, context.default_catalog)
-    assert len(prod_views) == 14
-    assert len(dev_views) == 14
-    assert len(user_default_tables) == 17
+    assert len(prod_views) == 16
+    assert len(dev_views) == 16
+    assert len(user_default_tables) == 21
     assert len(non_default_tables) == 0
     assert state_metadata.schemas == ["sqlmesh"]
     assert {x.sql() for x in state_metadata.qualified_tables}.issuperset(

tests/core/test_plan.py

@@ -832,6 +832,8 @@ def test_restate_models(sushi_context_pre_scheduling: Context):
         '"memory"."sushi"."waiter_as_customer_by_day"',
         '"memory"."sushi"."waiter_names"',
         '"memory"."sushi"."waiters"',
+        '"memory"."sushi"."count_customers_active"',
+        '"memory"."sushi"."count_customers_inactive"',
     }
 
 

tests/integrations/github/cicd/test_integration.py

@@ -1705,6 +1705,8 @@ def test_overlapping_changes_models(
 
 **Indirectly Modified:**
 - `sushi.active_customers`
+- `sushi.count_customers_active`
+- `sushi.count_customers_inactive`
 - `sushi.waiter_as_customer_by_day`
 
 """
@@ -1744,7 +1746,7 @@ def test_overlapping_changes_models(
 """
     )
 
-    assert len(get_environment_objects(controller, "hello_world_2")) == 4
+    assert len(get_environment_objects(controller, "hello_world_2")) == 6
     assert "new_col" in get_columns(controller, "hello_world_2", "customers")
 
     assert mock_pull_request.merge.called

tests/integrations/jupyter/test_magics.py

@@ -756,15 +756,15 @@ def test_info(notebook, sushi_context, convert_all_html_output_to_text, get_all_
     assert not output.stderr
     assert len(output.outputs) == 6
     assert convert_all_html_output_to_text(output) == [
-        "Models: 18",
+        "Models: 20",
         "Macros: 8",
         "",
         "Connection:\n  type: duckdb\n  concurrent_tasks: 1\n  register_comments: true\n  pre_ping: false\n  pretty_sql: false\n  extensions: []\n  connector_config: {}\n  secrets: None",
         "Test Connection:\n  type: duckdb\n  concurrent_tasks: 1\n  register_comments: true\n  pre_ping: false\n  pretty_sql: false\n  extensions: []\n  connector_config: {}\n  secrets: None",
         "Data warehouse connection succeeded",
     ]
     assert get_all_html_output(output) == [
-        "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Models: <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">18</span></pre>",
+        "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Models: <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">20</span></pre>",
         "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Macros: <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">8</span></pre>",
         "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"></pre>",
         '<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,\'DejaVu Sans Mono\',consolas,\'Courier New\',monospace">Connection:  type: duckdb  concurrent_tasks: <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">1</span>  register_comments: true  pre_ping: false  pretty_sql: false  extensions: <span style="font-weight: bold">[]</span>  connector_config: <span style="font-weight: bold">{}</span>  secrets: <span style="color: #800080; text-decoration-color: #800080; font-style: italic">None</span></pre>',