puppet-syntax 0.0.4 → 1.0.0

data/.travis.yml

@@ -1,3 +1,15 @@
+---
 language: ruby
+script: bundle exec rake
 rvm:
+  - 1.8.7
   - 1.9.3
+env:
+  - PUPPET_VERSION="~> 2.7.0"
+  - PUPPET_VERSION="~> 3.0.0"
+  - PUPPET_VERSION="~> 3.1.0"
+  - PUPPET_VERSION="~> 3.2.0"
+  - PUPPET_VERSION=">= 0"
+matrix:
+  allow_failures:
+    - env: PUPPET_VERSION=">= 0"

data/CHANGELOG

@@ -0,0 +1,21 @@
+2013-07-04 Release 1.0.0
+- Refactor code to make it easier to test.
+- Implement spec tests for syntax checks.
+- Pending spec tests for FileList matching.
+- Matrix tests for other Ruby/Puppet versions.
+- Improve usage example in README.
+
+2013-06-14 Release 0.0.4
+- Fix `$confdir` error for Puppet 3.x
+
+2013-06-11 Release 0.0.3
+- List rake as a dependency.
+- Output names of tasks to STDERR.
+- Match template paths correctly.
+- Add pending spec tests, not yet working.
+
+2013-06-10 Release 0.0.2
+- Fix namespacing of rake tasks.
+
+2013-06-10 Release 0.0.1
+- Initial release

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in puppet-syntax.gemspec
 gemspec
+
+# Override gemspec for CI matrix builds.
+if ENV['PUPPET_VERSION']
+  gem 'puppet', ENV['PUPPET_VERSION']
+end

data/README.md

@@ -8,6 +8,23 @@ Include the following in your `Rakefile`:
 
     require 'puppet-syntax/tasks/puppet-syntax'
 
+Test all manifests and templates relative to your `Rakefile`:
+
+    ➜  puppet git:(master) bundle exec rake syntax
+    ---> syntax:manifests
+    ---> syntax:templates
+
+A non-zero exit code and error message will be returned for any failures:
+
+    ➜  puppet git:(master) bundle exec rake syntax
+    ---> syntax:manifests
+    rake aborted!
+    Could not parse for environment production: Syntax error at end of file at demo.pp:2
+    Tasks: TOP => syntax => syntax:manifests
+    (See full trace by running task with --trace)
+
+## Configuration
+
 Paths can be excluded with:
 
     PuppetSyntax.exclude_paths = ["vendor/**/*"]

data/lib/puppet-syntax/manifests.rb

@@ -1,14 +1,11 @@
-require 'rake'
 require 'puppet'
 require 'puppet/face'
 
 module PuppetSyntax
   class Manifests
-    def validate_manifest(file)
-      Puppet::Face[:parser, '0.0.1'].validate(file)
-    end
+    def check(filelist)
+      raise "Expected an array of files" unless filelist.is_a?(Array)
 
-    def check
       errors = []
 
       # FIXME: We shouldn't need to do this. puppet/face should. See:
@@ -22,8 +19,7 @@ module PuppetSyntax
       Puppet::Util::Log.newdestination(Puppet::Test::LogCollector.new(errors))
       Puppet::Util::Log.level = :warning
 
-      matched_files = FileList["**/*.pp"].exclude(*PuppetSyntax.exclude_paths)
-      matched_files.each do |puppet_file|
+      filelist.each do |puppet_file|
         begin
           validate_manifest(puppet_file)
         rescue => error
@@ -31,13 +27,20 @@ module PuppetSyntax
         end
       end
 
-      # Exported resources will raise warnings when outside a puppetmaster.
       Puppet::Util::Log.close_all
+      errors.map! { |e| e.to_s }
+
+      # Exported resources will raise warnings when outside a puppetmaster.
       errors.reject! { |e|
-        e.to_s =~ /^You cannot collect( exported resources)? without storeconfigs being set/
+        e =~ /^You cannot collect( exported resources)? without storeconfigs being set/
       }
 
       errors
     end
+
+    private
+    def validate_manifest(file)
+      Puppet::Face[:parser, '0.0.1'].validate(file)
+    end
   end
 end

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

@@ -15,16 +15,24 @@ module PuppetSyntax
         desc 'Syntax check Puppet manifests'
         task :manifests do |t|
           $stderr.puts "---> #{t.name}"
+          files = FileList["**/*.pp"]
+          files.reject! { |f| File.directory?(f) }
+          files = files.exclude(*PuppetSyntax.exclude_paths)
+
           c = PuppetSyntax::Manifests.new
-          errors = c.check
+          errors = c.check(files)
           fail errors.join("\n") unless errors.empty?
         end
 
         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
+          errors = c.check(files)
           fail errors.join("\n") unless errors.empty?
         end
       end

data/lib/puppet-syntax/templates.rb

@@ -1,18 +1,16 @@
-require 'rake'
 require 'erb'
 require 'stringio'
 
 module PuppetSyntax
   class Templates
-    def check
+    def check(filelist)
+      raise "Expected an array of files" unless filelist.is_a?(Array)
+
       # We now have to redirect STDERR in order to capture warnings.
       $stderr = warnings = StringIO.new()
       errors = []
 
-      # Templates don't have to have a .erb extension
-      matched_files = FileList["**/templates/**/*"].exclude(*PuppetSyntax.exclude_paths)
-      matched_files.reject! { |f| File.directory?(f) }
-      matched_files.each do |erb_file|
+      filelist.each do |erb_file|
         begin
           erb = ERB.new(File.read(erb_file), nil, '-')
           erb.filename = erb_file
@@ -20,13 +18,15 @@ module PuppetSyntax
         rescue NameError
           # This is normal because we don't have the variables that would
           # ordinarily be bound by the parent Puppet manifest.
-        rescue StandardError, SyntaxError => error
+        rescue SyntaxError => error
           errors << error
         end
       end
 
       $stderr = STDERR
       errors << warnings.string unless warnings.string.empty?
+      errors.map! { |e| e.to_s }
+
       errors
     end
   end

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

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

@@ -0,0 +1,3 @@
+class failing_puppet_module {
+  this is not a valid resource name
+}

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

@@ -0,0 +1,5 @@
+class warning_puppet_module {
+  notify { 'this should raise a warning':
+    message => "because of \[\] escape characters",
+  }
+}

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

@@ -0,0 +1,5 @@
+class normal_puppet_module {
+  notify { 'should should pass':
+    message => 'with flying colours',
+  }
+}

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

@@ -0,0 +1,3 @@
+class uses_storeconfigs {
+  @@notify { 'exported': }
+}

data/spec/fixtures/test_module/templates/fail_error.erb

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

data/spec/fixtures/test_module/templates/fail_warning.erb

@@ -0,0 +1,2 @@
+Assignment in condition should warn.
+<%= "oh yes" if foo = true %>

data/spec/fixtures/test_module/templates/pass.erb

@@ -0,0 +1,2 @@
+<% valid = 'valid' -%>
+This is a <%= valid -%> template.

data/spec/fixtures/test_module/templates/pass_unbound_var.erb

@@ -0,0 +1 @@
+<%= this_variable_has_not_been_bound %>

data/spec/puppet-syntax/manifests_spec.rb

@@ -1,29 +1,57 @@
 require 'spec_helper'
 
 describe PuppetSyntax::Manifests do
+  let(:subject) { PuppetSyntax::Manifests.new }
+
+  it 'should expect an array of files' do
+    expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
+  end
+
   it 'should return nothing from a valid file' do
-    pending
+    files = fixture_manifests('pass.pp')
+    res = subject.check(files)
+
+    res.should == []
   end
 
   it 'should return an error from an invalid file' do
-    pending
+    files = fixture_manifests('fail_error.pp')
+    res = subject.check(files)
+
+    res.should have(1).items
+    res.first.should match(/Syntax error at '\}' .*:3$/)
   end
 
   it 'should return a warning from an invalid file' do
-    # "Unrecognised escape sequence \[\]"
-    pending
+    files = fixture_manifests('fail_warning.pp')
+    res = subject.check(files)
+
+    res.should have(2).items
+    res[0].should match(/Unrecognised escape sequence '\\\[' .* at line 3$/)
+    res[1].should match(/Unrecognised escape sequence '\\\]' .* at line 3$/)
   end
 
   it 'should ignore warnings about storeconfigs' do
-    # @@notify { 'foo': }
-    pending
+    files = fixture_manifests('pass_storeconfigs.pp')
+    res = subject.check(files)
+
+    res.should == []
   end
 
   it 'should read more than one valid file' do
-    pending
+    files = fixture_manifests(['pass.pp', 'pass_storeconfigs.pp'])
+    res = subject.check(files)
+
+    res.should == []
   end
 
   it 'should continue after finding an error in the first file' do
-    pending
+    files = fixture_manifests(['fail_error.pp', 'fail_warning.pp'])
+    res = subject.check(files)
+
+    res.should have(3).items
+    res[0].should match(/Syntax error at '\}' .*:3$/)
+    res[1].should match(/Unrecognised escape sequence '\\\[' .* at line 3$/)
+    res[2].should match(/Unrecognised escape sequence '\\\]' .* at line 3$/)
   end
 end

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'PuppetSyntax rake tasks' do
+  it 'should generate FileList of manifests relative to Rakefile' do
+    pending
+  end
+
+  it 'should generate FileList of templates relative to Rakefile' do
+    pending
+  end
+end

data/spec/puppet-syntax/templates_spec.rb

@@ -1,32 +1,55 @@
 require 'spec_helper'
 
 describe PuppetSyntax::Templates do
+  let(:subject) { PuppetSyntax::Templates.new }
+
+  it 'should expect an array of files' do
+    expect { subject.check(nil) }.to raise_error(/Expected an array of files/)
+  end
+
   it 'should return nothing from a valid file' do
-    pending
+    files = fixture_templates('pass.erb')
+    res = subject.check(files)
+
+    res.should == []
   end
 
   it 'should ignore NameErrors from unbound variables' do
-    pending
-  end
+    files = fixture_templates('pass_unbound_var.erb')
+    res = subject.check(files)
 
-  it 'should catch StandardError' do
-    pending
+    res.should == []
   end
 
   it 'should catch SyntaxError' do
-    pending
+    files = fixture_templates('fail_error.erb')
+    res = subject.check(files)
+
+    res.should have(1).items
+    res.first.should match(/2: syntax error, unexpected/)
   end
 
   it 'should catch Ruby warnings' do
-    # <%= if true -%>
-    pending
+    files = fixture_templates('fail_warning.erb')
+    res = subject.check(files)
+
+    res.should have(1).items
+    res.first.should match(/2: warning: found = in conditional/)
   end
 
   it 'should read more than one valid file' do
-    pending
+    files = fixture_templates(['pass.erb', 'pass_unbound_var.erb'])
+    res = subject.check(files)
+
+    res.should == []
   end
 
   it 'should continue after finding an error in the first file' do
-    pending
+    files = fixture_templates(['fail_error.erb', 'fail_warning.erb'])
+    res = subject.check(files)
+
+    res.should have(2).items
+    res[0].should match(/2: syntax error, unexpected/)
+    res[1].should match(/2: warning: found = in conditional/)
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,19 @@
 require 'rspec'
 require 'puppet-syntax'
 
+def fixture_templates(list)
+  fixture_files(list, 'templates')
+end
+
+def fixture_manifests(list)
+  fixture_files(list, 'manifests')
+end
+
+def fixture_files(list, path)
+  list = [list].flatten
+  list.map { |f| File.expand_path("../fixtures/test_module/#{path}/#{f}", __FILE__) }
+end
+
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,7 +111,16 @@ files:
 - lib/puppet-syntax/templates.rb
 - lib/puppet-syntax/version.rb
 - puppet-syntax.gemspec
+- spec/fixtures/test_module/manifests/fail_error.pp
+- spec/fixtures/test_module/manifests/fail_warning.pp
+- spec/fixtures/test_module/manifests/pass.pp
+- spec/fixtures/test_module/manifests/pass_storeconfigs.pp
+- spec/fixtures/test_module/templates/fail_error.erb
+- spec/fixtures/test_module/templates/fail_warning.erb
+- spec/fixtures/test_module/templates/pass.erb
+- spec/fixtures/test_module/templates/pass_unbound_var.erb
 - spec/puppet-syntax/manifests_spec.rb
+- spec/puppet-syntax/tasks/puppet-syntax_spec.rb
 - spec/puppet-syntax/templates_spec.rb
 - spec/puppet-syntax_spec.rb
 - spec/spec_helper.rb
@@ -129,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2044382737602392428
+      hash: -368354706311963489
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2044382737602392428
+      hash: -368354706311963489
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -146,7 +156,16 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- spec/fixtures/test_module/manifests/fail_error.pp
+- spec/fixtures/test_module/manifests/fail_warning.pp
+- spec/fixtures/test_module/manifests/pass.pp
+- spec/fixtures/test_module/manifests/pass_storeconfigs.pp
+- spec/fixtures/test_module/templates/fail_error.erb
+- spec/fixtures/test_module/templates/fail_warning.erb
+- spec/fixtures/test_module/templates/pass.erb
+- spec/fixtures/test_module/templates/pass_unbound_var.erb
 - spec/puppet-syntax/manifests_spec.rb
+- spec/puppet-syntax/tasks/puppet-syntax_spec.rb
 - spec/puppet-syntax/templates_spec.rb
 - spec/puppet-syntax_spec.rb
 - spec/spec_helper.rb