puppet-syntax 2.2.0 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5a8ea5b2dd10a9474032154b4716a5a51d59c2f
+  data.tar.gz: 620bbfbea83b5fedeb8d1e34161b2b08d0afad38
+SHA512:
+  metadata.gz: cc7eeb21577dd0ad6b0ce2b72f0fd207c44b40d35eba98f6108c2d133f53976d4b66a6896acd44e6278e56f3cf736efa3ac410ec530ce1faf1d1b7a1e14199f2
+  data.tar.gz: 4dedf7bfd033d33b8b7404234717e36b1c5e1d0c8e38c8e39f4d7d1f12fd487238a33d53af56ff9cc03279e561be20649f264b48599893868d9267655b059bc9

data/.travis.yml

@@ -6,22 +6,32 @@ script: bundle exec rake
 rvm:
   - 1.9.3
   - 2.1.6
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
 env:
-  - PUPPET_VERSION="~> 3.0.0"
-  - PUPPET_VERSION="~> 3.1.0"
-  - PUPPET_VERSION="~> 3.2.0"
-  - PUPPET_VERSION="~> 3.4.0"
-  - PUPPET_VERSION="~> 3.7.3"
-  - PUPPET_VERSION="~> 4.2.0"
-  - PUPPET_VERSION="~> 4.3.0"
+  - PUPPET_VERSION="~> 3.8.7"
+  - PUPPET_VERSION="~> 4.8.0"
   - PUPPET_VERSION=">= 0"
 matrix:
   exclude:
-    - rvm: 2.1.6
-      env: PUPPET_VERSION="~> 3.2.0"
-    - rvm: 2.1.6
-      env: PUPPET_VERSION="~> 3.1.0"
-    - rvm: 2.1.6
-      env: PUPPET_VERSION="~> 3.0.0"
+    - env: PUPPET_VERSION="~> 3.8.7"
+      rvm: 2.2.6
+    - env: PUPPET_VERSION="~> 3.8.7"
+      rvm: 2.3.3
+    - env: PUPPET_VERSION="~> 3.8.7"
+      rvm: 2.4.0
   allow_failures:
     - env: PUPPET_VERSION=">= 0"
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "kwxryZZ/t9EkWuYxhz3G1v+U3ZK4WdsiN0UFHDjijnAGPxqe/n+oBcNA8hOiNhjZeTFo8bADEZkL7JtdKQo9RvgStipyaS5gDHB/C1c4LOBWv4Tga21NNCAuBcE2CDtAH3+TzrZV5vv2+SpOrhKZpzZoAoR6PR1MWVWMUie/rE0="
+  gem: puppet-syntax
+  on:
+    rvm: 2.4.0
+    condition: '"$PUPPET_VERSION" = "~> 4.8.0"'
+    tags: true
+    all_branches: true
+    repo: voxpupuli/puppet-syntax

data/CHANGELOG

@@ -1,3 +1,10 @@
+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.
+- Only test ERB syntax in files with an *.erb extension. Thanks @alexiri.
+- Extend README to list specific files and checks implemented. Thanks @petems.
+- Refactor Rake filelist generation, add tests. Thanks @kjetilho, @rjw1.
+
 2016-12-02 Release 2.2.0
 - Replace Puppet.initialize_settings with Puppet::Test::TestHelper. Thanks @domcleal #60
   This clears out caches on every test so increases runtime.

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/gds-operations/puppet-syntax.svg?branch=master)](https://travis-ci.org/gds-operations/puppet-syntax)
+[![Build Status](https://travis-ci.org/voxpupuli/puppet-syntax.svg?branch=master)](https://travis-ci.org/voxpupuli/puppet-syntax)
 
 # Puppet::Syntax
 
@@ -51,6 +51,34 @@ Use in conjunction with lint and spec tests for Continuous Integration:
       :spec,
     ]
 
+## Checks
+
+### hiera
+
+Checks `.yaml` files for syntax errors.
+
+By default, the rake task will look for all `.yaml` files under:
+
+* `**/data/**/*.yaml`
+* `hieradata/**/*.yaml`
+* `hiera*.yaml`
+
+### manifests
+
+Checks `.pp` files for syntax errors
+
+### templates
+
+#### erb
+
+Checks `.erb` files for syntax errors
+
+#### epp
+
+Checks `.epp` files for syntax errors.
+
+Note: This will only occur when Puppet version specified is Puppet 4+ or Puppet 3 with the future parser enabled
+
 ## Configuration
 
 Paths can be excluded with:
@@ -65,6 +93,14 @@ If you are using some form of hiera data inside your module, you can configure w
 
     PuppetSyntax.hieradata_paths = ["**/data/**/*.yaml", "hieradata/**/*.yaml", "hiera*.yaml"]
 
+If you are trying to validate the syntax of code written for application orchestration, you can enable the `app_management` setting:
+
+    PuppetSyntax.app_management = true
+
+Deprecation notices will cause a failure by default, you can override this functionality by setting:
+
+    PuppetSyntax.fail_on_deprecation_notices = false
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/puppet-syntax.rb

@@ -6,10 +6,11 @@ require "puppet-syntax/hiera"
 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
 
   class << self
-    attr_accessor :exclude_paths, :future_parser, :hieradata_paths, :fail_on_deprecation_notices, :epp_only
+    attr_accessor :exclude_paths, :future_parser, :hieradata_paths, :fail_on_deprecation_notices, :epp_only, :app_management
   end
 end

data/lib/puppet-syntax/manifests.rb

@@ -59,6 +59,7 @@ 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::Face[:parser, :current].validate(file)
     end
   end

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

@@ -4,6 +4,24 @@ require 'rake/tasklib'
 
 module PuppetSyntax
   class RakeTask < ::Rake::TaskLib
+    def filelist(paths)
+      files = FileList[paths]
+      files.reject! { |f| File.directory?(f) }
+      files.exclude(*PuppetSyntax.exclude_paths)
+    end
+
+    def filelist_manifests
+      filelist("**/*.pp")
+    end
+
+    def filelist_templates
+      filelist(["**/templates/**/*.erb", "**/templates/**/*.epp"])
+    end
+
+    def filelist_hiera_yaml
+      filelist(PuppetSyntax.hieradata_paths)
+    end
+
     def initialize(*args)
       desc 'Syntax check Puppet manifests and templates'
       task :syntax => [
@@ -36,13 +54,17 @@ to puppetlabs_spec_helper >= 0.8.0 which now uses puppet-syntax.
 'true'. The `future_parser setting will be ignored.
             EOS
           end
+          if Puppet::PUPPETVERSION.to_f < 4.3 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.
+            EOS
+          end
+
           $stderr.puts "---> #{t.name}"
-          files = FileList["**/*.pp"]
-          files.reject! { |f| File.directory?(f) }
-          files = files.exclude(*PuppetSyntax.exclude_paths)
 
           c = PuppetSyntax::Manifests.new
-          output, has_errors = c.check(files)
+          output, has_errors = c.check(filelist_manifests)
           print "#{output.join("\n")}\n" unless output.empty?
           fail if has_errors || ( output.any? && PuppetSyntax.fail_on_deprecation_notices )
         end
@@ -50,12 +72,9 @@ to puppetlabs_spec_helper >= 0.8.0 which now uses puppet-syntax.
         desc 'Syntax check Puppet templates'
         task :templates do |t|
           $stderr.puts "---> #{t.name}"
-          files = FileList["**/templates/**/*"]
-          files.reject! { |f| File.directory?(f) }
-          files = files.exclude(*PuppetSyntax.exclude_paths)
 
           c = PuppetSyntax::Templates.new
-          errors = c.check(files)
+          errors = c.check(filelist_templates)
           fail errors.join("\n") unless errors.empty?
         end
 
@@ -67,12 +86,8 @@ to puppetlabs_spec_helper >= 0.8.0 which now uses puppet-syntax.
         namespace :hiera do
           task :yaml do |t|
             $stderr.puts "---> #{t.name}"
-            files = FileList.new(PuppetSyntax.hieradata_paths)
-            files.reject! { |f| File.directory?(f) }
-            files = files.exclude(*PuppetSyntax.exclude_paths)
-
             c = PuppetSyntax::Hiera.new
-            errors = c.check(files)
+            errors = c.check(filelist_hiera_yaml)
             fail errors.join("\n") unless errors.empty?
           end
         end

data/lib/puppet-syntax/templates.rb

@@ -14,7 +14,7 @@ module PuppetSyntax
       filelist.each do |file|
         if File.extname(file) == '.epp' or PuppetSyntax.epp_only
           errors.concat validate_epp(file)
-        else
+        elsif File.extname(file) == '.erb'
           errors.concat validate_erb(file)
         end
       end

data/lib/puppet-syntax/version.rb

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

data/puppet-syntax.gemspec

@@ -6,11 +6,11 @@ require 'puppet-syntax/version'
 Gem::Specification.new do |spec|
   spec.name          = "puppet-syntax"
   spec.version       = PuppetSyntax::VERSION
-  spec.authors       = ["Dan Carley"]
-  spec.email         = ["dan.carley@gmail.com"]
+  spec.authors       = ["Vox Pupuli"]
+  spec.email         = ["voxpupuli@groups.io"]
   spec.description   = %q{Syntax checks for Puppet manifests and templates}
   spec.summary       = %q{Syntax checks for Puppet manifests, templates, and Hiera YAML}
-  spec.homepage      = "https://github.com/gds-operations/puppet-syntax"
+  spec.homepage      = "https://github.com/voxpupuli/puppet-syntax"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/fixtures/test_module/manifests/test_app.pp

@@ -0,0 +1,3 @@
+application test_app {
+
+}

data/spec/fixtures/test_module/templates/ignore.tpl

@@ -0,0 +1,3 @@
+This is plain text
+<% This is not valid Ruby %>
+This is also plain text

data/spec/puppet-syntax/manifests_spec.rb

@@ -136,6 +136,50 @@ describe PuppetSyntax::Manifests do
     end
   end
 
+  describe 'app_management' do
+    after do
+      PuppetSyntax.app_management = false
+    end
+
+    context 'app_management = false (default)' do
+      it 'should fail to parse an application manifest' do
+
+        files = fixture_manifests(['test_app.pp'])
+        output,has_errors = subject.check(files)
+
+        expect(has_errors).to eq(true)
+        expect(output).to include(/error/)
+      end
+    end
+    context 'app_management = true' do
+      before(:each) {
+        PuppetSyntax.app_management = true
+      }
+      if Puppet::PUPPETVERSION.to_f >= 4.3
+        it 'should successfully parse an application manifest on Puppet >= 4.3.0' do
+          expect(PuppetSyntax.app_management).to eq(true)
+
+          files = fixture_manifests(['test_app.pp'])
+          output,has_errors = subject.check(files)
+
+          expect(output.size).to eq(0)
+          expect(has_errors).to eq(false)
+        end
+      else
+        it 'should fail to parse an application manifest on Puppet < 4.3.0' do
+          expect(PuppetSyntax.app_management).to eq(true)
+
+          files = fixture_manifests(['test_app.pp'])
+          output,has_errors = subject.check(files)
+
+          expect(output).to include(/error/)
+          expect(has_errors).to eq(true)
+        end
+      end
+    end
+  end
+
+
   describe 'future_parser' do
     context 'future_parser = false (default)' do
       if Puppet::Util::Package.versioncmp(Puppet.version, '4.0') < 0

data/spec/puppet-syntax/tasks/puppet-syntax_spec.rb

@@ -1,8 +1,42 @@
 require 'spec_helper'
 require 'puppet-syntax/tasks/puppet-syntax'
 
+known_pp = 'spec/fixtures/test_module/manifests/pass.pp'
+known_erb = 'spec/fixtures/test_module/templates/pass.erb'
+known_yaml = 'spec/fixtures/hiera/data/hiera_1.yaml'
+known_eyaml = 'spec/fixtures/hiera/data/hiera_2.eyaml'
+known_yaml_subdir = 'spec/fixtures/hiera/data/test/hiera_3.yaml'
+known_eyaml_subdir = 'spec/fixtures/hiera/data/test/hiera_4.eyaml'
+
 describe 'PuppetSyntax rake tasks' do
+  it 'should filter directories' do
+    list = PuppetSyntax::RakeTask.new.filelist(['**/lib', known_pp])
+    expect(list.count).to eq 1
+    expect(list).to include(known_pp)
+  end
+
   it 'should generate FileList of manifests relative to Rakefile' do
+    list = PuppetSyntax::RakeTask.new.filelist_manifests
+    expect(list).to include(known_pp)
+    expect(list.count).to eq 8
+  end
+
+  it 'should generate FileList of templates relative to Rakefile' do
+    list = PuppetSyntax::RakeTask.new.filelist_templates
+    expect(list).to include(known_erb)
+    expect(list.count).to eq 9
+  end
+
+  it 'should generate FileList of Hiera yaml files relative to Rakefile' do
+    list = PuppetSyntax::RakeTask.new.filelist_hiera_yaml
+    expect(list).to include(known_yaml)
+    expect(list).to include(known_eyaml)
+    expect(list).to include(known_yaml_subdir)
+    expect(list).to include(known_eyaml_subdir)
+    expect(list.count).to eq 4
+  end
+
+  it 'should check manifests relative to Rakefile' do
     if RSpec::Version::STRING < '3'
       pending
     else
@@ -10,11 +44,12 @@ describe 'PuppetSyntax rake tasks' do
     end
   end
 
-  it 'should generate FileList of templates relative to Rakefile' do
+  it 'should check templates relative to Rakefile' do
     if RSpec::Version::STRING < '3'
       pending
     else
       skip('needs to be done')
     end
   end
+
 end

data/spec/puppet-syntax/templates_spec.rb

@@ -60,6 +60,13 @@ describe PuppetSyntax::Templates do
     expect(res).to match([])
   end
 
+  it 'should ignore files without .erb extension' do
+    files = fixture_templates('ignore.tpl')
+    res = subject.check(files)
+
+    expect(res).to match([])
+  end
+
   if Puppet::PUPPETVERSION.to_f < 3.7
     context 'on Puppet < 3.7' do
       it 'should throw an exception when parsing EPP files' do

data/spec/puppet-syntax_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe PuppetSyntax do
   after do
     PuppetSyntax.exclude_paths = []
+    PuppetSyntax.app_management = false
   end
 
   it 'should default exclude_paths to empty array' do
@@ -24,6 +25,11 @@ describe PuppetSyntax do
     expect(PuppetSyntax.future_parser).to eq(true)
   end
 
+  it 'should support app_management setting setting' do
+    PuppetSyntax.app_management = true
+    expect(PuppetSyntax.app_management).to eq(true)
+  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,73 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 2.2.0
-  prerelease: 
+  version: 2.3.0
 platform: ruby
 authors:
-- Dan Carley
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: Syntax checks for Puppet manifests and templates
 email:
-- dan.carley@gmail.com
+- voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -81,6 +74,10 @@ files:
 - lib/puppet-syntax/templates.rb
 - lib/puppet-syntax/version.rb
 - puppet-syntax.gemspec
+- spec/fixtures/hiera/data/hiera_1.yaml
+- spec/fixtures/hiera/data/hiera_2.eyaml
+- spec/fixtures/hiera/data/test/hiera_3.yaml
+- 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_good.yaml
@@ -91,10 +88,12 @@ files:
 - spec/fixtures/test_module/manifests/pass.pp
 - spec/fixtures/test_module/manifests/pass_storeconfigs.pp
 - spec/fixtures/test_module/manifests/tag_notice.pp
+- spec/fixtures/test_module/manifests/test_app.pp
 - spec/fixtures/test_module/templates/fail_error.epp
 - spec/fixtures/test_module/templates/fail_error.erb
 - spec/fixtures/test_module/templates/fail_error_also.epp
 - spec/fixtures/test_module/templates/fail_warning.erb
+- spec/fixtures/test_module/templates/ignore.tpl
 - spec/fixtures/test_module/templates/pass.epp
 - spec/fixtures/test_module/templates/pass.erb
 - spec/fixtures/test_module/templates/pass_also.epp
@@ -106,38 +105,35 @@ files:
 - spec/puppet-syntax/templates_spec.rb
 - spec/puppet-syntax_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/gds-operations/puppet-syntax
+homepage: https://github.com/voxpupuli/puppet-syntax
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1305733798338570755
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1305733798338570755
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Syntax checks for Puppet manifests, templates, and Hiera YAML
 test_files:
+- spec/fixtures/hiera/data/hiera_1.yaml
+- spec/fixtures/hiera/data/hiera_2.eyaml
+- spec/fixtures/hiera/data/test/hiera_3.yaml
+- 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_good.yaml
@@ -148,10 +144,12 @@ test_files:
 - spec/fixtures/test_module/manifests/pass.pp
 - spec/fixtures/test_module/manifests/pass_storeconfigs.pp
 - spec/fixtures/test_module/manifests/tag_notice.pp
+- spec/fixtures/test_module/manifests/test_app.pp
 - spec/fixtures/test_module/templates/fail_error.epp
 - spec/fixtures/test_module/templates/fail_error.erb
 - spec/fixtures/test_module/templates/fail_error_also.epp
 - spec/fixtures/test_module/templates/fail_warning.erb
+- spec/fixtures/test_module/templates/ignore.tpl
 - spec/fixtures/test_module/templates/pass.epp
 - spec/fixtures/test_module/templates/pass.erb
 - spec/fixtures/test_module/templates/pass_also.epp