rspec-puppet-utils 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  metadata.gz: 73d31647aca9a8ea92a51e91875d9428ddf36d65522e540205bd22fc056c577c025bac30e777479234c390977a1b13d815a64ebb5a33e742543e489b59493d80
-  data.tar.gz: 875c88ed3de884c3acdf8341e3dc675d011fba4f04b112ac3f9cb370580af86ba5ec9d256c0f82c62787b151035903bc1e5e40b11b3f8b1a1ac8cfab6026c2a6
+  metadata.gz: 41a4497de981008000489d01e33176c07417196b7cbcb55479d24c66c2906a91ce39869e431fe0ee11f7b7efb5224f51a2e33dfe463681cf3eb5909efae42ac9
+  data.tar.gz: aebf955a77f6235a8259c89186bdb5544a912c12ec8daa6de71715840c6fa58dbc1c816917289311f862f3a131f2fe82825772da41b74e84b25dcef399fa3806
 SHA1: 
-  metadata.gz: a44abeac9ab5e7f480bc8a9e0d1587cd41e8d596
-  data.tar.gz: 69010a95237c2e8c0c0e8777b266e98d7c00e3ae
+  metadata.gz: 45f31b9cc95b9c2a29aba88d9ddb3dac85b81d28
+  data.tar.gz: 5beeeb27784486ac29730b0bb082a971fc46ad92

data/lib/hieradata/validator.rb

@@ -0,0 +1,25 @@
+
+module HieraData
+
+  class Validator
+
+    attr_accessor :data
+
+    def validate?(key, &block)
+
+      raise StandardError, '@data is nil, try load() first' unless @data
+      raise StandardError, '@data is empty' if @data.empty?
+
+      found = false
+      @data.keys.each do |file|
+        if @data[file].has_key? key
+          found = true
+          valid = block.call(@data[file][key])
+          raise StandardError, "Key #{key} is not valid in file #{file}" unless valid
+        end
+      end
+      raise StandardError, "Key #{key} was not found in any files" unless found
+    end
+
+  end
+end

data/lib/hieradata/yaml_validator.rb

@@ -0,0 +1,40 @@
+require 'hieradata/validator'
+require 'yaml'
+
+module HieraData
+
+  class YamlValidator < Validator
+
+    def initialize(directory, extensions = ['yaml', 'yml'])
+      raise ArgumentError, 'extensions should be an Array' unless extensions.is_a? Array
+      @directory = directory
+      @extensions = extensions.map {|ext| ext =~ /\..*/ ? ext : ".#{ext}" }
+    end
+
+    def load(ignore_empty = false)
+
+      files = Dir.glob(File.join(@directory, '**', '*')).reject { |path|
+        File.directory?(path) || !@extensions.include?(File.extname path )
+      }
+
+      @data = {}
+      files.each { |file|
+
+        # Assume all file names are unique i.e. thing.yaml and thing.yml don't both exist
+        file_name = File.basename(file).split('.').first
+
+        begin
+          yaml = File.open(file) { |yf|
+            YAML::load( yf )
+          }
+        rescue ArgumentError => e
+          raise StandardError, "Yaml Syntax error in file #{file}: #{e.message}"
+        end
+        raise StandardError, "Yaml file is empty: #{file}" if !yaml && !ignore_empty
+
+        @data[file_name.to_sym] = yaml
+      }
+
+    end
+  end
+end

data/lib/mock_function.rb

@@ -0,0 +1,27 @@
+require 'rspec-puppet'
+
+class MockFunction
+
+  attr_accessor :function_type, :has_default_value, :default_value
+
+  def initialize(example_group, name, options = {})
+    opts = options.nil? ? {} : options
+
+    @function_type = opts.has_key?(:type) ? opts[:type] : :rvalue
+
+    opts[:default_value] = nil if @function_type == :statement
+
+    @has_default_value = false
+    if opts.has_key?(:default_value)
+      @has_default_value = true
+      @default_value = opts[:default_value]
+    end
+
+    this = self
+    example_group.before(:each) {
+      Puppet::Parser::Functions.newfunction(name.to_sym, {:type => this.function_type}) { |args| this.call(args) }
+      this.stubs(:call).returns(this.default_value) if this.has_default_value
+    }
+  end
+
+end

data/lib/rspec-puppet-utils.rb

@@ -1,64 +1,10 @@
-require 'rspec-puppet'
+require 'rspec'
 require 'mocha'
-require 'erb'
+require 'lib/mock_function'
+require 'lib/template_harness'
+require 'lib/hieradata/validator'
+require 'lib/hieradata/yaml_validator'
 
 RSpec.configure do |c|
   c.mock_with :mocha
 end
-
-class MockFunction
-
-  attr_accessor :function_type, :has_default_value, :default_value
-
-  def initialize(example_group, name, options = {})
-    opts = options.nil? ? {} : options
-
-    @function_type = opts.has_key?(:type) ? opts[:type] : :rvalue
-
-    opts[:default_value] = nil if @function_type == :statement
-
-    @has_default_value = false
-    if opts.has_key?(:default_value)
-      @has_default_value = true
-      @default_value = opts[:default_value]
-    end
-
-    this = self
-    example_group.before(:each) {
-      Puppet::Parser::Functions.newfunction(name.to_sym, {:type => this.function_type}) { |args| this.call(args) }
-      this.stubs(:call).returns(this.default_value) if this.has_default_value
-    }
-  end
-end
-
-class TemplateHarness
-
-  def initialize(template, scope = nil)
-    @template = template
-    @isolator = Isolator.new(scope)
-  end
-
-  def set(name, value)
-    var_name = name.start_with?('@') ? name : "@#{name}"
-    @isolator.instance_variable_set(var_name, value)
-  end
-
-  def run
-    b = @isolator.get_binding
-    template = File.exists?(@template) ? File.new(@template).read : @template
-    ERB.new(template, 0, '-').result b
-  end
-
-  class Isolator
-    # Isolates the binding so that only the defined set
-    # of instance variables are available to erb
-    def initialize scope
-      @scope = scope
-    end
-    def get_binding
-      scope = @scope
-      binding
-    end
-  end
-
-end

data/lib/template_harness.rb

@@ -0,0 +1,33 @@
+require 'erb'
+
+class TemplateHarness
+
+  def initialize(template, scope = nil)
+    @template = template
+    @isolator = Isolator.new(scope)
+  end
+
+  def set(name, value)
+    var_name = name.start_with?('@') ? name : "@#{name}"
+    @isolator.instance_variable_set(var_name, value)
+  end
+
+  def run
+    b = @isolator.get_binding
+    template = File.exists?(@template) ? File.new(@template).read : @template
+    ERB.new(template, 0, '-').result b
+  end
+
+  class Isolator
+    # Isolates the binding so that only the defined set
+    # of instance variables are available to erb
+    def initialize scope
+      @scope = scope
+    end
+    def get_binding
+      scope = @scope
+      binding
+    end
+  end
+
+end

data/rspec-puppet-utils.gemspec

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = 'rspec-puppet-utils'
-  gem.version       = '1.0.0'
-  gem.description   = 'Helper classes for mock functions and templates'
+  gem.version       = '1.0.1'
+  gem.description   = 'Helper classes for mock/stub functions, templates and hierdata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'
   #gem.license       = ''

data/spec/classes/hieradata/validator_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'lib/hieradata/validator'
+
+module HieraData
+  class Test < Validator
+    def load
+      @data = {
+          :file1 => {
+              'key' => 'value',
+              :other => 'other value',
+              'missmatch' => 'string'
+          },
+          :file2 => {
+              'hello' => 'world',
+              'missmatch' => ['array']
+          }
+      }
+    end
+    def load_empty
+      @data = {}
+    end
+  end
+end
+
+describe HieraData::Validator do
+
+  validator = HieraData::Test.new
+  validator.load
+
+  it 'should have public data variable' do
+    expect(validator.data).to have_key :file1
+  end
+
+  it 'should use block to validate key' do
+    expect {
+      validator.validate?('key') { |v| v == 'value' }
+    }.to_not raise_error
+
+    expect {
+      validator.validate?('key') { |v| v == 'oooops' }
+    }.to raise_error StandardError, /Key key is not valid in file/
+  end
+
+  it 'should accept symbol as key' do
+    expect {
+      validator.validate?(:other) { |v| v == 'other value' }
+    }.to_not raise_error
+  end
+
+  it 'should validate key in all files' do
+    expect {
+      validator.validate?('missmatch') { |v| v.is_a? String }
+    }.to raise_error StandardError, /Key missmatch is not valid in file file2/
+  end
+
+  it 'should raise error if data is nil' do
+    nil_validator = HieraData::Test.new
+    expect {
+      nil_validator.validate?('meh') { }
+    }.to raise_error StandardError, /@data is nil, try load\(\) first/
+  end
+
+  it 'should raise error if data is empty' do
+    empty_validator = HieraData::Test.new
+    empty_validator.load_empty
+    expect {
+      empty_validator.validate?('meh') { }
+    }.to raise_error StandardError, /@data is empty/
+  end
+
+end

data/spec/classes/hieradata/yaml_validator_spec.rb

@@ -0,0 +1,72 @@
+require 'lib/hieradata/yaml_validator'
+
+describe HieraData::YamlValidator do
+
+  it 'should be of type Validator' do
+    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid')
+    expect(validator).to be_a_kind_of HieraData::Validator
+  end
+
+  context 'with valid yaml' do
+
+    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid')
+    validator.load
+
+    it 'should load yaml files into data' do
+      expect(validator.data.keys.size).to_not be 0
+    end
+
+    it 'should load yaml files recursively' do
+      expect(validator.data.keys).to include :nested
+    end
+
+    it 'should load yaml data from files' do
+      expect(validator.data[:valid]['string-value']).to eq 'a string'
+    end
+
+  end
+
+  context 'with multiple extensions' do
+
+    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid', ['yaml', 'foo'])
+    validator.load
+
+    it 'should load yml files into data' do
+      expect(validator.data).to have_key :other
+    end
+
+  end
+
+  context 'with extensions as string' do
+
+    it 'should load yml files into data' do
+      expect { HieraData::YamlValidator.new('meh', 'whooops') }.to raise_error ArgumentError, /extensions should be an Array/
+    end
+
+  end
+
+  context 'with invalid yaml' do
+
+    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/invalid')
+
+    it 'should raise error with syntax error' do
+      expect { validator.load }.to raise_error StandardError, /Yaml Syntax error in file .*\/invalid.yaml/
+    end
+
+  end
+
+  context 'with empty yaml' do
+
+    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/empty')
+
+    it 'should raise error' do
+      expect { validator.load }.to raise_error StandardError, /Yaml file is empty: .*\/empty.yaml/
+    end
+
+    it 'should ignore empty files when flag is set' do
+      expect { validator.load true }.to_not raise_error
+    end
+
+  end
+
+end

data/spec/classes/mock_function_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'rspec-puppet-utils'
+require 'lib/mock_function'
 
 describe MockFunction do
 

data/spec/classes/template_harness_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'rspec-puppet-utils'
+require 'lib/template_harness'
 
 describe TemplateHarness do
 

data/spec/classes/utils_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'rspec-puppet-utils'
+
+describe 'rspec-puppet-utils' do
+
+  it 'should require MockFunction' do
+    expect { MockFunction.class }.to_not raise_error
+  end
+
+  it 'should require TemplateHarness' do
+    expect { TemplateHarness.class }.to_not raise_error
+  end
+
+  it 'should require HieraData Validator' do
+    expect { HieraData::Validator.class }.to_not raise_error
+  end
+
+  it 'should require HieraData YamlValidator' do
+    expect { HieraData::YamlValidator.class }.to_not raise_error
+  end
+
+end

data/spec/fixtures/hieradata/empty/empty.yaml

@@ -0,0 +1 @@
+---

data/spec/fixtures/hieradata/invalid/invalid.yaml

@@ -0,0 +1,3 @@
+---
+# missing : between key and value
+'hello' 'world'

data/spec/fixtures/hieradata/valid/other.foo

@@ -0,0 +1,2 @@
+---
+'smtp': 25

data/spec/fixtures/hieradata/valid/sub/nested.yaml

@@ -0,0 +1,2 @@
+---
+'hello': 'world'

data/spec/fixtures/hieradata/valid/valid.yaml

@@ -0,0 +1,2 @@
+---
+'string-value' : 'a string'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Tom Poulton
@@ -9,10 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-03-04 00:00:00 Z
+date: 2014-03-11 00:00:00 Z
 dependencies: []
 
-description: Helper classes for mock functions and templates
+description: Helper classes for mock/stub functions, templates and hierdata
 email: 
 executables: []
 
@@ -25,10 +25,22 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/hieradata/validator.rb
+- lib/hieradata/yaml_validator.rb
+- lib/mock_function.rb
 - lib/rspec-puppet-utils.rb
+- lib/template_harness.rb
 - rspec-puppet-utils.gemspec
+- spec/classes/hieradata/validator_spec.rb
+- spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
 - spec/classes/template_harness_spec.rb
+- spec/classes/utils_spec.rb
+- spec/fixtures/hieradata/empty/empty.yaml
+- spec/fixtures/hieradata/invalid/invalid.yaml
+- spec/fixtures/hieradata/valid/other.foo
+- spec/fixtures/hieradata/valid/sub/nested.yaml
+- spec/fixtures/hieradata/valid/valid.yaml
 - spec/fixtures/templates/returns_elephant.erb
 - spec/spec_helper.rb
 homepage: https://github.com/Accuity/rspec-puppet-utils
@@ -58,7 +70,15 @@ signing_key:
 specification_version: 4
 summary: ""
 test_files: 
+- spec/classes/hieradata/validator_spec.rb
+- spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
 - spec/classes/template_harness_spec.rb
+- spec/classes/utils_spec.rb
+- spec/fixtures/hieradata/empty/empty.yaml
+- spec/fixtures/hieradata/invalid/invalid.yaml
+- spec/fixtures/hieradata/valid/other.foo
+- spec/fixtures/hieradata/valid/sub/nested.yaml
+- spec/fixtures/hieradata/valid/valid.yaml
 - spec/fixtures/templates/returns_elephant.erb
 - spec/spec_helper.rb