chef-attribute-validator 0.3.2 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzE4YmM5ZjAyNGVjM2MyYTY5M2Q2OGFmMWE5YmM3YmRiNWFmNWNlZQ==
+    ZDJjZjdhYTFkYWNmMGU0ZTg1MDg4MzdlMWE5Nzg0ZGEwYzhlOGYxNQ==
   data.tar.gz: !binary |-
-    Y2FlNGQ5NTYyZWMzY2UzY2JjOTZmZmMwYzY3MzFiZGNiNjU2N2U2NA==
+    MmM1OTA0N2RiN2E1MjE3NmQxNTg1NDc5ZjRhN2E1OGJmMDdmNzY4MQ==
 SHA512:
   metadata.gz: !binary |-
-    ZjM2NDdkOTBiMzQ3MDU5MmNkOGE1OGJlYzliZTY4ZWQ2NjZmNzcwODc0YmVl
-    OWEzZDdhYWYzOGExMmJiMDAwMTQ1OWYxNzg3MDYyZWE5ZmI4NjI4NDYzYWFj
-    ZTc3ODYzNTI0YTYxNTljNzdkOWNlN2RkNTIyZjI3MThiOWUzY2U=
+    NGMxOTE3M2Y3NTk3ZDU0NmJiY2I2YTdlZGIyYjY2MzBiMmUzNzk3OWQ3ZDhj
+    Yjc0NTA3MDZjN2M0NjAxYzVkMzM4MjEwMGI4NDRkYjFmYThjNGI0NzY2MTNi
+    NjA4YjQ3ZWY5MWQyYmVkNGNkZWE3MDZjYzNjODk3OTBmOTQ3ZDI=
   data.tar.gz: !binary |-
-    ZDdkYjUyOWM2OTIyYTcwNDZlYjA4OTQ2MDk0MDViOTIzMTExNDViZmRiOTVl
-    NzYyOGY0ZTIwOWZlOTI4OGQ0MzAzMjFkZWM5MmRmMmNjNTM3MmUyZjBmOWY0
-    MzhlZTNhODY3ODM1NzFmNjBlODNjN2VmODQ3ZTQ3ZDk3YmVkZTQ=
+    MDJlMjQ0YTZhM2JlYzE1YWRjMGJlZTY2NjE2NWMyNTdiZTBiYjRiNmJmNTQ2
+    NWM4NTQ4ZTlhYjMyNWFiOWJjNGVlZDU3MzBhZjI4ZmNiZjI2N2FjMWFmZWJl
+    N2Q2OWE0NWI4YWFjZDMwNmI3OGE0OTU1ZmE0OTdlNDc2YzIyZmI=

data/CHANGES

@@ -1,3 +1,7 @@
+2013-11-15 Clinton Wolfe 0.4.0
+   Add 'present' check
+   Reformat list of checks in README
+
 2013-11-15 Clinton Wolfe 0.3.2
    umm wait regex should not violate if given a non-string - use type check if you want that
 

data/README.md

@@ -50,14 +50,42 @@ 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.
 
-     type - Checks type of value.  One of 'string', 'number', 'boolean', 'hash', 'array'.
-     min_children - Integer.  Fails for all but Hash and Array.  For Hash and Array, minimum number of elements to be considered valid.
-     max_children - Integer.  Fails for all but Hash and Array.  For Hash and Array, maximum number of elements to be considered valid.
-     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.
+#### type 
+
+Checks type of value.  One of 'string', 'number', 'boolean', 'hash', 'array'.
+
+#### min_children
+
+Integer.  Fails for all but Hash and Array.  For Hash and Array, minimum number of elements to be considered valid.
+
+#### max_children 
+
+Integer.  Fails for all but Hash and Array.  For Hash and Array, maximum number of elements to be considered valid.
+
+#### 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.
+
+#### 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, like contructing objects from the stdlib).
+
+#### enum
+
+Array, a set of possible values.
+
+#### proc 
+
+A Proc, which will be evaluated to determine the validity.  The proc 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
 
@@ -76,20 +104,17 @@ Open a github issue at https://github.com/clintoncwolfe/chef-attribute-validator
 
 ### Roadmap
 
+#### Need examples in README
+
 #### Some wildcard syntax not yet supported
 
 Possibly eventually support for **, [<charclass>], or {<alternatives>}.
 
-#### Companion cookbook
-
-Simple cookbook named 'attribute-validator' that loads the gem and provides recipes for compile-time and convergence-time violation checking.
-
 #### Planned checks:
 
    looks_like/hostname
    looks_like/email
    name_regex - Regexp.  Applies given regex to the last element in the attribute path ('basename', if you will)   
-   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.
 
 ### Bugs and Defects
 

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

@@ -0,0 +1,34 @@
+class Chef
+  class Attribute
+    class Validator
+      class Check
+        class Present < Check
+
+          register_check('present', Present)
+
+          def validate_check_arg
+            unless check_arg.kind_of?(TrueClass) || check_arg.kind_of?(FalseClass)
+              raise "Bad 'present' check argument '#{check_arg}' for rule '#{rule_name}' - expected one of true,false"
+            end
+          end
+    
+          def check(attrset)
+            violations = []
+            if check_arg 
+              # OK, presence is required - violate if attrset is empty
+              if attrset.empty?
+                violations.push Chef::Attribute::Validator::Violation.new(rule_name, path_spec, "No attributes exist for path '#{path_spec}', but this rule says its presence is required.")
+              end
+            else
+              # Presence is taboo.  Violate on each extant attr
+              attrset.each do |path, value|
+                violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "This rule bans the presense of this attribute, but it exists (regardless of value).")
+              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.3.2"
+      VERSION = "0.4.0"
     end
   end
 end

data/test/fixtures/check_present_assorted.rb

@@ -0,0 +1,88 @@
+
+default['yep']['what'] = 'missed me'
+default['nil'] = nil
+
+default['empty']['string'] = ""
+default['empty']['array'] = []
+default['empty']['hash'] = {}
+
+default['present']['nil'] = nil
+default['present']['string'] = 'foo'
+default['present']['zero'] = 0
+default['present']['false'] = false
+default['present']['array'] = [ 'a' ] 
+default['present']['hash'] = { 'a' => 'b' }
+
+
+
+rules = default['attribute-validator']['rules']
+rules['missing-shallow'] = {
+  'path' =>  '/nope',
+  'present' => true,
+}
+
+rules['missing-deep'] = {
+  'path' =>  '/yep/nope',
+  'present' => true,
+}
+
+rules['value-nil'] = {
+  'path' =>  '/nil',
+  'present' => true,
+}
+
+rules['value-empty-string'] = {
+  'path' =>  '/empty/string',
+  'present' => true,
+}
+
+rules['value-empty-array'] = {
+  'path' =>  '/empty/array',
+  'present' => true,
+}
+
+rules['value-empty-hash'] = {
+  'path' =>  '/empty/hash',
+  'present' => true,
+}
+
+rules['value-present-string'] = {
+  'path' =>  '/present/string',
+  'present' => true,
+}
+
+rules['value-present-false'] = {
+  'path' =>  '/present/false',
+  'present' => true,
+}
+
+rules['value-present-zero'] = {
+  'path' =>  '/present/zero',
+  'present' => true,
+}
+
+rules['value-present-array'] = {
+  'path' =>  '/present/array',
+  'present' => true,
+}
+
+rules['value-present-hash'] = {
+  'path' =>  '/present/hash',
+  'present' => true,
+}
+
+rules['spurious-present-string'] = {
+  'path' =>  '/present/string',
+  'present' => false,
+}
+
+rules['spurious-present-nil'] = {
+  'path' =>  '/present/nil',
+  'present' => false,
+}
+
+rules['spurious-missing'] = {
+  'path' =>  '/nope',
+  'present' => false,
+}
+

data/test/fixtures/check_present_false.rb

@@ -0,0 +1,5 @@
+rules = default['attribute-validator']['rules']
+rules['check-present_false'] = {
+  'path' =>  '/feh',
+  'present' => false,
+}

data/test/fixtures/check_present_true.rb

@@ -0,0 +1,5 @@
+rules = default['attribute-validator']['rules']
+rules['check-present_true'] = {
+  'path' =>  '/feh',
+  'present' => true,
+}

data/test/fixtures/check_present_zero.rb

@@ -0,0 +1,5 @@
+rules = default['attribute-validator']['rules']
+rules['check-present_zero'] = {
+  'path' =>  '/feh',
+  'present' => 0,
+}

data/test/unit/check_present_spec.rb

@@ -0,0 +1,110 @@
+require_relative './spec_helper'
+
+# Verify that the 'present' check works correctly
+
+describe "'present' 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('present')
+    end
+  end
+
+  describe "check_arg checks" do
+    it "should accept true" do
+      node = CAVHelper.load_fixture_attributes('check_present_true')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept false" do
+      node = CAVHelper.load_fixture_attributes('check_present_false')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should reject 0" do
+      node = CAVHelper.load_fixture_attributes('check_present_zero')
+      expect { Chef::Attribute::Validator.new(node) }.to raise_error
+    end
+  end
+
+  context "when present is true, but the attribute is missing" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_present_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should violate when the attribute is missing, shallow" do
+      expect(av.validate_rule('missing-shallow')).not_to be_empty
+    end
+
+    it "should violate when the attribute is missing, deep" do
+      expect(av.validate_rule('missing-deep')).not_to be_empty
+    end
+  end
+
+  context "when present is true, and the value is missing" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_present_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate when the value is nil" do
+      expect(av.validate_rule('value-nil')).to be_empty
+    end
+
+    it "should not violate when the value is an empty string" do
+      expect(av.validate_rule('value-empty-string')).to be_empty
+    end
+
+    it "should not violate when the value is an empty array" do
+      expect(av.validate_rule('value-empty-array')).to be_empty
+    end
+
+    it "should not violate when the value is an empty hash" do
+      expect(av.validate_rule('value-empty-hash')).to be_empty
+    end
+  end
+
+  context "when present is true, and a value is present" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_present_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate when the value is a string " do
+      expect(av.validate_rule('value-present-string')).to be_empty
+    end
+
+    it "should not violate when the value is false " do
+      expect(av.validate_rule('value-present-false')).to be_empty
+    end
+
+    it "should not violate when the value is zero " do
+      expect(av.validate_rule('value-present-zero')).to be_empty
+    end
+
+    it "should not violate when the value is a non-empty array " do
+      expect(av.validate_rule('value-present-array')).to be_empty
+    end
+
+    it "should not violate when the value is a non-empty hash" do
+      expect(av.validate_rule('value-present-hash')).to be_empty
+    end
+  end
+
+  context "when present is false, but the value is present" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_present_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+    
+    it "should violate when the value is a string" do
+      expect(av.validate_rule('spurious-present-string')).not_to be_empty
+    end
+
+    it "should violate when the value is nil" do
+      expect(av.validate_rule('spurious-present-nil')).not_to be_empty
+    end
+  end
+
+  context "when present is false, but the attribute is missing" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_present_assorted') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+    
+    it "should not violate when the attribute is missing" do
+      expect(av.validate_rule('spurious-missing')).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.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Clinton Wolfe
@@ -78,6 +78,7 @@ files:
 - 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/present.rb
 - lib/chef-attribute-validator/checks/proc.rb
 - lib/chef-attribute-validator/checks/regex.rb
 - lib/chef-attribute-validator/checks/required.rb
@@ -102,6 +103,10 @@ files:
 - 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_present_assorted.rb
+- test/fixtures/check_present_false.rb
+- test/fixtures/check_present_true.rb
+- test/fixtures/check_present_zero.rb
 - test/fixtures/check_proc_arity0.rb
 - test/fixtures/check_proc_arity1.rb
 - test/fixtures/check_proc_arity2.rb
@@ -131,6 +136,7 @@ files:
 - test/unit/check_child_count_spec.rb
 - test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
+- test/unit/check_present_spec.rb
 - test/unit/check_proc_spec.rb
 - test/unit/check_regex_spec.rb
 - test/unit/check_required_spec.rb
@@ -177,6 +183,10 @@ test_files:
 - 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_present_assorted.rb
+- test/fixtures/check_present_false.rb
+- test/fixtures/check_present_true.rb
+- test/fixtures/check_present_zero.rb
 - test/fixtures/check_proc_arity0.rb
 - test/fixtures/check_proc_arity1.rb
 - test/fixtures/check_proc_arity2.rb
@@ -206,6 +216,7 @@ test_files:
 - test/unit/check_child_count_spec.rb
 - test/unit/check_enum_spec.rb
 - test/unit/check_looks_like_spec.rb
+- test/unit/check_present_spec.rb
 - test/unit/check_proc_spec.rb
 - test/unit/check_regex_spec.rb
 - test/unit/check_required_spec.rb