puppet-syntax: Validate hiera keys

[bastelfreak]

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:

$ 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:

$ 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:

$ 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:

 @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]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.80%. Comparing base (e3b7546) to head (f5a0016).

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.
📢 Have feedback on the report? Share it here.

[bastelfreak]

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

[gavindidrichsen]

Great idea!