Allow data tests to be documented
See original GitHub issueDescribe the feature
Currently, you can document pretty much everything but a data test. You also therefore cannot hide them from the docs site.
Open questions:
- Should they be under a
tests:
key, or adata_tests:
key?
Not much else to say here!
Issue Analytics
- State:
- Created 3 years ago
- Reactions:17
- Comments:7 (4 by maintainers)
Top Results From Across the Web
What is Test Data? Test Data Preparation Techniques with ...
The test data should be selected precisely and it must possess the following four qualities: 1) Realistic: By realistic, it means the data...
Read more >Data quality tests and documenting datasets
Data quality tests in Dataform are called assertions. ... Dataform allows you to add documentation to the datasets defined in your project.
Read more >Test Data Tutorial: A Comprehensive Guide With Examples ...
This Test Data tutorial will cover essential test data, its challenges, processes, best practices, and more. Now let's understand Test Data in depth....
Read more >Standards and Guidelines for Statistical Surveys - SAMHSA
This document provides 20 standards that apply to Federal censuses and surveys whose statistical purposes include the description, estimation, or analysis ...
Read more >Adding Attachments to Tests, Activities, and Issues
Use attachments to store a test's output data for later analysis. Overview. Tests often produce output such as files, images, screenshots, and data...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I think the ticket activity doesn’t reflect the demand for this feature, there has been at least 6 users asking about in on Slack this past year: https://getdbt.slack.com/archives/CBSQTAPLG/p1631304882432300
It might be because the wording used in the ticket has changed: schema test → generic test data test → singular test
I think custom tests are code as much as models and macros are, so documenting them is equally important.
IMO, having the static description as is in written in the YAML without replacing the values would already be nice and useful, the more complex version could be kept for later.
I would say that for me a
tests:
label would imply all kind of tests, including schema tests, but looking at the current naming it looks like the most reasonable. Current names related to tests:tests
folder, not data-testsdbt_project
we specify a folder fortest-paths
, not data-test-paths