question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Allow data tests to be documented

See original GitHub issue

Describe 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 a data_tests: key?

Not much else to say here!

Issue Analytics

  • State:open
  • Created 3 years ago
  • Reactions:17
  • Comments:7 (4 by maintainers)

github_iconTop GitHub Comments

9reactions
NicolasPAcommented, Aug 30, 2022

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.

@jtcohen6: I think a new tests: key in .yml files is exactly how we’d want to do this. Singular tests wouldn’t be too hard. Generic tests would be trickier, since the good version (IMO) allows for templated descriptions that includes the values of {{ model }}, {{ column_name }}, and potentially other arguments.

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.

1reaction
RobMcZagcommented, Oct 19, 2020

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:

  • data tests are in the tests folder, not data-tests
  • in dbt_projectwe specify a folder for test-paths, not data-test-paths
Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found