Customizing dbt Test Output Name

[MrsT]

Is there a way to customize the auto-generated dbt test name? By default I see it’s test_name, model name, properties… Can I customize the name myself?

[obar1]

Curious… customize how given those examples ?

[MrsT]

Let’s say for the first one, I just wanted to call it “is_unique” (for example, if I knew it would be the absolutely ONLY place I was calling this test)

(This is for a case where the generated name is extremely long since there are a lot of properties past in. I’d like to truncate the name to make the output easier to parse)

[joellabes]

You can do this by using the name property on the test: https://docs.getdbt.com/reference/resource-properties/tests#define-a-custom-name-for-one-test

[MrsT]

Does that imply that I can use the list_unexpected_properties test, renaming it to contract_unexpected_properties in this particular test? That doesn’t seem to work here. Am I misunderstanding something?

I get a compilation error that the ‘test_contract_unexpected_properties’ is undefined

[joellabes]

This is the example code from the docs:

version: 2

models:
  - name: orders
    columns:
      - name: status
        tests:
          - accepted_values:
              name: unexpected_order_status_today
              values: ['placed', 'shipped', 'completed', 'returned']
              config:
                where: "order_date = current_date"

In your case, you would do something like:

models: 
  - name: contract_schema
    columns: 
      - name: key
        tests:
          - list_unexpected_properties:
              name: contract_unexpected_properties
              value_set: [caseId, billingMethod, ...]

In the code you provided, you’re trying to attach two tests to the key column, a contract_unexpected_properties test with no arguments (like the built-in unique or not_null tests) and a list_unexpected_properties test which has a value_set argument.

[MrsT]

That is beautiful and exactly what I’m looking for. Thank you!

For my own understanding, I don’t see the exact sample code you pasted in the docs you linked. Can you help me find that? It would have made things much clearer for me initially.

[joellabes]

It’s towards the bottom of the page (screenshot below); if you can’t see it, check which version of the docs you’re using (in my screenshot I have v1.3 selected). If you are looking at an old version then it might not show up; I don’t remember when this functionality was added!

[MrsT]

Changing the version did it for me. Good to know that it was on v1.0 by default and I didn’t easily see how to change it. Hopefully, this makes things much clearer going forward.

Thanks again for your help!