(GH-26) Refactor workspace detection for control repos and modules #29
Conversation
This file contains hidden or 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
glennsarti
force-pushed
the
gh-26-puppet-lint-in-control-repos
branch
2 times, most recently
from
d55d7dd to
5b3b3c0
Compare
Previously the --local-workspace option was mostly ignored in the puppetfile validation. However this has caused problems when validating inside control repositories which do not have a metadata.json file (instead it's Puppetfile). This commit refactors the workspace detection out of the puppetfile validation and moves it into the Document Store. This commit also adds a simple timed based caching mechanism to reduce File IO as it can be exercised vigourously when users are typing and validation is occuring very often. An arbitrary value of 60 seconds was chosen the TTL of the cache. This means that after 60 seconds the workspace will be re-evaluated to make sure the user is still in a module (metadata.json) or control repo (Puppetfile).
…rmation This commit adds integeration tests for the caching mechanism used in the workspace.
glennsarti
force-pushed
the
gh-26-puppet-lint-in-control-repos
branch
from
cad215a to
ac714a4
Compare
glennsarti
changed the title
glennsarti
force-pushed
the
gh-26-puppet-lint-in-control-repos
branch
from
ac714a4 to
d93f66a
Compare
michaeltlombardi
approved these changes
Jun 1, 2018
While Pathname is a great utility it is not supported cross platform > ... however non-Unix pathnames are supported experimentally. ... [1] This commit changes; * The usage of Pathname back to core Dir and File classes * Adds a helper method dir_exists? to make testing easier * Fixes the file_exist? method to check if the thing that exists is actually not a directory * Adds tests to ensure the directory traversing terminates correctly [1] http://ruby-doc.org/stdlib-2.1.9/libdoc/pathname/rdoc/Pathname.html
…tion Now that the workspace root detection has been moved from the manifest validator to the Document Store, the manifest validator can use the new methods. This commit; * Updates the validator to use the new Document Store root path detection * Removes redundant method from the validator * Removes the workspace argument as it's no longer required * Updates all call-sites and tests with the removal of the workspace argument
glennsarti
force-pushed
the
gh-26-puppet-lint-in-control-repos
branch
from
d93f66a to
d259969
Compare
michaeltlombardi
approved these changes
Jun 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 the --local-workspace option was mostly ignored in the puppetfile
validation. However this has caused problems when validating inside control
repositories which do not have a metadata.json file (instead it's Puppetfile).
This commit refactors the workspace detection out of the puppetfile validation
and moves it into the Document Store.
This commit also adds a simple timed based caching mechanism to reduce File IO
as it can be exercised vigourously when users are typing and validation is
occuring very often. An arbitrary value of 60 seconds was chosen the TTL of the
cache. This means that after 60 seconds the workspace will be re-evaluated to
make sure the user is still in a module (metadata.json) or control repo
(Puppetfile).
Now that the workspace root detection has been moved from the manifest validator
to the Document Store, the manifest validator can use the new methods. This
commit;