chef-attribute-validator 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDJjZjdhYTFkYWNmMGU0ZTg1MDg4MzdlMWE5Nzg0ZGEwYzhlOGYxNQ==
+    NTQ4ZTZkNWViNzg0YmRiM2NiODkwOWE5NzM1MGU5YzFiMTk2MWU3NQ==
   data.tar.gz: !binary |-
-    MmM1OTA0N2RiN2E1MjE3NmQxNTg1NDc5ZjRhN2E1OGJmMDdmNzY4MQ==
+    YjUyYjI3YTRmNmQ0ODJjMGUyOTZlZGY2MjVjMGJhNWE3ZjliMzQwMQ==
 SHA512:
   metadata.gz: !binary |-
-    NGMxOTE3M2Y3NTk3ZDU0NmJiY2I2YTdlZGIyYjY2MzBiMmUzNzk3OWQ3ZDhj
-    Yjc0NTA3MDZjN2M0NjAxYzVkMzM4MjEwMGI4NDRkYjFmYThjNGI0NzY2MTNi
-    NjA4YjQ3ZWY5MWQyYmVkNGNkZWE3MDZjYzNjODk3OTBmOTQ3ZDI=
+    Mzk5MjVlOTQ0MzYzMmMzNTVlZWViN2VmZGQ3MGU0YWUxYWNlZGFhOGRjNjQw
+    YWQ2ODI3MDM3MDhhZDZiOWM1ZGQ5Nzk5MzExNGE0NmU4NDYwNjk1NDA1ZTcy
+    MDk1OTBjNjI1Yzc3YWJiZGI5NGQ5YzhjZmI5NjM1NmYyY2Q5YWI=
   data.tar.gz: !binary |-
-    MDJlMjQ0YTZhM2JlYzE1YWRjMGJlZTY2NjE2NWMyNTdiZTBiYjRiNmJmNTQ2
-    NWM4NTQ4ZTlhYjMyNWFiOWJjNGVlZDU3MzBhZjI4ZmNiZjI2N2FjMWFmZWJl
-    N2Q2OWE0NWI4YWFjZDMwNmI3OGE0OTU1ZmE0OTdlNDc2YzIyZmI=
+    ZDVhNjc5MGE0YWE4Yzg0N2M2NWM4MWZlZjhlNDk5ZjBmMDBkMjg5NGVkYzNj
+    OGVmMDA1NWJmODRmMDU5YjYwYzhmYzk4NTBiNzAzYjFhNzkyZDU4MjIzZmI5
+    YzNlZDY4NjE5YTFhZDk3MTUwYmVkODA2MDc3N2I3M2FkM2JmMzI=

data/CHANGES

@@ -1,3 +1,8 @@
+2013-12-05 Clinton Wolfe 0.5.0
+   Add looks_like => 'guid'
+   Add looks_like => 'email'
+   Add looks_like => 'hostname'
+
 2013-11-15 Clinton Wolfe 0.4.0
    Add 'present' check
    Reformat list of checks in README

data/README.md

@@ -76,7 +76,27 @@ Boolean.  If true, fails if the path matches zero attributes, or the value is ni
 
 #### looks_like
 
-String, one of 'url', 'ip'.  Applies canned regexes (or more sophisticated matchers, like contructing objects from the stdlib).
+String, one of 'email', 'guid', 'ip', 'url'.  Applies canned regexes (or more sophisticated matchers, like constructing objects from the stdlib).  Details:
+
+##### email
+
+Uses a naive regex to do a simple sanity check.  It may be too tight or too loose for you, in which case you can use a Proc and spend as much of your energy as you please solving that problem.
+
+##### guid
+
+Uses a regex to match GUID/UUIDs, like 'ec73f2a8-510d-4e6a-be5d-7b234da03c92'
+
+##### hostname
+
+Uses a regex to guess if it looks hostnamish.  Does not require a dot.  Accepts IPv4, and checks ranges.
+
+##### ip
+
+Uses the stdlib 'ipaddr' library to try to construct an IPAddr object from the value.  If it worked, it's an IP.  IPv6 is supported; ranges are checked; CIDR notation is supported; and no you can't pass a hostname to this.
+
+##### url
+
+Uses the stdlib 'url' library to try to construct an URI object from the value.  If it worked, it's an URL.  This is probably too loose; it will accept bare hostnames, for example.
 
 #### enum
 
@@ -108,12 +128,10 @@ Open a github issue at https://github.com/clintoncwolfe/chef-attribute-validator
 
 #### Some wildcard syntax not yet supported
 
-Possibly eventually support for **, [<charclass>], or {<alternatives>}.
+Possibly eventually support for [<charclass>], or {<alternatives>}.
 
 #### 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)   
 
 ### Bugs and Defects
@@ -126,7 +144,6 @@ No real exception class, just raising a bare string exception, which could certa
 
 BrutalRegex is terrible.
 
-
 ## Author
 
 Clinton Wolfe

data/chef-attribute-validator.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Chef::Attribute::Validator::VERSION
   spec.authors       = ["Clinton Wolfe"]
   spec.email         = ["clinton@omniti.com"]
-  spec.description   = %q{Define, enforce, and handle violations of validation rules for Chef node attributes.  This gem provides the validation engine, and can be used outside of a convergence run; a cookbook (attribute-validator) is availabel to perform validation during a chef run, at compile or converge time.}
+  spec.description   = %q{Define, enforce, and handle violations of validation rules for Chef node attributes.  This gem provides the validation engine, and can be used outside of a convergence run; a cookbook (attribute-validator) is available to perform validation during a chef run, at compile or converge time.}
   spec.summary       = %q{A Rubygem implementing a rule engine for validating Chef node attributes.}
   spec.homepage      = "https://github.com/clintoncwolfe/chef-attribute-validator"
   spec.license       = "BSD (3-clause)"

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

@@ -12,6 +12,9 @@ class Chef
 
           def validate_check_arg
             expected = [
+                        'email',
+                        'guid',
+                        'hostname',
                         'ip',
                         'url',
                        ]
@@ -26,25 +29,66 @@ class Chef
             attrset.each do |path, value|
               if val_scalar?(value) then
                 next if value.nil?
-                case check_arg
-                when 'ip'
-                  begin
-                    IPAddr.new(value)
-                  rescue
-                    violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like an IP address")
-                  end
-                when 'url'
-                  begin
-                    URI(value)
-                  rescue
-                    violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like a URL")
-                  end
+                unless value.respond_to?(:match)
+                  violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' is not string-like, so it can't be a #{check_arg}")
+                  next
                 end
+                send(('ll_check_' + check_arg).to_sym, value, path, violations)
               end
             end
             violations
           end
 
+          private
+          
+          def ll_check_guid(value, path, violations)
+            guid_regex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
+            unless value.match(guid_regex)
+              violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like a v4 UUID (see RFC 4122)")
+            end
+          end
+
+          def ll_check_ip(value, path, violations)
+            begin
+              IPAddr.new(value)
+            rescue
+              violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like an IP address")
+            end  
+          end
+
+          def ll_check_url(value, path, violations)
+            begin
+              URI(value)
+            rescue
+              violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like a URL")
+            end
+          end
+          
+          def ll_check_email(value, path, violations)
+            # This is simple and crude.  Will reject some things you might wish it didn't:
+            # root@localhost
+            # root
+            #
+            
+            # Email validation with regexes is stupid.
+            email_regex = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
+            unless value.match(email_regex)
+              violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like an email address, but I could be wrong.  If I am wrong, use a Proc instead.")
+            end
+          end
+
+          def ll_check_hostname(value, path, violations)
+            ip_regex = /^(\d{1,3}\.){3}\d{1,3}$/
+            hostname_regex = /^([a-z0-9\-]+\.)*[a-z0-9\-]{2,}$/i
+
+            if value.match(ip_regex)
+              ll_check_ip(value, path, violations)
+            else
+              unless value.match(hostname_regex)
+                violations.push Chef::Attribute::Validator::Violation.new(rule_name, path, "Value '#{value}' does not look like a hostname, nor an IPv4.")
+              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.4.0"
+      VERSION = "0.5.0"
     end
   end
 end

data/test/fixtures/check_looks_like_arg_email.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-looks-like-arg-email'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'email',
+}
+

data/test/fixtures/check_looks_like_arg_guid.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-looks-like-arg-guid'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'guid',
+}
+

data/test/fixtures/check_looks_like_arg_hostname.rb

@@ -0,0 +1,6 @@
+rules = default['attribute-validator']['rules']
+rules['check-looks-like-arg-hostname'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'hostname',
+}
+

data/test/fixtures/check_looks_like_email.rb

@@ -0,0 +1,74 @@
+
+default['nil'] = nil
+default['empty'] = ''
+
+default['email']['joe'] = 'joe@example.com'
+default['email']['case']['lower'] = 'ray@cartalk.com'
+default['email']['case']['upper'] = 'TOMMY@CARTALK.COM'
+default['email']['tagged'] = 'joe+tag@foo.com'
+
+default['email']['no']['user'] = '@foo.com'
+default['email']['no']['hostname'] = 'johnny@'
+
+default['email']['bad']['quotes'] = '"Click and Clack" <show@cartalk.com>'
+default['email']['bad']['spaces'] = '"Click and Clack" <show@cartalk.com>'
+default['email']['bad']['phonetic'] = 'joeATfoo.com'
+
+rules = default['attribute-validator']['rules']
+rules['email-missing'] = {
+  'path' =>  '/nope',
+  'looks_like' => 'email',
+}
+
+rules['email-nil'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'email',
+}
+
+rules['email-empty'] = {
+  'path' =>  '/empty',
+  'looks_like' => 'email',
+}
+
+rules['email-spaces'] = {
+  'path' =>  '/email/bad/spaces',
+  'looks_like' => 'email',
+}
+
+rules['email-case-upper'] = {
+  'path' =>  '/email/case/upper',
+  'looks_like' => 'email',
+}
+
+rules['email-joe'] = {
+  'path' =>  '/email/joe',
+  'looks_like' => 'email',
+}
+
+rules['email-tagged'] = {
+  'path' =>  '/email/tagged',
+  'looks_like' => 'email',
+}
+
+rules['email-no-user'] = {
+  'path' =>  '/email/no/user',
+  'looks_like' => 'email',
+}
+
+rules['email-no-hostname'] = {
+  'path' =>  '/email/no/hostname',
+  'looks_like' => 'email',
+}
+
+rules['email-quotes'] = {
+  'path' =>  '/email/bad/quotes',
+  'looks_like' => 'email',
+}
+
+rules['email-phonetic-at'] = {
+  'path' =>  '/email/bad/phonetic',
+  'looks_like' => 'email',
+}
+
+
+

data/test/fixtures/check_looks_like_guid.rb

@@ -0,0 +1,38 @@
+
+default['nil'] = nil
+default['empty'] = ''
+
+default['guid']['case']['lower'] = 'ec73f2a8-510d-4e6a-be5d-7b234da03c92'
+default['guid']['case']['upper'] = 'ACCF642E-2CD3-4D20-921E-A80E91EAFEC8'
+default['guid']['spaces'] = 'db592238 8175 491b a914 f1e4eaf732bf'
+
+rules = default['attribute-validator']['rules']
+rules['guid-missing'] = {
+  'path' =>  '/nope',
+  'looks_like' => 'guid',
+}
+
+rules['guid-nil'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'guid',
+}
+
+rules['guid-empty'] = {
+  'path' =>  '/empty',
+  'looks_like' => 'guid',
+}
+
+rules['guid-spaces'] = {
+  'path' =>  '/guid/spaces',
+  'looks_like' => 'guid',
+}
+
+rules['guid-upper-case'] = {
+  'path' =>  '/guid/case/upper',
+  'looks_like' => 'guid',
+}
+
+rules['guid-lower-case'] = {
+  'path' =>  '/guid/case/lower',
+  'looks_like' => 'guid',
+}

data/test/fixtures/check_looks_like_hostname.rb

@@ -0,0 +1,70 @@
+
+default['nil'] = nil
+default['empty'] = ''
+
+default['hostname']['case']['lower'] = 'wombat.example.org'
+default['hostname']['case']['upper'] = 'WOMBAT.EXAMPLE.ORG'
+default['hostname']['spaces'] = 'wombat example.org'
+default['hostname']['localhost'] = 'localhost'
+default['hostname']['underscore'] = 'under_score.org'
+default['hostname']['iad'] = 'foo.iad'
+default['hostname']['ip']['i127'] = '127.0.0.1'
+default['hostname']['ip']['i300'] = '300.300.300.300'
+
+rules = default['attribute-validator']['rules']
+rules['hostname-missing'] = {
+  'path' =>  '/nope',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-nil'] = {
+  'path' =>  '/nil',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-empty'] = {
+  'path' =>  '/empty',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-case-lower'] = {
+  'path' =>  '/hostname/case/lower',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-case-upper'] = {
+  'path' =>  '/hostname/case/upper',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-localhost'] = {
+  'path' =>  '/hostname/localhost',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-iad'] = {
+  'path' =>  '/hostname/iad',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-ip-127'] = {
+  'path' =>  '/hostname/ip/i127',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-ip-300'] = {
+  'path' =>  '/hostname/ip/i300',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-underscore'] = {
+  'path' =>  '/hostname/underscore',
+  'looks_like' => 'hostname',
+}
+
+rules['hostname-spaces'] = {
+  'path' =>  '/hostname/spaces',
+  'looks_like' => 'hostname',
+}
+
+

data/test/unit/check_looks_like_spec.rb

@@ -12,6 +12,18 @@ describe "'looks_like' check" do
   end
 
   describe "check_arg checks" do
+    it "should accept 'email'" do
+      node = CAVHelper.load_fixture_attributes('check_looks_like_arg_email')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept 'guid'" do
+      node = CAVHelper.load_fixture_attributes('check_looks_like_arg_guid')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
+    it "should accept 'hostname'" do
+      node = CAVHelper.load_fixture_attributes('check_looks_like_arg_hostname')
+      expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
+    end
     it "should accept 'ip'" do
       node = CAVHelper.load_fixture_attributes('check_looks_like_arg_ip')
       expect { Chef::Attribute::Validator.new(node) }.not_to raise_error
@@ -101,6 +113,135 @@ describe "'looks_like' check" do
 
   end
 
+  context "when the mode is 'guid'" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_looks_like_guid') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate on missing" do
+      expect(av.validate_rule('guid-missing')).to be_empty
+    end
+
+    it "should not violate on nil" do
+      expect(av.validate_rule('guid-nil')).to be_empty
+    end
+
+    it "should not violate on a lower-case guid" do
+      expect(av.validate_rule('guid-lower-case')).to be_empty
+    end
+
+    it "should not violate on a upper-case guid" do
+      expect(av.validate_rule('guid-upper-case')).to be_empty
+    end
+
+    it "should violate on a guid without dashes" do
+      expect(av.validate_rule('guid-spaces')).not_to be_empty
+    end
+
+    it "should violate on an empty string" do
+      expect(av.validate_rule('guid-empty')).not_to be_empty
+    end
+
+  end
+
+  context "when the mode is 'email'" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_looks_like_email') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate on missing" do
+      expect(av.validate_rule('email-missing')).to be_empty
+    end
+
+    it "should not violate on nil" do
+      expect(av.validate_rule('email-nil')).to be_empty
+    end
+
+    it "should violate on an empty string" do
+      expect(av.validate_rule('email-empty')).not_to be_empty
+    end
+
+    it "should not violate on joe@example.com" do
+      expect(av.validate_rule('email-joe')).to be_empty
+    end
+
+    it "should not violate on a upper-case email" do
+      expect(av.validate_rule('email-case-upper')).to be_empty
+    end
+
+    it "should not violate on a joe+tag@foo.com" do
+      expect(av.validate_rule('email-tagged')).to be_empty
+    end
+
+    it "should violate on a email without a user" do
+      expect(av.validate_rule('email-no-user')).not_to be_empty
+    end
+
+    it "should violate on a email without a hostname" do
+      expect(av.validate_rule('email-no-hostname')).not_to be_empty
+    end
+
+    it "should violate on a email with spaces" do
+      expect(av.validate_rule('email-spaces')).not_to be_empty
+    end
+
+    it "should violate on a email with quotes" do
+      expect(av.validate_rule('email-quotes')).not_to be_empty
+    end
+
+    it "should violate on phonetic-at" do
+      expect(av.validate_rule('email-phonetic-at')).not_to be_empty
+    end
+
+  end
+
+  context "when the mode is 'hostname'" do
+    let(:node) { CAVHelper.load_fixture_attributes('check_looks_like_hostname') }
+    let(:av) { Chef::Attribute::Validator.new(node) }
+
+    it "should not violate on missing" do
+      expect(av.validate_rule('hostname-missing')).to be_empty
+    end
+
+    it "should not violate on nil" do
+      expect(av.validate_rule('hostname-nil')).to be_empty
+    end
 
+    it "should violate on an empty string" do
+      expect(av.validate_rule('hostname-empty')).not_to be_empty
+    end
+
+    it "should not violate on a lower-case hostname" do
+      expect(av.validate_rule('hostname-case-lower')).to be_empty
+    end
+
+    it "should not violate on a upper-case hostname" do
+      expect(av.validate_rule('hostname-case-upper')).to be_empty
+    end
+
+    it "should not violate on a 'localhost'" do
+      expect(av.validate_rule('hostname-localhost')).to be_empty
+    end
+
+    it "should not violate on 'foo.iad'" do
+      expect(av.validate_rule('hostname-iad')).to be_empty
+    end
+
+    it "should not violate on '127.0.0.1'" do
+      expect(av.validate_rule('hostname-ip-127')).to be_empty
+    end
+
+    it "should violate on '300.300.300.300'" do
+      expect(av.validate_rule('hostname-ip-300')).not_to be_empty
+    end
+
+    it "should violate on 'under_score.com'" do
+      expect(av.validate_rule('hostname-underscore')).not_to be_empty
+    end
+
+    it "should violate on spaces" do
+      expect(av.validate_rule('hostname-spaces')).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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Clinton Wolfe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,7 +56,7 @@ dependencies:
         version: 11.6.0
 description: Define, enforce, and handle violations of validation rules for Chef node
   attributes.  This gem provides the validation engine, and can be used outside of
-  a convergence run; a cookbook (attribute-validator) is availabel to perform validation
+  a convergence run; a cookbook (attribute-validator) is available to perform validation
   during a chef run, at compile or converge time.
 email:
 - clinton@omniti.com
@@ -97,10 +97,16 @@ files:
 - test/fixtures/check_enum_assorted.rb
 - test/fixtures/check_enum_nil.rb
 - test/fixtures/check_enum_string.rb
+- test/fixtures/check_looks_like_arg_email.rb
+- test/fixtures/check_looks_like_arg_guid.rb
+- test/fixtures/check_looks_like_arg_hostname.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_email.rb
+- test/fixtures/check_looks_like_guid.rb
+- test/fixtures/check_looks_like_hostname.rb
 - test/fixtures/check_looks_like_ip.rb
 - test/fixtures/check_looks_like_url.rb
 - test/fixtures/check_present_assorted.rb
@@ -177,10 +183,16 @@ test_files:
 - test/fixtures/check_enum_assorted.rb
 - test/fixtures/check_enum_nil.rb
 - test/fixtures/check_enum_string.rb
+- test/fixtures/check_looks_like_arg_email.rb
+- test/fixtures/check_looks_like_arg_guid.rb
+- test/fixtures/check_looks_like_arg_hostname.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_email.rb
+- test/fixtures/check_looks_like_guid.rb
+- test/fixtures/check_looks_like_hostname.rb
 - test/fixtures/check_looks_like_ip.rb
 - test/fixtures/check_looks_like_url.rb
 - test/fixtures/check_present_assorted.rb