dbt-unittest

This is a dbt package to enhance dbt package development by providing unit testing macros.

• Installation Instructions
• Requirements
• Macros in the dbt package
  • assert_true
  • assert_false
  • assert_is_none
  • assert_is_not_none
  • assert_equals
  • assert_not_equals
  • assert_in
  • assert_not_in
  • assert_list_equals
  • assert_dict_equals
  • Comparison macros
    • equals
    • not_equals
    • contains
    • not_in
    • is_true
    • is_false
    • is_none
    • is_not_none
    • list_equals
    • dict_equals

Installation Instructions

Check dbt Hub for the latest installation instructions.

Requirements

• dbt-core: 1.0.0 or later

Macros in the dbt package

assert_true

Test that expr is true.

Usage:

  {{ dbt_unittest.assert_true(true) }}
  {{ dbt_unittest.assert_true(1 == 1) }}

assert_false

Test that expr is false.

Usage:

  {{ dbt_unittest.assert_false(false) }}
  {{ dbt_unittest.assert_false(1 != 1) }}

assert_is_none

Test that expr is None.

Usage:

  {{ dbt_unittest.assert_is_none(none) }}

assert_is_not_none

Test that expr is not None.

Usage:

  {{ dbt_unittest.assert_is_not_none(none) }}

assert_equals

Test that first and second are equal. If the values do not compare equal, the test will fail.

Usage:

  {{ dbt_unittest.assert_equals("foo", "bar") }}

assert_not_equals

Test that first and second are not equal. If the values do compare equal, the test will fail.

Usage:

  {{ dbt_unittest.assert_not_equals("foo", "bar") }}

assert_in

Test that member is in container.

Usage:

  {{ dbt_unittest.assert_in(1, [1, 2, 3]) }}

assert_not_in

Test that member is not in container.

Usage:

  {{ dbt_unittest.assert_not_in(4, [1, 2, 3]) }}

assert_list_equals

Tests that two lists are equal.

Usage:

  {{ dbt_unittest.assert_list_equals([1, 2, 3], [4, 5]) }}

assert_dict_equals

Test that two dictionaries are equal.

Usage:

  {{ dbt_unittest.assert_dict_equals({"k": 1}, {"k": 1}) }}

Comparison macros

equals

Return true if two values are equal.

Usage:

  {% set result = dbt_unittest.equals(1, 1) %}

not_equals

Return true if two values are not equal.

Usage:

  {% set result = dbt_unittest.not_equals(1, 2) %}

contains

Return true if a value exists within a collection.

Usage:

  {% set result = dbt_unittest.contains(1, [1, 2, 3]) %}

not_in

Return true if a value does not exist within a collection.

Usage:

  {% set result = dbt_unittest.not_in(4, [1, 2, 3]) %}

is_true

Return true when the value is strictly true.

Usage:

  {% set result = dbt_unittest.is_true(true) %}

is_false

Return true when the value is strictly false.

Usage:

  {% set result = dbt_unittest.is_false(false) %}

is_none

Return true if the value is None.

Usage:

  {% set result = dbt_unittest.is_none(none) %}

is_not_none

Return true if the value is not None.

Usage:

  {% set result = dbt_unittest.is_not_none(1) %}

list_equals

Return true if two lists are equal. Lists may contain nested lists or dictionaries.

Usage:

  {% set result = dbt_unittest.list_equals([1, 2], [1, 2]) %}

dict_equals

Return true if two dictionaries are equal. Dictionaries may contain nested dictionaries or lists.

Usage:

  {% set result = dbt_unittest.dict_equals({'a': 1}, {'a': 1}) %}

Contributors

Yu Ishikawa

Doug Beatty

Ernesto Ongaro

Ryan Hill