Skip to content

Manifest Checks: Tests#

Note

The below checks require manifest.json to be present.

Classes:

Name Description
CheckTestHasTags

Data tests must have the specified tags.

CheckTestHasTags #

Data tests must have the specified tags.

Parameters:

Name Type Description Default
criteria Literal['any', 'all', 'one'] | None

Whether the test must have any, all, or exactly one of the specified tags. Default: any.

 required
tags list[str]

List of tags to check for.

 required

Receives at execution time:

Name Type Description
test DbtBouncerTestBase

The DbtBouncerTestBase object to check.

Other Parameters (passed via config file):

Name Type Description
description str | None

Description of what the check does and why it is implemented.
exclude str | None

Regex pattern to match the test path. Test paths that match the pattern will not be checked.
include str | None

Regex pattern to match the test path. Only test paths that match the pattern will be checked.
severity Literal['error', 'warn'] | None

Severity level of the check. Default: error.

Example(s): 

manifest_checks:
    - name: check_test_has_tags
      tags:
        - critical

Source code in src/dbt_bouncer/checks/manifest/check_tests.py 
12
13
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
class CheckTestHasTags(BaseCheck):
    """Data tests must have the specified tags.

    Parameters:
        criteria (Literal["any", "all", "one"] | None): Whether the test must have any, all, or exactly one of the specified tags. Default: `any`.
        tags (list[str]): List of tags to check for.

    Receives:
        test (DbtBouncerTestBase): The DbtBouncerTestBase object to check.

    Other Parameters:
        description (str | None): Description of what the check does and why it is implemented.
        exclude (str | None): Regex pattern to match the test path. Test paths that match the pattern will not be checked.
        include (str | None): Regex pattern to match the test path. Only test paths that match the pattern will be checked.
        severity (Literal["error", "warn"] | None): Severity level of the check. Default: `error`.

    Example(s):
        ```yaml
        manifest_checks:
            - name: check_test_has_tags
              tags:
                - critical
        ```

    """

    criteria: Literal["any", "all", "one"] = Field(default="any")
    name: Literal["check_test_has_tags"]
    tags: list[str]
    test: "DbtBouncerTestBase | None" = Field(default=None)

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

        Raises:
            DbtBouncerFailedCheckError: If the test does not have the required tags.

        """
        test = self._require_test()
        test_tags = test.tags or []
        if self.criteria == "any":
            if not any(tag in test_tags for tag in self.tags):
                raise DbtBouncerFailedCheckError(
                    f"`{test.unique_id}` does not have any of the required tags: {self.tags}."
                )
        elif self.criteria == "all":
            missing_tags = [tag for tag in self.tags if tag not in test_tags]
            if missing_tags:
                raise DbtBouncerFailedCheckError(
                    f"`{test.unique_id}` is missing required tags: {missing_tags}."
                )
        elif self.criteria == "one" and sum(tag in test_tags for tag in self.tags) != 1:
            raise DbtBouncerFailedCheckError(
                f"`{test.unique_id}` must have exactly one of the required tags: {self.tags}."
            )