cheffish 1.4.1 → 1.4.2

data/lib/cheffish/server_api.rb

@@ -1,52 +1,52 @@
-#
-# Author:: John Keiser (<jkeiser@opscode.com>)
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# 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 'chef/version'
-require 'chef/http'
-require 'chef/http/authenticator'
-require 'chef/http/cookie_manager'
-require 'chef/http/decompressor'
-require 'chef/http/json_input'
-require 'chef/http/json_output'
-if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('11.12')
-  require 'chef/http/remote_request_id'
-end
-
-module Cheffish
-  # Exactly like Chef::ServerAPI, but requires you to pass in what keys you want (no defaults)
-  class ServerAPI < Chef::HTTP
-
-    def initialize(url, options = {})
-      super(url, options)
-      root_url = URI.parse(url)
-      root_url.path = ''
-      @root_url = root_url.to_s
-    end
-
-    attr_reader :root_url
-
-    use Chef::HTTP::JSONInput
-    use Chef::HTTP::JSONOutput
-    use Chef::HTTP::CookieManager
-    use Chef::HTTP::Decompressor
-    use Chef::HTTP::Authenticator
-    if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('11.12')
-      use Chef::HTTP::RemoteRequestID
-    end
-  end
-end
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'chef/version'
+require 'chef/http'
+require 'chef/http/authenticator'
+require 'chef/http/cookie_manager'
+require 'chef/http/decompressor'
+require 'chef/http/json_input'
+require 'chef/http/json_output'
+if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('11.12')
+  require 'chef/http/remote_request_id'
+end
+
+module Cheffish
+  # Exactly like Chef::ServerAPI, but requires you to pass in what keys you want (no defaults)
+  class ServerAPI < Chef::HTTP
+
+    def initialize(url, options = {})
+      super(url, options)
+      root_url = URI.parse(url)
+      root_url.path = ''
+      @root_url = root_url.to_s
+    end
+
+    attr_reader :root_url
+
+    use Chef::HTTP::JSONInput
+    use Chef::HTTP::JSONOutput
+    use Chef::HTTP::CookieManager
+    use Chef::HTTP::Decompressor
+    use Chef::HTTP::Authenticator
+    if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('11.12')
+      use Chef::HTTP::RemoteRequestID
+    end
+  end
+end

data/lib/cheffish/version.rb

@@ -1,3 +1,3 @@
-module Cheffish
-  VERSION = '1.4.1'
-end
+module Cheffish
+  VERSION = '1.4.2'
+end

data/lib/cheffish/with_pattern.rb

@@ -1,21 +1,21 @@
-module Cheffish
-  module WithPattern
-    def with(symbol)
-      class_eval <<EOM
-        attr_accessor :current_#{symbol}
-
-        def with_#{symbol}(value)
-          old_value = self.current_#{symbol}
-          self.current_#{symbol} = value
-          if block_given?
-            begin
-              yield
-            ensure
-              self.current_#{symbol} = old_value
-            end
-          end
-        end
-EOM
-    end
-  end
-end
+module Cheffish
+  module WithPattern
+    def with(symbol)
+      class_eval <<EOM
+        attr_accessor :current_#{symbol}
+
+        def with_#{symbol}(value)
+          old_value = self.current_#{symbol}
+          self.current_#{symbol} = value
+          if block_given?
+            begin
+              yield
+            ensure
+              self.current_#{symbol} = old_value
+            end
+          end
+        end
+EOM
+    end
+  end
+end

data/lib/cheffish.rb

@@ -1,235 +1,235 @@
-module Cheffish
-  NAME_REGEX = /^[.\-[:alnum:]_]+$/
-
-  def self.inline_resource(provider, provider_action, *resources, &block)
-    BasicChefClient.inline_resource(provider, provider_action, *resources, &block)
-  end
-
-  def self.default_chef_server(config = profiled_config)
-    {
-      :chef_server_url => config[:chef_server_url],
-      :options => {
-        :client_name => config[:node_name],
-        :signing_key_filename => config[:client_key]
-      }
-    }
-  end
-
-  def self.chef_server_api(chef_server = default_chef_server)
-    # Pin the server api version to 0 until https://github.com/chef/cheffish/issues/56
-    # gets the correct compatibility fix.
-    chef_server[:options] ||= {}
-    chef_server[:options].merge!(api_version: "0")
-    Cheffish::ServerAPI.new(chef_server[:chef_server_url], chef_server[:options])
-  end
-
-  def self.profiled_config(config = Chef::Config)
-    if config.profile && config.profiles && config.profiles[config.profile]
-      MergedConfig.new(config.profiles[config.profile], config)
-    else
-      config
-    end
-  end
-
-  def self.load_chef_config(chef_config = Chef::Config)
-    if ::Gem::Version.new(::Chef::VERSION) >= ::Gem::Version.new('12.0.0')
-      chef_config.config_file = ::Chef::Knife.chef_config_dir
-    else
-      chef_config.config_file = ::Chef::Knife.locate_config_file
-    end
-    config_fetcher = Chef::ConfigFetcher.new(chef_config.config_file, chef_config.config_file_jail)
-    if chef_config.config_file.nil?
-      Chef::Log.warn("No config file found or specified on command line, using command line options.")
-    elsif config_fetcher.config_missing?
-      Chef::Log.warn("Did not find config file: #{chef_config.config_file}, using command line options.")
-    else
-      config_content = config_fetcher.read_config
-      config_file_path = chef_config.config_file
-      begin
-        chef_config.from_string(config_content, config_file_path)
-      rescue Exception => error
-        Chef::Log.fatal("Configuration error #{error.class}: #{error.message}")
-        filtered_trace = error.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
-        filtered_trace.each {|line| Chef::Log.fatal("  " + line )}
-        Chef::Application.fatal!("Aborting due to error in '#{config_file_path}'", 2)
-      end
-    end
-    Cheffish.profiled_config(chef_config)
-  end
-
-  def self.honor_local_mode(local_mode_default = true, &block)
-    if !Chef::Config.has_key?(:local_mode) && !local_mode_default.nil?
-      Chef::Config.local_mode = local_mode_default
-    end
-    if Chef::Config.local_mode && !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
-      Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
-    end
-    begin
-      require 'chef/local_mode'
-      Chef::LocalMode.with_server_connectivity(&block)
-
-    rescue LoadError
-      Chef::Application.setup_server_connectivity
-      if block_given?
-        begin
-          yield
-        ensure
-          Chef::Application.destroy_server_connectivity
-        end
-      end
-    end
-  end
-
-  def self.get_private_key(name, config = profiled_config)
-    key, key_path = get_private_key_with_path(name, config)
-    key
-  end
-
-  def self.get_private_key_with_path(name, config = profiled_config)
-    if config[:private_keys] && config[:private_keys][name]
-      named_key = config[:private_keys][name]
-      if named_key.is_a?(String)
-        Chef::Log.info("Got key #{name} from Chef::Config.private_keys.#{name}, which points at #{named_key}.  Reading key from there ...")
-        return [ IO.read(named_key), named_key]
-      else
-        Chef::Log.info("Got key #{name} raw from Chef::Config.private_keys.#{name}.")
-        return [ named_key.to_pem, nil ]
-      end
-    elsif config[:private_key_paths]
-      config[:private_key_paths].each do |private_key_path|
-        next unless File.exist?(private_key_path)
-        Dir.entries(private_key_path).sort.each do |key|
-          ext = File.extname(key)
-          if ext == '' || ext == '.pem'
-            key_name = key[0..-(ext.length+1)]
-            if key_name == name
-              Chef::Log.info("Reading key #{name} from file #{private_key_path}/#{key}")
-              return [ IO.read("#{private_key_path}/#{key}"), "#{private_key_path}/#{key}" ]
-            end
-          end
-        end
-      end
-    end
-    nil
-  end
-
-  # `NOT_PASSED` is defined in chef-12.5.0, this guard will ensure we
-  # don't redefine it if it's already there
-  NOT_PASSED=Object.new unless defined?(NOT_PASSED)
-
-  def self.node_attributes(klass)
-    klass.class_eval do
-      attribute :name, :kind_of => String, :regex => Cheffish::NAME_REGEX, :name_attribute => true
-      attribute :chef_environment, :kind_of => String, :regex => Cheffish::NAME_REGEX
-      attribute :run_list, :kind_of => Array # We should let them specify it as a series of parameters too
-      attribute :attributes, :kind_of => Hash
-
-      # Specifies that this is a complete specification for the environment (i.e. attributes you don't specify will be
-      # reset to their defaults)
-      attribute :complete, :kind_of => [TrueClass, FalseClass]
-
-      attribute :raw_json, :kind_of => Hash
-      attribute :chef_server, :kind_of => Hash
-
-      # attribute 'ip_address', '127.0.0.1'
-      # attribute [ 'pushy', 'port' ], '9000'
-      # attribute 'ip_addresses' do |existing_value|
-      #   (existing_value || []) + [ '127.0.0.1' ]
-      # end
-      # attribute 'ip_address', :delete
-      attr_accessor :attribute_modifiers
-      def attribute(attribute_path, value=NOT_PASSED, &block)
-        @attribute_modifiers ||= []
-        if value != NOT_PASSED
-          @attribute_modifiers << [ attribute_path, value ]
-        elsif block
-          @attribute_modifiers << [ attribute_path, block ]
-        else
-          raise "attribute requires either a value or a block"
-        end
-      end
-
-      # Patchy tags
-      # tag 'webserver', 'apache', 'myenvironment'
-      def tag(*tags)
-        attribute 'tags' do |existing_tags|
-          existing_tags ||= []
-          tags.each do |tag|
-            if !existing_tags.include?(tag.to_s)
-              existing_tags << tag.to_s
-            end
-          end
-          existing_tags
-        end
-      end
-      def remove_tag(*tags)
-        attribute 'tags' do |existing_tags|
-          if existing_tags
-            tags.each do |tag|
-              existing_tags.delete(tag.to_s)
-            end
-          end
-          existing_tags
-        end
-      end
-
-      # NON-patchy tags
-      # tags :a, :b, :c # removes all other tags
-      def tags(*tags)
-        if tags.size == 0
-          attribute('tags')
-        else
-          tags = tags[0] if tags.size == 1 && tags[0].kind_of?(Array)
-          attribute 'tags', tags.map { |tag| tag.to_s }
-        end
-      end
-
-      # Order matters--if two things here are in the wrong order, they will be flipped in the run list
-      # recipe 'apache', 'mysql'
-      # recipe 'recipe@version'
-      # recipe 'recipe'
-      # role ''
-      attr_accessor :run_list_modifiers
-      attr_accessor :run_list_removers
-      def recipe(*recipes)
-        if recipes.size == 0
-          raise ArgumentError, "At least one recipe must be specified"
-        end
-        @run_list_modifiers ||= []
-        @run_list_modifiers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
-      end
-      def role(*roles)
-        if roles.size == 0
-          raise ArgumentError, "At least one role must be specified"
-        end
-        @run_list_modifiers ||= []
-        @run_list_modifiers += roles.map { |role| Chef::RunList::RunListItem.new("role[#{role}]") }
-      end
-      def remove_recipe(*recipes)
-        if recipes.size == 0
-          raise ArgumentError, "At least one recipe must be specified"
-        end
-        @run_list_removers ||= []
-        @run_list_removers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
-      end
-      def remove_role(*roles)
-        if roles.size == 0
-          raise ArgumentError, "At least one role must be specified"
-        end
-        @run_list_removers ||= []
-        @run_list_removers += roles.map { |role| Chef::RunList::RunListItem.new("role[#{role}]") }
-      end
-    end
-  end
-end
-
-# Include all recipe objects so require 'cheffish' brings in the whole recipe DSL
-
-require 'chef/run_list/run_list_item'
-require 'cheffish/basic_chef_client'
-require 'cheffish/server_api'
-require 'chef/knife'
-require 'chef/config_fetcher'
-require 'chef/log'
-require 'chef/application'
-require 'cheffish/recipe_dsl'
+module Cheffish
+  NAME_REGEX = /^[.\-[:alnum:]_]+$/
+
+  def self.inline_resource(provider, provider_action, *resources, &block)
+    BasicChefClient.inline_resource(provider, provider_action, *resources, &block)
+  end
+
+  def self.default_chef_server(config = profiled_config)
+    {
+      :chef_server_url => config[:chef_server_url],
+      :options => {
+        :client_name => config[:node_name],
+        :signing_key_filename => config[:client_key]
+      }
+    }
+  end
+
+  def self.chef_server_api(chef_server = default_chef_server)
+    # Pin the server api version to 0 until https://github.com/chef/cheffish/issues/56
+    # gets the correct compatibility fix.
+    chef_server[:options] ||= {}
+    chef_server[:options].merge!(api_version: "0")
+    Cheffish::ServerAPI.new(chef_server[:chef_server_url], chef_server[:options])
+  end
+
+  def self.profiled_config(config = Chef::Config)
+    if config.profile && config.profiles && config.profiles[config.profile]
+      MergedConfig.new(config.profiles[config.profile], config)
+    else
+      config
+    end
+  end
+
+  def self.load_chef_config(chef_config = Chef::Config)
+    if ::Gem::Version.new(::Chef::VERSION) >= ::Gem::Version.new('12.0.0')
+      chef_config.config_file = ::Chef::Knife.chef_config_dir
+    else
+      chef_config.config_file = ::Chef::Knife.locate_config_file
+    end
+    config_fetcher = Chef::ConfigFetcher.new(chef_config.config_file, chef_config.config_file_jail)
+    if chef_config.config_file.nil?
+      Chef::Log.warn("No config file found or specified on command line, using command line options.")
+    elsif config_fetcher.config_missing?
+      Chef::Log.warn("Did not find config file: #{chef_config.config_file}, using command line options.")
+    else
+      config_content = config_fetcher.read_config
+      config_file_path = chef_config.config_file
+      begin
+        chef_config.from_string(config_content, config_file_path)
+      rescue Exception => error
+        Chef::Log.fatal("Configuration error #{error.class}: #{error.message}")
+        filtered_trace = error.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
+        filtered_trace.each {|line| Chef::Log.fatal("  " + line )}
+        Chef::Application.fatal!("Aborting due to error in '#{config_file_path}'", 2)
+      end
+    end
+    Cheffish.profiled_config(chef_config)
+  end
+
+  def self.honor_local_mode(local_mode_default = true, &block)
+    if !Chef::Config.has_key?(:local_mode) && !local_mode_default.nil?
+      Chef::Config.local_mode = local_mode_default
+    end
+    if Chef::Config.local_mode && !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
+      Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
+    end
+    begin
+      require 'chef/local_mode'
+      Chef::LocalMode.with_server_connectivity(&block)
+
+    rescue LoadError
+      Chef::Application.setup_server_connectivity
+      if block_given?
+        begin
+          yield
+        ensure
+          Chef::Application.destroy_server_connectivity
+        end
+      end
+    end
+  end
+
+  def self.get_private_key(name, config = profiled_config)
+    key, key_path = get_private_key_with_path(name, config)
+    key
+  end
+
+  def self.get_private_key_with_path(name, config = profiled_config)
+    if config[:private_keys] && config[:private_keys][name]
+      named_key = config[:private_keys][name]
+      if named_key.is_a?(String)
+        Chef::Log.info("Got key #{name} from Chef::Config.private_keys.#{name}, which points at #{named_key}.  Reading key from there ...")
+        return [ IO.read(named_key), named_key]
+      else
+        Chef::Log.info("Got key #{name} raw from Chef::Config.private_keys.#{name}.")
+        return [ named_key.to_pem, nil ]
+      end
+    elsif config[:private_key_paths]
+      config[:private_key_paths].each do |private_key_path|
+        next unless File.exist?(private_key_path)
+        Dir.entries(private_key_path).sort.each do |key|
+          ext = File.extname(key)
+          if ext == '' || ext == '.pem'
+            key_name = key[0..-(ext.length+1)]
+            if key_name == name
+              Chef::Log.info("Reading key #{name} from file #{private_key_path}/#{key}")
+              return [ IO.read("#{private_key_path}/#{key}"), "#{private_key_path}/#{key}" ]
+            end
+          end
+        end
+      end
+    end
+    nil
+  end
+
+  # `NOT_PASSED` is defined in chef-12.5.0, this guard will ensure we
+  # don't redefine it if it's already there
+  NOT_PASSED=Object.new unless defined?(NOT_PASSED)
+
+  def self.node_attributes(klass)
+    klass.class_eval do
+      attribute :name, :kind_of => String, :regex => Cheffish::NAME_REGEX, :name_attribute => true
+      attribute :chef_environment, :kind_of => String, :regex => Cheffish::NAME_REGEX
+      attribute :run_list, :kind_of => Array # We should let them specify it as a series of parameters too
+      attribute :attributes, :kind_of => Hash
+
+      # Specifies that this is a complete specification for the environment (i.e. attributes you don't specify will be
+      # reset to their defaults)
+      attribute :complete, :kind_of => [TrueClass, FalseClass]
+
+      attribute :raw_json, :kind_of => Hash
+      attribute :chef_server, :kind_of => Hash
+
+      # attribute 'ip_address', '127.0.0.1'
+      # attribute [ 'pushy', 'port' ], '9000'
+      # attribute 'ip_addresses' do |existing_value|
+      #   (existing_value || []) + [ '127.0.0.1' ]
+      # end
+      # attribute 'ip_address', :delete
+      attr_accessor :attribute_modifiers
+      def attribute(attribute_path, value=NOT_PASSED, &block)
+        @attribute_modifiers ||= []
+        if value != NOT_PASSED
+          @attribute_modifiers << [ attribute_path, value ]
+        elsif block
+          @attribute_modifiers << [ attribute_path, block ]
+        else
+          raise "attribute requires either a value or a block"
+        end
+      end
+
+      # Patchy tags
+      # tag 'webserver', 'apache', 'myenvironment'
+      def tag(*tags)
+        attribute 'tags' do |existing_tags|
+          existing_tags ||= []
+          tags.each do |tag|
+            if !existing_tags.include?(tag.to_s)
+              existing_tags << tag.to_s
+            end
+          end
+          existing_tags
+        end
+      end
+      def remove_tag(*tags)
+        attribute 'tags' do |existing_tags|
+          if existing_tags
+            tags.each do |tag|
+              existing_tags.delete(tag.to_s)
+            end
+          end
+          existing_tags
+        end
+      end
+
+      # NON-patchy tags
+      # tags :a, :b, :c # removes all other tags
+      def tags(*tags)
+        if tags.size == 0
+          attribute('tags')
+        else
+          tags = tags[0] if tags.size == 1 && tags[0].kind_of?(Array)
+          attribute 'tags', tags.map { |tag| tag.to_s }
+        end
+      end
+
+      # Order matters--if two things here are in the wrong order, they will be flipped in the run list
+      # recipe 'apache', 'mysql'
+      # recipe 'recipe@version'
+      # recipe 'recipe'
+      # role ''
+      attr_accessor :run_list_modifiers
+      attr_accessor :run_list_removers
+      def recipe(*recipes)
+        if recipes.size == 0
+          raise ArgumentError, "At least one recipe must be specified"
+        end
+        @run_list_modifiers ||= []
+        @run_list_modifiers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
+      end
+      def role(*roles)
+        if roles.size == 0
+          raise ArgumentError, "At least one role must be specified"
+        end
+        @run_list_modifiers ||= []
+        @run_list_modifiers += roles.map { |role| Chef::RunList::RunListItem.new("role[#{role}]") }
+      end
+      def remove_recipe(*recipes)
+        if recipes.size == 0
+          raise ArgumentError, "At least one recipe must be specified"
+        end
+        @run_list_removers ||= []
+        @run_list_removers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
+      end
+      def remove_role(*roles)
+        if roles.size == 0
+          raise ArgumentError, "At least one role must be specified"
+        end
+        @run_list_removers ||= []
+        @run_list_removers += roles.map { |role| Chef::RunList::RunListItem.new("role[#{role}]") }
+      end
+    end
+  end
+end
+
+# Include all recipe objects so require 'cheffish' brings in the whole recipe DSL
+
+require 'chef/run_list/run_list_item'
+require 'cheffish/basic_chef_client'
+require 'cheffish/server_api'
+require 'chef/knife'
+require 'chef/config_fetcher'
+require 'chef/log'
+require 'chef/application'
+require 'cheffish/recipe_dsl'