rspec-puppet-utils 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  data.tar.gz: a4dd63771ed01e8d6afa8f1e971ee5d34fd5422c
-  metadata.gz: c6a81e4e44b6d5e1198e5c4d27c4d9bf3d383cec
+  data.tar.gz: 1cee9e4a75b93b9b3d2bbdd4d9c18d6f224c5448
+  metadata.gz: da8f2e5c38ad50874bfcdba758d6e239922654da
 SHA512: 
-  data.tar.gz: f0b85634b96353cee343e2238264a90b8a03aca441125c5fe7d08b048f803c8e38fd303e5a678d0641513d1fd64f14151d03b0366b3c4db53f94dbc949f32f27
-  metadata.gz: 39365b0ebfbfa4af02a41502d0f8bfa268648dee536082f871fe2cd8d7efbe5afa35ae6fc75e483185551d9fee6d644c3de7aa51b3e93b898747b0d65eb4c205
+  data.tar.gz: d75f54a18d91e8ca31bf1ed170ec118e35b1253cf9f91ac3dd9e972d4234e91cefcd8a9ec912324d7e92a4683e9d9438a02b28210123caab03e27f3b503a7d71
+  metadata.gz: 8135746b0dfe552fd456f5b5eb747a1180f4c8c943d1918ee8b1beb0b46004fd3dcce66fed644a4c78748279f6dfa7069e952956ef4d28c21783c3976f460983

data/README.md

@@ -2,6 +2,8 @@
 
 This is a more refined version of a previous project about [rspec-puppet unit testing](https://github.com/TomPoulton/rspec-puppet-unit-testing), it provides a class for mocking functions, a harness for testing templates, and a simple tool for testing hiera data files. The motivation for mocking functions etc is provided in that project so I won't go over it here.
 
+See [release notes for v2.0.0](../../wiki/Release-Notes#v200)
+
 ## Usage
 
 ### MockFunction
@@ -127,6 +129,15 @@ describe 'YAML hieradata' do
       }
     end
 
+    # Supply a list of files that the key must be in
+    # (all matches in all other files are still validated)
+    # :live and :qa correspond to live.yaml and qa.yaml
+    it 'should override password in live and qa' do
+      validator.validate('password', [:live, :qa]) { |v|
+        expect ...
+      }
+    end
+
   end
 
 end

data/lib/hieradata/validator.rb

@@ -3,35 +3,46 @@ module RSpecPuppetUtils
 
     class Validator
 
-      attr_reader :data
+      attr_reader :data, :load_errors
 
-      def validate(key, &block)
-        raise ValidationError, 'No data available, try #load first' if @data.nil? || @data.empty?
-
-        found = false
+      def validate(key, required_files = [], &block)
+        pre_checks(required_files)
+        @found = false
         @data.keys.each do |file|
-          keys = get_matching_keys(key, file)
-          keys.each do |matched_key|
-            found = true
-            begin
-              block.call(@data[file][matched_key])
-            rescue Exception => e
-              raise ValidationError, "#{matched_key} is invalid in #{file}: #{e.message}"
-            end
-          end
+          validate_file file, key, required_files, &block
         end
-        raise ValidationError, "No match for #{key.inspect} was not found in any files" unless found
+        raise ValidationError, "No match for #{key.inspect} was not found in any files" unless @found
+        raise ValidationError, "No match for #{key.inspect} was not found in: #{required_files.join ', '}" unless required_files.empty?
       end
 
       private
 
+      def pre_checks(required_files)
+        raise ValidationError, "Errors occurred during data load:\n#{@load_errors.join "\n"}\n" unless @load_errors.empty?
+        raise StandardError, 'No data available, try #load first' if @data.nil? || @data.empty?
+        raise ArgumentError, 'required files should be an Array' unless required_files.is_a?(Array)
+      end
+
+      def validate_file(file, key, required_files, &block)
+        keys = get_matching_keys key, file
+        keys.each do |matched_key|
+          @found = true
+          begin
+            required_files.delete file
+            block.call @data[file][matched_key]
+          rescue StandardError => e
+            raise ValidationError, "#{matched_key} is invalid in #{file}: #{e.message}"
+          end
+        end
+      end
+
       def get_matching_keys(key, file)
         if key.is_a?(String) || key.is_a?(Symbol)
           keys = @data[file].has_key?(key) ? [key] : []
         elsif key.is_a?(Regexp)
           keys = @data[file].keys.select { |k| k.to_s =~ key }
         else
-          raise ValidationError, 'Search key must be a String, Symbol or a Regexp'
+          raise ArgumentError, 'Search key must be a String, Symbol or a Regexp'
         end
         keys
       end

data/lib/hieradata/yaml_validator.rb

@@ -12,31 +12,43 @@ module RSpecPuppetUtils
         @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 )
-        }
-
+      def load_data(*args)
+        @load_errors = []
         @data = {}
-        files.each { |file|
+        files = find_yaml_files
+        files.each { |file| load_data_for_file file, args.include?(:ignore_empty) }
+        self
+      end
 
-          # Assume all file names are unique i.e. thing.yaml and thing.yml don't both exist
-          file_name = File.basename(file).split('.').first
+      # Deprecated - delete soon!
+      def load(ignore_empty = false)
+        warn '#load is deprecated, use #load_data instead'
+        ignore_empty ? load_data(:ignore_empty) : load_data
+        raise ValidationError, @load_errors[0] unless @load_errors.empty?
+      end
 
-          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}" unless yaml || ignore_empty
+      private
+
+      def load_data_for_file(file, ignore_empty)
+        # 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
+          @load_errors.push "Error in file #{file}: #{e.message}"
+          return
+        end
+        @load_errors.push "Yaml file is empty: #{file}" unless yaml || ignore_empty
+        @data[file_name.to_sym] = yaml if yaml
+      end
 
-          @data[file_name.to_sym] = yaml if yaml
+      def find_yaml_files
+        Dir.glob(File.join(@directory, '**', '*')).reject { |path|
+          File.directory?(path) || !@extensions.include?(File.extname path )
         }
-
       end
+
     end
+
   end
 end

data/rspec-puppet-utils.gemspec

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

data/spec/classes/hieradata/validator_spec.rb

@@ -4,7 +4,10 @@ require 'lib/hieradata/validator'
 include RSpecPuppetUtils
 
 module HieraData
-  class Test < Validator
+  class TestValidator < Validator
+    def initialize
+      @load_errors = []
+    end
     def load
       @data = {
           :file1 => {
@@ -17,18 +20,24 @@ module HieraData
               'hello' => 'world',
               'missmatch' => ['array'],
               'hat' => 'fedora',
+          },
+          :file3 => {
+              'squid' => 'giant',
           }
       }
     end
     def load_empty
       @data = {}
     end
+    def set_load_errors(errors)
+      @load_errors = errors
+    end
   end
 end
 
 describe HieraData::Validator do
 
-  validator = HieraData::Test.new
+  validator = HieraData::TestValidator.new
   validator.load
 
   it 'should have public data variable' do
@@ -92,24 +101,67 @@ describe HieraData::Validator do
 
   end
 
+  context 'with required files' do
+
+    it 'should raise error if required files in not an Array' do
+      expect {
+        validator.validate('cat', nil) { }
+      }.to raise_error ArgumentError, 'required files should be an Array'
+    end
+
+    it 'should raise error when key is not found in required file' do
+      expect {
+        validator.validate('cat', [:file2]) { }
+      }.to raise_error HieraData::ValidationError
+    end
+
+    it 'should report which files are missing the key' do
+      expect {
+        validator.validate('cat', [:file2, :file3]) { }
+      }.to raise_error HieraData::ValidationError, 'No match for "cat" was not found in: file2, file3'
+    end
+
+    it 'should report broader error if key is not in any files' do
+      expect {
+        validator.validate('dog', [:file1]) { }
+      }.to raise_error HieraData::ValidationError, 'No match for "dog" was not found in any files'
+    end
+
+  end
+
+  it 'should raise error if key is not a valid type' do
+    expect {
+      validator.validate(['key']) { }
+    }.to raise_error ArgumentError, 'Search key must be a String, Symbol or a Regexp'
+  end
+
+  it 'should raise error if there were load errors' do
+    load_error_validator = HieraData::TestValidator.new
+    load_error_validator.load_empty
+    load_error_validator.set_load_errors ['file1 is empty', 'file2 has syntax errors']
+    expect {
+      load_error_validator.validate('') { }
+    }.to raise_error HieraData::ValidationError, /file1 is empty\nfile2 has syntax errors/
+  end
+
   it 'should raise error if data is nil' do
-    nil_validator = HieraData::Test.new
+    nil_validator = HieraData::TestValidator.new
     expect {
       nil_validator.validate('meh') { }
-    }.to raise_error HieraData::ValidationError, /No data available/
+    }.to raise_error StandardError, /No data available/
   end
 
   it 'should raise error if data is empty' do
-    empty_validator = HieraData::Test.new
+    empty_validator = HieraData::TestValidator.new
     empty_validator.load_empty
     expect {
       empty_validator.validate('meh') { }
-    }.to raise_error HieraData::ValidationError, /No data available/
+    }.to raise_error StandardError, /No data available/
   end
 
 end
 
-describe HieraData::Validator do
+describe HieraData::ValidationError do
 
   it 'should inherit from StandardError' do
     expect(HieraData::ValidationError.ancestors).to include StandardError

data/spec/classes/hieradata/yaml_validator_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'lib/hieradata/yaml_validator'
 
 include RSpecPuppetUtils
@@ -9,69 +10,130 @@ describe HieraData::YamlValidator do
     expect(validator).to be_a_kind_of HieraData::Validator
   end
 
-  context 'with valid yaml' do
+  describe '#load_data' do
 
-    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid')
-    validator.load
+    context 'with valid yaml' do
+
+      validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid')
+      validator.load_data
+
+      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
+
+      it 'should not add any load errors' do
+        expect(validator.load_errors).to be_an Array
+        expect(validator.load_errors).to be_empty
+      end
 
-    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
+    context 'with multiple extensions' do
+
+      validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid', ['yaml', 'foo'])
+      validator.load_data
+
+      it 'should load yml files into data' do
+        expect(validator.data).to have_key :other
+      end
+
     end
 
-    it 'should load yaml data from files' do
-      expect(validator.data[:valid]['string-value']).to eq 'a string'
+    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
 
-  end
+    context 'with invalid yaml' do
+
+      validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/invalid')
 
-  context 'with multiple extensions' do
+      it 'should not raise error' do
+        expect {
+          validator.load_data
+        }.to_not raise_error
+      end
 
-    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid', ['yaml', 'foo'])
-    validator.load
+      it 'should add error to load_errors' do
+        expect(validator.load_errors).to be_an Array
+        expect(validator.load_errors.size).to eq 1
+        expect(validator.load_errors[0]).to match /Error in file .*\/invalid.yaml/
+      end
 
-    it 'should load yml files into data' do
-      expect(validator.data).to have_key :other
     end
 
-  end
+    context 'with empty yaml' do
 
-  context 'with extensions as string' do
+      subject(:validator) { HieraData::YamlValidator.new('spec/fixtures/hieradata/empty') }
 
-    it 'should load yml files into data' do
-      expect { HieraData::YamlValidator.new('meh', 'whooops') }.to raise_error ArgumentError, /extensions should be an Array/
-    end
+      it 'should not raise error by default' do
+        expect {
+          validator.load_data
+        }.to_not raise_error # /Yaml file is empty: .*\/empty.yaml/
+      end
 
-  end
+      it 'should add error to load_errors' do
+        validator.load_data
+        expect(validator.load_errors).to be_an Array
+        expect(validator.load_errors.size).to eq 1
+        expect(validator.load_errors[0]).to match /Yaml file is empty: .*\/empty.yaml/
+      end
+
+      it 'should ignore empty files when flag is set' do
+        expect { validator.load_data :ignore_empty }.to_not raise_error
+      end
 
-  context 'with invalid yaml' do
+      it 'should not add empty files to @data' do
+        validator.load_data :ignore_empty
+        expect(validator.data.keys).to_not include :empty
+      end
 
-    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/invalid')
+      it 'should add non empty files to data' do
+        validator.load_data :ignore_empty
+        expect(validator.data.keys).to include :not_empty
+      end
 
-    it 'should raise error with syntax error' do
-      expect { validator.load }.to raise_error StandardError, /Yaml Syntax error in file .*\/invalid.yaml/
     end
 
-  end
+    it 'should return validator instance' do
+      validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/valid')
+      expect(validator.load_data).to eq validator
+    end
 
-  context 'with empty yaml' do
+  end
 
-    validator = HieraData::YamlValidator.new('spec/fixtures/hieradata/empty')
+  describe '#load' do
 
-    it 'should raise error' do
-      expect { validator.load }.to raise_error StandardError, /Yaml file is empty: .*\/empty.yaml/
+    subject(:validator) { HieraData::YamlValidator.new('spec/fixtures/hieradata/empty') }
+    before(:each) do
+      validator.stubs(:warn) # Hide warn message from output
     end
 
-    it 'should ignore empty files when flag is set' do
+    it 'should support old #load method' do
       expect { validator.load true }.to_not raise_error
+      expect(validator.data.keys).to include :not_empty
+    end
+
+    it 'should still throw errors if necessary' do
+      expect {
+        validator.load
+      }.to raise_error HieraData::ValidationError
     end
 
-    it 'should not add empty files to @data' do
+    it 'should warn when using old #load method' do
+      validator.expects(:warn).with('#load is deprecated, use #load_data instead').once
       validator.load true
-      expect(validator.data.keys).to_not include :empty
     end
 
   end

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

@@ -0,0 +1,2 @@
+---
+'key' : 'value'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors: 
 - Tom Poulton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-03-19 00:00:00 Z
+date: 2014-03-24 00:00:00 Z
 dependencies: []
 
 description: Helper classes for mock/stub functions, templates and hierdata
@@ -37,6 +37,7 @@ files:
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml
+- spec/fixtures/hieradata/empty/not_empty.yaml
 - spec/fixtures/hieradata/invalid/invalid.yaml
 - spec/fixtures/hieradata/valid/other.foo
 - spec/fixtures/hieradata/valid/sub/nested.yaml
@@ -76,6 +77,7 @@ test_files:
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml
+- spec/fixtures/hieradata/empty/not_empty.yaml
 - spec/fixtures/hieradata/invalid/invalid.yaml
 - spec/fixtures/hieradata/valid/other.foo
 - spec/fixtures/hieradata/valid/sub/nested.yaml