puppet-syntax 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 680101f8a3cfb9d6c9c389e8c89f6514107f45ea6a20d067ca82724613ba47de
-  data.tar.gz: 89685e36048969d15ef866c21637be9c41fe89fc71ad3e05298399f0b7192622
+  metadata.gz: 45c8f3b9275ea2f9c7cccb72c2b930a15079ff0618ee55d62d8b3d393ec3f8a1
+  data.tar.gz: 11d6e05a07d6932b9180a9e09eb1e5c7cf47b209c7c935bd4d5635e51ce11bba
 SHA512:
-  metadata.gz: a4b33477972e17a5fd5274bf5767a6ce310a3381359404b1d060f0cf63a7507efd8f4896bf52aad1758f392a7618f64eb0dc30a0b5607406d7c5e7375ab23133
-  data.tar.gz: 5495e81fe81b45bf9e99579320407d9e64cc70fb14cba686e52ad87439feb87a708d1b6230c50e5eafff9afcce3fd620dc57e403628776af4bb06e3404bf6b74
+  metadata.gz: 87e65a0f0e244ee179926e7e9b3904a5f0c77b87b6789a24f98efa18e78a8345312b434c5fbd051c92b9332572b19346a0bddad3623c341b6d9479ec6f55e094
+  data.tar.gz: 2bfd3fae9730595def3f1892a753279a7a081ab9ba4f09f8dafc1c798e7aaf67c469886c1fca22a994274d02343a9d838d90a02c56f16dd0c4b65099c28a9404

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-02-07 19:46:27 UTC using RuboCop version 1.60.2.
+# on 2024-03-08 16:09:27 UTC using RuboCop version 1.61.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -31,6 +31,7 @@ Lint/SuppressedException:
 
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AutoCorrect.
 Lint/UselessAssignment:
   Exclude:
     - 'lib/puppet-syntax/templates.rb'
@@ -73,7 +74,7 @@ RSpec/DescribeClass:
 
 # Offense count: 19
 # This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SkipBlocks, EnforcedStyle.
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
 # SupportedStyles: described_class, explicit
 RSpec/DescribedClass:
   Exclude:
@@ -85,7 +86,7 @@ RSpec/DescribedClass:
 # Offense count: 7
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 14
+  Max: 16
 
 # Offense count: 4
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
@@ -99,7 +100,7 @@ RSpec/FilePath:
 
 # Offense count: 29
 RSpec/MultipleExpectations:
-  Max: 8
+  Max: 10
 
 # Offense count: 30
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
@@ -139,13 +140,12 @@ Rake/Desc:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 2
+# Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, conditionals
 Style/AndOr:
   Exclude:
-    - 'lib/puppet-syntax/manifests.rb'
     - 'lib/puppet-syntax/templates.rb'
 
 # Offense count: 1

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v4.1.0](https://github.com/voxpupuli/puppet-syntax/tree/v4.1.0) (2024-03-12)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v4.0.1...v4.1.0)
+
+**Implemented enhancements:**
+
+- Hiera: Test for wrong interpolation syntax [\#143](https://github.com/voxpupuli/puppet-syntax/pull/143) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v4.0.1](https://github.com/voxpupuli/puppet-syntax/tree/v4.0.1) (2024-03-12)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v4.0.0...v4.0.1)
+
+**Fixed bugs:**
+
+- Raise warning if hiera check is called but disabled [\#165](https://github.com/voxpupuli/puppet-syntax/pull/165) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- Drop Puppet 5.4 check [\#166](https://github.com/voxpupuli/puppet-syntax/pull/166) ([bastelfreak](https://github.com/bastelfreak))
+- README.md: Update required Puppet/Ruby versions [\#164](https://github.com/voxpupuli/puppet-syntax/pull/164) ([bastelfreak](https://github.com/bastelfreak))
+- Update voxpupuli-rubocop requirement from ~\> 2.4.0 to ~\> 2.5.0 [\#163](https://github.com/voxpupuli/puppet-syntax/pull/163) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v4.0.0](https://github.com/voxpupuli/puppet-syntax/tree/v4.0.0) (2024-02-07)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v3.3.0...v4.0.0)

data/README.md

@@ -15,8 +15,8 @@ Hiera YAML.
 
 Puppet::Syntax is supported with:
 
-- Puppet >= 5.0 that provides the `validate` face.
-- Ruby >= 2.4
+- Puppet >= 7.0
+- Ruby >= 2.7
 
 For the specific versions that we test against, see the [GitHub Actions workflow](.github/workflows/test.yml).
 
@@ -85,6 +85,13 @@ This reports common mistakes in key names in Hiera files, such as:
 * Invalid camel casing, such as: `noCamelCase::warning3: true`.
 * Use of hyphens, such as: `no-hyphens::warning4: true`.
 
+
+* To enable a syntax check on Hiera values, set:
+
+```ruby
+PuppetSyntax.check_hiera_data = true
+```
+
 ## Usage
 
 * To enable Puppet::Syntax, include the following in your module's `Rakefile`:
@@ -139,6 +146,21 @@ By default, this rake task looks for all `.yaml` files in a single module under:
 * `hieradata/**/*.yaml`
 * `hiera*.yaml`
 
+It will validate the syntax of each Hiera *key*. for values, it will check if
+the interpolation function syntax is correct. Wrong:
+
+```
+foo:
+  "%{lookup('baz'):3306}": []
+```
+
+correct would be:
+
+```
+foo:
+  "%{lookup('baz')}:3306": []
+```
+
 ### manifests
 
 Checks all `.pp` files in the module for syntax errors.

data/lib/puppet-syntax/hiera.rb

@@ -20,6 +20,16 @@ module PuppetSyntax
       end
     end
 
+    def check_hiera_data(_key, value)
+      # using filter_map to remove nil values
+      # there will be nil values if check_broken_function_call didn't return a string
+      # this is a shorthand for filter.compact
+      # https://blog.saeloun.com/2019/05/25/ruby-2-7-enumerable-filter-map/
+      keys_and_values(value).filter_map do |element|
+        check_broken_function_call(element)
+      end
+    end
+
     # Recurse through complex data structures.  Return on first error.
     def check_eyaml_data(name, val)
       error = nil
@@ -87,6 +97,11 @@ module PuppetSyntax
             key_msg = check_hiera_key(k)
             errors << "WARNING: #{hiera_file}: Key :#{k}: #{key_msg}" if key_msg
           end
+          if PuppetSyntax.check_hiera_data
+            check_hiera_data(k, v).each do |value_msg|
+              errors << "WARNING: #{hiera_file}: Key :#{k}: #{value_msg}"
+            end
+          end
           eyaml_msg = check_eyaml_data(k, v)
           errors << "WARNING: #{hiera_file}: #{eyaml_msg}" if eyaml_msg
         end
@@ -96,5 +111,51 @@ module PuppetSyntax
 
       errors
     end
+
+    private
+
+    # you can call functions in hiera, like this:
+    # "%{lookup('this_is_ok')}"
+    # you can do this in everywhere in a hiera value
+    # you cannot do string concatenation within {}:
+    # "%{lookup('this_is_ok'):3306}"
+    # You can do string concatenation outside of {}:
+    # "%{lookup('this_is_ok')}:3306"
+    def check_broken_function_call(element)
+      'string after a function call but before `}` in the value' if element.is_a?(String) && /%{.+\('.*'\).+}/.match?(element)
+    end
+
+    # gets a hash or array, returns all keys + values as array
+    def flatten_data(data, parent_key = [])
+      if data.is_a?(Hash)
+        data.flat_map do |key, value|
+          current_key = parent_key + [key.to_s]
+          if value.is_a?(Hash) || value.is_a?(Array)
+            flatten_data(value, current_key)
+          else
+            [current_key.join('.'), value]
+          end
+        end
+      elsif data.is_a?(Array) && !data.empty?
+        data.flat_map do |value|
+          if value.is_a?(Hash) || value.is_a?(Array)
+            flatten_data(value, parent_key)
+          else
+            [parent_key.join('.'), value]
+          end
+        end
+      else
+        [parent_key.join('.')]
+      end
+    end
+
+    # gets a string, hash or array, returns all keys + values as flattened + unique array
+    def keys_and_values(value)
+      if value.is_a?(Hash) || value.is_a?(Array)
+        flatten_data(value).flatten.uniq
+      else
+        [value]
+      end
+    end
   end
 end

data/lib/puppet-syntax/manifests.rb

@@ -61,7 +61,7 @@ module PuppetSyntax
     private
 
     def validate_manifest(file)
-      Puppet[:tasks] = true if Puppet::Util::Package.versioncmp(Puppet.version, '5.4.0') >= 0 and file.match(%r{.*plans/.*\.pp$})
+      Puppet[:tasks] = true if %r{.*plans/.*\.pp$}.match?(file)
       Puppet::Face[:parser, :current].validate(file)
     end
   end

data/lib/puppet-syntax/tasks/puppet-syntax.rb

@@ -26,7 +26,7 @@ module PuppetSyntax
     end
 
     def initialize(*_args)
-      desc 'Syntax check Puppet manifests and templates'
+      desc 'Syntax check for Puppet manifests, templates and Hiera'
       task syntax: [
         'syntax:manifests',
         'syntax:templates',
@@ -69,6 +69,7 @@ module PuppetSyntax
         namespace :hiera do
           task :yaml do |t|
             warn "---> #{t.name}"
+            warn "#{t.name} was called, but PuppetSyntax.check_hiera_keys is false. hiera syntax won't be checked" unless PuppetSyntax.check_hiera_keys
             c = PuppetSyntax::Hiera.new
             errors = c.check(filelist_hiera_yaml)
             $stdout.puts "#{errors.join("\n")}\n" unless errors.empty?

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/lib/puppet-syntax.rb

@@ -20,6 +20,7 @@ module PuppetSyntax
   ]
   @fail_on_deprecation_notices = true
   @check_hiera_keys = false
+  @check_hiera_data = false
 
   class << self
     attr_accessor :exclude_paths,
@@ -28,6 +29,7 @@ module PuppetSyntax
                   :templates_paths,
                   :fail_on_deprecation_notices,
                   :epp_only,
-                  :check_hiera_keys
+                  :check_hiera_keys,
+                  :check_hiera_data
   end
 end

data/puppet-syntax.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.14.2'
   spec.add_development_dependency 'rb-readline', '~> 0.5.5'
 
-  spec.add_development_dependency 'voxpupuli-rubocop', '~> 2.4.0'
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 2.5.0'
 end

data/spec/fixtures/hiera/hiera_badkey.yaml

@@ -9,3 +9,9 @@ typical:typo::warning1:   true
 noCamelCase::warning3:    true
 no-hyphens::warning4:     true
 :picky::warning5:         true
+this_is::warning6:
+  "%{lookup('foobar'):3306}": []
+this_is::warning7:
+  - "%{lookup('foobar'):3306}"
+this_is::warning8:
+  foo: "%{lookup('foobar'):3306}"

data/spec/puppet-syntax/hiera_spec.rb

@@ -24,11 +24,12 @@ describe PuppetSyntax::Hiera do
   context 'check_hiera_keys = true' do
     before do
       PuppetSyntax.check_hiera_keys = true
+      PuppetSyntax.check_hiera_data = true
     end
 
     it 'returns warnings for invalid keys' do
       hiera_yaml = 'hiera_badkey.yaml'
-      examples = 5
+      examples = 8
       files = fixture_hiera(hiera_yaml)
       res = subject.check(files)
       (1..examples).each do |n|
@@ -40,6 +41,9 @@ describe PuppetSyntax::Hiera do
       expect(res[2]).to match('Key :noCamelCase::warning3: Not a valid Puppet variable name for automatic lookup')
       expect(res[3]).to match('Key :no-hyphens::warning4: Not a valid Puppet variable name for automatic lookup')
       expect(res[4]).to match('Key :picky::warning5: Puppet automatic lookup will not look up symbols')
+      expect(res[5]).to match('Key :this_is::warning6: string after a function call but before `}` in the value')
+      expect(res[6]).to match('Key :this_is::warning7: string after a function call but before `}` in the value')
+      expect(res[7]).to match('Key :this_is::warning8: string after a function call but before `}` in the value')
     end
 
     it 'returns warnings for bad eyaml values' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 description: Syntax checks for Puppet manifests and templates
 email:
 - voxpupuli@groups.io