Merge pull request #31 from godatadriven/add-first-test

Adding first test to dbt-bouncer

.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
           - id: debug-statements
           - id: detect-private-key
           - id: end-of-file-fixer
+            exclude: dbt_project/target/manifest.json
     - repo: https://github.com/pycqa/isort
       rev: 5.13.2
       hooks:

dbt_bouncer/main.py

@@ -5,6 +5,7 @@
 from dbt_artifacts_parser.parser import parse_manifest
 
 from dbt_bouncer.logger import logger
+from dbt_bouncer.runner import runner
 from dbt_bouncer.version import version
 
 
@@ -35,15 +36,22 @@ def cli(dbt_artifacts_dir):
     for _, v in manifest_obj.nodes.items():
         if v.package_name == manifest_obj.metadata.project_name:
             if v.resource_type == "model":
-                project_models.append(v)
+                project_models.append(v.model_dump())
             elif v.resource_type == "test":
-                project_tests.append(v)
+                project_tests.append(v.model_dump())
 
     project_sources = []
     for _, v in manifest_obj.sources.items():
         if v.package_name == manifest_obj.metadata.project_name:
-            project_sources.append(v)
+            project_sources.append(v.model_dump())
 
     logger.info(
         f"Parsed `{manifest_obj.metadata.project_name}` project, found {len(project_models)} nodes, {len(project_sources)} sources and {len(project_tests)} tests."
     )
+
+    logger.info("Running tests...")
+    runner(
+        models=project_models,
+        sources=project_sources,
+        tests=project_tests,
+    )

dbt_bouncer/runner.py

@@ -0,0 +1,40 @@
+from typing import Dict, List
+
+import pytest
+
+
+class FixturePlugin(object):
+    def __init__(self):
+        self.models_ = None
+        self.sources_ = None
+        self.tests_ = None
+
+    @pytest.fixture(scope="session")
+    def models(self):
+        return self.models_
+
+    @pytest.fixture(scope="session")
+    def sources(self):
+        return self.sources_
+
+    @pytest.fixture(scope="session")
+    def tests(self):
+        return self.tests_
+
+
+def runner(
+    models: List[Dict[str, str]],
+    sources: List[Dict[str, str]],
+    tests: List[Dict[str, str]],
+) -> None:
+    """
+    Run pytest using fixtures from artifacts.
+    """
+
+    # Create a fixture plugin that can be used to inject the manifest into the tests
+    fixtures = FixturePlugin()
+    for att in ["models", "sources", "tests"]:
+        setattr(fixtures, att + "_", locals()[att])
+
+    # Run the tests, if one fails then pytest will raise an exception
+    pytest.main(["dbt_bouncer/tests"], plugins=[fixtures])

dbt_bouncer/tests/test_models.py

@@ -0,0 +1,13 @@
+def populated_model_description(models):
+    """
+    Models must have a populated description.
+    """
+
+    for model in models:
+        assert (
+            len(model["description"].strip()) > 4
+        ), f"{model['unique_id']} does not have a populated description."
+
+
+def test_populated_model_description(models):
+    populated_model_description(models=models)

dbt_project/models/_schema.yml

@@ -2,7 +2,15 @@ version: 2
 
 models:
   - name: model_1
+    description: Super basic model that has a description and a test
     columns:
       - name: id
         tests:
           - not_null
+
+  - name: model_2
+    description: Super basic model that has a description and a test
+    columns:
+      - name: id
+        tests:
+          - unique

dbt_project/models/model_2.sql

@@ -0,0 +1 @@
+select 1 as id

pyproject.toml

@@ -49,13 +49,13 @@ version = "0.0.0"
 python = ">=3.8,<3.13"
 click = "*"
 dbt-artifacts-parser = "^0"
+pytest = "*"
 
 [tool.poetry.group.dev.dependencies]
 dbt-core="*"
 dbt-duckdb="*"
 pex = "^2"
 pre-commit = "^3"
-pytest = "*"
 pytest-cov = "*"
 pytest-xdist = "*"
 

tests/tests/test_models.py

@@ -0,0 +1,82 @@
+from contextlib import nullcontext as does_not_raise
+
+import pytest
+
+from dbt_bouncer.tests.test_models import populated_model_description
+
+
+@pytest.mark.parametrize(
+    "models,expectation",
+    [
+        (
+            [
+                {
+                    "description": "Description that is more than 4 characters.",
+                    "unique_id": "model.package_name.model_1",
+                }
+            ],
+            does_not_raise(),
+        ),
+        (
+            [
+                {
+                    "description": """A
+                        multiline
+                        description
+                        """,
+                    "unique_id": "model.package_name.model_2",
+                }
+            ],
+            does_not_raise(),
+        ),
+        (
+            [
+                {
+                    "description": "",
+                    "unique_id": "model.package_name.model_3",
+                }
+            ],
+            pytest.raises(AssertionError),
+        ),
+        (
+            [
+                {
+                    "description": " ",
+                    "unique_id": "model.package_name.model_4",
+                }
+            ],
+            pytest.raises(AssertionError),
+        ),
+        (
+            [
+                {
+                    "description": """
+                        """,
+                    "unique_id": "model.package_name.model_5",
+                }
+            ],
+            pytest.raises(AssertionError),
+        ),
+        (
+            [
+                {
+                    "description": "-",
+                    "unique_id": "model.package_name.model_6",
+                }
+            ],
+            pytest.raises(AssertionError),
+        ),
+        (
+            [
+                {
+                    "description": "null",
+                    "unique_id": "model.package_name.model_7",
+                }
+            ],
+            pytest.raises(AssertionError),
+        ),
+    ],
+)
+def test_populated_model_description(models, expectation):
+    with expectation:
+        populated_model_description(models=models)