Skip to content

Manifest Checks: Metadata#

Note

The below checks require manifest.json to be present.

Classes:

Name Description
CheckProjectName

Enforce that the name of the dbt project matches a supplied regex. Generally used to enforce that project names conform to something like company_<DOMAIN>.

CheckProjectName #

Enforce that the name of the dbt project matches a supplied regex. Generally used to enforce that project names conform to something like company_<DOMAIN>.

Parameters:

Name Type Description Default
project_name_pattern str

Regex pattern to match the project name.

 required

Receives at execution time:

Name Type Description
manifest_obj DbtBouncerManifest

The manifest object.

Other Parameters (passed via config file):

Name Type Description
description str | None

Description of what the check does and why it is implemented.
severity Literal['error', 'warn'] | None

Severity level of the check. Default: error.

Example(s): 

manifest_checks:
    - name: check_project_name
      project_name_pattern: ^awesome_company_

Source code in src/dbt_bouncer/checks/manifest/check_metadata.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class CheckProjectName(BaseCheck):
    """Enforce that the name of the dbt project matches a supplied regex. Generally used to enforce that project names conform to something like  `company_<DOMAIN>`.

    Parameters:
        project_name_pattern (str): Regex pattern to match the project name.

    Receives:
        manifest_obj (DbtBouncerManifest): The manifest object.

    Other Parameters:
        description (str | None): Description of what the check does and why it is implemented.
        severity (Literal["error", "warn"] | None): Severity level of the check. Default: `error`.

    Example(s):
        ```yaml
        manifest_checks:
            - name: check_project_name
              project_name_pattern: ^awesome_company_
        ```

    """

    model_config = ConfigDict(extra="forbid")

    description: str | None = Field(
        default=None,
        description="Description of what the check does and why it is implemented.",
    )
    index: int | None = Field(
        default=None,
        description="Index to uniquely identify the check, calculated at runtime.",
    )
    manifest_obj: "DbtBouncerManifest | None" = Field(default=None)
    name: Literal["check_project_name"]
    package_name: str | None = Field(default=None)
    project_name_pattern: str
    severity: Literal["error", "warn"] | None = Field(
        default="error",
        description="Severity of the check, one of 'error' or 'warn'.",
    )

    _compiled_project_name_pattern: re.Pattern[str] = PrivateAttr()

    def model_post_init(self, __context: object) -> None:
        """Compile the regex pattern once at initialisation time."""
        self._compiled_project_name_pattern = compile_pattern(
            self.project_name_pattern.strip()
        )

    def execute(self) -> None:
        """Execute the check.

        Raises:
            DbtBouncerFailedCheckError: If project name does not match regex.

        """
        if self.manifest_obj is None:
            raise DbtBouncerFailedCheckError("self.manifest_obj is None")

        package_name = (
            self.package_name or self.manifest_obj.manifest.metadata.project_name
        )
        if (
            self._compiled_project_name_pattern.match(
                str(package_name),
            )
            is None
        ):
            raise DbtBouncerFailedCheckError(
                f"Project name (`{package_name}`) does not conform to the supplied regex `({self.project_name_pattern.strip()})`."
            )