Add JSON formatter for machine-readable output #68
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| for rule, result in results.items(): | ||
| if result is None: | ||
| self._model_results[model.name]["results"][rule.source()] = { | ||
| "result": "OK", |
There was a problem hiding this comment.
Maybe we can make this an Enum or something, so it's clear what are the possible results codes?
There was a problem hiding this comment.
That's a good idea, but given it's also used in the HumanReadableFormatter, this would require a bit of refactoring to have it proper. I suggest to keep it simple for now :)
Co-authored-by: Jochem van Dooren <[email protected]>
jochemvandooren
approved these changes
Aug 8, 2024
Comment on lines
+37
to
+52
| "pass": true, | ||
| "results": { | ||
| "tests.conftest.rule_severity_low": { | ||
| "result": "OK", | ||
| "severity": "low", | ||
| "message": null | ||
| }, | ||
| "tests.conftest.rule_severity_medium": { | ||
| "result": "ERR", | ||
| "severity": "medium", | ||
| "message": "Oh noes" | ||
| }, | ||
| "tests.conftest.rule_severity_critical": { | ||
| "result": "WARN", | ||
| "severity": "critical", | ||
| "message": "Error" |
There was a problem hiding this comment.
Interesting pass considering the rules.result 😁 Not a problem though!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ability to save and use results from dbt-score in other tooling opens new possibilities.
To that end, add a new formatter, which uses
stdoutto print a JSON document displayingdbt-score's results.Example:
$ dbt_score lint -f json { "models": { "model1": { "score": 5.0, "badge": "🥈", "pass": true, "results": { "dbt_score.rules.generic.columns_have_description": { "result": "OK", "severity": "medium", "message": null }, "dbt_score.rules.generic.has_description": { "result": "WARN", "severity": "medium", "message": "Model lacks a description." } } } }, "project": { "score": 5.0, "badge": "🥈" "pass": true } }