Skip to content

Commit 84332cb

Browse files
committed
chore: testing docs additions
- tests dbt docs blocks
1 parent 3507a19 commit 84332cb

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

tests/dbt/test_docs.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
from __future__ import annotations
2+
3+
import pytest
4+
5+
from sqlmesh.dbt.project import Project
6+
7+
pytestmark = pytest.mark.dbt
8+
9+
10+
def test_docs_inline(sushi_test_project: Project):
11+
# Inline description in yaml
12+
top_waiters = sushi_test_project.context._models["top_waiters"]
13+
assert top_waiters.description == "description of top waiters"
14+
15+
# Docs block from .md file
16+
waiters = sushi_test_project.context._models["waiters"]
17+
assert waiters.description == "waiters docs block"

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ version: 2
22

33
models:
44
- name: top_waiters
5+
description: description of top waiters
56
columns:
67
- name: waiter_id
78
data_type: int
@@ -18,6 +19,7 @@ models:
1819
warn_after: {count: 8, period: hour}
1920
error_after: {count: 9, period: hour}
2021
- name: waiters
22+
description: '{{ doc("waiters") }}'
2123
- name: waiter_as_customer_by_day
2224
- name: waiter_revenue_by_day
2325
versions:
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{% docs waiters %}
2+
waiters docs block
3+
{% enddocs %}
4+

0 commit comments

Comments
 (0)