(GH-768) Fix in_module_root? gives false positives #783
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
Previously the module root detection used the bare `lib` directory to detect if a user was in a module root, without a metadata.json. However this caused false positives as `lib` is a very common directory. For example when in a ruby gem project. This commit modifies the detect to use more puppet specific paths: * lib/puppet * lib/facter * lib/puppet_x This commit also adds tests for these folder directories, and uses the PDK Filesystem abstraction classes.
Previously the module root detection was changed to not detect the bare `lib` directory however this caused many of the unit tests to fail as it was detecting the PDK gem as a valid module (which it is not). This commit adds an empty module root fixture and mocks the various tests use this as the module root.
Previously the `ensure_in_module!` tests tested for the various module directories (lib, tasks and so on). However this is really just duplicating the tests for `in_module_root?` which is not required. This commit removes these tests and just mocks the response from `in_module_root?`. This results in no loss of test coverage.
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.
Fixes #768
Previously the module root detection used the bare
libdirectory to detect ifa user was in a module root, without a metadata.json. However this caused
false positives as
libis a very common directory. For example when in a rubygem project. This commit modifies the detect to use more puppet specific paths:
This commit also adds tests for these folder directories, and uses the PDK
Filesystem abstraction classes.