garcun 0.0.2

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'
+
+desc 'Generate Ruby documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['**/*.rb', '-', 'README.md', 'LICENSE']
+    t.stats_options = %w(--list-undoc)
+  end
+end
+
+task doc: %w(yard)
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]
+
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
+end

data/garcun.gemspec

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'garcon/version'
+
+Gem::Specification.new do |gem|
+  gem.name        =   'garcun'
+  gem.version     =    Garcon::VERSION.dup
+  gem.authors     = [ 'Stefano Harding' ]
+  gem.email       = [ 'riddopic@gmail.com' ]
+  gem.description =   'A useful collection of methods to make cooking more fun'
+  gem.summary     =    gem.description
+  gem.homepage    =   'https://github.com/riddopic/garcun'
+  gem.license     =   'Apache 2.0'
+
+  gem.require_paths         = %w[lib]
+  gem.files                 = `git ls-files`.split($/)
+  gem.test_files            = `git ls-files -- spec`.split($/)
+  gem.extra_rdoc_files      = %w[LICENSE README.md]
+  gem.required_ruby_version = '>= 2.0.0'
+
+  gem.add_dependency 'chef',           '>= 11.0'
+  gem.add_dependency 'bundler'
+
+  # Development gems
+  gem.add_development_dependency 'rake',        '~> 10.4'
+  gem.add_development_dependency 'yard',        '~> 0.8'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'stove',       '~> 3.2', '>= 3.2.3'
+  gem.add_development_dependency 'thor'
+
+  # Test gems
+  gem.add_development_dependency 'rspec',       '~> 3.2'
+  gem.add_development_dependency 'rspec-its',   '~> 1.2'
+  gem.add_development_dependency 'chefspec',    '~> 4.2'
+  gem.add_development_dependency 'fuubar',      '~> 2.0'
+  gem.add_development_dependency 'simplecov',   '~> 0.9'
+  gem.add_development_dependency 'foodcritic',  '~> 4.0'
+  gem.add_development_dependency 'berkshelf',   '~> 3.2'
+  gem.add_development_dependency 'serverspec'
+  gem.add_development_dependency 'inch'
+  gem.add_development_dependency 'yardstick'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-shell'
+  gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'guard-rubocop'
+  gem.add_development_dependency 'guard-foodcritic'
+  gem.add_development_dependency 'guard-kitchen'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'ruby_gntp'
+
+  # Integration gems
+  gem.add_development_dependency 'test-kitchen',    '~> 1.3'
+  gem.add_development_dependency 'kitchen-vagrant'
+  gem.add_development_dependency 'vagrant-wrapper'
+  gem.add_development_dependency 'kitchen-docker'
+  gem.add_development_dependency 'kitchen-sync'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'geminabox-rake'
+
+  # Versioning
+  gem.add_development_dependency 'version'
+  gem.add_development_dependency 'thor-scmversion'
+  gem.add_development_dependency 'semverse'
+end

data/lib/garcon.rb

@@ -0,0 +1,290 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#                   ____   ____  ____      __   ___   ____
+#                  /    T /    T|    \    /  ] /   \ |    \
+#                 Y   __jY  o  ||  D  )  /  / Y     Y|  _  Y
+#                 |  T  ||     ||    /  /  /  |  O  ||  |  |
+#                 |  l_ ||  _  ||    \ /   \_ |     ||  |  |
+#                 |     ||  |  ||  .  Y\     |l     !|  |  |
+#                 l___,_jl__j__jl__j\_j \____j \___/ l__j__j
+
+require 'chef/recipe'
+require 'chef/resource'
+require 'chef/provider'
+
+require_relative 'garcon/version'
+require_relative 'garcon/configuration'
+require_relative 'garcon/exceptions'
+require_relative 'garcon/inflections'
+require_relative 'garcon/secret'
+require_relative 'garcon/stash/store'
+require_relative 'garcon/core_ext'
+require_relative 'garcon/task'
+require_relative 'garcon/utils'
+
+# Pirla o Sfigato Magnà  Capo  Fregna
+
+module Garcon
+  # Extends base class or a module with garcon methods, called when module is
+  # included, extends the object with class and instance methods.
+  #
+  # @param [Object] object
+  #   The object including Garcon
+  #
+  # @return [self]
+  #
+  # @api private
+  def self.included(object)
+    super
+    if Class === object
+      object.send(:include, ClassInclusions) # TODO fix this...
+    else
+      object.extend(ModuleExtensions)
+    end
+  end
+  private_class_method :included
+
+  # Extends an object with garcon extensions, called when module is extended,
+  # extends the object with class and instance methods.
+  #
+  # @param [Object] object
+  #   The object including Garcon.
+  #
+  # @return [self]
+  #
+  # @api private
+  def self.extended(object)
+    object.extend(Extensions)
+  end
+  private_class_method :extended
+
+  # Sets the global Crypto configuration.
+  #
+  # @example
+  #   Garcon.config do |c|
+  #     c.crypto.password = "!mWh0!s@y!m"
+  #     c.crypto.salt     = "9e5f851900cad8892ac8b737b7370cbe"
+  #   end
+  #
+  # @return [Garcon::Crypto]
+  #
+  # @api public
+  def self.crypto(&block)
+    configuration.crypto(&block)
+  end
+
+  # Sets the global Crypto configuration value.
+  #
+  # @param [Boolean] value
+  #
+  # @return [Garcon::Crypto]
+  #
+  # @api public
+  def self.crypto=(value)
+    configuration.crypto = value
+    self
+  end
+
+  # Returns the global Crypto setting.
+  #
+  # @return [Boolean]
+  #
+  # @api public
+  def self.crypto
+    configuration.crypto
+  end
+
+  # Sets the global Secret configuration.
+  #
+  # @return [Garcon::Secret]
+  #
+  # @api public
+  def self.secret(&block)
+    configuration.secret(&block)
+  end
+
+  # Sets the global Secret configuration value.
+  #
+  # @param [Boolean] value
+  #
+  # @return [Garcon::Secret]
+  #
+  # @api public
+  def self.secret=(value)
+    configuration.secret = value
+    self
+  end
+
+  # Returns the global Secret setting.
+  #
+  # @return [Boolean]
+  #
+  # @api public
+  def self.secret
+    configuration.secret
+  end
+
+  # Provides access to the global Garcon configuration
+  #
+  # @example
+  #   Garcon.config do |config|
+  #     config.blender = true
+  #   end
+  #
+  # @return [Configuration]
+  #
+  # @api public
+  def self.config(&block)
+    yield configuration if block_given?
+    configuration
+  end
+
+  # Global configuration instance.
+  #
+  # @return [Configuration]
+  #
+  # @api private
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Defines if global executors should be auto-terminated with an `at_exit`
+  # callback. When set to `false` it will be the application programmer's
+  # responsibility to ensure that the global thread pools are shutdown properly
+  # prior to application exit.
+  #
+  def self.disable_auto_termination_of_global_executors!
+    Garcon.config.auto_terminate_global_executors.make_false
+  end
+  #
+  # @return [Boolean]
+  #   true when global thread pools will auto-terminate on application exit
+  #   using an `at_exit` handler; false when no auto-termination will occur.
+  #
+  def self.auto_terminate_global_executors?
+    Garcon.config.auto_terminate_global_executors.value
+  end
+
+  # Defines if *ALL* executors should be auto-terminated with an `at_exit`
+  # callback. When set to `false` it will be the application programmer's
+  # responsibility to ensure that *all* thread pools, including the global
+  # thread pools, are shutdown properly prior to application exit.
+  #
+  def self.disable_auto_termination_of_all_executors!
+    Garcon.config.auto_terminate_all_executors.make_false
+  end
+
+  # @return [Boolean]
+  #   true when *all* thread pools will auto-terminate on application exit
+  #   using an `at_exit` handler; false when no auto-termination will occur.
+  #
+  def self.auto_terminate_all_executors?
+    Garcon.config.auto_terminate_all_executors.value
+  end
+
+  # Global thread pool optimized for short, fast *operations*.
+  #
+  # @return [ThreadPoolExecutor] the thread pool
+  def self.global_fast_executor
+    Garcon.config.global_fast_executor.value
+  end
+
+  # Global thread pool optimized for long, blocking (IO) *tasks*.
+  #
+  # @return [ThreadPoolExecutor] the thread pool
+  def self.global_io_executor
+    Garcon.config.global_io_executor.value
+  end
+
+  # Global thread pool user for global *timers*.
+  #
+  # @return [Garcon::TimerSet] the thread pool
+  #
+  # @see Garcon::timer
+  def self.global_timer_set
+    Garcon.config.global_timer_set.value
+  end
+
+  def self.shutdown_global_executors
+    global_fast_executor.shutdown
+    global_io_executor.shutdown
+    global_timer_set.shutdown
+  end
+
+  def self.kill_global_executors
+    global_fast_executor.kill
+    global_io_executor.kill
+    global_timer_set.kill
+  end
+
+  def self.wait_for_global_executors_termination(timeout = nil)
+    latch = CountDownLatch.new(3)
+    [ global_fast_executor, global_io_executor, global_timer_set ].each do |ex|
+      Thread.new { ex.wait_for_termination(timeout); latch.count_down }
+    end
+    latch.wait(timeout)
+  end
+
+  def self.new_fast_executor(opts = {})
+    FixedThreadPool.new(
+      [2, Garcon.processor_count].max,
+      stop_on_exit:     opts.fetch(:stop_on_exit, true),
+      idletime:         60,         # 1 minute
+      max_queue:        0,          # unlimited
+      fallback_policy: :caller_runs # shouldn't matter -- 0 max queue
+    )
+  end
+
+  def self.new_io_executor(opts = {})
+    ThreadPoolExecutor.new(
+      min_threads:      [2, Garcon.processor_count].max,
+      max_threads:      ThreadPoolExecutor::DEFAULT_MAX_POOL_SIZE,
+      stop_on_exit:     opts.fetch(:stop_on_exit, true),
+      idletime:         60,         # 1 minute
+      max_queue:        0,          # unlimited
+      fallback_policy: :caller_runs # shouldn't matter -- 0 max queue
+    )
+  end
+
+  # @return [String] object inspection
+  # @api public
+  def inspect
+    instance_variables.inject([
+      "\n#<#{self.class}:0x#{object_id.to_s(16)}>",
+      "\tInstance variables:"
+    ]) do |result, item|
+      result << "\t\t#{item} = #{instance_variable_get(item)}"
+      result
+    end.join("\n")
+  end
+
+  # @return [String] string of instance
+  # @api public
+  def to_s
+    "<#{self.class}:0x#{object_id.to_s(16)}>"
+  end
+
+  # @api private
+  def self.warn(msg)
+    Kernel.warn(msg)
+  end
+end
+
+require_relative 'garcon/chef_inclusions'

data/lib/garcon/chef/chef_helpers.rb

@@ -0,0 +1,343 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Garcon
+  # More sweetness syntactical sugar for our Pâtissier.
+  #
+  module ChefHelpers
+    # Methods are also available as module-level methods as well as a mixin.
+    extend self
+
+    include Chef::Mixin::ShellOut
+    include Garcon::Exceptions
+
+    # def chef_run_context
+    #   ::Chef::RunContext.new(chef_node, nil, nil)
+    # end
+    #
+    #  TODO - ARE THESE CAUSING TROUBLE???
+    #
+    # def chef_node
+    #   node = ::Chef::Node.new
+    #   node.consume_external_attrs(nil, ohai)
+    #   node
+    # end
+
+    # Boolean indicating if the given Ruby Gem is installed.
+    #
+    # @param [String] gem
+    #   The name of the Ruby Gem to check for.
+    #
+    # @return [Boolean]
+    #   True if the Ruby Gem is installed, otherwise false.
+    #
+    def gem_installed?(gem = name)
+      Gem::Specification.find_all_by_name(gem).blank? ? false : true
+    end
+
+    # Search for a matching node by a given role or tag.
+    #
+    # @param [Symbol] type
+    #   The filter type, can be `:role` or `:tag`.
+    #
+    # @param [String] filter
+    #   The role or tag to filter on.
+    #
+    # @param [Boolean] single
+    #   True if we should return only a single match, or false to return all
+    #   of the matches.
+    #
+    # @yield an optional block to enumerate over the nodes.
+    #
+    # @return [Array, Proc]
+    #   The value of the passed block or node.
+    #
+    # @api public
+    def find_by(type, filter, single = true, &block)
+      nodes = []
+      env   = node.chef_environment
+      if node.public_send(Inflections.pluralize(type.to_s)).include? filter
+        nodes << node
+      end
+      if !single || nodes.empty?
+        search(:node, "#{type}:#{filter} AND chef_environment:#{env}") do |n|
+          nodes << n
+        end
+      end
+
+      if block_given?
+        nodes.each { |n| yield n }
+      else
+        single ? nodes.first : nodes
+      end
+    end
+
+    # Search for a matching node by role.
+    #
+    # @param [String] role
+    #   The role to filter on.
+    #
+    # @param [Boolean] single
+    #   True if we should return only a single match, or false to return all
+    #   of the matches.
+    #
+    # @yield an optional block to enumerate over the nodes.
+    #
+    # @return [Array, Proc]
+    #   The value of the passed block or node.
+    #
+    # @api public
+    def find_by_role(role, single = true, &block)
+      find_matching :role, role, single, block
+    end
+
+    # Search for a matching node by tag.
+    #
+    # @param [String] tag
+    #   The role or tag to filter on.
+    #
+    # @param [Boolean] single
+    #   True if we should return only a single match, or false to return all
+    #   of the matches.
+    #
+    # @yield an optional block to enumerate over the nodes.
+    #
+    # @return [Array, Proc]
+    #   The value of the passed block or node.
+    #
+    # @api public
+    def find_by_tag(tag, single = true, &block)
+      find_matching :tag, tag, single, block
+    end
+
+    alias_method :find_matching,      :find_by
+    alias_method :find_matching_role, :find_by_role
+    alias_method :find_matching_tag,  :find_by_tag
+
+    # Adds a `run_now` method onto Resources so you can immediately execute
+    # the resource block. This is a shortcut so you do not have to set the
+    # action to :nothing, and then use the `.run_action` method with the
+    # desired action.
+    #
+    # @example
+    #     service 'sshd' do
+    #       action [:enable, :start]
+    #     end.run_now
+    #
+    def run_now(resource = nil)
+      resource ||= self
+      actions = Array(resource.action)
+      Chef::Log.debug "Immediate execution of #{resource.name} #{actions}"
+      resource.action(:nothing)
+      actions.each { |action| resource.run_action(action) }
+    end
+
+    # Returns true if the current node is a docker container, otherwise
+    # false.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def docker?
+      ::File.exist?('/.dockerinit') || ::File.exist?('/.dockerenv')
+    end
+
+    # Returns true if the current node has selinux enabled, otherwise false.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def selinux?
+      if installed?('getenforce')
+        Mixlib::ShellOut.new('getenforce').run_command.stdout != "Disabled\n"
+      else
+        false
+      end
+    end
+
+    # Retrieve the version number of the cookbook in the run list.
+    #
+    # @param name [String]
+    #   name of cookbook to retrieve the version on.
+    #
+    # @return [Integer]
+    #   version of the cookbook.
+    #
+    # @api public
+    def cookbook_version(name = nil)
+      cookbook = name.nil? ? cookbook_name : name
+      node.run_context.cookbook_collection[cookbook].metadata.version
+    end
+
+    # Shortcut to return cache path, if you pass in a file it will return
+    # the file with the cache path.
+    #
+    # @example
+    #   file_cache_path
+    #     => "/var/chef/cache/"
+    #
+    #   file_cache_path 'patch.tar.gz'
+    #     => "/var/chef/cache/patch.tar.gz"
+    #
+    #   file_cache_path "#{node[:name]}-backup.tar.gz"
+    #     => "/var/chef/cache/c20d24209cc8-backup.tar.gz"
+    #
+    # @param [String] args
+    #   name of file to return path with file
+    #
+    # @return [String]
+    #
+    # @api public
+    def file_cache_path(*args)
+      if args.nil?
+        Chef::Config[:file_cache_path]
+      else
+        ::File.join(Chef::Config[:file_cache_path], args)
+      end
+    end
+
+    # Invokes the public method whose name goes as first argument just like
+    # `public_send` does, except that if the receiver does not respond to
+    # it the call returns `nil` rather than raising an exception.
+    #
+    # @note `_?` is defined on `Object`. Therefore, it won't work with
+    # instances of classes that do not have `Object` among their ancestors,
+    # like direct subclasses of `BasicObject`.
+    #
+    # @param [String] object
+    #   The object to send the method to.
+    #
+    # @param [Symbol] method
+    #   The method to send to the object.
+    #
+    # @api public
+    def _?(*args, &block)
+      if args.empty? && block_given?
+        yield self
+      else
+        resp = public_send(*args[0], &block) if respond_to?(args.first)
+        return nil if resp.nil?
+        !!resp == resp ? args[1] : [args[1], resp]
+      end
+    end
+
+    # Checks for existence of a cookbook file or template source in a cookbook.
+    #
+    # @example
+    #   has_source?("foo.erb", :templates)
+    #   has_source?("bar.conf", :files, "a_cookbook")
+    #
+    # @param [String] source
+    #   Name of the desired template or cookbook file source.
+    #
+    # @param [Symbol] segment
+    #   One of `:files` or `:templates`.
+    #
+    # @param [String, Nil] cookbook
+    #   The name of the cookbook to look in, defaults to current cookbook.
+    #
+    # @return [String, Nil]
+    #   Full path to the source or nil if it doesn't exist.
+    #
+    def has_source?(source, segment, cookbook = nil)
+      cookbook ||= cookbook_name
+      begin
+        run_context.cookbook_collection[cookbook].send(
+          :find_preferred_manifest_record, run_context.node, segment, source
+        )
+      rescue Chef::Exceptions::FileNotFound
+        nil
+      end
+    end
+
+    # Returns a hash using col1 as keys and col2 as values.
+    #
+    # @example zip_hash([:name, :age, :sex], ['Earl', 30, 'male'])
+    #   => { :age => 30, :name => "Earl", :sex => "male" }
+    #
+    # @param [Array] col1
+    #   Containing the keys.
+    #
+    # @param [Array] col2
+    #   Values for hash.
+    #
+    # @return [Hash]
+    #
+    def zip_hash(col1, col2)
+      col1.zip(col2).inject({}) { |r, i| r[i[0]] = i[1]; r }
+    end
+
+    # Amazingly and somewhat surprisingly comma separate a number
+    #
+    # @param [Integer] num
+    #
+    # @return [String]
+    #
+    # @api public
+    def comma_separate(num)
+      num.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+    end
+
+    # Creates a temp directory executing the block provided. When done the
+    # temp directory and all it's contents are garbage collected.
+    #
+    # @yield [Proc] block
+    #   A block that will be run
+    #
+    # @return [Object]
+    #   Result of the block operation
+    #
+    # @api public
+    def with_tmp_dir(&block)
+      Dir.mktmpdir(SecureRandom.hex(3)) do |tmp_dir|
+        Dir.chdir(tmp_dir, &block)
+      end
+    end
+
+    # Boolean method to check if a command line utility is installed.
+    #
+    # @param [String] cmd
+    #   the command to find
+    #
+    # @return [TrueClass, FalseClass]
+    #   true if the command is found in the path, false otherwise
+    #
+    def installed?(cmd)
+      !Garcon::FileHelper.which(cmd).nil?
+    end
+
+    # @return [String] object inspection
+    # @api public
+    def inspect
+      instance_variables.inject([
+        "\n#<#{self.class}:0x#{self.object_id.to_s(16)}>",
+        "\tInstance variables:"
+      ]) do |result, item|
+        result << "\t\t#{item} = #{instance_variable_get(item)}"
+        result
+      end.join("\n")
+    end
+
+    # @return [String] string of instance
+    # @api public
+    def to_s
+      "<#{self.class}:0x#{self.object_id.to_s(16)}>"
+    end
+  end
+end