chef-validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96f68557aac3836d187ceb87181e923a4eea0ec2
+  data.tar.gz: baa308339adda3b01a64db18f191118bd3e33be3
+SHA512:
+  metadata.gz: 7f10c83d480434bd1f190591da5179f9b16d5a4d634209aaf3b652425c2b88a8a38d5c942fbf0f318b1963185414120704da8c19df81a999992398a38613297e
+  data.tar.gz: 33c7d07a5af966cdeaf29675df67067b397c9a1b0a8899a01c51616cd00b748e181860559b61e6ff767d3eea6d8350166298b02d1dfb7a00dfa6e3a021ee8a22

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.kitchen/
+.kitchen.local.yml
+.DS_Store
+Berksfile.lock
+.vagrant

data/Berksfile

@@ -0,0 +1,3 @@
+source "https://supermarket.getchef.com"
+
+metadata

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release of validation

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jamie Winsor
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# validation-cookbook
+
+Perform validation on your node's attributes from a Cookbook's attribute metadata definitions.
+
+## Supported Platforms
+
+* Ubuntu 12.04 / 14.04
+* CentOS
+
+## Usage
+
+Add the validation cookbook to your cookbook's metadata
+
+```
+name             "my_app"
+maintainer       "Jamie Winsor"
+maintainer_email "jamie@vialstudios.com"
+license          "MIT"
+description      "Installs/Configures my_app"
+long_description "Installs/Configures my_app"
+version          "0.1.0"
+
+depends "validation"
+```
+
+Now leverage the `validate_attributes` definition provided by the validation cookbook by placing it in one of your cookbook's recipes.
+
+```
+validate_attributes "my_app"
+```
+
+### Compile time validation
+
+By default, attribute validation will occur at convergence time but this can be switched to compile time by setting an attribute on the `validate_attributes` definition.
+
+```
+validate_attributes "my_app" do
+  mode :compile
+end
+```
+
+### Convergence time validation
+
+You can also explicitly validate at convergence
+
+```
+validate_attributes "my_app" do
+  mode :converge
+end
+```
+
+However, this is not necessary since `:converge` is the default mode.
+
+### Filtering validation
+
+The name parameter of the `validate_attributes` definition is also the `cookbook` parameter. Setting this to the name of a cookbook will cause attribute validations to only be run for the metadata of that cookbook for the resource the definition creates. You can have multiple `validate_attributes` definitions within your resource chain or you can validate against all of your run context's loaded cookbooks.
+
+```
+validate_attributes "all"
+```
+
+> Note: I swear to fucking god - if one of you makes a cookbook called "all" and puts that shit on the community site I will drink myself into the grave faster than I already am.
+
+## License and Authors
+
+Author:: Jamie Winsor (<jamie@vialstudios.com>)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Vagrantfile

@@ -0,0 +1,21 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.require_version ">= 1.5.0"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.hostname = "validation-berkshelf"
+  config.omnibus.chef_version = :latest
+  config.vm.box = "chef/ubuntu-14.04"
+  config.vm.network :private_network, type: "dhcp"
+  config.vm.synced_folder "./pkg", "/vagrant_data"
+
+  config.vm.provision :chef_solo do |chef|
+    chef.run_list = [
+      "recipe[validation::default]"
+    ]
+  end
+end

data/chef-validation.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef/validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-validation"
+  spec.version       = Chef::Validation::VERSION
+  spec.authors       = ["Jamie Winsor"]
+  spec.email         = ["jamie@vialstudios.com"]
+  spec.summary       = %q{Perform validation on your node's attributes from a Cookbook's attribute metadata definitions.}
+  spec.description   = %q{Perform validation on your node's attributes from a Cookbook's attribute metadata definitions.}
+  spec.homepage      = "https://github.com/reset/chef-validation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chef", "~> 11.16"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/chefignore

@@ -0,0 +1,94 @@
+# Put files/directories that should be ignored in this file when uploading
+# or sharing to the community site.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+cookbooks/*
+tmp
+
+# Cookbooks #
+#############
+CONTRIBUTING
+CHANGELOG*
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile
+
+# Travis #
+##########
+.travis.yml

data/definitions/validate_attributes.rb

@@ -0,0 +1,51 @@
+#
+# Cookbook Name:: validation
+# Definition:: validate_attributes
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Jamie Winsor
+#
+
+define :validate_attributes, mode: :converge, cookbook: nil do
+  cookbook = params[:cookbook].nil? ? params[:name] : params[:cookbook]
+  cookbook = nil if cookbook == "all"
+
+  include_recipe "validation::default"
+
+  if params[:mode] == :compile
+    errors = if cookbook.nil?
+      Chef::Log.info("attribute-validation for all cookbooks (compile time)")
+      Chef::Validation.validate(node)
+    else
+      Chef::Log.info("attribute-validation for '#{cookbook}' (compile time)")
+      Chef::Validation.validate(node, cookbook)
+    end
+    unless errors.empty?
+      formatted = Chef::Validation::Formatter.format_errors(errors)
+      Chef::Application.fatal!(formatted)
+    end
+  else
+    if cookbook.nil?
+      ruby_block "attribute-validation for all cookbooks (convergence time)" do
+        block do
+          errors = Chef::Validation.validate(node)
+          unless errors.empty?
+            formatted = Chef::Validation::Formatter.format_errors(errors)
+            Chef::Application.fatal!(formatted)
+          end
+        end
+      end
+    else
+      ruby_block "attribute-validation for '#{cookbook}' (convergence time)" do
+        block do
+          errors = Chef::Validation.validate(node, cookbook)
+          unless errors.empty?
+            formatted = Chef::Validation::Formatter.format_errors(errors)
+            Chef::Application.fatal!(formatted)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef-validation.rb

@@ -0,0 +1 @@
+require "chef/validation"

data/lib/chef/validation.rb

@@ -0,0 +1,63 @@
+class Chef; end;
+require "chef/node"
+require "chef/cookbook/metadata"
+
+module Chef::Validation
+  require_relative "validation/version"
+  require_relative "validation/formatter"
+  require_relative "validation/ext"
+  require_relative "validation/validator"
+
+  class << self
+    # Validates the given node object against all attribute rules defined in all the metadata
+    # of all loaded cookbooks for the node's current run context.
+    #
+    # If an optional cookbook name is provided then the validations will only be run for the
+    # metadata of that particular cookbook.
+    #
+    # An errors hash is returned where keys are populated with the names of cookbooks that are
+    # failing validation and the values are an error hash returned from
+    # `Chef::Validation::Validator.run/2`. That error hash is made up of keys representing
+    # the name of an attribute which did not pass all rules and the values are error message
+    # strings.
+    #
+    #   {
+    #     "elixir" => {
+    #       "elixir/version" => [
+    #         "'elixir/version' is a required attribute but was nil."
+    #       ]
+    #     }
+    #   }
+    #
+    # @param [Chef::Node] node
+    # @param [String, nil] cookbook
+    #
+    # @return [Hash]
+    def validate(node, cookbook = nil)
+      cookbook.nil? ? validate_all(node) : validate_one(node, cookbook)
+    end
+
+    private
+
+      def validate_all(node)
+        total_errors = {}
+        ContextExt.cookbooks(node.run_context).each do |cookbook|
+          unless (errors = Validator.run(node, cookbook.metadata)).empty?
+            total_errors[cookbook.name] = errors
+          end
+        end
+        total_errors
+      end
+
+      def validate_one(node, name)
+        total_errors = {}
+        unless cookbook = ContextExt.cookbook(node.run_context, name)
+          raise "Cookbook not found: #{cookbook}"
+        end
+        unless (errors = Validator.run(node, cookbook.metadata)).empty?
+          total_errors[cookbook.name] = errors
+        end
+        total_errors
+      end
+  end
+end

data/lib/chef/validation/ext.rb

@@ -0,0 +1,2 @@
+require_relative "ext/context"
+require_relative "ext/hash"

data/lib/chef/validation/ext/context.rb

@@ -0,0 +1,24 @@
+module Chef::Validation
+  module ContextExt
+    class << self
+      # Returns a single cookbook from the given run context of the given name.
+      #
+      # @param [Chef::RunContext] context
+      # @param [String] name
+      #
+      # @return [Chef::CookbookVersion]
+      def cookbook(context, name)
+        context.cookbook_collection[name]
+      end
+
+      # Returns all loaded cookbooks from the given run context.
+      #
+      # @param [Chef::RunContext] context
+      #
+      # @return [Array<Chef::CookbookVersion>]
+      def cookbooks(context)
+        context.cookbook_collection.collect { |k, v| v }
+      end
+    end
+  end
+end

data/lib/chef/validation/ext/hash.rb

@@ -0,0 +1,38 @@
+module Chef::Validation
+  module HashExt
+    class << self
+      # Return the value of the nested hash key from the given dotted path
+      #
+      # @example
+      #
+      #   nested_hash = {
+      #     "deep" => {
+      #       "nested" => {
+      #         "hash" => :my_value
+      #       }
+      #     }
+      #   }
+      #
+      #   HashExt.dig(hash, "deep/nested/hash") => :my_value
+      #
+      # @param [Hash] hash
+      # @param [String] path
+      # @param [String] separator
+      #
+      # @return [Object, nil]
+      def dig(hash, path, separator = "/")
+        return nil unless !path.nil? && !path.empty?
+        return nil unless hash.respond_to?(:has_key?)
+        return hash unless hash.respond_to?(:[])
+
+        key, rest = path.split(separator, 2)
+        match     = hash[key.to_s].nil? ? hash[key.to_sym] : hash[key.to_s]
+        if rest.nil? or match.nil?
+          match
+        else
+          dig(match, rest, separator)
+        end
+      end
+    end
+  end
+end

data/lib/chef/validation/formatter.rb

@@ -0,0 +1,27 @@
+module Chef::Validation
+  module Formatter
+    class << self
+      # Formats an error hash returned by `Chef::Validation.run/2` into a human readable
+      # string to be output in a Chef run.
+      #
+      # @param [Hash] errors
+      #
+      # @return [String]
+      def format_errors(errors)
+        msg = []
+        msg << "Attribute Validation failure report:"
+        msg << ""
+        errors.each do |cookbook, attrs|
+          msg << "  # '#{cookbook}' failed validation for (#{attrs.length}) attribute(s)."
+          attrs.each do |name, errs|
+            msg << "    * #{name}"
+            errs.each do |err|
+              msg << "      - #{err}"
+            end
+          end
+        end
+        msg.join("\n")
+      end
+    end
+  end
+end

data/lib/chef/validation/validator.rb

@@ -0,0 +1,103 @@
+module Chef::Validation
+  module Validator
+    class << self
+      # Validates that the given node object satisfies all of the attribute constraints
+      # found in the given metadata.
+      #
+      # Returns a hash containing key/value pairs where the keys are the name of an
+      # attribute which was not properly set on the node object and the values are
+      # errors that were generated for that attribute.
+      #
+      # @param [Chef::Node] node
+      # @param [Chef::Metadata] metadata
+      #
+      # @return [Hash]
+      def run(node, metadata)
+        errors = {}
+        metadata.attributes.each do |attribute, rules|
+          unless (err = validate(node, attribute, rules)).empty?
+            errors[attribute] = err
+          end
+        end
+        errors
+      end
+
+      # Validates that the given node object passes the given validation rules for
+      # the given attribute name.
+      #
+      # @param [Chef::Node] node
+      #   node to validate
+      # @param [String] name
+      #   name of the attribute to validate
+      # @param [Hash] rules
+      #   a hash of rules (defined by the metadata of a cookbook)
+      #
+      # @return [Array<String>]
+      def validate(node, name, rules)
+        value  = HashExt.dig(node.attributes, name, ATTR_SEPARATOR)
+        errors = []
+
+        if (rules["required"] == "required" || rules["required"] == true)
+          errors += validate_required(value, name)
+        end
+        unless rules["type"].nil?
+          errors += validate_type(value, rules["type"], name)
+        end
+        unless rules["choice"].nil? || rules["choice"].empty?
+          errors += validate_choice(value, rules["choice"], name)
+        end
+
+        errors
+      end
+
+      private
+
+        ATTR_SEPARATOR = "/".freeze
+        STRING         = "string".freeze
+        ARRAY          = "array".freeze
+        HASH           = "hash".freeze
+        SYMBOL         = "symbol".freeze
+        BOOLEAN        = "boolean".freeze
+        NUMERIC        = "numeric".freeze
+
+        def validate_choice(value, choices, name, errors = [])
+          unless choices.include?(value)
+            errors << "Must be one of the following choices: #{choices.join(", ")}."
+          end
+          errors
+        end
+
+        def validate_required(value, name, errors = [])
+          if value.empty? || value.nil?
+            errors << "Required attribute but was not present."
+          end
+          errors
+        end
+
+        def validate_type(value, type, name, errors = [])
+          state = nil
+          case type.downcase
+          when STRING
+            state = :error unless value.is_a?(String)
+          when ARRAY
+            state = :error unless value.is_a?(Array)
+          when HASH
+            state = :error unless value.is_a?(Hash) || value.is_a?(Mash)
+          when SYMBOL
+            state = :error unless value.is_a?(Symbol)
+          when BOOLEAN
+            state = :error unless value.is_a?(Boolean)
+          when NUMERIC
+            state = :error unless value.is_a?(Fixnum)
+          else
+            nil
+          end
+
+          if state == :error
+            errors << "Must be of type '#{type}' but got: #{value.class}."
+          end
+          errors
+        end
+    end
+  end
+end

data/lib/chef/validation/version.rb

@@ -0,0 +1,4 @@
+class Chef; end;
+module Chef::Validation
+  VERSION = "0.1.0"
+end

data/libraries/chef_validation.rb

@@ -0,0 +1,18 @@
+#
+# Cookbook Name:: validation
+# Library:: chef_validation
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Jamie Winsor
+#
+
+class Chef
+  module Validation
+    class << self
+      def cookbook_version(node)
+        node.run_context.cookbook_collection["validation"].metadata.version
+      end
+    end
+  end
+end

data/metadata.rb

@@ -0,0 +1,13 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "chef/validation/version"
+
+name             "validation"
+maintainer       "Jamie Winsor"
+maintainer_email "jamie@vialstudios.com"
+license          "MIT"
+description      "Perform validation on your node's attributes from a Cookbook's attribute metadata definitions."
+long_description "Perform validation on your node's attributes from a Cookbook's attribute metadata definitions."
+version           Chef::Validation::VERSION
+
+supports "ubuntu"
+supports "centos"

data/recipes/default.rb

@@ -0,0 +1,16 @@
+#
+# Cookbook Name:: validation
+# Recipe:: default
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Jamie Winsor
+#
+
+chef_gem "chef-validation" do
+  version Chef::Validation.cookbook_version(node)
+  options "--ignore-dependencies"
+  action :nothing
+end.run_action(:install)
+
+require "chef-validation"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: chef-validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Winsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Perform validation on your node's attributes from a Cookbook's attribute
+  metadata definitions.
+email:
+- jamie@vialstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Berksfile
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- chef-validation.gemspec
+- chefignore
+- definitions/validate_attributes.rb
+- lib/chef-validation.rb
+- lib/chef/validation.rb
+- lib/chef/validation/ext.rb
+- lib/chef/validation/ext/context.rb
+- lib/chef/validation/ext/hash.rb
+- lib/chef/validation/formatter.rb
+- lib/chef/validation/validator.rb
+- lib/chef/validation/version.rb
+- libraries/chef_validation.rb
+- metadata.rb
+- recipes/default.rb
+homepage: https://github.com/reset/chef-validation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Perform validation on your node's attributes from a Cookbook's attribute
+  metadata definitions.
+test_files: []