Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Test description empty in manifest.json #10272

Closed
2 tasks done
siljamardla opened this issue Jun 7, 2024 · 1 comment
Closed
2 tasks done

[Bug] Test description empty in manifest.json #10272

siljamardla opened this issue Jun 7, 2024 · 1 comment
Labels
bug Something isn't working dbt tests Issues related to built-in dbt testing functionality duplicate This issue or pull request already exists

Comments

@siljamardla
Copy link

Is this a new bug in dbt-core?

  • I believe this is a new bug in dbt-core
  • I have searched the existing issues, and I could not find an existing issue for this bug

Current Behavior

I have defined a custom test and I have documented the test in YML like this:

tests:
  - name: my_custom_test
    description: >
      Some business description about my custom test
    meta:
      owner: '@silja.mardla'

However, the description does not show up in the dbt-genarted doc site.
So I searched the manifest.json for this test and it looks like the description and meta are empty in the manifest. I've shortened it a bit, but this is how the relevant parts look like:

"test.common.my_custom_test":{
   "database":"XXX",
   "schema":"dbt_test__audit",
   "name":"my_custom_test",
   "resource_type":"test",
   "package_name":"common",
   "path":"my_custom_test.sql",
   "original_file_path":"tests/my_custom_test.sql",
   "unique_id":"test.common.my_custom_test",

   ...   

      "meta":{
         
      },
      "group":null,
      "materialized":"test",
      "severity":"ERROR",
      "store_failures":null,
      "store_failures_as":null,
      "where":null,
      "limit":null,
      "fail_calc":"count(*)",
      "warn_if":"!= 0",
      "error_if":"!= 0"
   },
   "tags":[
      
   ],
   "description":"",
   "columns":{
      
   },
   "meta":{
      
   },
   "group":null,
   "docs":{
      "show":true,
      "node_color":null
   },
  ...

Expected Behavior

Tests can be documented like any other dbt asset.

Steps To Reproduce

Add test description and meta in a YML file and check the manifest to see if the description is there.

Relevant log output

No response

Environment

- OS: MacOS
- Python:
- dbt: 1.7.9

Which database adapter are you using with dbt?

spark

Additional Context

No response

@siljamardla siljamardla added bug Something isn't working triage labels Jun 7, 2024
@dbeatty10 dbeatty10 added the dbt tests Issues related to built-in dbt testing functionality label Jun 7, 2024
@dbeatty10
Copy link
Contributor

Thanks for reaching out about this @siljamardla !

We've already got some similar issues open, so I'm going to close this one as a dupe. Here are the pre-existing issues:

@dbeatty10 dbeatty10 closed this as not planned Won't fix, can't repro, duplicate, stale Jun 9, 2024
@dbeatty10 dbeatty10 added duplicate This issue or pull request already exists and removed triage labels Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dbt tests Issues related to built-in dbt testing functionality duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants