Provide test name and kwargs in test nodes in the manifest

[foundinblank]

Feature

Feature description

In the documentation website, the columns box shows three different types of built-in schema tests: P, U, N (primary key, unique, not_null). But not for the fourth built-in schema test, accepted_values. It also doesn't show any custom schema tests.

Who will this benefit?

Anyone who uses accepted_values and was expecting to see it in their docs site! For custom schema tests, a single letter would need to be defined...or just stuff the name of it into the Tests column. 🙂

Link to code: https://github.com/fishtown-analytics/dbt-docs/blob/master/src/app/docs/model.html#L126-L134

[drewbanin]

This is prioritized for our Wilt Chamberlain release.

If you want to feel sad, have a look at the code responsible for rendering column tests in the docs site. The docs site needs to parse test attributes out of generated test names because dbt is not currently encoding this information in the manifest in a structured way.

In order to delete all of this code, as well as support accepted_values tests, we should add a structured dict to test nodes with the following information:

1. the name of the test macro
2. the arguments supplied to the test macro (represented as a dictionary)

The docs site is going to need to semantically know what unique, not_null, etc mean, but I think that's acceptable for now.

In the future, I'd like to make schema tests capable of generating their own descriptions. This would help us render custom schema test information in the docs site. Out of scope for this particular issue, but worth keeping in mind.

Feature spec:

Include a test_definition: (or similar) field in test nodes which contains:

• the test type
• the kwargs provided to the test

eg:

{
  "name": "unique_stg_close_opportunities_opportunity_id"
  "raw_sql": "{{ test_unique(model=ref('stg_close_opportunities'), column_name='opportunity_id') }}",
  ...
  "test_definition": {
    "test_type": "schema",
    "test": "unique",
    "options": {
      "model": "ref('stg_close_opportunities')"
      "column_name": "opportunity_id"
    }
  }
}

I think ideally, the model option shown here would read as stg_close_opportunities, not ref('stg_close_opportunities'), but I suspect that might be difficult to implement at the present time. Either one is going to be usable (and much better than what we have now!) in the dbt Docs code.

This will enable us to add accepted values to the docs site, as well as clean up some really gnarly code around relationships tests.

For custom data tests, that field should look like:

{
  "name": "unique_stg_close_opportunities_opportunity_id"
  "raw_sql": "select 1 as id",
  ...
  "test_definition": {
    "test_type": "data"
  }
}

[drewbanin]

Kicking this out of Wilt Chamberlain and into Louisa May Alcott

[drewbanin]

fyi the corresponding fix for this in the autogenerated docs site was merged and will be live in 0.15.0

Thanks for the initial request - hope you're doing well @foundinblank :)