dbt-bouncer 1.31.2rc3__py3-none-any.whl → 2.0.0rc1__py3-none-any.whl

dbt_bouncer/artifact_parsers/parsers_run_results.py

@@ -1,6 +1,6 @@
 import logging
 import warnings
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+from typing import TYPE_CHECKING, Any, TypeAlias
 
 from pydantic import BaseModel
 
@@ -27,7 +27,7 @@ if TYPE_CHECKING:
 
 from dbt_bouncer.artifact_parsers.parsers_common import load_dbt_artifact
 
-DbtBouncerRunResultBase = Union[RunResultOutput_v5, RunResultOutput_Latest]
+DbtBouncerRunResultBase: TypeAlias = RunResultOutput_v5 | RunResultOutput_Latest
 
 
 class DbtBouncerRunResult(BaseModel):
@@ -39,8 +39,8 @@ class DbtBouncerRunResult(BaseModel):
 
 
 def parse_run_results(
-    run_results: Dict[str, Any],
-) -> Union[RunResultsV5, RunResultsLatest]:
+    run_results: dict[str, Any],
+) -> RunResultsV5 | RunResultsLatest:
     """Parse run-results.json.
 
     Args:
@@ -50,7 +50,7 @@ def parse_run_results(
         ValueError: If the schema version is not supported.
 
     Returns:
-        Union[ RunResultsV5, RunResultsLatest]:
+        RunResultsV5 | RunResultsLatest:
 
     """
     dbt_schema_version = run_results["metadata"]["dbt_schema_version"]
@@ -64,12 +64,21 @@ def parse_run_results(
 def parse_run_results_artifact(
     artifact_dir: "Path",
     manifest_obj: "DbtBouncerManifest",
-    package_name: Optional[str] = None,
-) -> List[DbtBouncerRunResult]:
+    package_name: str | None = None,
+) -> list[DbtBouncerRunResult]:
     """Parse the run_results.json artifact.
 
+    Args:
+        artifact_dir (Path): Path to the dbt artifacts directory.
+        manifest_obj (DbtBouncerManifest): The manifest object.
+        package_name (str | None): The package name to filter results by. If None,
+            uses the project name from the manifest.
+
     Returns:
-        List[DbtBouncerRunResult]: A list of DbtBouncerRunResult objects.
+        list[DbtBouncerRunResult]: A list of DbtBouncerRunResult objects.
+
+    Raises:
+        TypeError: If the loaded artifact is not of the expected type.
 
     """
 
@@ -93,24 +102,28 @@ def parse_run_results_artifact(
                 manifest_obj.manifest.exposures[unique_id].original_file_path
             )
         else:
-            return clean_path_str(
-                manifest_obj.manifest.unit_tests[unique_id].original_file_path
-            )
+            unit_tests = getattr(manifest_obj.manifest, "unit_tests", {})
+            if unique_id in unit_tests:
+                return clean_path_str(unit_tests[unique_id].original_file_path)
+            return ""
 
-    run_results_obj: Union[RunResultsV5, RunResultsLatest] = load_dbt_artifact(
+    run_results_obj = load_dbt_artifact(
         artifact_name="run_results.json",
         dbt_artifacts_dir=artifact_dir,
     )
 
+    if not isinstance(run_results_obj, (RunResultsV5, RunResultsLatest)):
+        raise TypeError(
+            f"Expected RunResultsV5 or RunResultsLatest, got {type(run_results_obj)}"
+        )
+
     project_run_results = [
         DbtBouncerRunResult(
-            **{
-                "original_file_path": (
-                    get_clean_path_str(unique_id=r.unique_id, manifest_obj=manifest_obj)
-                ),
-                "run_result": r,
-                "unique_id": r.unique_id,
-            },
+            original_file_path=get_clean_path_str(
+                unique_id=r.unique_id, manifest_obj=manifest_obj
+            ),
+            run_result=r,
+            unique_id=r.unique_id,
         )
         for r in run_results_obj.results
         if r.unique_id.split(".")[1]

dbt_bouncer/check_base.py

@@ -1,7 +1,9 @@
-from typing import TYPE_CHECKING, List, Literal, Optional
+from typing import TYPE_CHECKING, ClassVar, Literal
 
 from pydantic import BaseModel, ConfigDict, Field
 
+from dbt_bouncer.utils import is_description_populated
+
 if TYPE_CHECKING:
     import warnings
 
@@ -20,42 +22,44 @@ class BaseCheck(BaseModel):
 
     model_config = ConfigDict(extra="forbid")
 
-    description: Optional[str] = Field(
+    description: str | None = Field(
         default=None,
         description="Description of what the check does and why it is implemented.",
     )
-    exclude: Optional[str] = Field(
+    exclude: str | None = Field(
         default=None,
         description="Regexp to match which paths to exclude.",
     )
-    include: Optional[str] = Field(
+    include: str | None = Field(
         default=None,
         description="Regexp to match which paths to include.",
     )
-    index: Optional[int] = Field(
+    index: int | None = Field(
         default=None,
         description="Index to uniquely identify the check, calculated at runtime.",
     )
-    materialization: Optional[Literal["ephemeral", "incremental", "table", "view"]] = (
+    materialization: Literal["ephemeral", "incremental", "table", "view"] | None = (
         Field(
             default=None,
             description="Limit check to models with the specified materialization.",
         )
     )
-    severity: Optional[Literal["error", "warn"]] = Field(
+    severity: Literal["error", "warn"] | None = Field(
         default="error",
         description="Severity of the check, one of 'error' or 'warn'.",
     )
 
+    _min_description_length: ClassVar[int] = 4
+
     # Helper methods
     def is_catalog_node_a_model(
-        self, catalog_node: "CatalogNodes", models: List["DbtBouncerModelBase"]
+        self, catalog_node: "CatalogNodes", models: list["DbtBouncerModelBase"]
     ) -> bool:
         """Check if a catalog node is a model.
 
         Args:
             catalog_node (CatalogNodes): The CatalogNodes object to check.
-            models (List[DbtBouncerModelBase]): List of DbtBouncerModelBase objects parsed from `manifest.json`.
+            models (list[DbtBouncerModelBase]): List of DbtBouncerModelBase objects parsed from `manifest.json`.
 
         Returns:
             bool: Whether a catalog node is a model.
@@ -69,14 +73,21 @@ class BaseCheck(BaseModel):
         else:
             return False
 
-    def is_description_populated(self, description: str) -> bool:
+    def _is_description_populated(
+        self, description: str, min_description_length: int | None
+    ) -> bool:
         """Check if a description is populated.
 
         Args:
             description (str): Description.
+            min_description_length (int): Minimum length of the description.
 
         Returns:
             bool: Whether a description is validly populated.
 
         """
-        return len(description.strip()) > 4
+        return is_description_populated(
+            description=description,
+            min_description_length=min_description_length
+            or self._min_description_length,
+        )

dbt_bouncer/checks/catalog/check_catalog_sources.py

@@ -1,8 +1,9 @@
-from typing import TYPE_CHECKING, List, Literal
+from typing import TYPE_CHECKING, Literal
 
 from pydantic import Field
 
 from dbt_bouncer.check_base import BaseCheck
+from dbt_bouncer.checks.common import DbtBouncerFailedCheckError
 
 if TYPE_CHECKING:
     import warnings
@@ -23,13 +24,13 @@ class CheckSourceColumnsAreAllDocumented(BaseCheck):
 
     Receives:
         catalog_source (CatalogNodes): The CatalogNodes object to check.
-        sources (List[DbtBouncerSourceBase]): List of DbtBouncerSourceBase objects parsed from `catalog.json`.
+        sources (list[DbtBouncerSourceBase]): List of DbtBouncerSourceBase objects parsed from `catalog.json`.
 
     Other Parameters:
-        description (Optional[str]): Description of what the check does and why it is implemented.
-        exclude (Optional[str]): Regex pattern to match the source path (i.e the .yml file where the source is configured). Source paths that match the pattern will not be checked.
-        include (Optional[str]): Regex pattern to match the source path (i.e the .yml file where the source is configured). Only source paths that match the pattern will be checked.
-        severity (Optional[Literal["error", "warn"]]): Severity level of the check. Default: `error`.
+        description (str | None): Description of what the check does and why it is implemented.
+        exclude (str | None): Regex pattern to match the source path (i.e the .yml file where the source is configured). Source paths that match the pattern will not be checked.
+        include (str | None): Regex pattern to match the source path (i.e the .yml file where the source is configured). Only source paths that match the pattern will be checked.
+        severity (Literal["error", "warn"] | None): Severity level of the check. Default: `error`.
 
     Example(s):
         ```yaml
@@ -39,12 +40,20 @@ class CheckSourceColumnsAreAllDocumented(BaseCheck):
 
     """
 
-    catalog_source: "CatalogNodes" = Field(default=None)
+    catalog_source: "CatalogNodes | None" = Field(default=None)
     name: Literal["check_source_columns_are_all_documented"]
-    sources: List["DbtBouncerSourceBase"] = Field(default=[])
+    sources: list["DbtBouncerSourceBase"] = Field(default=[])
 
     def execute(self) -> None:
-        """Execute the check."""
+        """Execute the check.
+
+        Raises:
+            DbtBouncerFailedCheckError: If columns are undocumented.
+
+        """
+        if self.catalog_source is None:
+            raise DbtBouncerFailedCheckError("self.catalog_source is None")
+
         source = next(
             s for s in self.sources if s.unique_id == self.catalog_source.unique_id
         )
@@ -53,6 +62,7 @@ class CheckSourceColumnsAreAllDocumented(BaseCheck):
             for _, v in self.catalog_source.columns.items()
             if v.name not in source.columns
         ]
-        assert not undocumented_columns, (
-            f"`{self.catalog_source.unique_id}` has columns that are not included in the sources properties file: {undocumented_columns}"
-        )
+        if undocumented_columns:
+            raise DbtBouncerFailedCheckError(
+                f"`{self.catalog_source.unique_id}` has columns that are not included in the sources properties file: {undocumented_columns}"
+            )