puppet-syntax 1.0.0 → 1.1.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+2013-09-06 Release 1.1.0
+- Syntax checks for Hiera YAML files.
+- Improved documentation.
+
 2013-07-04 Release 1.0.0
 - Refactor code to make it easier to test.
 - Implement spec tests for syntax checks.

data/README.md

@@ -1,6 +1,16 @@
 # Puppet::Syntax
 
-Syntax checks for Puppet manifests and templates
+Syntax checks for Puppet manifests and templates.
+
+## Version support
+
+This should work on any version of:
+
+- Puppet >= 2.7 that provides the `validate` face.
+- Ruby >= 1.8 with `erb` from stdlib.
+
+You can see the matrix of specific versions that we currently test against
+in the [TravisCI config](.travis.yml).
 
 ## Usage
 
@@ -23,6 +33,14 @@ A non-zero exit code and error message will be returned for any failures:
     Tasks: TOP => syntax => syntax:manifests
     (See full trace by running task with --trace)
 
+Use in conjunction with lint and spec tests for Continuous Integration:
+
+    task :test => [
+      :syntax,
+      :lint,
+      :spec,
+    ]
+
 ## Configuration
 
 Paths can be excluded with:

data/lib/puppet-syntax.rb

@@ -1,6 +1,7 @@
 require "puppet-syntax/version"
 require "puppet-syntax/manifests"
 require "puppet-syntax/templates"
+require "puppet-syntax/hiera"
 
 module PuppetSyntax
   class << self

data/lib/puppet-syntax/hiera.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module PuppetSyntax
+  class Hiera
+    def check(filelist)
+      raise "Expected an array of files" unless filelist.is_a?(Array)
+
+      errors = []
+
+      filelist.each do |hiera_file|
+        begin
+          YAML.load_file(hiera_file)
+        rescue Exception => error
+          errors << error
+        end
+       end
+
+      errors.map! { |e| e.to_s }
+
+      errors
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ module PuppetSyntax
       task :syntax => [
         'syntax:manifests',
         'syntax:templates',
+        'syntax:hiera',
       ]
 
       namespace :syntax do
@@ -35,6 +36,24 @@ module PuppetSyntax
           errors = c.check(files)
           fail errors.join("\n") unless errors.empty?
         end
+
+        desc 'Syntax check Hiera config files'
+        task :hiera => [
+          'syntax:hiera:yaml',
+        ]
+
+        namespace :hiera do
+          task :yaml do |t|
+            $stderr.puts "---> #{t.name}"
+            files = FileList["hieradata/**/*.yaml", "hiera*.yaml"]
+            files.reject! { |f| File.directory?(f) }
+            files = files.exclude(*PuppetSyntax.exclude_paths)
+
+            c = PuppetSyntax::Hiera.new
+            errors = c.check(files)
+            fail errors.join("\n") unless errors.empty?
+          end
+        end
       end
     end
   end

data/lib/puppet-syntax/version.rb

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

data/spec/fixtures/hiera/hiera_bad.yaml

@@ -0,0 +1 @@
+%YAMLBAD

data/spec/fixtures/hiera/hiera_bad_18.yaml

@@ -0,0 +1,3 @@
+---
+!!!str
+foo

data/spec/fixtures/hiera/hiera_good.yaml

@@ -0,0 +1,7 @@
+---
+:backends:
+  - yaml
+:yaml:
+  :datadir: './hieradata/good'
+:hierarchy:
+  - common

data/spec/puppet-syntax/hiera_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe PuppetSyntax::Hiera do
+  let(:subject) { PuppetSyntax::Hiera.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 valid YAML" do
+    files = fixture_hiera('hiera_good.yaml')
+    res = subject.check(files)
+    expect(res).to be == []
+  end
+
+  it "should return an error from invalid YAML" do
+    case RUBY_VERSION
+    when /1.8/
+      files = fixture_hiera('hiera_bad_18.yaml')
+      expected = /syntax error on line 3, col -1: `'/
+    else
+      files = fixture_hiera('hiera_bad.yaml')
+      expected = /scanning a directive at line 1 column 1/
+    end
+    res = subject.check(files)
+    expect(res.size).to be == 1
+    expect(res.first).to match(expected)
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,11 +106,15 @@ files:
 - README.md
 - Rakefile
 - lib/puppet-syntax.rb
+- lib/puppet-syntax/hiera.rb
 - lib/puppet-syntax/manifests.rb
 - lib/puppet-syntax/tasks/puppet-syntax.rb
 - lib/puppet-syntax/templates.rb
 - lib/puppet-syntax/version.rb
 - puppet-syntax.gemspec
+- spec/fixtures/hiera/hiera_bad.yaml
+- spec/fixtures/hiera/hiera_bad_18.yaml
+- spec/fixtures/hiera/hiera_good.yaml
 - spec/fixtures/test_module/manifests/fail_error.pp
 - spec/fixtures/test_module/manifests/fail_warning.pp
 - spec/fixtures/test_module/manifests/pass.pp
@@ -119,6 +123,7 @@ files:
 - 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/hiera_spec.rb
 - spec/puppet-syntax/manifests_spec.rb
 - spec/puppet-syntax/tasks/puppet-syntax_spec.rb
 - spec/puppet-syntax/templates_spec.rb
@@ -139,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -368354706311963489
+      hash: 4527904498098256296
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -148,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -368354706311963489
+      hash: 4527904498098256296
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -156,6 +161,9 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- spec/fixtures/hiera/hiera_bad.yaml
+- spec/fixtures/hiera/hiera_bad_18.yaml
+- spec/fixtures/hiera/hiera_good.yaml
 - spec/fixtures/test_module/manifests/fail_error.pp
 - spec/fixtures/test_module/manifests/fail_warning.pp
 - spec/fixtures/test_module/manifests/pass.pp
@@ -164,6 +172,7 @@ test_files:
 - 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/hiera_spec.rb
 - spec/puppet-syntax/manifests_spec.rb
 - spec/puppet-syntax/tasks/puppet-syntax_spec.rb
 - spec/puppet-syntax/templates_spec.rb