chore: testing docs additions

- tests dbt docs blocks

Author: benfdking

examples/sushi_dbt/models/waiter_as_customer_by_day.sql

@@ -0,0 +1,4 @@
+{% docs waiters %}
+waiters docs block
+{% enddocs %}
+

examples/sushi_dbt/models/waiters_doc_block.md

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+from pathlib import Path
+from sqlmesh.dbt.context import DbtContext
+
+# Initialize the context for the sushi_test project
+context = DbtContext(project_root=Path("tests/fixtures/dbt/sushi_test"))
+
+# Get the manifest
+manifest = context._manifest
+if manifest and hasattr(manifest, '_manifest'):
+    nodes = manifest._manifest.nodes
+    
+    print("=== Checking node descriptions ===")
+    for node_name, node in nodes.items():
+        if 'top_waiters' in node_name or ('waiters' in node_name and 'waiter_' not in node_name):
+            print(f'\nNode: {node_name}')
+            print(f'  Has description attr: {hasattr(node, "description")}')
+            if hasattr(node, "description"):
+                print(f'  description value: {node.description!r}')
+            
+            if hasattr(node, 'to_dict'):
+                node_dict = node.to_dict()
+                print(f'  description in dict: {"description" in node_dict}')
+                if "description" in node_dict:
+                    print(f'  dict description value: {node_dict["description"]!r}')
+            
+            if hasattr(node, 'config'):
+                config_dict = node.config.to_dict()
+                print(f'  description in config: {"description" in config_dict}')
+                if "description" in config_dict:
+                    print(f'  config description value: {config_dict["description"]!r}')
+
+# Now check the loaded models
+print("\n=== Checking loaded models ===")
+models = manifest.models() if manifest else {}
+for name, model in models.items():
+    if name == 'top_waiters' or name == 'waiters':
+        print(f'\nModel: {name}')
+        print(f'  description: {model.description!r}')

test_descriptions.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+import pytest
+
+from sqlmesh.dbt.project import Project
+
+pytestmark = pytest.mark.dbt
+
+
+def test_docs_inline(sushi_test_project: Project):
+    # Inline description in yaml
+    top_waiters = sushi_test_project.context._models["top_waiters"]
+    assert top_waiters.description == "description of top waiters"
+
+    # Docs block from .md file
+    waiters = sushi_test_project.context._models["waiters"]
+    assert waiters.description == "waiters docs block"

tests/dbt/test_docs.py

@@ -2,6 +2,7 @@ version: 2
 
 models:
   - name: top_waiters
+    description: description of top waiters
     columns:
       - name: waiter_id
         data_type: int
@@ -18,6 +19,7 @@ models:
         warn_after: {count: 8, period: hour}
         error_after: {count: 9, period: hour}
   - name: waiters
+    description: '{{ doc("waiters") }}'
   - name: waiter_as_customer_by_day
   - name: waiter_revenue_by_day
     versions:

tests/fixtures/dbt/sushi_test/models/schema.yml

@@ -0,0 +1,4 @@
+{% docs waiters %}
+waiters docs block
+{% enddocs %}
+