chef-attribute-validator 0.6.0 → 0.6.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTZkNWQ0OWFiOTIwYmRlOWQ1ZWE3MTE5YzNhZjRmYzkzNDkxMTljZg==
+    MGNhOTQ2Yzg2ZmNjODk4M2I3ZjAzM2U2YjAzNTgxMTExYmY0MGY0YQ==
   data.tar.gz: !binary |-
-    ZjczMmQzYmNjNDJiNDM1MzM1MTJhNDJlNDA3MTIwYmQxMWY0ODVjNQ==
+    MmRkZmM4Y2NmYWJhNzNmMzM2OGU1Mzc4MTU3M2ZkOTMzMGEwNDc3Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZWM2OTNlM2NjYmVkMDM0ZTI4MjdmZTYxNjk5YzA1Y2U0MWFmZmViYTM5MzQ4
-    MjgyZDNmM2UzODdhODRhODNjYjMxYTZhOGJkODVlNmI2YjQ1YjYxMTRiZDUw
-    ZDJjZDZlOWIxODlmZmE2OTlkZTk1NzI1ZWYxNWY4Y2M2MjVhMjg=
+    NDJkYWMxZDI4YzdhMWY2ZTVhYWRjMjU1YTg5ZmYyMTQwNjRkZjkwMGIzMTBl
+    Y2VlMjgzNmM5OTVjMDM1N2I3YTU1Y2Y2OGRkZGRkOWE3NWVjYjg4ZGE5ODc5
+    OTU2ZTk2MGU2NWVkZTVlMTRmY2MxOTVlZmVkZmUxNDEzZDViOGM=
   data.tar.gz: !binary |-
-    NmRmMWZiMDE4MGM5M2RjNjY4M2IzNGM3YjhlY2UxZjhhYTU1Yjg4ZjEwNzA0
-    YTVkYTRkMDRjZjI5ZDVjOGYwOWNiODU0NzRlMTE2YTExYTdmZjBkYWE0ZjJk
-    NzdkMmE3ZmQ1OGQ0MTEyYWZlNmY4MjYwMjdiMzFkNjk3Nzg1N2Q=
+    ZjZjNzQ5Nzc5YjdmM2I3OTBiNzI0NDQ4NDM1Y2RiYzk3ZjAzYzg1MzQ5NGVh
+    NjExYmM5ZmNlOWEzODNiYjIwNzgyYjVmOWMyYzE1YmI2NjY2ODJkMjE4YzE3
+    OTczMjBjOGFiNDM2YTQ1NWY4ODhhYWFiMTg4ZDkzZDBjYjA0NmE=

data/CHANGES

@@ -1,3 +1,7 @@
+2014-05-20 Clinton Wolfe 0.6.1
+   Fixed issue #6, inconsistent behavior for 'enum' and 'type' checks when a attr has a nil value
+   Fixed issue #5, pathfinder breaking when given a path containing a stringified integer and no wildcards
+
 2014-01-27 Clinton Wolfe 0.6.0
    Loosened runtime dep on chef
 

data/README.md

@@ -50,6 +50,8 @@ Each rule gets a unique name.  Each entry is hash structure with the following k
 The remaining entries describe criteria to enforce on the value of the attribute(s) 
 referenced by 'path'.  You may list zero or more.
 
+Note that nil is permitted as a value by all checks, except the 'required' check (which performs nilness checks) and the 'proc' check (which implements arbitrary user behavior).
+
 #### type 
 
 Checks type of value.  One of 'string', 'number', 'boolean', 'hash', 'array'.
@@ -64,7 +66,7 @@ Integer.  Fails for all but Hash and Array.  For Hash and Array, maximum number
 
 #### present
 
-Boolean.  If true, fails if the path matches zero attributes.  If false, fails if the path matches nonzero attributes.  Does not consider nilness, only existence of attribute key(s).  See also required.
+Boolean.  If true, fails if the path matches zero attributes.  If false, fails if the path matches nonzero attributes.  This is most useful for enforcing deprecated attributes.  Does not consider nilness, only existence of attribute key(s).  See also required.
 
 #### regex
 

data/lib/chef-attribute-validator/check.rb

@@ -42,10 +42,7 @@ class Chef
            String,
           ].any? { |k| val.kind_of?(k) }
         end
-        
-
-
-
+       
       end
     end
   end

data/lib/chef-attribute-validator/checks/enum.rb

@@ -15,7 +15,7 @@ class Chef
           def check(attrset)
             violations = []
             attrset.each do |path, value|
-              if val_scalar?(value)
+              if val_scalar?(value) && ! value.nil?
                 unless check_arg.include?(value)
                   violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Attribute's value is '#{value}', which is not one of '#{check_arg.map{ |e| e.to_s }.join(',')} '")
                 end

data/lib/chef-attribute-validator/checks/type.rb

@@ -33,6 +33,7 @@ class Chef
             }
 
             attrset.each do |path, value|
+              next if value.nil?
               unless klasses[check_arg].any? {|k| value.kind_of?(k) }
                 violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Attribute's value is '#{value}', which does not appear to be the right type - expected '#{check_arg}'")
               end

data/lib/chef-attribute-validator/version.rb

@@ -1,7 +1,7 @@
 class Chef
   class Attribute
     class Validator
-      VERSION = "0.6.0"
+      VERSION = "0.6.1"
     end
   end
 end

data/lib/chef-attribute-validator/wildcard_expander.rb

@@ -23,9 +23,6 @@ class Chef
           # Since we begin with /, the first element is ""
           if steps[0] == "" then steps.shift end
 
-          # Promote integer strings to integers
-          steps.map! { |s| s.match(/^\d+$/) ? s.to_i : s }
-
           steps
         end
 
@@ -35,11 +32,27 @@ class Chef
           nv = node
           steps = slashpath_to_steps(slashpath)
           while steps.size > 0 
-            nv = nv[steps.shift]
+            step = steps.shift
+            if nv.kind_of?(Chef::Node::ImmutableArray) then
+              step = convert_step_to_integer(step)
+              return nil if step.nil? # Given a non-int path step for an array...
+            end
+            nv = nv[step]
           end
           nv
         end
 
+        def convert_step_to_integer(step)
+          if step.match(/^\d+$/) then 
+            # Treat things that start with leading zeros as strings, not as integers.  This supports 
+            # having attributes like '00', and calling that an error if you try to access the 00 element of an array.
+            return nil if step.match(/^0+\d+$/)
+            return step.to_i
+          else
+            return nil
+          end          
+        end
+
         def path_exists_by_slashpath? (slashpath)
           nv = node
           steps = slashpath_to_steps(slashpath)
@@ -47,10 +60,12 @@ class Chef
             step = steps.shift
             
             if nv.kind_of?(Chef::Node::ImmutableArray) then
-              # TODO: what if the step isn't an int?
+
+              step_as_int = convert_step_to_integer(step) 
+              return false if step_as_int.nil? # Given a non-int path step for an array...
               
-              if nv.size > step then
-                nv = nv[step]
+              if nv.size > step_as_int then
+                nv = nv[step_as_int]
               else
                 # Array not long enough
                 return false

data/test/fixtures/check_enum_assorted.rb

@@ -8,13 +8,13 @@ default['fruits']['a'] = 'banana'
 default['fruits']['b'] = 'gichee'
 default['fruits']['c'] = 'tomato'
 
-default['cats'][0] = 'leopard'
-default['cats'][1] = 'puma'
-default['cats'][2] = 'mountain lion'
-default['cats'][3] = 'catamount'
-
+default['cats'] = [ 'leopard', 'puma', 'mountain lion', 'catamount' ]
 
 rules = default['attribute-validator']['rules']
+rules['nil'] = {
+  'path' =>  '/nil',
+  'enum' => ['a'],
+}
 rules['empty-a'] = {
   'path' =>  '/empty',
   'enum' => ['a'],

data/test/fixtures/check_proc_assorted.rb

@@ -20,7 +20,6 @@ proc_array_looks_fibonacci = Proc.new do |rule_name, attrset|
   prev1 = 0 
   prev2 = 1
   attrset.each do |path, value|
-    # binding.pry
     unless value == prev1 + prev2
       violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, 'Stopped looking like a fibonacci sequence')
     end

data/test/fixtures/regression_4_integer_in_path.rb

@@ -0,0 +1,12 @@
+default['array'] = [ { 'child0' => 'value' }, { 'child1' => 'value' } ]
+default['hash']['0']['child0'] = 'value'
+default['hash']['1']['child1'] = 'value'
+default['hash']['00']['child00'] = 'value'
+default['hash']['01']['child01'] = 'value'
+
+default['deeper_array']['poney'] = [ { 'child0' => 'value' }, { 'child1' => 'value' } ]
+default['deeper_hash']['poney']['0']['child0'] = 'value'
+default['deeper_hash']['poney']['1']['child1'] = 'value'
+default['deeper_hash']['poney']['00']['child00'] = 'value'
+default['deeper_hash']['poney']['01']['child01'] = 'value'
+

data/test/regression/4-integer-in-path.rb

@@ -0,0 +1,107 @@
+require_relative './spec_helper.rb'
+
+describe "Issue #4 - When the search path contains a stringified integer" do
+  let(:node) { CAVHelper.load_fixture_attributes('regression_4_integer_in_path') }
+  
+  context "when there is no wildcard in the path" do
+
+    context "when the path spec contains a single-digit int" do
+      context "when the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/array/0/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/array/0/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/hash/0/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/hash/0/child0')
+        end
+      end      
+    end
+
+    context "when the path spec contains a two-digit int" do
+      context "when the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/array/00/child0', node) }
+        it "should NOT find the entry" do
+          expect(exp.expand_all).not_to include('/array/00/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/hash/00/child00', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/hash/00/child00')
+        end
+      end      
+    end
+
+  end
+
+  context "when there is a wildcard on the int segment" do
+
+    context "when the path spec contains a single-digit int" do
+      context "when the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/array/*/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/array/0/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/hash/*/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/hash/0/child0')
+        end
+      end      
+    end
+
+    context "when the path spec contains a two-digit int" do
+      context "when the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/array/*/child0', node) }
+        it "should NOT find the entry" do
+          expect(exp.expand_all).not_to include('/array/00/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/hash/*/child00', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/hash/00/child00')
+        end
+      end      
+    end
+
+  end
+
+  context "when there is a wildcard prior to the int segment" do
+
+    context "when the path spec contains a single-digit int" do
+      context "the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/deeper_array/*/0/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/deeper_array/poney/0/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/deeper_hash/*/0/child0', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/deeper_hash/poney/0/child0')
+        end
+      end      
+    end
+
+    context "when the path spec contains a two-digit int" do
+      context "the targetted attribute is an array" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/deeper_array/*/00/child0', node) }
+        it "should NOT find the entry" do
+          expect(exp.expand_all).not_to include('/deeper_array/poney/00/child0')
+        end
+      end
+      context "when the targetted attribute is a hash" do        
+        let(:exp) { Chef::Attribute::Validator::WildcardExpander.choose('/deeper_hash/*/00/child00', node) }
+        it "should find the entry" do
+          expect(exp.expand_all).to include('/deeper_hash/poney/00/child00')
+        end
+      end      
+    end
+
+  end
+end

data/test/regression/spec_helper.rb

@@ -0,0 +1,17 @@
+
+require 'chef/node'
+
+require_relative '../../lib/chef-attribute-validator'
+
+module CAVHelper
+  def load_fixture_attributes(filename, node = nil)
+    node ||= Chef::Node.new
+    filepath = File.join(File.dirname(__FILE__), '..', 'fixtures', filename)
+    filepath = filepath.gsub(/\.rb$/, '') + '.rb'
+    node.from_file(filepath)
+    node
+  end
+
+  module_function :load_fixture_attributes
+
+end

data/test/unit/attr_set_spec_wildcard.rb

@@ -60,7 +60,7 @@ describe Chef::Attribute::Validator::AttributeSet do
       end
       let(:ats) {  Chef::Attribute::Validator::AttributeSet.new(node, '/*') }
       it "should be able to list all root elements" do
-        expect(ats.size).to eq 7
+        expect(ats.size).to eq 6
       end
     end
 

data/test/unit/check_enum_spec.rb

@@ -47,6 +47,10 @@ describe "'enum' check" do
       expect(av.validate_rule('empty-empty-match')).to be_empty
     end
 
+    it "should not violate on a nil-valued entry" do
+      expect(av.validate_rule('nil')).to be_empty
+    end
+
     it "should not violate on a hash-valued entry" do
       expect(av.validate_rule('hash')).to be_empty
     end

data/test/unit/check_looks_like_spec.rb

@@ -243,5 +243,4 @@ describe "'looks_like' check" do
 
   end
   
-
 end

data/test/unit/check_proc_spec.rb

@@ -51,10 +51,6 @@ describe "'proc' check" do
       expect(av.validate_rule('nil-always-fail')).not_to be_empty
     end
 
-    it "a violation should include the correct rule name" do
-      expect(av.validate_rule('nil-always-fail')[0].rule_name).to eql 'nil-always-fail'
-    end
-
     it "fibonacci scanner should not violate on a correct fib sequence" do
       expect(av.validate_rule('valid-fibo')).to be_empty
     end
@@ -63,6 +59,9 @@ describe "'proc' check" do
       expect(av.validate_rule('invalid-fibo')).not_to be_empty
     end
 
+    it "a violation should include the correct rule name" do
+      expect(av.validate_rule('invalid-fibo')[0].rule_name).to eql 'invalid-fibo'
+    end
 
   end
 

data/test/unit/check_regex_spec.rb

@@ -38,6 +38,10 @@ describe "'regex' check" do
       expect(av.validate_rule('empty-empty')).to be_empty
     end
 
+    it "/foo/ should not violate on nil" do
+      expect(av.validate_rule('foo-nil')).to be_empty
+    end
+
     it "/foo/ should not violate on foo" do
       expect(av.validate_rule('foo-foo')).to be_empty
     end

data/test/unit/check_type_spec.rb

@@ -27,8 +27,8 @@ describe "'type' check" do
       expect(av.validate_rule('string-number')).not_to be_empty
     end
 
-    it "should violate on nil" do
-      expect(av.validate_rule('string-nil')).not_to be_empty
+    it "should not violate on nil" do
+      expect(av.validate_rule('string-nil')).to be_empty
     end
 
     it "should violate on array" do
@@ -57,8 +57,8 @@ describe "'type' check" do
       expect(av.validate_rule('number-as-string')).not_to be_empty
     end
 
-    it "should violate on nil" do
-      expect(av.validate_rule('number-nil')).not_to be_empty
+    it "should not violate on nil" do
+      expect(av.validate_rule('number-nil')).to be_empty
     end
 
     it "should violate on array" do
@@ -99,8 +99,8 @@ describe "'type' check" do
       expect(av.validate_rule('boolean-empty')).not_to be_empty
     end
 
-    it "should violate on nil" do
-      expect(av.validate_rule('boolean-nil')).not_to be_empty
+    it "should not violate on nil" do
+      expect(av.validate_rule('boolean-nil')).to be_empty
     end
 
     it "should violate on array" do
@@ -141,8 +141,8 @@ describe "'type' check" do
       expect(av.validate_rule('array-zero')).not_to be_empty
     end
 
-    it "should violate on nil" do
-      expect(av.validate_rule('array-nil')).not_to be_empty
+    it "should not violate on nil" do
+      expect(av.validate_rule('array-nil')).to be_empty
     end
 
     it "should violate on hash" do
@@ -179,8 +179,8 @@ describe "'type' check" do
       expect(av.validate_rule('hash-zero')).not_to be_empty
     end
 
-    it "should violate on nil" do
-      expect(av.validate_rule('hash-nil')).not_to be_empty
+    it "should not violate on nil" do
+      expect(av.validate_rule('hash-nil')).to be_empty
     end
 
     it "should violate on array" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-attribute-validator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Clinton Wolfe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,16 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: !binary |-
+          MS4z
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: !binary |-
+          MS4z
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,11 +132,14 @@ files:
 - test/fixtures/expander_brutal_deep_hash.rb
 - test/fixtures/expander_brutal_deep_mixed.rb
 - test/fixtures/expander_brutal_flat.rb
+- test/fixtures/regression_4_integer_in_path.rb
 - test/fixtures/rules_empty.rb
 - test/fixtures/rules_missing_path.rb
 - test/fixtures/rules_no_check.rb
 - test/fixtures/rules_type_and_min_children.rb
 - test/fixtures/rules_type_check.rb
+- test/regression/4-integer-in-path.rb
+- test/regression/spec_helper.rb
 - test/unit/attr_set_spec.rb
 - test/unit/attr_set_spec_wildcard.rb
 - test/unit/check_child_count_spec.rb
@@ -216,11 +221,14 @@ test_files:
 - test/fixtures/expander_brutal_deep_hash.rb
 - test/fixtures/expander_brutal_deep_mixed.rb
 - test/fixtures/expander_brutal_flat.rb
+- test/fixtures/regression_4_integer_in_path.rb
 - test/fixtures/rules_empty.rb
 - test/fixtures/rules_missing_path.rb
 - test/fixtures/rules_no_check.rb
 - test/fixtures/rules_type_and_min_children.rb
 - test/fixtures/rules_type_check.rb
+- test/regression/4-integer-in-path.rb
+- test/regression/spec_helper.rb
 - test/unit/attr_set_spec.rb
 - test/unit/attr_set_spec_wildcard.rb
 - test/unit/check_child_count_spec.rb
@@ -234,4 +242,3 @@ test_files:
 - test/unit/expanders/brutal_regex_spec.rb
 - test/unit/rule_parse_spec.rb
 - test/unit/spec_helper.rb
-has_rdoc: