Skip to content

Commit

Permalink
Suggested updates from Ganz
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeatty10 committed Oct 23, 2024
1 parent 69715ac commit 8488b99
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions website/docs/docs/build/unit-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ With dbt Core v1.8 and dbt Cloud environments that have gone versionless by sele
- Unit tests must be defined in a YML file in your `models/` directory.
- Table names must be [aliased](/docs/build/custom-aliases) in order to unit test `join` logic.
- Redshift customers need to be aware of a [limitation when building unit tests](/reference/resource-configs/redshift-configs#unit-test-limitations) that requires a workaround.
- All references (`ref()`) used in your model must be included in the unit test configuration as input fixtures, even if they do not directly affect the logic being tested. If these references are missing, you may encounter "node not found" errors during compilation.

Read the [reference doc](/reference/resource-properties/unit-tests) for more details about formatting your unit tests.

Expand Down Expand Up @@ -56,6 +57,8 @@ Use the [resource type](/reference/global-configs/resource-type) flag `--exclude

## Unit testing a model

When defining mock data for a unit test, it's crucial to include all necessary input values that satisfy the entire model logic. This means including values that fulfill any `WHERE` clauses, `JOIN` conditions, or other constraints present in the model, even if they do not seem directly related to the specific logic being tested. Failing to do so may lead to errors or unexpected null values in the unit test results.

This example creates a new `dim_customers` model with a field `is_valid_email_address` that calculates whether or not the customer’s email is valid:

<file name='dim_customers.sql'>
Expand Down Expand Up @@ -319,6 +322,36 @@ Exit codes differ from data test success and failure outputs because they don't
Learn about [exit codes](/reference/exit-codes) for more information.


### Common Pitfalls

Check warning on line 325 in website/docs/docs/build/unit-tests.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/build/unit-tests.md#L325

[custom.SentenceCaseHeaders] 'Common Pitfalls' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'Common Pitfalls' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/build/unit-tests.md", "range": {"start": {"line": 325, "column": 5}}}, "severity": "WARNING"}
> - **Missing Fixtures for Referenced Models**: When creating a unit test, all referenced models must be declared as mock inputs. Missing any referenced model, even if it isn't directly involved in the specific logic being tested, will lead to compilation errors such as "node not found."
> - **Not Satisfying `WHERE` or `JOIN` Logic**: Ensure that the mock data meets all conditions in the model, such as `WHERE` clauses or `JOIN` requirements. If these conditions are not met, the unit test will either return null rows or fail to execute properly. This often involves adding rows for auxiliary data tables, like locations or transactions, to satisfy joins and filters.

### How Unit Tests Compile

Check warning on line 329 in website/docs/docs/build/unit-tests.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/build/unit-tests.md#L329

[custom.SentenceCaseHeaders] 'How Unit Tests Compile' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'How Unit Tests Compile' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/build/unit-tests.md", "range": {"start": {"line": 329, "column": 5}}}, "severity": "WARNING"}
> During a unit test, dbt creates Common Table Expressions (CTEs) for all dependencies of the model using the mock input data you provide. These CTEs replace the actual references (`ref()`) in the model and allow dbt to run your SQL logic against the mock data.
>
> For example, when you provide a reference such as `ref('stg_transactions')`, dbt creates a CTE named `__dbt__cte__stg_transactions` that contains the mocked data. The entire compiled SQL might look something like this:
> ```sql
> with
> __dbt__cte__stg_transactions as (
> -- fixture for stg_transactions
> -- contains unions to create "test inputs" corresponding to all rows
> ),
> __dbt__cte__stg_locations as (
> -- fixture for stg_locations
> -- contains select statement that "mocks" stg_locations
> ),
> applied_donations as (
> select
> transaction_id,
> sum(cash_value) as donated_cash
> from __dbt__cte__stg_donations
> group by transaction_id
> )
> select * from __dbt__cte__stg_transactions;
> ```
> Understanding this process will help ensure you configure your unit tests correctly and avoid common issues.


## Additional resources

- [Unit testing reference page](/reference/resource-properties/unit-tests)
Expand Down

0 comments on commit 8488b99

Please sign in to comment.