chef-attribute-validator 0.6.1 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGNhOTQ2Yzg2ZmNjODk4M2I3ZjAzM2U2YjAzNTgxMTExYmY0MGY0YQ==
+    NzA5OGRmZWY5NTA2YmRiMjkyNTFjOTY1ZDY2MzUzZjA0M2E1YzI5Mg==
   data.tar.gz: !binary |-
-    MmRkZmM4Y2NmYWJhNzNmMzM2OGU1Mzc4MTU3M2ZkOTMzMGEwNDc3Yg==
+    ZTkwOGY2NDJhZmEwNTljMGZkM2VhMjE5ZTM3NzJhOWQ0NzcyMTNhMw==
 SHA512:
   metadata.gz: !binary |-
-    NDJkYWMxZDI4YzdhMWY2ZTVhYWRjMjU1YTg5ZmYyMTQwNjRkZjkwMGIzMTBl
-    Y2VlMjgzNmM5OTVjMDM1N2I3YTU1Y2Y2OGRkZGRkOWE3NWVjYjg4ZGE5ODc5
-    OTU2ZTk2MGU2NWVkZTVlMTRmY2MxOTVlZmVkZmUxNDEzZDViOGM=
+    ZDIyYzhmODk5Mzg2YTg0ZDgxZWRkYTgxZjE3NzllZTAzYWE2NmUyYmJiODQ4
+    ZTZlZGUxMmRmZDI0YTZjMmE5NjFlOWI2Mzk4ODcyNWMwNTU5NGRkODQ0YWZh
+    YTUyOWRiYzg5MDdiMzU5MWRhNGYxYjY5N2Y2YTk4OTljMDdlOWI=
   data.tar.gz: !binary |-
-    ZjZjNzQ5Nzc5YjdmM2I3OTBiNzI0NDQ4NDM1Y2RiYzk3ZjAzYzg1MzQ5NGVh
-    NjExYmM5ZmNlOWEzODNiYjIwNzgyYjVmOWMyYzE1YmI2NjY2ODJkMjE4YzE3
-    OTczMjBjOGFiNDM2YTQ1NWY4ODhhYWFiMTg4ZDkzZDBjYjA0NmE=
+    ZGVkZmM2YzhlZDYyYmRmNmIzYjgzZmYyMWU3ZjA5MjY4ZmQwMmQ2NWM3Nzk3
+    MTIwNTE2NjhlNzEzODdjNzExYzQxNTRhZTY3NWU3MTA0OWNkZTNiOGVlZjJj
+    M2VlNzQxNjAyYWQxOGMyZWYwMzgyOTY2ODIwMmMyYTZhN2VjMzc=

data/CHANGES

@@ -1,3 +1,6 @@
+2014-05-21 Clinton Wolfe 0.7.0
+   Added 'child_keys' check type
+
 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

data/README.md

@@ -50,7 +50,16 @@ 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).
+Note that nil is permitted as a value by most checks, except the following: 
+
+  'required' check (which performs nilness checks)
+  'proc' check (which implements arbitrary user behavior)
+  'min_children', 'max_children' (which are restricted to operating on Hashes and Arrays)
+  'child_keys' (which is restricted to operating on Hashes)
+
+#### child_keys
+
+Checks the immediate keys of the given path (which must be a Hash).  Check argument may be an Array of Strings, in which case each key that is present must be in the list of valid keys, or else a Regexp, which will be matched against each key.
 
 #### type 
 
@@ -78,7 +87,7 @@ Boolean.  If true, fails if the path matches zero attributes, or the value is ni
 
 #### looks_like
 
-String, one of 'email', 'guid', 'ip', 'url'.  Applies canned regexes (or more sophisticated matchers, like constructing objects from the stdlib).  Details:
+String, one of 'email', 'guid', 'hostname', 'ip', 'url'.  Applies canned regexes (or more sophisticated matchers, like constructing objects from the stdlib).  Details:
 
 ##### email
 
@@ -134,7 +143,7 @@ Possibly eventually support for [<charclass>], or {<alternatives>}.
 
 #### Planned checks:
 
-   name_regex - Regexp.  Applies given regex to the last element in the attribute path ('basename', if you will)   
+Perhaps a hostname:port looks_like?
 
 ### Bugs and Defects
 

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

@@ -0,0 +1,46 @@
+class Chef
+  class Attribute
+    class Validator
+      class Check
+        class ChildKeys < Check
+
+          register_check('child_keys', ChildKeys)
+
+          def validate_check_arg
+            if check_arg.kind_of?(Array)
+              unless check_arg.all? { |e| e.kind_of?(String) } 
+                raise "Bad 'child_keys' check argument '#{check_arg}' for rule '#{rule_name}' - expected a Regexp or an Array of Strings."
+              end
+            elsif ! check_arg.kind_of?(Regexp)
+              raise "Bad 'child_keys' check argument '#{check_arg}' for rule '#{rule_name}' - expected a Regexp or an Array of Strings."
+            end
+          end
+
+          def check(attrset)
+            violations = []
+            attrset.each do |path, value|
+              # Must be hashlike
+              if [ Mash, Hash ].any? { |k| value.kind_of?(k) }
+                value.keys.each do |key|
+                  if check_arg.kind_of?(Array)
+                    unless check_arg.include?(key)
+                      violations.push Chef::Attribute::Validator::Violation.new(rule_name, path + '/' + key, "Child Key #{key} must be one of #{check_arg.join(', ')}.")                      
+                    end
+                  elsif check_arg.kind_of?(Regexp)
+                    unless check_arg.match(key)
+                      violations.push Chef::Attribute::Validator::Violation.new(rule_name, path + '/' + key, "Child Key #{key} does not match regex '#{check_arg}'")
+                    end
+                  end
+                end
+              else
+                violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Attribute's value is '#{value}', but must be a Hash-like thing to use child_keys")
+              end
+            end
+            violations
+          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.6.1"
+      VERSION = "0.7.0"
     end
   end
 end

data/test/fixtures/check_child_keys_arg_array.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-child-keys-arg-array'] = {
+  'path' =>  '/nil',
+  'child_keys' => ['thing','thang','thung']
+}
+

data/test/fixtures/check_child_keys_arg_literal_regex.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-child-keys-arg-literal-regex'] = {
+  'path' =>  '/nil',
+  'child_keys' => /^$/,
+}
+

data/test/fixtures/check_child_keys_arg_nil.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-child-keys-arg-nil'] = {
+  'path' =>  '/nil',
+  'child_keys' => nil,
+}
+

data/test/fixtures/check_child_keys_arg_regexp_object.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-child-keys-arg-regexp-object'] = {
+  'path' =>  '/nil',
+  'child_keys' => Regexp.new('foo')
+}
+

data/test/fixtures/check_child_keys_arg_string.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-child-keys-arg-string'] = {
+  'path' =>  '/nil',
+  'child_keys' => 'thing',
+}
+

data/test/fixtures/check_child_keys_assorted.rb

@@ -0,0 +1,90 @@
+default['nil'] = nil
+default['scalar'] = 'thing'
+default['array'] = [ 1, 2, 3 ]
+default['empty-hash'] = {}
+default['three']['foo'] = 1
+default['three']['oofoo'] = 2
+default['three']['foof'] = 3
+default['two']['foo'] = 1
+default['two']['goof'] = 1
+
+default['foo']['foo'] = 1
+default['bar']['bar'] = 1
+default['barfoo']['bar'] = 1
+default['barfoo']['foo'] = 1
+default['foobarbaz']['foo'] = 1
+default['foobarbaz']['bar'] = 1
+default['foobarbaz']['baz'] = 1
+default['baz']['baz'] = 1
+
+rules = default['attribute-validator']['rules']
+rules['re-foo-nil'] = {
+  'path' =>  '/nil',
+  'child_keys' => /foo/,
+}
+rules['re-foo-scalar'] = {
+  'path' =>  '/scalar',
+  'child_keys' => /foo/,
+}
+rules['re-foo-array'] = {
+  'path' =>  '/array',
+  'child_keys' => /foo/,
+}
+rules['re-foo-empty-hash'] = {
+  'path' =>  '/empty-hash',
+  'child_keys' => /foo/,
+}
+rules['re-foo-three'] = {
+  'path' =>  '/three',
+  'child_keys' => /foo/,
+}
+rules['re-foo-two'] = {
+  'path' =>  '/two',
+  'child_keys' => /foo/,
+}
+
+
+
+rules['ar-foo-nil'] = {
+  'path' =>  '/nil',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-scalar'] = {
+  'path' =>  '/scalar',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-array'] = {
+  'path' =>  '/array',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-empty-hash'] = {
+  'path' =>  '/empty-hash',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-foo'] = {
+  'path' =>  '/foo',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-bar'] = {
+  'path' =>  '/bar',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-barfoo'] = {
+  'path' =>  '/barfoo',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-foobarbaz'] = {
+  'path' =>  '/foobarbaz',
+  'child_keys' => ['foo', 'bar'],
+}
+rules['ar-foo-baz'] = {
+  'path' =>  '/baz',
+  'child_keys' => ['foo', 'bar'],
+}
+
+
+
+
+
+
+

data/test/unit/check_child_keys_spec.rb

@@ -0,0 +1,109 @@
+require_relative './spec_helper'
+
+# Verify that the 'child_keys' check works correctly
+
+describe "'child_keys' 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('child_keys')
+    end
+  end
+
+  describe "check_arg checks" do
+    it "should accept a // literal regex" do
+      node = CAVHelper.load_fixture_attributes('check_child_keys_arg_literal_regex')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept a Regexp object" do
+      node = CAVHelper.load_fixture_attributes('check_child_keys_arg_regexp_object')
+      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_child_keys_arg_array')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should reject a string" do
+      node = CAVHelper.load_fixture_attributes('check_child_keys_arg_string')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+    it "should reject a nil regex" do
+      node = CAVHelper.load_fixture_attributes('check_child_keys_arg_nil')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+  end
+
+  describe "assorted regexes" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_child_keys_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    # Must be a hash to have keys - empty hash OK
+    it "/foo/ should violate on nil" do
+      expect(av.validate_rule('re-foo-nil')).not_to be_empty
+    end
+
+    it "/foo/ should violate on a scalar" do
+      expect(av.validate_rule('re-foo-scalar')).not_to be_empty
+    end
+
+    it "/foo/ should violate on an array" do
+      expect(av.validate_rule('re-foo-array')).not_to be_empty
+    end
+
+    it "/foo/ should not violate on empty hash" do
+      expect(av.validate_rule('re-foo-empty-hash')).to be_empty
+    end
+
+    it "/foo/ should not violate on foo, oofoo, foof" do
+      expect(av.validate_rule('re-foo-three')).to be_empty
+    end
+
+    it "/foo/ should violate on foo, goof" do
+      expect(av.validate_rule('re-foo-two')).not_to be_empty
+    end
+  end
+
+  describe "assorted arrays" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_child_keys_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    # Must be a hash to have keys - empty hash OK
+    it "['foo', 'bar'] should violate on nil" do
+      expect(av.validate_rule('ar-foo-nil')).not_to be_empty
+    end
+
+    it "['foo', 'bar'] should violate on a scalar" do
+      expect(av.validate_rule('ar-foo-scalar')).not_to be_empty
+    end
+
+    it "['foo', 'bar'] should violate on an array" do
+      expect(av.validate_rule('ar-foo-array')).not_to be_empty
+    end
+
+    it "['foo', 'bar'] should not violate on empty hash" do
+      expect(av.validate_rule('ar-foo-empty-hash')).to be_empty
+    end
+
+    it "['foo', 'bar'] should not violate on foo" do
+      expect(av.validate_rule('ar-foo-foo')).to be_empty
+    end
+
+    it "['foo', 'bar'] should not violate on bar" do
+      expect(av.validate_rule('ar-foo-bar')).to be_empty
+    end
+
+    it "['foo', 'bar'] should not violate on bar, foo" do
+      expect(av.validate_rule('ar-foo-barfoo')).to be_empty
+    end
+
+    it "['foo', 'bar'] should violate on foo, bar, baz" do
+      expect(av.validate_rule('ar-foo-foobarbaz')).not_to be_empty
+    end
+
+    it "['foo', 'bar'] should violate on baz" do
+      expect(av.validate_rule('ar-foo-baz')).not_to be_empty
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-attribute-validator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Clinton Wolfe
@@ -74,6 +74,7 @@ files:
 - lib/chef-attribute-validator.rb
 - lib/chef-attribute-validator/attribute_set.rb
 - lib/chef-attribute-validator/check.rb
+- lib/chef-attribute-validator/checks/child_keys.rb
 - lib/chef-attribute-validator/checks/enum.rb
 - lib/chef-attribute-validator/checks/looks_like.rb
 - lib/chef-attribute-validator/checks/max_children.rb
@@ -91,6 +92,12 @@ files:
 - lib/chef-attribute-validator/wildcard_expander/no_wildcards.rb
 - test/fixtures/attr_set.rb
 - test/fixtures/check_child_count.rb
+- test/fixtures/check_child_keys_arg_array.rb
+- test/fixtures/check_child_keys_arg_literal_regex.rb
+- test/fixtures/check_child_keys_arg_nil.rb
+- test/fixtures/check_child_keys_arg_regexp_object.rb
+- test/fixtures/check_child_keys_arg_string.rb
+- test/fixtures/check_child_keys_assorted.rb
 - test/fixtures/check_enum_array_empty.rb
 - test/fixtures/check_enum_array_mixed.rb
 - test/fixtures/check_enum_array_strings.rb
@@ -143,6 +150,7 @@ files:
 - test/unit/attr_set_spec.rb
 - test/unit/attr_set_spec_wildcard.rb
 - test/unit/check_child_count_spec.rb
+- test/unit/check_child_keys_spec.rb
 - test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
 - test/unit/check_present_spec.rb
@@ -180,6 +188,12 @@ 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_child_keys_arg_array.rb
+- test/fixtures/check_child_keys_arg_literal_regex.rb
+- test/fixtures/check_child_keys_arg_nil.rb
+- test/fixtures/check_child_keys_arg_regexp_object.rb
+- test/fixtures/check_child_keys_arg_string.rb
+- test/fixtures/check_child_keys_assorted.rb
 - test/fixtures/check_enum_array_empty.rb
 - test/fixtures/check_enum_array_mixed.rb
 - test/fixtures/check_enum_array_strings.rb
@@ -232,6 +246,7 @@ 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_child_keys_spec.rb
 - test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
 - test/unit/check_present_spec.rb