Fix dbt deps failing on tarballs #9068
Merged
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
This test was written _after_ the fix was commited. However, I ran this test against main without the fix and it failed. After running the test with the tarball fix, it passed.
…date` We had a conditional to skip validation for a package if the package included the `tarball` key. However, this conditional always returned false as it was nested inside a conditional that the package had the default `package` key, which means it's not a tarball package, but a package package (maybe we need better differentiation here). If we need additional validation for tarballs down the road, we should do that one level up. At this time we have no additional validaitons to add.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9068 +/- ##
==========================================
+ Coverage 86.56% 86.60% +0.03%
==========================================
Files 179 179
Lines 26538 26538
==========================================
+ Hits 22973 22983 +10
+ Misses 3565 3555 -10
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Thanks for removing the logic that's not needed! |
martynydbt
requested review from
ChenyuLInx
and removed request for
ChenyuLInx
emmyoop
approved these changes
Nov 14, 2023
We initially included this fixture due to copy and pasting another test. However, this `setUp` fixture isn't actually necessary for the tarball dependency tests.
github-actions bot
pushed a commit
that referenced
this pull request
Nov 14, 2023
* tarball lockfile fix * Add changie doc for tarball deps issue * Add integration test for ensuring tarball package specification works This test was written _after_ the fix was commited. However, I ran this test against main without the fix and it failed. After running the test with the tarball fix, it passed. * Remove unnecessary `tarball` conditional logic in `PackageConfig.validate` We had a conditional to skip validation for a package if the package included the `tarball` key. However, this conditional always returned false as it was nested inside a conditional that the package had the default `package` key, which means it's not a tarball package, but a package package (maybe we need better differentiation here). If we need additional validation for tarballs down the road, we should do that one level up. At this time we have no additional validaitons to add. * Fix typos in changie doc for tarball deps issue * Improve tarball package test naming and add related unhappy path test * Remove unnecessary `setUp` fixture from tarball package tests We initially included this fixture due to copy and pasting another test. However, this `setUp` fixture isn't actually necessary for the tarball dependency tests. --------- Co-authored-by: Chenyu Li <chenyu.li@dbtlabs.com> (cherry picked from commit 017faf4)
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.
resolves #9062
Problem
In 1.7.x it's default behavior for a
packages-lock.ymlto be produced when runningdbt deps. However, ourto_dictfunction on tarball packages tries to produces fields which don't actually exist (and are thus populated withNone), and drop some of the required fields 😬 Thus when we try to parse thepackages-lock.ymlthe process blows up 😅 Specifically it raises aDbtProjectErrorsaying thepackages.ymlis malformed. However the error is really that we mangled thepackages-lock.yml, and thus the yaml can't be used to produce the python object representation of the tarball package.Solution
We corrected the
to_dictfunction for tarball packages.Checklist