cheffish 14.0.1 → 14.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b322f6c35d8de419ca2d82d4b6314d6611ea8fc1f3713a0dd2a226d805f9cf32
-  data.tar.gz: e9f224665c4aa7c477310f58873db64f785c2ea57550cd0c2a78b1ac9239c9cc
+  metadata.gz: b546acb84203496cb2e896764aaaf437971b8fc1e45f62d561ab263ee78e2fea
+  data.tar.gz: 96d154e73378a8c2008117c1b50e4eb1077cd43db9bc1748a702dccd08e1ddb6
 SHA512:
-  metadata.gz: 79ff38ae7d3a5739e5a8d1464758899156c6d8282713d6c5a22cb18e3fd0229a58f69c3db4d7588b2f57585b0ab555a2314850f9b0f61fa868f4ec2426266bd7
-  data.tar.gz: fbaf1722dd64857f8da5946f4b61a7249370113f34b98cf63802513dd6f30bf12d37e27ebe777cf78d428402043fa0a01281487b9daf57de4e857d7348258dc9
+  metadata.gz: 6c34534a52657f87d803ea12a629c76c3f6ae9a10e7cc982640ac4162c4db683bf0ebcae3860381f80f34eb08b8cde880faa368ffbe84b6946160ccdc0d62913
+  data.tar.gz: 380ffbe2f90d104b9a60820498452c1d8e496a603b8dcc17ef1218ffc7f34d231fdb3fffdc103410ff08b51e90d08d3e85ae5e3c98385a470e33b18902fc5852

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "chefstyle", "= 0.6.0"
+  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
   gem "rake"
   gem "rspec", "~> 3.0"
 end
@@ -18,3 +18,22 @@ else
     gem "ohai", "~> 14"
   end
 end
+
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :debug do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+  gem "rb-readline"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -1,47 +1,42 @@
-require "bundler"
-require "rubygems"
-require "rubygems/package_task"
-require "rdoc/task"
-require "rspec/core/rake_task"
-
-Bundler::GemHelper.install_tasks
-
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
-end
-
-gem_spec = eval(File.read("cheffish.gemspec"))
-
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "cheffish #{gem_spec.version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
+require "bundler/gem_tasks"
 
 begin
-  require "github_changelog_generator/task"
+  require "rspec/core/rake_task"
 
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    require "cheffish/version"
-    config.future_release = Cheffish::VERSION
-    config.enhancement_labels = "enhancement,Enhancement,Improvement,New Feature,Feature".split(",")
-    config.bug_labels = "bug,Bug,Upstream Bug".split(",")
-    config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Discussion".split(",")
-    config.issues = false
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
   end
 rescue LoadError
+  desc "rspec is not installed, this task is disabled"
+  task :spec do
+    abort "rspec is not installed. bundle install first to make sure all dependencies are installed."
+  end
 end
 
 begin
   require "chefstyle"
   require "rubocop/rake_task"
+  desc "Run Chefstyle tests"
   RuboCop::RakeTask.new(:style) do |task|
     task.options += ["--display-cop-names", "--no-color"]
   end
 rescue LoadError
-  puts "chefstyle/rubocop is not available."
+  puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
 end
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:docs)
+rescue LoadError
+  puts "yard is not available. bundle install first to make sure all dependencies are installed."
+end
+
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "cheffish"
+  ARGV.clear
+  IRB.start
+end
+
+task default: [:style, :spec]

data/cheffish.gemspec

@@ -5,12 +5,12 @@ Gem::Specification.new do |s|
   s.name = "cheffish"
   s.version = Cheffish::VERSION
   s.platform = Gem::Platform::RUBY
-  s.extra_rdoc_files = [ "README.md", "LICENSE" ]
+  s.license = "Apache-2.0"
   s.summary = "A library to manipulate Chef in Chef."
   s.description = s.summary
   s.author = "John Keiser"
   s.email = "jkeiser@chef.io"
-  s.homepage = "http://github.com/chef/cheffish"
+  s.homepage = "https://github.com/chef/cheffish"
 
   s.required_ruby_version = ">= 2.4.0"
 
@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.executables  = %w{ }
 
   s.require_path = "lib"
-  s.files = %w{Gemfile Rakefile LICENSE README.md} + Dir.glob("*.gemspec") +
-    Dir.glob("{distro,lib,tasks,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  s.files = %w{Gemfile Rakefile LICENSE} + Dir.glob("*.gemspec") +
+    Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
 end

data/lib/chef/resource/chef_acl.rb

@@ -124,7 +124,7 @@ class Chef
           # If recurse is on_change, then we will recurse if there is no ACL, or if
           # the ACL has changed.
           if new_resource.recursive == true || (new_resource.recursive == :on_change && (!acl || changed))
-            children, error = list(path, "*")
+            children, _error = list(path, "*")
             Chef::ChefFS::Parallelizer.parallel_do(children) do |child|
               next if child.split("/")[-1] == "containers"
               create_acl(child)
@@ -141,7 +141,7 @@ class Chef
         # Get the current ACL for the given path
         def current_acl(acl_path)
           @current_acls ||= {}
-          if !@current_acls.has_key?(acl_path)
+          if !@current_acls.key?(acl_path)
             @current_acls[acl_path] = begin
               rest.get(rest_url(acl_path))
             rescue Net::HTTPServerException => e
@@ -299,8 +299,8 @@ class Chef
             #
             # Result: /*/foo = [ '/organizations/foo', '/users/foo' ]
             #
-            matches = Chef::ChefFS::Parallelizer.parallelize(matches) do |path|
-              found, error = list(path, part)
+            matches = Chef::ChefFS::Parallelizer.parallelize(matches) do |pth|
+              found, error = list(pth, part)
               if error
                 if parts[0..index - 1].all? { |p| p != "*" }
                   raise error

data/lib/chef/resource/chef_data_bag_item.rb

@@ -112,12 +112,12 @@ class Chef
           end
 
           # Determine if data bag is encrypted and if so, what its version is
-          first_real_key, first_real_value = (current_resource.raw_data || {}).select { |key, value| key != "id" && !value.nil? }.first
+          _first_real_key, first_real_value = (current_resource.raw_data || {}).select { |key, value| key != "id" && !value.nil? }.first
           if first_real_value
             if first_real_value.is_a?(Hash) &&
                 first_real_value["version"].is_a?(Integer) &&
                 first_real_value["version"] > 0 &&
-                first_real_value.has_key?("encrypted_data")
+                first_real_value.key?("encrypted_data")
 
               current_resource.encrypt true
               current_resource.encryption_version first_real_value["version"]
@@ -232,7 +232,7 @@ class Chef
               result = current_decrypted.merge(new_resource.raw_data || {})
             end
             result["id"] = new_resource.id
-            result = apply_modifiers(new_resource.raw_data_modifiers, result)
+            _result = apply_modifiers(new_resource.raw_data_modifiers, result)
           end
         end
 
@@ -283,7 +283,7 @@ class Chef
               if !new_resource.complete
                 raise "Cannot encrypt #{new_resource.name} due to failure to decrypt existing resource.  Set 'complete true' to overwrite or add the old secret as old_secret / old_secret_path."
               end
-              differences = [ "overwrite data bag item (cannot decrypt old data bag item)"]
+              _differences = [ "overwrite data bag item (cannot decrypt old data bag item)"]
               differences = (new_resource.raw_data.keys & current_resource.raw_data.keys).map { |key| "overwrite #{key}" }
               differences += (new_resource.raw_data.keys - current_resource.raw_data.keys).map { |key| "add #{key}" }
               differences += (current_resource.raw_data.keys - new_resource.raw_data.keys).map { |key| "remove #{key}" }

data/lib/chef/resource/chef_mirror.rb

@@ -45,7 +45,7 @@ class Chef
         set_or_return(
           :freeze_on_upload,
           arg,
-          :kind_of => Boolean
+          kind_of: Boolean
         )
       end
 
@@ -153,11 +153,11 @@ class Chef
 
         def remote_fs
           config = {
-            :chef_server_url => new_resource.chef_server[:chef_server_url],
-            :node_name => new_resource.chef_server[:options][:client_name],
-            :client_key => new_resource.chef_server[:options][:signing_key_filename],
-            :repo_mode => repo_mode,
-            :versioned_cookbooks => Chef::Config.versioned_cookbooks,
+            chef_server_url: new_resource.chef_server[:chef_server_url],
+            node_name: new_resource.chef_server[:options][:client_name],
+            client_key: new_resource.chef_server[:options][:signing_key_filename],
+            repo_mode: repo_mode,
+            versioned_cookbooks: Chef::Config.versioned_cookbooks,
           }
           Chef::ChefFS::FileSystem::ChefServer::ChefServerRootDir.new("remote", config)
         end
@@ -168,10 +168,10 @@ class Chef
 
         def options
           result = {
-            :purge => new_resource.purge,
-            :freeze => new_resource.freeze_on_upload,
-            :diff => new_resource.no_diff,
-            :dry_run => whyrun_mode?,
+            purge: new_resource.purge,
+            freeze: new_resource.freeze_on_upload,
+            diff: new_resource.no_diff,
+            dry_run: whyrun_mode?,
           }
           result[:diff] = !result[:diff]
           result[:repo_mode] = repo_mode

data/lib/chef/resource/chef_organization.rb

@@ -45,7 +45,7 @@ class Chef
 
         # Revoke invites and memberships when asked
         invites_to_remove.each do |user|
-          if outstanding_invites.has_key?(user)
+          if outstanding_invites.key?(user)
             converge_by "revoke #{user}'s invitation to organization #{new_resource.organization_name}" do
               rest.delete("#{rest.root_url}/organizations/#{new_resource.organization_name}/association_requests/#{outstanding_invites[user]}")
             end
@@ -61,7 +61,7 @@ class Chef
 
         # Invite and add members when asked
         new_resource.invites.each do |user|
-          if !existing_members.include?(user) && !outstanding_invites.has_key?(user)
+          if !existing_members.include?(user) && !outstanding_invites.key?(user)
             converge_by "invite #{user} to organization #{new_resource.organization_name}" do
               rest.post("#{rest.root_url}/organizations/#{new_resource.organization_name}/association_requests", { "user" => user })
             end

data/lib/chef/resource/chef_resolved_cookbooks.rb

@@ -31,7 +31,7 @@ class Chef
         new_resource.cookbooks_from.each do |path|
           ::Dir.entries(path).each do |name|
             if ::File.directory?(::File.join(path, name)) && name != "." && name != ".."
-              new_resource.berksfile.cookbook name, :path => ::File.join(path, name)
+              new_resource.berksfile.cookbook name, path: ::File.join(path, name)
             end
           end
         end
@@ -41,9 +41,9 @@ class Chef
         # Ridley really really wants a key :/
         if new_resource.chef_server[:options][:signing_key_filename]
           new_resource.berksfile.upload(
-            :server_url => new_resource.chef_server[:chef_server_url],
-            :client_name => new_resource.chef_server[:options][:client_name],
-            :client_key => new_resource.chef_server[:options][:signing_key_filename])
+            server_url: new_resource.chef_server[:chef_server_url],
+            client_name: new_resource.chef_server[:options][:client_name],
+            client_key: new_resource.chef_server[:options][:signing_key_filename])
         else
           file = Tempfile.new("privatekey")
           begin
@@ -51,9 +51,9 @@ class Chef
             file.close
 
             new_resource.berksfile.upload(
-              :server_url => new_resource.chef_server[:chef_server_url],
-              :client_name => new_resource.chef_server[:options][:client_name] || "me",
-              :client_key => file.path)
+              server_url: new_resource.chef_server[:chef_server_url],
+              client_name: new_resource.chef_server[:options][:client_name] || "me",
+              client_key: file.path)
 
           ensure
             file.close

data/lib/chef/resource/chef_user.rb

@@ -14,9 +14,9 @@ class Chef
       property :external_authentication_uid
       property :recovery_authentication_enabled, Boolean
       property :password, String # Hmm.  There is no way to idempotentize this.
-      #property :salt  # TODO server doesn't support sending or receiving these, but it's the only way to backup / restore a user
-      #property :hashed_password
-      #property :hash_type
+      # property :salt  # TODO server doesn't support sending or receiving these, but it's the only way to backup / restore a user
+      # property :hashed_password
+      # property :hash_type
 
       # Input key
       property :source_key # String or OpenSSL::PKey::*

data/lib/chef/resource/private_key.rb

@@ -31,7 +31,7 @@ class Chef
 
       # PEM-only
       property :pass_phrase, String
-      property :cipher, OpenSSL::Cipher.ciphers, default: "DES-EDE3-CBC"
+      property :cipher, String, equal_to: OpenSSL::Cipher.ciphers.map { |x| x.downcase }, default: "des-ede3-cbc", coerce: proc { |x| x.downcase }
 
       # Set this to regenerate the key if it does not have the desired characteristics (like size, type, etc.)
       property :regenerate_if_different, Boolean
@@ -180,12 +180,12 @@ class Chef
         def new_source_key
           @new_source_key ||= begin
                                 if new_resource.source_key.is_a?(String)
-                                  source_key, source_key_format = Cheffish::KeyFormatter.decode(new_resource.source_key, new_resource.source_key_pass_phrase)
+                                  source_key, _source_key_format = Cheffish::KeyFormatter.decode(new_resource.source_key, new_resource.source_key_pass_phrase)
                                   source_key
                                 elsif new_resource.source_key
                                   new_resource.source_key
                                 elsif new_resource.source_key_path
-                                  source_key, source_key_format = Cheffish::KeyFormatter.decode(IO.read(new_resource.source_key_path), new_resource.source_key_pass_phrase, new_resource.source_key_path)
+                                  source_key, _source_key_format = Cheffish::KeyFormatter.decode(IO.read(new_resource.source_key_path), new_resource.source_key_pass_phrase, new_resource.source_key_path)
                                   source_key
                                 else
                                   nil

data/lib/chef/resource/public_key.rb

@@ -57,11 +57,11 @@ class Chef
         def new_source_key
           @new_source_key ||= begin
             if new_resource.source_key.is_a?(String)
-              source_key, source_key_format = Cheffish::KeyFormatter.decode(new_resource.source_key, new_resource.source_key_pass_phrase)
+              source_key, _source_key_format = Cheffish::KeyFormatter.decode(new_resource.source_key, new_resource.source_key_pass_phrase)
             elsif new_resource.source_key
               source_key = new_resource.source_key
             elsif new_resource.source_key_path
-              source_key, source_key_format = Cheffish::KeyFormatter.decode(IO.read(new_resource.source_key_path), new_resource.source_key_pass_phrase, new_resource.source_key_path)
+              source_key, _source_key_format = Cheffish::KeyFormatter.decode(IO.read(new_resource.source_key_path), new_resource.source_key_pass_phrase, new_resource.source_key_path)
             else
               return nil
             end

data/lib/cheffish.rb

@@ -7,10 +7,10 @@ module Cheffish
 
   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],
+      chef_server_url: config[:chef_server_url],
+      options: {
+        client_name: config[:node_name],
+        signing_key_filename: config[:client_key],
       },
     }
   end
@@ -58,10 +58,10 @@ module Cheffish
   end
 
   def self.honor_local_mode(local_mode_default = true, &block)
-    if !Chef::Config.has_key?(:local_mode) && !local_mode_default.nil?
+    if !Chef::Config.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)
+    if Chef::Config.local_mode && !Chef::Config.key?(:cookbook_path) && !Chef::Config.key?(:chef_repo_path)
       Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
     end
     begin
@@ -81,7 +81,7 @@ module Cheffish
   end
 
   def self.get_private_key(name, config = profiled_config)
-    key, key_path = get_private_key_with_path(name, config)
+    key, _key_path = get_private_key_with_path(name, config)
     key
   end
 

data/lib/cheffish/base_resource.rb

@@ -94,7 +94,7 @@ module Cheffish
         if old_json.kind_of?(Hash) && new_json.kind_of?(Hash)
           removed_keys = old_json.keys.inject({}) { |hash, key| hash[key] = true; hash }
           new_json.each_pair do |new_key, new_value|
-            if old_json.has_key?(new_key)
+            if old_json.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)

data/lib/cheffish/basic_chef_client.rb

@@ -29,10 +29,9 @@ module Cheffish
         @event_catcher = BasicChefClientEvents.new
         dispatcher = Chef::EventDispatch::Dispatcher.new(@event_catcher)
         case events
-        when nil
         when Array
           events.each { |e| dispatcher.register(e) } if events
-        else
+        when !nil
           dispatcher.register(events)
         end
         @run_context = Chef::RunContext.new(node, {}, dispatcher)

data/lib/cheffish/chef_actor_base.rb

@@ -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
@@ -29,15 +29,15 @@ module Cheffish
           end
           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"]
+            result = rest.post((actor_path).to_s, normalize_for_post(new_json))
+            current_public_key, _current_public_key_format = Cheffish::KeyFormatter.decode(result["public_key"]) if result["public_key"]
           end
         end
 
         # Write out the public key
         if new_resource.output_key_path
           # TODO use inline_resource
-          key_content = Cheffish::KeyFormatter.encode(current_public_key, { :format => new_resource.output_key_format })
+          key_content = Cheffish::KeyFormatter.encode(current_public_key, { format: new_resource.output_key_format })
           if !current_resource.output_key_path
             action = "create"
           elsif key_content != IO.read(current_resource.output_key_path)
@@ -76,7 +76,7 @@ module Cheffish
         @new_public_key ||= begin
           if new_resource.source_key
             if new_resource.source_key.is_a?(String)
-              key, key_format = Cheffish::KeyFormatter.decode(new_resource.source_key)
+              key, _key_format = Cheffish::KeyFormatter.decode(new_resource.source_key)
 
               if key.private?
                 key.public_key
@@ -95,7 +95,7 @@ module Cheffish
             else
               source_key_str = IO.read(source_key_path)
             end
-            source_key, source_key_format = Cheffish::KeyFormatter.decode(source_key_str, new_resource.source_key_pass_phrase, source_key_path)
+            source_key, _source_key_format = Cheffish::KeyFormatter.decode(source_key_str, new_resource.source_key_pass_phrase, source_key_path)
             if source_key.private?
               source_key.public_key
             else