cheffish 4.0.0 → 4.1.0

data/lib/chef/resource/public_key.rb

@@ -1,7 +1,7 @@
-require 'openssl/cipher'
-require 'cheffish/base_resource'
-require 'openssl'
-require 'cheffish/key_formatter'
+require "openssl/cipher"
+require "cheffish/base_resource"
+require "openssl"
+require "cheffish/key_formatter"
 
 class Chef
   class Resource
@@ -23,7 +23,6 @@ class Chef
         Chef::Log.debug("Overloading #{resource_name}.load_prior_resource with NOOP")
       end
 
-
       action :create do
         if !new_source_key
           raise "No source key specified"
@@ -68,10 +67,10 @@ class Chef
             end
 
             if source_key.private?
-              @new_source_key_publicity = 'private'
+              @new_source_key_publicity = "private"
               source_key.public_key
             else
-              @new_source_key_publicity = 'public'
+              @new_source_key_publicity = "public"
               source_key
             end
           end

data/lib/cheffish.rb

@@ -10,8 +10,8 @@ module Cheffish
       :chef_server_url => config[:chef_server_url],
       :options => {
         :client_name => config[:node_name],
-        :signing_key_filename => config[:client_key]
-      }
+        :signing_key_filename => config[:client_key],
+      },
     }
   end
 
@@ -19,7 +19,7 @@ module Cheffish
     # 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")
+    chef_server[:options][:api_version] = "0"
     Cheffish::ServerAPI.new(chef_server[:chef_server_url], chef_server[:options])
   end
 
@@ -32,7 +32,7 @@ module Cheffish
   end
 
   def self.load_chef_config(chef_config = Chef::Config)
-    if ::Gem::Version.new(::Chef::VERSION) >= ::Gem::Version.new('12.0.0')
+    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
@@ -50,7 +50,7 @@ module Cheffish
       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 )}
+        filtered_trace.each { |line| Chef::Log.fatal("  " + line ) }
         Chef::Application.fatal!("Aborting due to error in '#{config_file_path}'", 2)
       end
     end
@@ -65,7 +65,7 @@ module Cheffish
       Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
     end
     begin
-      require 'chef/local_mode'
+      require "chef/local_mode"
       Chef::LocalMode.with_server_connectivity(&block)
 
     rescue LoadError
@@ -100,8 +100,8 @@ module Cheffish
         next unless File.exist?(private_key_path)
         Dir.entries(private_key_path).sort.each do |key|
           ext = File.extname(key)
-          if key == name || ext == '' || ext == '.pem'
-            key_name = key[0..-(ext.length+1)]
+          if key == name || ext == "" || ext == ".pem"
+            key_name = key[0..-(ext.length + 1)]
             if key_name == name || key == name
               Chef::Log.info("Reading key #{name} from file #{private_key_path}/#{key}")
               return [ IO.read("#{private_key_path}/#{key}"), "#{private_key_path}/#{key}" ]
@@ -120,12 +120,12 @@ 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'
-require 'cheffish/node_properties'
+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"
+require "cheffish/node_properties"

data/lib/cheffish/array_property.rb

@@ -1,4 +1,4 @@
-require 'chef/property'
+require "chef/property"
 
 module Cheffish
   # A typical array property. Defaults to [], accepts multiple args to setter, accumulates values.
@@ -12,7 +12,7 @@ module Cheffish
 
     # Support my_property 'a', 'b', 'c'; my_property 'a'; and my_property ['a', 'b']
     def emit_dsl
-      declared_in.class_eval(<<-EOM, __FILE__, __LINE__+1)
+      declared_in.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
         def #{name}(*values)
           property = self.class.properties[#{name.inspect}]
           if values.empty?

data/lib/cheffish/base_properties.rb

@@ -1,6 +1,6 @@
-require 'chef/mixin/properties'
-require 'cheffish/array_property'
-require 'cheffish'
+require "chef/mixin/properties"
+require "cheffish/array_property"
+require "cheffish"
 
 module Cheffish
   module BaseProperties

data/lib/cheffish/base_resource.rb

@@ -1,5 +1,5 @@
-require 'chef/resource'
-require 'cheffish/base_properties'
+require "chef/resource"
+require "cheffish/base_properties"
 
 module Cheffish
   class BaseResource < Chef::Resource
@@ -84,7 +84,7 @@ module Cheffish
         data_handler.normalize(json, fake_entry)
       end
 
-      def json_differences(old_json, new_json, print_values=true, name = '', result = nil)
+      def json_differences(old_json, new_json, print_values = true, name = "", result = nil)
         result ||= []
         json_differences_internal(old_json, new_json, print_values, name, result)
         result
@@ -97,7 +97,7 @@ module Cheffish
             if old_json.has_key?(new_key)
               removed_keys.delete(new_key)
               if new_value != old_json[new_key]
-                json_differences_internal(old_json[new_key], new_value, print_values, name == '' ? new_key : "#{name}.#{new_key}", result)
+                json_differences_internal(old_json[new_key], new_value, print_values, name == "" ? new_key : "#{name}.#{new_key}", result)
               end
             else
               if print_values
@@ -136,11 +136,11 @@ module Cheffish
         modifiers.each do |path, value|
           path = [path] if !path.kind_of?(Array)
           path = path.map { |path_part| path_part.to_s }
-          parent = 0.upto(path.size-2).inject(json) do |hash, index|
+          parent = 0.upto(path.size - 2).inject(json) do |hash, index|
             if hash.nil?
               nil
             elsif !hash.is_a?(Hash)
-              raise "Attempt to set #{path} to #{value} when #{path[0..index-1]} is not a hash"
+              raise "Attempt to set #{path} to #{value} when #{path[0..index - 1]} is not a hash"
             else
               hash[path[index]]
             end
@@ -181,7 +181,7 @@ module Cheffish
         result = []
         add_to_run_list_index = 0
         run_list_index = 0
-        while run_list_index < run_list.run_list_items.size do
+        while run_list_index < run_list.run_list_items.size
           # See if the desired run list has this item
           found_desired = add_to_run_list.index { |item| same_run_list_item(item, run_list[run_list_index]) }
           if found_desired
@@ -192,7 +192,7 @@ module Cheffish
             # be X, A, B, Y, Z.
             if found_desired >= add_to_run_list_index
               result += add_to_run_list[add_to_run_list_index..found_desired].map { |item| item.to_s }
-              add_to_run_list_index = found_desired+1
+              add_to_run_list_index = found_desired + 1
             end
           else
             # If not, just copy it in

data/lib/cheffish/basic_chef_client.rb

@@ -1,13 +1,13 @@
-require 'cheffish/version'
-require 'chef/dsl/recipe'
-require 'chef/event_dispatch/base'
-require 'chef/event_dispatch/dispatcher'
-require 'chef/node'
-require 'chef/run_context'
-require 'chef/runner'
-require 'forwardable'
-require 'chef/providers'
-require 'chef/resources'
+require "cheffish/version"
+require "chef/dsl/recipe"
+require "chef/event_dispatch/base"
+require "chef/event_dispatch/dispatcher"
+require "chef/node"
+require "chef/run_context"
+require "chef/runner"
+require "forwardable"
+require "chef/providers"
+require "chef/resources"
 
 module Cheffish
   class BasicChefClient
@@ -16,8 +16,8 @@ module Cheffish
     def initialize(node = nil, events = nil, **chef_config)
       if !node
         node = Chef::Node.new
-        node.name 'basic_chef_client'
-        node.automatic[:platform] = 'basic_chef_client'
+        node.name "basic_chef_client"
+        node.automatic[:platform] = "basic_chef_client"
         node.automatic[:platform_version] = Cheffish::VERSION
       end
 
@@ -25,7 +25,7 @@ module Cheffish
       @chef_config = chef_config
 
       with_chef_config do
-        @cookbook_name = 'basic_chef_client'
+        @cookbook_name = "basic_chef_client"
         @event_catcher = BasicChefClientEvents.new
         dispatcher = Chef::EventDispatch::Dispatcher.new(@event_catcher)
         case events
@@ -37,7 +37,7 @@ module Cheffish
         end
         @run_context = Chef::RunContext.new(node, {}, dispatcher)
         @updated = []
-        @cookbook_name = 'basic_chef_client'
+        @cookbook_name = "basic_chef_client"
       end
     end
 
@@ -58,7 +58,7 @@ module Cheffish
 
     def load_block(&block)
       with_chef_config do
-        @recipe_name = 'block'
+        @recipe_name = "block"
         instance_eval(&block)
       end
     end
@@ -79,7 +79,7 @@ module Cheffish
 
     # Builds a resource sans context, which can be later used in a new client's
     # add_resource() method.
-    def self.build_resource(type, name, created_at=nil, &resource_attrs_block)
+    def self.build_resource(type, name, created_at = nil, &resource_attrs_block)
       created_at ||= caller[0]
       result = BasicChefClient.new.tap do |client|
         client.with_chef_config do
@@ -129,7 +129,7 @@ module Cheffish
       # end
       begin
         deep_merge_config(chef_config, Chef::Config)
-        block.call
+        yield
       ensure
         # $stdout = old_stdout if chef_config[:stdout]
         # $stderr = old_stderr if chef_config[:stderr]

data/lib/cheffish/chef_actor_base.rb

@@ -1,5 +1,5 @@
-require 'cheffish/key_formatter'
-require 'cheffish/base_resource'
+require "cheffish/key_formatter"
+require "cheffish/base_resource"
 
 module Cheffish
   class ChefActorBase < Cheffish::BaseResource
@@ -11,7 +11,7 @@ module Cheffish
         end
 
         # Create or update the client/user
-        current_public_key = new_json['public_key']
+        current_public_key = new_json["public_key"]
         differences = json_differences(current_json, new_json)
         if current_resource_exists?
           # Update the actor if it's different
@@ -19,7 +19,7 @@ module Cheffish
             description = [ "update #{actor_type} #{new_resource.name} at #{actor_path}" ] + differences
             converge_by description do
               result = rest.put("#{actor_path}/#{new_resource.name}", normalize_for_put(new_json))
-              current_public_key, current_public_key_format = Cheffish::KeyFormatter.decode(result['public_key']) if result['public_key']
+              current_public_key, current_public_key_format = Cheffish::KeyFormatter.decode(result["public_key"]) if result["public_key"]
             end
           end
         else
@@ -30,7 +30,7 @@ module Cheffish
           description = [ "create #{actor_type} #{new_resource.name} at #{actor_path}" ] + differences
           converge_by description do
             result = rest.post("#{actor_path}", normalize_for_post(new_json))
-            current_public_key, current_public_key_format = Cheffish::KeyFormatter.decode(result['public_key']) if result['public_key']
+            current_public_key, current_public_key_format = Cheffish::KeyFormatter.decode(result["public_key"]) if result["public_key"]
           end
         end
 
@@ -39,9 +39,9 @@ module Cheffish
           # TODO use inline_resource
           key_content = Cheffish::KeyFormatter.encode(current_public_key, { :format => new_resource.output_key_format })
           if !current_resource.output_key_path
-            action = 'create'
+            action = "create"
           elsif key_content != IO.read(current_resource.output_key_path)
-            action = 'overwrite'
+            action = "overwrite"
           else
             action = nil
           end
@@ -109,7 +109,7 @@ module Cheffish
 
       def augment_new_json(json)
         if new_public_key
-          json['public_key'] = new_public_key.to_pem
+          json["public_key"] = new_public_key.to_pem
         end
         json
       end

data/lib/cheffish/chef_run.rb

@@ -1,4 +1,4 @@
-require 'cheffish/basic_chef_client'
+require "cheffish/basic_chef_client"
 
 module Cheffish
   class ChefRun
@@ -11,7 +11,7 @@ module Cheffish
     #        - log_location: <path|IO object> - where to stream logs to
     #        - verbose_logging: true|false - true if you want verbose logging in :debug
     #
-    def initialize(chef_config={})
+    def initialize(chef_config = {})
       @chef_config = chef_config || {}
     end
 
@@ -56,18 +56,23 @@ module Cheffish
     def stdout
       @client ? client.chef_config[:stdout].string : nil
     end
+
     def stderr
       @client ? client.chef_config[:stderr].string : nil
     end
+
     def logs
       @client ? client.chef_config[:log_location].string : nil
     end
+
     def logged_warnings
       logs.lines.select { |l| l =~ /^\[[^\]]*\] WARN:/ }.join("\n")
     end
+
     def logged_errors
       logs.lines.select { |l| l =~ /^\[[^\]]*\] ERROR:/ }.join("\n")
     end
+
     def logged_info
       logs.lines.select { |l| l =~ /^\[[^\]]*\] INFO:/ }.join("\n")
     end

data/lib/cheffish/chef_run_data.rb

@@ -1,5 +1,5 @@
-require 'chef/config'
-require 'cheffish/with_pattern'
+require "chef/config"
+require "cheffish/with_pattern"
 
 module Cheffish
   class ChefRunData

data/lib/cheffish/chef_run_listener.rb

@@ -1,4 +1,4 @@
-require 'chef/event_dispatch/base'
+require "chef/event_dispatch/base"
 
 module Cheffish
   class ChefRunListener < Chef::EventDispatch::Base

data/lib/cheffish/key_formatter.rb

@@ -1,14 +1,14 @@
-require 'openssl'
-require 'net/ssh'
-require 'etc'
-require 'socket'
-require 'digest/md5'
-require 'base64'
+require "openssl"
+require "net/ssh"
+require "etc"
+require "socket"
+require "digest/md5"
+require "base64"
 
 module Cheffish
   class KeyFormatter
     # Returns nil or key, format
-    def self.decode(str, pass_phrase=nil, filename='')
+    def self.decode(str, pass_phrase = nil, filename = "")
       key_format = {}
       key_format[:format] = format_of(str)
 
@@ -38,7 +38,7 @@ module Cheffish
         encode_openssh_key(key)
       when :pem
         if key_format[:pass_phrase]
-          cipher = key_format[:cipher] || 'DES-EDE3-CBC'
+          cipher = key_format[:cipher] || "DES-EDE3-CBC"
           key.to_pem(OpenSSL::Cipher.new(cipher), key_format[:pass_phrase])
         else
           key.to_pem
@@ -48,44 +48,42 @@ module Cheffish
       when :fingerprint, :pkcs1md5fingerprint
         hexes = Digest::MD5.hexdigest(key.to_der)
         # Put : between every pair of hexes
-        hexes.scan(/../).join(':')
+        hexes.scan(/../).join(":")
       when :rfc4716md5fingerprint
         type, base64_data, etc = encode_openssh_key(key).split
         data = Base64.decode64(base64_data)
         hexes = Digest::MD5.hexdigest(data)
-        hexes.scan(/../).join(':')
+        hexes.scan(/../).join(":")
       when :pkcs8sha1fingerprint
         if RUBY_VERSION.to_f >= 2.0
           raise "PKCS8 SHA1 not supported in Ruby #{RUBY_VERSION}"
         end
-        require 'openssl_pkcs8'
+        require "openssl_pkcs8"
         pkcs8_pem = key.to_pem_pkcs8
         pkcs8_base64 = pkcs8_pem.split("\n").reject { |l| l =~ /^-----/ }
         pkcs8_data = Base64.decode64(pkcs8_base64.join)
         hexes = Digest::SHA1.hexdigest(pkcs8_data)
-        hexes.scan(/../).join(':')
+        hexes.scan(/../).join(":")
       else
         raise "Unrecognized key format #{format}"
       end
     end
 
-    private
-
     def self.encode_openssh_key(key)
       # TODO there really isn't a method somewhere in net/ssh or openssl that does this??
       type = key.ssh_type
-      data = [ key.to_blob ].pack('m0')
+      data = [ key.to_blob ].pack("m0")
       "#{type} #{data} #{Etc.getlogin}@#{Socket.gethostname}"
     end
 
-    def self.decode_openssh_key(str, filename='')
+    def self.decode_openssh_key(str, filename = "")
       Net::SSH::KeyFactory.load_data_public_key(str, filename)
     end
 
     def self.format_of(key_contents)
-      if key_contents.start_with?('-----BEGIN ')
+      if key_contents.start_with?("-----BEGIN ")
         :pem
-      elsif key_contents.start_with?('ssh-rsa ') || key_contents.start_with?('ssh-dss ')
+      elsif key_contents.start_with?("ssh-rsa ", "ssh-dss ")
         :openssh
       else
         :der