Fix config bug where mockery crashes when package map is nil #730
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
Fixes issue vektra#726. We needed an additional bit of logic to ensure that if the `config` section is nil that we default it to being an empty map.
This commit adds a fix where we create a copy of the top-level config map, instead of using it directly. Previously this situation caused an infinite loop in the map structure, so creating a copy prevents that from happening.
The test wasn't properly initializing the viper object so the config wasn't getting decoded into the struct properly. Also adding more comments to various places to better explain what the code was doing, as even I, the person who wrote it, was confused as to what I was doing. How can I expect other people to understand it if I can't?!
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #730 +/- ##
===================================================
- Coverage 75.44910% 75.25042% -0.19868%
===================================================
Files 9 9
Lines 2338 2396 +58
===================================================
+ Hits 1764 1803 +39
- Misses 438 455 +17
- Partials 136 138 +2
☔ View full report in Codecov by Sentry. |
fix usage of predeclared identifier
Subpackages were not correctly inheriting their parent package configuration.
LandonTClipp
force-pushed
the
issue_726
branch
from
7e216de
to
2dd8f00
Compare
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.
Description
This PR fixes a number of things related to config parsing.
packagesmap contained a package that pointed to a nil value, mocker would crash because it expected the mapping to be non-empty. The PR changes it so that mockery gracefully handles cases like this by lazily injecting aconfigmap into the package.showconfig, or really in any situation where you wanted to serialized the config using a yaml parser. The fix was to do a deep copy of the configuration whenever merging top-level with package-level config.Also moving to using gotestsum for test output. This provides a much cleaner overview of the tests that passed/failed.
Type of change
Version of Golang used when building/testing:
How Has This Been Tested?
Unit test
Checklist