(maint) Do not raise NoMethodError on normal env info writing #1148
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
mwaggett
reviewed
Apr 21, 2021
|
This looks good to me, other than my one comment. |
Magisus
approved these changes
Apr 22, 2021
Previously when calling write_environment_info we would call Module#repo to collect the sha, if it existed. However, only git backed modules have this method defined. So the write_environment_info method would cause an exception which it caught and ignored when inspecting any non-git-backed modules. This moves to use the Module#properties method which is well defined for every type of module and has an `:actual` key which matches the value that the write_environment_info used to gather. We do not collect `:actual` key values for any module besides those of type `:git` to match the behavior preivously. This also adds a test for the failure case of the write_environment_info method that was previously untested. I have a feeling that this is no longer needed now that we do not call Module#repo indiscriminantly, however it is included to err on the safe side.
justinstoller
force-pushed
the
maint-no-raise-env-info-writing
branch
from
36e8fc7 to
065b475
Compare
mwaggett
approved these changes
Apr 23, 2021
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.
Previously when calling write_environment_info we would call
Module#repo to collect the sha, if it existed. However, only git backed
modules have this method defined. So the write_environment_info method
would cause an exception which it caught and ignored when inspecting any
non-git-backed modules.
This moves to use the Module#properties method which is well defined for
every type of module and has an
:actualkey which matches the valuethat the write_environment_info used to gather. We do not collect
:actualkey values for any module besides those of type:gittomatch the behavior preivously.
This also adds a test for the failure case of the write_environment_info
method that was previously untested. I have a feeling that this is no
longer needed now that we do not call Module#repo indiscriminantly,
however it is included to err on the safe side.
Please add all notable changes to the "Unreleased" section of the CHANGELOG in the format: