chef-attribute-validator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MThmOWZjYmNhMzI0ODZiODM4ZmNmMWYzOGVkYjNjZDIyMWMzZGU0OA==
+    NDNkM2Y5MDMwZTEwNmYwN2Q0ZmQ3NzkzYzQyN2NlNjE2ODYwNTc1Mg==
   data.tar.gz: !binary |-
-    ZWU3YmQzMGNkYmQ2Y2ExYTE1NWQ4MWY1MmUzNDVhMTljNjAzNDE0MA==
+    ZjNiMGQwNDZkM2Y0MmI2OGFjZWM3MTM0MjI2ZDA2OGRhNTFkZWZjNg==
 SHA512:
   metadata.gz: !binary |-
-    ZDFiZjFiNmUyZDE2MTljOTI3ZWNiNDI5ZjVjN2ZmNTAyYTVhMDdiMzMwZmU1
-    MGZmODUxZDIyNjJhNjJhMmMzODYzMjMwZWFkMDIyNzg3YWU5YWZkYjQ1Mjg3
-    YzU5YTJiNjM3NDM0Y2EwM2FlYjdmMGZmNjEzMzU3M2FiYTU2OGI=
+    NWY1MTBhNTk3MTU2MTQ4NWFkZDk5MjY5NTdlZTY2ODI1YTQ4ZDcwYzU5MGQx
+    NGFlMmE1OTZhZjdiZWIwZDNiZGY1YzI0YWY3MjAzYTlhYTI0YjliNmM0NzA3
+    NzUwNzczMjI1OWVjNzFkNjdiNDYyYzE4NDAxZWUyYWYxNGZkNDA=
   data.tar.gz: !binary |-
-    MmVmZWQ1YzA2M2ZlOTkxMjE2ZDg5ZGE0MmI0NGRkZTcwNDQ3M2I5YWRhYTdk
-    OTY3N2E3ZjZhN2I4NTk5YTc2NjBlYjk5ZDViMWI5M2U3NDM4M2NjYjlmNTNi
-    NTdjNzJmMzI4MWM5NDNjYWQ0ZmU3MGZmYWU5NmRjY2ZlYmQ0YjU=
+    ZWM3YzFjMjRhZTY2MjYzNjI3YzhhZmU4ZGY4ZDNhMGExYmY5YzMzZDljYmQw
+    NWQzNThjN2UwOWI3YjkyNTQ1YTJhOWRhZjFjZTIxZGJiYjJjNjBkMWYzZjdl
+    ZTliYWRhOGQ5ZDk2ZjExYjZkM2Q0ZTdiMjljMTVhZjJjOTViOTQ=

data/CHANGES

@@ -1,3 +1,7 @@
+2013-11-12 Clinton Wolfe 0.3.0 
+   Support for enum check 
+   Support for proc check
+
 2013-11-12 Clinton Wolfe 0.2.0
    Support for wildcards - *, **, ?
      Crude implementation using brute force and regexes

data/README.md

@@ -56,6 +56,8 @@ referenced by 'path'.  You may list zero or more.
      regex - Regexp.  Applies given regex to the value.  Ignored for Hash and Array.  See looks_like for a selection of canned regexen.
      required - Boolean.  If true, fails if the path matches zero attributes, or the value is nil, or the value is the empty string, or if the value is an empty array or empty hash.  No-op if false (use present => false to enforce absence).
      looks_like - String, one of 'url', 'ip'. Applies canned regexes (or more sophisticated matchers).
+     enum - Array, a set of possible values.  
+     proc - a Proc, which should take two args - a string rule name, and a Chef::Attribute::Validator::AttributeSet.  You can treat the attribute set as a hash - its each() methods will yield path, value pairs.  The proc should return a possibly empty array of Chef::Attribute::Validator::Violations.
 
 ## Referencing Attributes
 

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

@@ -0,0 +1,31 @@
+class Chef
+  class Attribute
+    class Validator
+      class Check
+        class Enum < Check
+
+          register_check('enum', Enum)
+
+          def validate_check_arg
+            unless check_arg.kind_of?(Array)
+              raise "Bad 'enum' check argument '#{check_arg}' for rule '#{rule_name}' - expected an Array"
+            end
+          end
+
+          def check(attrset)
+            violations = []
+            attrset.each do |path, value|
+              if val_scalar?(value)
+                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
+              end
+            end
+            violations
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+class Chef
+  class Attribute
+    class Validator
+      class Check
+        class Proc < Check
+
+          register_check('proc', Proc)
+
+          def validate_check_arg
+            unless check_arg.kind_of?(::Proc)
+              raise "Bad 'proc' check argument '#{check_arg}' for rule '#{rule_name}' - expected a Proc"
+            end
+            unless check_arg.arity == 2
+              raise "Bad 'proc' check argument '#{check_arg}' for rule '#{rule_name}' - Proc must take exactly two arguments, a rule name and an AttributeSet."
+            end
+          end
+
+          def check(attrset)
+            check_arg.call(rule_name, attrset)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 class Chef
   class Attribute
     class Validator
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

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

@@ -39,7 +39,7 @@ class Chef
               end
             else
               node_cursor.keys.each do |key|
-                child_paths.push prefix + '/' + key
+                child_paths.push prefix + '/' + key.to_s
                 if node_cursor[key].kind_of?(Mash) || node_cursor[key].kind_of?(Array)
                   child_paths += find_all_slashpaths(prefix + '/' + key, node_cursor[key])
                 end

data/test/fixtures/check_enum_array_empty.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-enum-array-empty'] = {
+  'path' =>  '/empty',
+  'enum' => [],
+}
+

data/test/fixtures/check_enum_array_mixed.rb

@@ -0,0 +1,7 @@
+rules = default['attribute-validator']['rules']
+rules['check-enum-array-mixed'] = {
+  'path' =>  '/empty',
+  'enum' => ['a', :b, 3],
+}
+
+

data/test/fixtures/check_enum_array_strings.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-enum-array-empty'] = {
+  'path' =>  '/empty',
+  'enum' => ['a', 'b', 'c'],
+}
+

data/test/fixtures/check_enum_assorted.rb

@@ -0,0 +1,52 @@
+default['empty'] = ""
+default['nil'] = nil
+
+default['not']['a']['scalar']['here'] = {}
+
+
+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'
+
+
+rules = default['attribute-validator']['rules']
+rules['empty-a'] = {
+  'path' =>  '/empty',
+  'enum' => ['a'],
+}
+rules['empty-empty'] = {
+  'path' =>  '/empty',
+  'enum' => [],
+}
+rules['empty-empty-match'] = {
+  'path' =>  '/empty',
+  'enum' => [''],
+}
+rules['hash'] = {
+  'path' => '/not/a/scalar',
+  'enum' => [ 'a' ],
+}
+rules['fruits'] = {
+  'path' => '/fruits/a',
+  'enum' => ['banana', 'gichee', 'apple'],
+}
+rules['mixed-fruits'] = {
+  'path' => '/fruits/b',
+  'enum' => [:banana, 'gichee', 23],
+}
+
+rules['today-its-a-vegetable'] = {
+  'path' => '/fruits/c',
+  'enum' => ['banana', 'gichee', 'apple'],
+}
+
+rules['cougars'] = {
+  'path' => '/cats/*',
+  'enum' => ['leopard', 'puma', 'mountain lion', 'catamount'],
+}
+

data/test/fixtures/check_enum_nil.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-enum-nil'] = {
+  'path' =>  '/empty',
+  'enum' => nil,
+}
+

data/test/fixtures/check_enum_string.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-enum-string'] = {
+  'path' =>  '/empty',
+  'enum' => 'lol, l8r, <3',
+}
+

data/test/fixtures/check_proc_arity0.rb

@@ -0,0 +1,10 @@
+rules = default['attribute-validator']['rules']
+rules['check-proc-nil'] = {
+  'path' =>  '/nope',
+  'proc' => Proc.new do
+    []
+  end
+
+    
+}
+

data/test/fixtures/check_proc_arity1.rb

@@ -0,0 +1,10 @@
+rules = default['attribute-validator']['rules']
+rules['check-proc-nil'] = {
+  'path' =>  '/nope',
+  'proc' => Proc.new do |attrs|
+    []
+  end
+
+    
+}
+

data/test/fixtures/check_proc_arity2.rb

@@ -0,0 +1,10 @@
+rules = default['attribute-validator']['rules']
+rules['check-proc-nil'] = {
+  'path' =>  '/nope',
+  'proc' => Proc.new do |a,b|
+    []
+  end
+
+    
+}
+

data/test/fixtures/check_proc_arity3.rb

@@ -0,0 +1,10 @@
+rules = default['attribute-validator']['rules']
+rules['check-proc-nil'] = {
+  'path' =>  '/nope',
+  'proc' => Proc.new do |a,b,c|
+    []
+  end
+
+    
+}
+

data/test/fixtures/check_proc_assorted.rb

@@ -0,0 +1,63 @@
+default['nil'] = nil
+default['bunnies'] = [1, 2, 3, 5, 8]
+default['rabbot'] = [1, 2, 3, 5, 8, 0]
+
+
+rules = default['attribute-validator']['rules']
+
+proc_never_fail = Proc.new do |rule_name, attrset|
+  # No matter what, return no violations
+  []
+end
+
+proc_always_fail = Proc.new do |rule_name, attrset|
+  # No matter what, return a violation
+  [ Chef::Attribute::Validator::Violation.new(rule_name, '/meh', 'I always fail') ]
+end
+
+proc_array_looks_fibonacci = Proc.new do |rule_name, attrset|
+  violations = []
+  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
+    prev1 = prev2
+    prev2 = value
+  end
+  violations
+end
+
+
+rules['missing-never-fail'] = {
+  'path' =>  '/nope',
+  'proc' => proc_never_fail
+}
+
+rules['nil-never-fail'] = {
+  'path' =>  '/nil',
+  'proc' => proc_never_fail
+}
+
+rules['nil-always-fail'] = {
+  'path' =>  '/nil',
+  'proc' => proc_always_fail
+}
+
+rules['missing-always-fail'] = {
+  'path' =>  '/nope',
+  'proc' => proc_always_fail
+}
+
+rules['valid-fibo'] = {
+  'path' =>  '/bunnies/*',
+  'proc' => proc_array_looks_fibonacci
+}
+rules['invalid-fibo'] = {
+  'path' =>  '/rabbot/*',
+  'proc' => proc_array_looks_fibonacci
+}
+
+

data/test/fixtures/check_proc_nil.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-proc-nil'] = {
+  'path' =>  '/nope',
+  'proc' => nil,
+}
+

data/test/unit/check_enum_spec.rb

@@ -0,0 +1,72 @@
+require_relative './spec_helper'
+
+describe "'enum' check" do
+
+  describe "check registry" do
+    it "should be present in the Check registry" do
+      expect(Chef::Attribute::Validator::Check.list_check_types).to include('enum')
+    end
+  end
+
+  describe "check_arg checks" do
+    it "should accept an empty array" do
+      node = CAVHelper.load_fixture_attributes('check_enum_array_empty')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept an array of strings" do
+      node = CAVHelper.load_fixture_attributes('check_enum_array_strings')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept a mixed array" do
+      node = CAVHelper.load_fixture_attributes('check_enum_array_mixed')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should reject a string" do
+      node = CAVHelper.load_fixture_attributes('check_enum_string')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+    it "should reject a nil" do
+      node = CAVHelper.load_fixture_attributes('check_enum_nil')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+  end
+
+  describe "assorted arrays" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_enum_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should violate on an empty string with an empty enum list" do
+      expect(av.validate_rule('empty-empty')).not_to be_empty
+    end
+
+    it "should violate on an empty string with a non-empty enum list" do
+      expect(av.validate_rule('empty-a')).not_to be_empty
+    end
+
+    it "should not violate on an empty string with a '' enum list" do
+      expect(av.validate_rule('empty-empty-match')).to be_empty
+    end
+
+    it "should not violate on a hash-valued entry" do
+      expect(av.validate_rule('hash')).to be_empty
+    end
+
+    it "should not violate on a simple entry" do
+      expect(av.validate_rule('fruits')).to be_empty
+    end
+
+    it "should not violate on a mixed entry" do
+      expect(av.validate_rule('mixed-fruits')).to be_empty
+    end
+
+    it "should not violate when running over an array attribute" do
+      expect(av.validate_rule('cougars')).to be_empty
+    end
+
+    it "should violate when a tomato is not a fruit" do
+      expect(av.validate_rule('today-its-a-vegetable')).not_to be_empty
+    end
+
+  end
+
+end

data/test/unit/check_proc_spec.rb

@@ -0,0 +1,69 @@
+require_relative './spec_helper'
+
+describe "'proc' check" do
+
+  describe "check registry" do
+    it "should be present in the Check registry" do
+      expect(Chef::Attribute::Validator::Check.list_check_types).to include('proc')
+    end
+  end
+
+  describe "check_arg checks" do
+    it "should reject nil" do
+      node = CAVHelper.load_fixture_attributes('check_proc_nil')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+    it "should reject a 0-arg Proc" do
+      node = CAVHelper.load_fixture_attributes('check_proc_arity0')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+    it "should reject a 1-arg Proc" do
+      node = CAVHelper.load_fixture_attributes('check_proc_arity1')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+    it "should accept a 2-arg Proc" do
+      node = CAVHelper.load_fixture_attributes('check_proc_arity2')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should reject a 3-arg Proc" do
+      node = CAVHelper.load_fixture_attributes('check_proc_arity3')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+  end
+
+  describe "assorted procs" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_proc_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate on a missing attribute with a never-fail proc" do
+      expect(av.validate_rule('missing-never-fail')).to be_empty
+    end
+
+    it "should not violate on a nil attribute with a never-fail proc" do
+      expect(av.validate_rule('nil-never-fail')).to be_empty
+    end
+
+    it "should violate on a missing attribute with an always-fail proc" do
+      expect(av.validate_rule('missing-always-fail')).not_to be_empty
+    end
+
+    it "should violate on a nil attribute with an always-fail proc" 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
+
+    it "fibonacci scanner should violate on a incorrect fib sequence" do
+      expect(av.validate_rule('invalid-fibo')).not_to be_empty
+    end
+
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-attribute-validator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Clinton Wolfe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,9 +74,11 @@ files:
 - lib/chef-attribute-validator.rb
 - lib/chef-attribute-validator/attribute_set.rb
 - lib/chef-attribute-validator/check.rb
+- lib/chef-attribute-validator/checks/enum.rb
 - lib/chef-attribute-validator/checks/looks_like.rb
 - lib/chef-attribute-validator/checks/max_children.rb
 - lib/chef-attribute-validator/checks/min_children.rb
+- lib/chef-attribute-validator/checks/proc.rb
 - lib/chef-attribute-validator/checks/regex.rb
 - lib/chef-attribute-validator/checks/required.rb
 - lib/chef-attribute-validator/checks/type.rb
@@ -88,12 +90,24 @@ files:
 - lib/chef-attribute-validator/wildcard_expander/no_wildcards.rb
 - test/fixtures/attr_set.rb
 - test/fixtures/check_child_count.rb
+- test/fixtures/check_enum_array_empty.rb
+- test/fixtures/check_enum_array_mixed.rb
+- test/fixtures/check_enum_array_strings.rb
+- test/fixtures/check_enum_assorted.rb
+- test/fixtures/check_enum_nil.rb
+- test/fixtures/check_enum_string.rb
 - test/fixtures/check_looks_like_arg_ip.rb
 - test/fixtures/check_looks_like_arg_regex.rb
 - test/fixtures/check_looks_like_arg_url.rb
 - test/fixtures/check_looks_like_arg_your_mom.rb
 - test/fixtures/check_looks_like_ip.rb
 - test/fixtures/check_looks_like_url.rb
+- test/fixtures/check_proc_arity0.rb
+- test/fixtures/check_proc_arity1.rb
+- test/fixtures/check_proc_arity2.rb
+- test/fixtures/check_proc_arity3.rb
+- test/fixtures/check_proc_assorted.rb
+- test/fixtures/check_proc_nil.rb
 - test/fixtures/check_regex_assorted.rb
 - test/fixtures/check_regex_literal.rb
 - test/fixtures/check_regex_nil.rb
@@ -115,7 +129,9 @@ files:
 - test/unit/attr_set_spec.rb
 - test/unit/attr_set_spec_wildcard.rb
 - test/unit/check_child_count_spec.rb
+- test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
+- test/unit/check_proc_spec.rb
 - test/unit/check_regex_spec.rb
 - test/unit/check_required_spec.rb
 - test/unit/check_type_spec.rb
@@ -149,12 +165,24 @@ summary: A Rubygem implementing a rule engine for validating Chef node attribute
 test_files:
 - test/fixtures/attr_set.rb
 - test/fixtures/check_child_count.rb
+- test/fixtures/check_enum_array_empty.rb
+- test/fixtures/check_enum_array_mixed.rb
+- test/fixtures/check_enum_array_strings.rb
+- test/fixtures/check_enum_assorted.rb
+- test/fixtures/check_enum_nil.rb
+- test/fixtures/check_enum_string.rb
 - test/fixtures/check_looks_like_arg_ip.rb
 - test/fixtures/check_looks_like_arg_regex.rb
 - test/fixtures/check_looks_like_arg_url.rb
 - test/fixtures/check_looks_like_arg_your_mom.rb
 - test/fixtures/check_looks_like_ip.rb
 - test/fixtures/check_looks_like_url.rb
+- test/fixtures/check_proc_arity0.rb
+- test/fixtures/check_proc_arity1.rb
+- test/fixtures/check_proc_arity2.rb
+- test/fixtures/check_proc_arity3.rb
+- test/fixtures/check_proc_assorted.rb
+- test/fixtures/check_proc_nil.rb
 - test/fixtures/check_regex_assorted.rb
 - test/fixtures/check_regex_literal.rb
 - test/fixtures/check_regex_nil.rb
@@ -176,7 +204,9 @@ test_files:
 - test/unit/attr_set_spec.rb
 - test/unit/attr_set_spec_wildcard.rb
 - test/unit/check_child_count_spec.rb
+- test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
+- test/unit/check_proc_spec.rb
 - test/unit/check_regex_spec.rb
 - test/unit/check_required_spec.rb
 - test/unit/check_type_spec.rb