puppet-syntax 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a8ea5b2dd10a9474032154b4716a5a51d59c2f
-  data.tar.gz: 620bbfbea83b5fedeb8d1e34161b2b08d0afad38
+  metadata.gz: 6606744a1866c599818bf66f5049dd0fdafeaa68
+  data.tar.gz: 353c86d96ce6356fa46fddcbb66eb8429ee81a3a
 SHA512:
-  metadata.gz: cc7eeb21577dd0ad6b0ce2b72f0fd207c44b40d35eba98f6108c2d133f53976d4b66a6896acd44e6278e56f3cf736efa3ac410ec530ce1faf1d1b7a1e14199f2
-  data.tar.gz: 4dedf7bfd033d33b8b7404234717e36b1c5e1d0c8e38c8e39f4d7d1f12fd487238a33d53af56ff9cc03279e561be20649f264b48599893868d9267655b059bc9
+  metadata.gz: 3ea3d4e1c1f63a3f7f92dcd1d99e3401004c3e6eec01036d2227f0127b45d01a7790f58f9147b4f9d172649aa4264aed100da2e9a822179f5b68b6363616de85
+  data.tar.gz: e50e01a78dcf9b35ee36be7866e1328ab39df08dbab5d45f45a7bdcd4ef06e9ffdc5149df7227dbf92f8e461be9b92f23c84d231b07e410a20ac401963259a0e

data/.travis.yml

@@ -12,7 +12,9 @@ rvm:
 env:
   - PUPPET_VERSION="~> 3.8.7"
   - PUPPET_VERSION="~> 4.8.0"
+  - PUPPET_VERSION="~> 4.9.0"
   - PUPPET_VERSION=">= 0"
+  - PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
 matrix:
   exclude:
     - env: PUPPET_VERSION="~> 3.8.7"
@@ -21,9 +23,16 @@ matrix:
       rvm: 2.3.3
     - env: PUPPET_VERSION="~> 3.8.7"
       rvm: 2.4.0
+    # 4.9 with Ruby 1.9.3 issues deprecation warnings
+    - env: PUPPET_VERSION="~> 4.9.0"
+      rvm: 1.9.3
+    - env: PUPPET_VERSION=">= 0"
+      rvm: 1.9.3
+    - env: PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
+      rvm: 1.9.3
   allow_failures:
     - env: PUPPET_VERSION=">= 0"
-
+    - env: PUPPET_VERSION="git://github.com/puppetlabs/puppet.git#master"
 deploy:
   provider: rubygems
   api_key:

data/CHANGELOG

@@ -1,3 +1,9 @@
+2017-03-14 Release 2.4.0
+- Add check_hiera_keys flag for deep checking of Hiera key name correctness. Thanks @petems.
+- Fix Puppet version comparisons for compatibility with Puppet 4.10.
+- Fix app_management setting compatibility with Puppet 5.
+- Refactor PUPPETVERSION usage to Puppet.version public API.
+
 2017-01-30 Release 2.3.0
 - Add app_management flag for Puppet application orchestration support. Thanks @ipcrm.
 - Check all *yaml file extensions, including eyaml. thanks @kjetilho, @rjw1.

data/Gemfile

@@ -1,11 +1,24 @@
 source 'https://rubygems.org'
 
+# Find a location or specific version for a gem. place_or_version can be a
+# version, which is most often used. It can also be git, which is specified as
+# `git://somewhere.git#branch`. You can also use a file source location, which
+# is specified as `file://some/location/on/disk`.
+def location_for(place_or_version, fake_version = nil)
+  if place_or_version =~ /^(git[:@][^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place_or_version =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place_or_version, { :require => false }]
+  end
+end
+
 # Specify your gem's dependencies in puppet-syntax.gemspec
 gemspec
 
 # Override gemspec for CI matrix builds.
-puppet_version = ENV['PUPPET_VERSION'] || '>2.7.0'
-gem 'puppet', puppet_version
+gem 'puppet', *location_for(ENV['PUPPET_VERSION'] || '>2.7.0')
 
 # older version required for ruby 1.9 compat, as it is pulled in as dependency of puppet, this has to be carried by the module
 gem 'json_pure', '<= 2.0.1'

data/README.md

@@ -97,10 +97,23 @@ If you are trying to validate the syntax of code written for application orchest
 
     PuppetSyntax.app_management = true
 
+`app_management` is supported on Puppet 4.3 or higher, defaulting to off. On Puppet 5, it is always enabled.
+
 Deprecation notices will cause a failure by default, you can override this functionality by setting:
 
     PuppetSyntax.fail_on_deprecation_notices = false
 
+Common mistakes in key names in Hiera files will be reported:
+
+- Leading :: in keys eg. `::notsotypical::warning2: true`
+- Single colon scope seperators eg. `:picky::warning5: true`
+- Invalid camel casing eg. `noCamelCase::warning3: true`
+- Use of hyphens eg. `no-hyphens::warning4: true`
+
+This can be enabled by setting
+
+    PuppetSyntax.check_hiera_keys = true
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/puppet-syntax.rb

@@ -2,15 +2,32 @@ require "puppet-syntax/version"
 require "puppet-syntax/manifests"
 require "puppet-syntax/templates"
 require "puppet-syntax/hiera"
+require "puppet/version"
 
 module PuppetSyntax
   @exclude_paths = []
   @future_parser = false
-  @hieradata_paths = ["**/data/**/*.*yaml", "hieradata/**/*.*yaml", "hiera*.*yaml"]
+  @hieradata_paths = [
+    "**/data/**/*.*yaml",
+    "hieradata/**/*.*yaml",
+    "hiera*.*yaml"
+  ]
   @fail_on_deprecation_notices = true
-  @app_management = false
+  @app_management = Puppet.version.to_i >= 5 ? true : false
+  @check_hiera_keys = false
 
   class << self
-    attr_accessor :exclude_paths, :future_parser, :hieradata_paths, :fail_on_deprecation_notices, :epp_only, :app_management
+    attr_accessor :exclude_paths,
+                  :future_parser,
+                  :hieradata_paths,
+                  :fail_on_deprecation_notices,
+                  :epp_only,
+                  :check_hiera_keys
+    attr_reader :app_management
+
+    def app_management=(app_management)
+      raise 'app_management cannot be disabled on Puppet 5 or higher' if Puppet.version.to_i >= 5 && !app_management
+      @app_management = app_management
+    end
   end
 end

data/lib/puppet-syntax/hiera.rb

@@ -2,6 +2,24 @@ require 'yaml'
 
 module PuppetSyntax
   class Hiera
+
+    def check_hiera_key(key)
+      if key.is_a? Symbol
+        if key.to_s.start_with?(':')
+          return "Puppet automatic lookup will not use leading '::'"
+        elsif key !~ /^[a-z]+$/ # we allow Hiera's own configuration
+          return "Puppet automatic lookup will not look up symbols"
+        end
+      elsif key !~ /^[a-z][a-z0-9_]+(::[a-z][a-z0-9_]+)*$/
+        if key =~ /[^:]:[^:]/
+          # be extra helpful
+          return "Looks like a missing colon"
+        else
+          return "Not a valid Puppet variable name for automatic lookup"
+        end
+      end
+    end
+
     def check(filelist)
       raise "Expected an array of files" unless filelist.is_a?(Array)
 
@@ -9,11 +27,20 @@ module PuppetSyntax
 
       filelist.each do |hiera_file|
         begin
-          YAML.load_file(hiera_file)
+          yamldata = YAML.load_file(hiera_file)
         rescue Exception => error
           errors << "ERROR: Failed to parse #{hiera_file}: #{error}"
+          next
+        end
+        if yamldata
+          yamldata.each do |k,v|
+            if PuppetSyntax.check_hiera_keys
+              key_msg = check_hiera_key(k)
+              errors << "WARNING: #{hiera_file}: Key :#{k}: #{key_msg}" if key_msg
+            end
+          end
         end
-       end
+      end
 
       errors.map! { |e| e.to_s }
 

data/lib/puppet-syntax/manifests.rb

@@ -58,8 +58,8 @@ module PuppetSyntax
 
     private
     def validate_manifest(file)
-      Puppet[:parser] = 'future' if PuppetSyntax.future_parser and Puppet::PUPPETVERSION.to_i < 4
-      Puppet[:app_management] = true if PuppetSyntax.app_management and Puppet::PUPPETVERSION.to_f >= 4.3
+      Puppet[:parser] = 'future' if PuppetSyntax.future_parser and Puppet.version.to_i < 4
+      Puppet[:app_management] = true if PuppetSyntax.app_management && (Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0 && Puppet.version.to_i < 5)
       Puppet::Face[:parser, :current].validate(file)
     end
   end

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

@@ -48,13 +48,13 @@ to puppetlabs_spec_helper >= 0.8.0 which now uses puppet-syntax.
 
         desc 'Syntax check Puppet manifests'
         task :manifests do |t|
-          if Puppet::PUPPETVERSION.to_i >= 4 and PuppetSyntax.future_parser
+          if Puppet.version.to_i >= 4 and PuppetSyntax.future_parser
             $stderr.puts <<-EOS
 [INFO] Puppet 4 has been detected and `future_parser` has been set to
 'true'. The `future_parser setting will be ignored.
             EOS
           end
-          if Puppet::PUPPETVERSION.to_f < 4.3 and PuppetSyntax.app_management
+          if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') < 0 and PuppetSyntax.app_management
             $stderr.puts <<-EOS
 [WARNING] Puppet `app_management` has been detected but the Puppet
 version is less then 4.3.  The `app_management` setting will be ignored.

data/lib/puppet-syntax/templates.rb

@@ -27,7 +27,7 @@ module PuppetSyntax
     end
 
     def validate_epp(filename)
-      if Puppet::PUPPETVERSION.to_f < 3.7
+      if Puppet.version.to_f < 3.7
         raise "Cannot validate EPP without Puppet 4 or future parser (3.7+)"
       end
 

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/puppet-syntax.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rake"
 
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
   spec.add_development_dependency "gem_publisher", "~> 1.3"
 end

data/spec/fixtures/hiera/hiera_badkey.yaml

@@ -0,0 +1,11 @@
+---
+this_is_ok: 0
+this_is_ok::too: 0
+th1s_is_ok::two3: 0
+:eventhis: 0
+
+typical:typo::warning1:   true
+::notsotypical::warning2: true
+noCamelCase::warning3:    true
+no-hyphens::warning4:     true
+:picky::warning5:         true

data/spec/puppet-syntax/hiera_spec.rb

@@ -21,4 +21,34 @@ describe PuppetSyntax::Hiera do
     expect(res.size).to be == 1
     expect(res.first).to match(expected)
   end
+
+  context 'check_hiera_keys = true' do
+    before(:each) {
+      PuppetSyntax.check_hiera_keys = true
+    }
+
+    it "should return warnings for invalid keys" do
+      hiera_yaml = 'hiera_badkey.yaml'
+      examples = 5
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      (1..examples).each do |n|
+        expect(res).to include(/::warning#{n}/)
+      end
+      expect(res.size).to be == examples
+      expect(res[0]).to match('Key :typical:typo::warning1: Looks like a missing colon')
+      expect(res[1]).to match('Key ::notsotypical::warning2: Puppet automatic lookup will not use leading \'::\'')
+      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')
+    end
+
+    it "should handle empty files" do
+      hiera_yaml = 'hiera_key_empty.yaml'
+      files = fixture_hiera(hiera_yaml)
+      res = subject.check(files)
+      expect(res).to be_empty
+    end
+
+  end
 end

data/spec/puppet-syntax/manifests_spec.rb

@@ -28,9 +28,9 @@ describe PuppetSyntax::Manifests do
     files = fixture_manifests('fail_error.pp')
     output, has_errors = subject.check(files)
 
-    if Puppet::PUPPETVERSION.to_i >= 4
+    if Puppet.version.to_i >= 4
       expect(output.size).to eq(3)
-      expect(output[2]).to match(/Found 2 errors. Giving up/)
+      expect(output[2]).to match(/2 errors. Giving up/)
       expect(has_errors).to eq(true)
     else
       expect(output.size).to eq(1)
@@ -72,11 +72,11 @@ describe PuppetSyntax::Manifests do
     output, has_errors = subject.check(files)
 
     expect(has_errors).to eq(true)
-    if Puppet::PUPPETVERSION.to_i >= 4
+    if Puppet.version.to_i >= 4
       expect(output.size).to eq(5)
       expect(output[0]).to match(/This Name has no effect. A Host Class Definition can not end with a value-producing expression without other effect at \S*\/fail_error.pp:2:32$/)
       expect(output[1]).to match(/This Name has no effect. A value(-producing expression without other effect may only be placed last in a block\/sequence| was produced and then forgotten.*) at \S*\/fail_error.pp:2:3$/)
-      expect(output[2]).to match('Found 2 errors. Giving up')
+      expect(output[2]).to match('2 errors. Giving up')
       expect(output[3]).to match(/Unrecogni(s|z)ed escape sequence '\\\['/)
       expect(output[4]).to match(/Unrecogni(s|z)ed escape sequence '\\\]'/)
     else
@@ -138,10 +138,10 @@ describe PuppetSyntax::Manifests do
 
   describe 'app_management' do
     after do
-      PuppetSyntax.app_management = false
+      PuppetSyntax.app_management = false if Puppet.version.to_i < 5
     end
 
-    context 'app_management = false (default)' do
+    context 'app_management = false (default)', :if => (Puppet.version.to_i < 5) do
       it 'should fail to parse an application manifest' do
 
         files = fixture_manifests(['test_app.pp'])
@@ -155,7 +155,7 @@ describe PuppetSyntax::Manifests do
       before(:each) {
         PuppetSyntax.app_management = true
       }
-      if Puppet::PUPPETVERSION.to_f >= 4.3
+      if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
         it 'should successfully parse an application manifest on Puppet >= 4.3.0' do
           expect(PuppetSyntax.app_management).to eq(true)
 
@@ -211,7 +211,7 @@ describe PuppetSyntax::Manifests do
         PuppetSyntax.future_parser = true
       }
 
-      if Puppet::Util::Package.versioncmp(Puppet.version, '3.2') >= 0 and Puppet::PUPPETVERSION.to_i < 4
+      if Puppet::Util::Package.versioncmp(Puppet.version, '3.2') >= 0 and Puppet.version.to_i < 4
         context 'Puppet >= 3.2 < 4' do
           it 'should pass with future option set to true on future manifest' do
             files = fixture_manifests(['future_syntax.pp'])

data/spec/puppet-syntax/templates_spec.rb

@@ -67,7 +67,7 @@ describe PuppetSyntax::Templates do
     expect(res).to match([])
   end
 
-  if Puppet::PUPPETVERSION.to_f < 3.7
+  if Puppet.version.to_f < 3.7
     context 'on Puppet < 3.7' do
       it 'should throw an exception when parsing EPP files' do
         file = fixture_templates('pass.epp')
@@ -87,7 +87,7 @@ describe PuppetSyntax::Templates do
     end
   end
 
-  if Puppet::PUPPETVERSION.to_f >= 3.7
+  if Puppet.version.to_f >= 3.7
     context 'on Puppet >= 3.7' do
       it 'should return nothing from a valid file' do
         files = fixture_templates('pass.epp')

data/spec/puppet-syntax_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetSyntax do
   after do
     PuppetSyntax.exclude_paths = []
-    PuppetSyntax.app_management = false
+    PuppetSyntax.app_management = false if Puppet.version.to_i < 5
   end
 
   it 'should default exclude_paths to empty array' do
@@ -30,6 +30,10 @@ describe PuppetSyntax do
     expect(PuppetSyntax.app_management).to eq(true)
   end
 
+  it 'should raise error when app_management is disabled on 5.x', :if => (Puppet.version.to_i >= 5) do
+    expect { PuppetSyntax.app_management = false }.to raise_error(/app_management cannot be disabled on Puppet 5 or higher/)
+  end
+
   it 'should support a fail_on_deprecation_notices setting' do
     PuppetSyntax.fail_on_deprecation_notices = false
     expect(PuppetSyntax.fail_on_deprecation_notices).to eq(false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +108,9 @@ files:
 - spec/fixtures/hiera/data/test/hiera_4.eyaml
 - spec/fixtures/hiera/hiera_bad.yaml
 - spec/fixtures/hiera/hiera_bad_18.yaml
+- spec/fixtures/hiera/hiera_badkey.yaml
 - spec/fixtures/hiera/hiera_good.yaml
+- spec/fixtures/hiera/hiera_key_empty.yaml
 - spec/fixtures/test_module/manifests/deprecation_notice.pp
 - spec/fixtures/test_module/manifests/fail_error.pp
 - spec/fixtures/test_module/manifests/fail_warning.pp
@@ -136,7 +166,9 @@ test_files:
 - spec/fixtures/hiera/data/test/hiera_4.eyaml
 - spec/fixtures/hiera/hiera_bad.yaml
 - spec/fixtures/hiera/hiera_bad_18.yaml
+- spec/fixtures/hiera/hiera_badkey.yaml
 - spec/fixtures/hiera/hiera_good.yaml
+- spec/fixtures/hiera/hiera_key_empty.yaml
 - spec/fixtures/test_module/manifests/deprecation_notice.pp
 - spec/fixtures/test_module/manifests/fail_error.pp
 - spec/fixtures/test_module/manifests/fail_warning.pp