cheffish 4.0.0 → 4.1.0

data/lib/chef/resource/chef_container.rb

@@ -1,17 +1,17 @@
-require 'cheffish'
-require 'cheffish/base_resource'
-require 'chef/chef_fs/data_handler/container_data_handler'
+require "cheffish"
+require "cheffish/base_resource"
+require "chef/chef_fs/data_handler/container_data_handler"
 
 class Chef
   class Resource
     class ChefContainer < Cheffish::BaseResource
       resource_name :chef_container
 
-      property :name, Cheffish::NAME_REGEX, name_property: true
+      property :chef_container_name, Cheffish::NAME_REGEX, name_property: true
 
       action :create do
         if !@current_exists
-          converge_by "create container #{new_resource.name} at #{rest.url}" do
+          converge_by "create container #{new_resource.chef_container_name} at #{rest.url}" do
             rest.post("containers", normalize_for_post(new_json))
           end
         end
@@ -19,8 +19,8 @@ class Chef
 
       action :delete do
         if @current_exists
-          converge_by "delete container #{new_resource.name} at #{rest.url}" do
-            rest.delete("containers/#{new_resource.name}")
+          converge_by "delete container #{new_resource.chef_container_name} at #{rest.url}" do
+            rest.delete("containers/#{new_resource.chef_container_name}")
           end
         end
       end
@@ -28,7 +28,7 @@ class Chef
       action_class.class_eval do
         def load_current_resource
           begin
-            @current_exists = rest.get("containers/#{new_resource.name}")
+            @current_exists = rest.get("containers/#{new_resource.chef_container_name}")
           rescue Net::HTTPServerException => e
             if e.response.code == "404"
               @current_exists = false
@@ -47,7 +47,7 @@ class Chef
         end
 
         def keys
-          { 'containername' => :name, 'containerpath' => :name }
+          { "containername" => :chef_container_name, "containerpath" => :chef_container_name }
         end
       end
     end

data/lib/chef/resource/chef_data_bag.rb

@@ -1,25 +1,25 @@
-require 'cheffish'
-require 'cheffish/base_resource'
+require "cheffish"
+require "cheffish/base_resource"
 
 class Chef
   class Resource
     class ChefDataBag < Cheffish::BaseResource
       resource_name :chef_data_bag
 
-      property :name, Cheffish::NAME_REGEX, name_property: true
+      property :data_bag_name, Cheffish::NAME_REGEX, name_property: true
 
       action :create do
         if !current_resource_exists?
-          converge_by "create data bag #{new_resource.name} at #{rest.url}" do
-            rest.post("data", { 'name' => new_resource.name })
+          converge_by "create data bag #{new_resource.data_bag_name} at #{rest.url}" do
+            rest.post("data", { "name" => new_resource.data_bag_name })
           end
         end
       end
 
       action :delete do
         if current_resource_exists?
-          converge_by "delete data bag #{new_resource.name} at #{rest.url}" do
-            rest.delete("data/#{new_resource.name}")
+          converge_by "delete data bag #{new_resource.data_bag_name} at #{rest.url}" do
+            rest.delete("data/#{new_resource.data_bag_name}")
           end
         end
       end
@@ -27,7 +27,7 @@ class Chef
       action_class.class_eval do
         def load_current_resource
           begin
-            @current_resource = json_to_resource(rest.get("data/#{new_resource.name}"))
+            @current_resource = json_to_resource(rest.get("data/#{new_resource.data_bag_name}"))
           rescue Net::HTTPServerException => e
             if e.response.code == "404"
               @current_resource = not_found_resource
@@ -47,7 +47,7 @@ class Chef
         end
 
         def json_to_resource(json)
-          Chef::Resource::ChefDataBag.new(json['name'], run_context)
+          Chef::Resource::ChefDataBag.new(json["name"], run_context)
         end
       end
     end

data/lib/chef/resource/chef_data_bag_item.rb

@@ -1,8 +1,8 @@
-require 'cheffish'
-require 'chef/config'
-require 'cheffish/base_resource'
-require 'chef/chef_fs/data_handler/data_bag_item_data_handler'
-require 'chef/encrypted_data_bag_item'
+require "cheffish"
+require "chef/config"
+require "cheffish/base_resource"
+require "chef/chef_fs/data_handler/data_bag_item_data_handler"
+require "chef/encrypted_data_bag_item"
 
 class Chef
   class Resource
@@ -28,9 +28,9 @@ class Chef
 
       # If data_bag and id are not specified, take them from name.
       # name can either be id, or data_bag/id
-      property :id, String, default: lazy { name.split('/', 2)[-1] }
+      property :id, String, default: lazy { name.split("/", 2)[-1] }
       property :data_bag, String, default: lazy {
-        split = name.split('/', 2)
+        split = name.split("/", 2)
         split.size >= 2 ? split[0] : nil
       }
 
@@ -59,7 +59,7 @@ class Chef
       # end
       # value 'ip_address', :delete
       attr_reader :raw_data_modifiers
-      def value(raw_data_path, value=NOT_PASSED, &block)
+      def value(raw_data_path, value = NOT_PASSED, &block)
         @raw_data_modifiers ||= []
         if value != NOT_PASSED
           @raw_data_modifiers << [ raw_data_path, value ]
@@ -112,15 +112,15 @@ 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["version"].is_a?(Integer) &&
+                first_real_value["version"] > 0 &&
+                first_real_value.has_key?("encrypted_data")
 
               current_resource.encrypt true
-              current_resource.encryption_version first_real_value['version']
+              current_resource.encryption_version first_real_value["version"]
 
               decrypt_error = nil
 
@@ -231,7 +231,7 @@ class Chef
             else
               result = current_decrypted.merge(new_resource.raw_data || {})
             end
-            result['id'] = new_resource.id
+            result["id"] = new_resource.id
             result = apply_modifiers(new_resource.raw_data_modifiers, result)
           end
         end
@@ -240,11 +240,11 @@ class Chef
         def current_decrypted
           @current_decrypted ||= begin
             if current_resource.secret
-              decrypt(current_resource.raw_data || { 'id' => new_resource.id }, current_resource.secret)
+              decrypt(current_resource.raw_data || { "id" => new_resource.id }, current_resource.secret)
             elsif current_resource.encrypt
               raise "Could not decrypt current data bag item #{current_resource.name}"
             else
-              current_resource.raw_data || { 'id' => new_resource.id }
+              current_resource.raw_data || { "id" => new_resource.id }
             end
           end
         end
@@ -254,15 +254,15 @@ class Chef
           if new_encrypt
             if current_resource.encrypt
               # Both are encrypted, check if the encryption type is the same
-              description = ''
+              description = ""
               if new_secret != current_resource.secret
-                description << ' with new secret'
+                description << " with new secret"
               end
               if new_resource.encryption_version != current_resource.encryption_version
                 description << " from v#{current_resource.encryption_version} to v#{new_resource.encryption_version} encryption"
               end
 
-              if description != ''
+              if description != ""
                 # Encryption is different, we're reencrypting
                 differences = [ "re-encrypt#{description}"]
               else
@@ -276,7 +276,7 @@ class Chef
 
             # Get differences in the actual json
             if current_resource.secret
-              json_differences(current_decrypted, new_decrypted, false, '', differences)
+              json_differences(current_decrypted, new_decrypted, false, "", differences)
             elsif current_resource.encrypt
               # Encryption is different and we can't read the old values.  Only allow the change
               # if we're overwriting the data bag item
@@ -284,11 +284,11 @@ class Chef
                 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 = (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 = (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}" }
             else
-              json_differences(current_decrypted, new_decrypted, false, '', differences)
+              json_differences(current_decrypted, new_decrypted, false, "", differences)
             end
           else
             if current_resource.encrypt
@@ -297,7 +297,7 @@ class Chef
             else
               differences = []
             end
-            json_differences(current_decrypted, new_decrypted, true, '', differences)
+            json_differences(current_decrypted, new_decrypted, true, "", differences)
           end
           differences
         end
@@ -316,9 +316,9 @@ class Chef
 
         def keys
           {
-            'id' => :id,
-            'data_bag' => :data_bag,
-            'raw_data' => :raw_data
+            "id" => :id,
+            "data_bag" => :data_bag,
+            "raw_data" => :raw_data,
           }
         end
 

data/lib/chef/resource/chef_environment.rb

@@ -1,17 +1,17 @@
-require 'cheffish'
-require 'cheffish/base_resource'
-require 'chef/environment'
-require 'chef/chef_fs/data_handler/environment_data_handler'
+require "cheffish"
+require "cheffish/base_resource"
+require "chef/environment"
+require "chef/chef_fs/data_handler/environment_data_handler"
 
 class Chef
   class Resource
     class ChefEnvironment < Cheffish::BaseResource
       resource_name :chef_environment
 
-      property :name, Cheffish::NAME_REGEX, name_property: true
+      property :environment_name, Cheffish::NAME_REGEX, name_property: true
       property :description, String
       property :cookbook_versions, Hash, callbacks: {
-        "should have valid cookbook versions" => lambda { |value| Chef::Environment.validate_cookbook_versions(value) }
+        "should have valid cookbook versions" => lambda { |value| Chef::Environment.validate_cookbook_versions(value) },
       }
       property :default_attributes, Hash
       property :override_attributes, Hash
@@ -23,7 +23,7 @@ class Chef
       # end
       # default 'ip_address', :delete
       attr_reader :default_attribute_modifiers
-      def default(attribute_path, value=NOT_PASSED, &block)
+      def default(attribute_path, value = NOT_PASSED, &block)
         @default_attribute_modifiers ||= []
         if value != NOT_PASSED
           @default_attribute_modifiers << [ attribute_path, value ]
@@ -41,7 +41,7 @@ class Chef
       # end
       # override 'ip_address', :delete
       attr_reader :override_attribute_modifiers
-      def override(attribute_path, value=NOT_PASSED, &block)
+      def override(attribute_path, value = NOT_PASSED, &block)
         @override_attribute_modifiers ||= []
         if value != NOT_PASSED
           @override_attribute_modifiers << [ attribute_path, value ]
@@ -55,19 +55,18 @@ class Chef
       alias :attributes :default_attributes
       alias :attribute :default
 
-
       action :create do
         differences = json_differences(current_json, new_json)
 
         if current_resource_exists?
           if differences.size > 0
-            description = [ "update environment #{new_resource.name} at #{rest.url}" ] + differences
+            description = [ "update environment #{new_resource.environment_name} at #{rest.url}" ] + differences
             converge_by description do
-              rest.put("environments/#{new_resource.name}", normalize_for_put(new_json))
+              rest.put("environments/#{new_resource.environment_name}", normalize_for_put(new_json))
             end
           end
         else
-          description = [ "create environment #{new_resource.name} at #{rest.url}" ] + differences
+          description = [ "create environment #{new_resource.environment_name} at #{rest.url}" ] + differences
           converge_by description do
             rest.post("environments", normalize_for_post(new_json))
           end
@@ -76,8 +75,8 @@ class Chef
 
       action :delete do
         if current_resource_exists?
-          converge_by "delete environment #{new_resource.name} at #{rest.url}" do
-            rest.delete("environments/#{new_resource.name}")
+          converge_by "delete environment #{new_resource.environment_name} at #{rest.url}" do
+            rest.delete("environments/#{new_resource.environment_name}")
           end
         end
       end
@@ -85,7 +84,7 @@ class Chef
       action_class.class_eval do
         def load_current_resource
           begin
-            @current_resource = json_to_resource(rest.get("environments/#{new_resource.name}"))
+            @current_resource = json_to_resource(rest.get("environments/#{new_resource.environment_name}"))
           rescue Net::HTTPServerException => e
             if e.response.code == "404"
               @current_resource = not_found_resource
@@ -97,8 +96,8 @@ class Chef
 
         def augment_new_json(json)
           # Apply modifiers
-          json['default_attributes'] = apply_modifiers(new_resource.default_attribute_modifiers, json['default_attributes'])
-          json['override_attributes'] = apply_modifiers(new_resource.override_attribute_modifiers, json['override_attributes'])
+          json["default_attributes"] = apply_modifiers(new_resource.default_attribute_modifiers, json["default_attributes"])
+          json["override_attributes"] = apply_modifiers(new_resource.override_attribute_modifiers, json["override_attributes"])
           json
         end
 
@@ -116,11 +115,11 @@ class Chef
 
         def keys
           {
-            'name' => :name,
-            'description' => :description,
-            'cookbook_versions' => :cookbook_versions,
-            'default_attributes' => :default_attributes,
-            'override_attributes' => :override_attributes
+            "name" => :environment_name,
+            "description" => :description,
+            "cookbook_versions" => :cookbook_versions,
+            "default_attributes" => :default_attributes,
+            "override_attributes" => :override_attributes,
           }
         end
       end

data/lib/chef/resource/chef_group.rb

@@ -1,14 +1,14 @@
-require 'cheffish'
-require 'cheffish/base_resource'
-require 'chef/run_list/run_list_item'
-require 'chef/chef_fs/data_handler/group_data_handler'
+require "cheffish"
+require "cheffish/base_resource"
+require "chef/run_list/run_list_item"
+require "chef/chef_fs/data_handler/group_data_handler"
 
 class Chef
   class Resource
     class ChefGroup < Cheffish::BaseResource
       resource_name :chef_group
 
-      property :name, Cheffish::NAME_REGEX, name_property: true
+      property :group_name, Cheffish::NAME_REGEX, name_property: true
       property :users, ArrayType
       property :clients, ArrayType
       property :groups, ArrayType
@@ -21,13 +21,13 @@ class Chef
 
         if current_resource_exists?
           if differences.size > 0
-            description = [ "update group #{new_resource.name} at #{rest.url}" ] + differences
+            description = [ "update group #{new_resource.group_name} at #{rest.url}" ] + differences
             converge_by description do
-              rest.put("groups/#{new_resource.name}", normalize_for_put(new_json))
+              rest.put("groups/#{new_resource.group_name}", normalize_for_put(new_json))
             end
           end
         else
-          description = [ "create group #{new_resource.name} at #{rest.url}" ] + differences
+          description = [ "create group #{new_resource.group_name} at #{rest.url}" ] + differences
           converge_by description do
             rest.post("groups", normalize_for_post(new_json))
           end
@@ -36,8 +36,8 @@ class Chef
 
       action :delete do
         if current_resource_exists?
-          converge_by "delete group #{new_resource.name} at #{rest.url}" do
-            rest.delete("groups/#{new_resource.name}")
+          converge_by "delete group #{new_resource.group_name} at #{rest.url}" do
+            rest.delete("groups/#{new_resource.group_name}")
           end
         end
       end
@@ -45,7 +45,7 @@ class Chef
       action_class.class_eval do
         def load_current_resource
           begin
-            @current_resource = json_to_resource(rest.get("groups/#{new_resource.name}"))
+            @current_resource = json_to_resource(rest.get("groups/#{new_resource.group_name}"))
           rescue Net::HTTPServerException => e
             if e.response.code == "404"
               @current_resource = not_found_resource
@@ -57,12 +57,12 @@ class Chef
 
         def augment_new_json(json)
           # Apply modifiers
-          json['users']   |= new_resource.users
-          json['clients'] |= new_resource.clients
-          json['groups']  |= new_resource.groups
-          json['users']   -= new_resource.remove_users
-          json['clients'] -= new_resource.remove_clients
-          json['groups']  -= new_resource.remove_groups
+          json["users"]   |= new_resource.users
+          json["clients"] |= new_resource.clients
+          json["groups"]  |= new_resource.groups
+          json["users"]   -= new_resource.remove_users
+          json["clients"] -= new_resource.remove_clients
+          json["groups"]  -= new_resource.remove_groups
           json
         end
 
@@ -80,8 +80,8 @@ class Chef
 
         def keys
           {
-            'name' => :name,
-            'groupname' => :name
+            "name" => :group_name,
+            "groupname" => :group_name,
           }
         end
       end

data/lib/chef/resource/chef_mirror.rb

@@ -1,10 +1,10 @@
-require 'cheffish'
-require 'cheffish/base_resource'
-require 'chef/chef_fs/file_pattern'
-require 'chef/chef_fs/file_system'
-require 'chef/chef_fs/parallelizer'
-require 'chef/chef_fs/file_system/chef_server_root_dir'
-require 'chef/chef_fs/file_system/chef_repository_file_system_root_dir'
+require "cheffish"
+require "cheffish/base_resource"
+require "chef/chef_fs/file_pattern"
+require "chef/chef_fs/file_system"
+require "chef/chef_fs/parallelizer"
+require "chef/chef_fs/file_system/chef_server_root_dir"
+require "chef/chef_fs/file_system/chef_repository_file_system_root_dir"
 
 class Chef
   class Resource
@@ -33,7 +33,21 @@ class Chef
       property :purge, Boolean
 
       # Whether to freeze cookbooks on upload
-      property :freeze, Boolean
+      property :freeze_on_upload, Boolean
+
+      # `freeze` is an already-existing instance method on Object, so we can't use it or we'll throw
+      # a deprecation warning. `freeze` has been renamed to `freeze_on_upload` and this method
+      # is here to log a deprecation warning.
+      def freeze(arg = nil)
+        Chef::Log.warn("Property `freeze` on the `chef_mirror` resource has changed to `freeze_on_upload`." \
+          "Please use `freeze_on_upload` instead. This will raise an exception in a future version of the cheffish gem.")
+
+        set_or_return(
+          :freeze_on_upload,
+          arg,
+          :kind_of => Boolean
+        )
+      end
 
       # If this is true, only new files will be copied.  File contents will not be
       # diffed, so changed files will never be uploaded.
@@ -42,7 +56,6 @@ class Chef
       # Number of parallel threads to list/upload/download with.  Defaults to 10.
       property :concurrency, Integer, default: 10, desired_state: false
 
-
       action :upload do
         with_modified_config do
           copy_to(local_fs, remote_fs)
@@ -87,7 +100,7 @@ class Chef
 
           # We don't let the user pass absolute paths; we want to reserve those for
           # multi-org support (/organizations/foo).
-          if new_resource.path[0] == '/'
+          if new_resource.path[0] == "/"
             raise "Absolute paths in chef_mirror not yet supported."
           end
           # Copy!
@@ -117,10 +130,10 @@ class Chef
 
           # Go through the expected object paths and figure out the local paths for each.
           case repo_mode
-          when 'hosted_everything'
-            object_names = %w(acls clients cookbooks containers data_bags environments groups nodes roles)
+          when "hosted_everything"
+            object_names = %w{acls clients cookbooks containers data_bags environments groups nodes roles}
           else
-            object_names = %w(clients cookbooks data_bags environments nodes roles users)
+            object_names = %w{clients cookbooks data_bags environments nodes roles users}
           end
 
           object_paths = {}
@@ -144,21 +157,21 @@ class Chef
             :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
+            :versioned_cookbooks => Chef::Config.versioned_cookbooks,
           }
           Chef::ChefFS::FileSystem::ChefServerRootDir.new("remote", config)
         end
 
         def repo_mode
-          new_resource.chef_server[:chef_server_url] =~ /\/organizations\// ? 'hosted_everything' : 'everything'
+          new_resource.chef_server[:chef_server_url] =~ /\/organizations\// ? "hosted_everything" : "everything"
         end
 
         def options
           result = {
             :purge => new_resource.purge,
-            :freeze => new_resource.freeze,
+            :freeze => new_resource.freeze_on_upload,
             :diff => new_resource.no_diff,
-            :dry_run => whyrun_mode?
+            :dry_run => whyrun_mode?,
           }
           result[:diff] = !result[:diff]
           result[:repo_mode] = repo_mode
@@ -185,10 +198,12 @@ class Chef
             mirror.converge_by str do
             end
           end
+
           def warn(str)
             mirror.converge_by "WARNING: #{str}" do
             end
           end
+
           def error(str)
             mirror.converge_by "ERROR: #{str}" do
             end