puppet-syntax: Validate hiera keys #441
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
For a long time puppet-syntax has support to validate hiera keys and eyaml. We should use this functionality. https://github.com/voxpupuli/puppet-syntax?tab=readme-ov-file#configuration From my local testing. The default output: ```terminal $ bundle exec rake syntax ---> syntax:manifests ---> syntax:templates ---> syntax:hiera:yaml ``` Now that's a bug in puppet-syntax. It always prints the subtasks, even if they aren't executed. If I break a hiera data file: ```diff $ git diff data/common.yaml diff --git a/data/common.yaml b/data/common.yaml index ad8bb3d..4243024 100644 --- a/data/common.yaml +++ b/data/common.yaml @@ -19,5 +19,5 @@ lookup_options: merge: 'unique' # Default is currently yum path -yum::plugin::versionlock::path: /etc/yum/pluginconf.d/versionlock.list +::yum::plugin::versionlock::path: /etc/yum/pluginconf.d/versionlock.list yum::settings::mainconf: /etc/yum.conf ``` I get the following output: ```terminal $ bundle exec rake syntax ---> syntax:manifests ---> syntax:templates ---> syntax:hiera:yaml WARNING: data/common.yaml: Key ::yum::plugin::versionlock::path: Puppet automatic lookup will not use leading '::' ``` by default puppet-syntax uses the following paths for hiera files: ```ruby @hieradata_paths = [ '**/data/**/*.*{yaml,yml}', 'hieradata/**/*.*{yaml,yml}', 'hiera*.*{yaml,yml}', ] ``` https://github.com/voxpupuli/puppet-syntax/blob/master/lib/puppet-syntax.rb#L9-L13
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #441 +/- ##
==========================================
+ Coverage 41.71% 41.80% +0.08%
==========================================
Files 10 10
Lines 676 677 +1
==========================================
+ Hits 282 283 +1
Misses 394 394 ☔ View full report in Codecov by Sentry. |
rwaffen
approved these changes
Mar 8, 2024
|
There's also a related PR in puppet-syntax to print a warning if the hiera check is called but disabled: voxpupuli/puppet-syntax#165 |
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.
For a long time puppet-syntax has support to validate hiera keys and eyaml. We should use this functionality.
https://github.com/voxpupuli/puppet-syntax?tab=readme-ov-file#configuration
From my local testing. The default output:
Now that's a bug in puppet-syntax. It always prints the subtasks, even if they aren't executed.
If I break a hiera data file:
I get the following output:
by default puppet-syntax uses the following paths for hiera files:
https://github.com/voxpupuli/puppet-syntax/blob/master/lib/puppet-syntax.rb#L9-L13