chef 14.5.33 → 14.6.47

data/lib/chef/cookbook_version.rb

@@ -407,7 +407,7 @@ class Chef
       output["cookbook_name"] = name
       output["name"] = full_name
       output["frozen?"] = frozen_version?
-      output["metadata"] = metadata.to_hash
+      output["metadata"] = metadata.to_h
       output["version"] = version
       output.merge(cookbook_manifest.by_parent_directory)
     end

data/lib/chef/data_bag.rb

@@ -58,7 +58,7 @@ class Chef
       )
     end
 
-    def to_hash
+    def to_h
       result = {
         "name"       => @name,
         "json_class" => self.class.name,
@@ -67,9 +67,11 @@ class Chef
       result
     end
 
+    alias_method :to_hash, :to_h
+
     # Serialize this object as a hash
     def to_json(*a)
-      Chef::JSONCompat.to_json(to_hash, *a)
+      Chef::JSONCompat.to_json(to_h, *a)
     end
 
     def chef_server_rest

data/lib/chef/data_bag_item.rb

@@ -101,13 +101,15 @@ class Chef
       "data_bag_item_#{data_bag_name}_#{id}"
     end
 
-    def to_hash
+    def to_h
       result = raw_data.dup
       result["chef_type"] = "data_bag_item"
       result["data_bag"] = data_bag.to_s
       result
     end
 
+    alias_method :to_hash, :to_h
+
     # Serialize this object as a hash
     def to_json(*a)
       result = {
@@ -180,9 +182,9 @@ class Chef
     end
 
     def ==(other)
-      other.respond_to?(:to_hash) &&
+      other.respond_to?(:to_h) &&
         other.respond_to?(:data_bag) &&
-        (other.to_hash == to_hash) &&
+        (other.to_h == to_h) &&
         (other.data_bag.to_s == data_bag.to_s)
     end
 

data/lib/chef/data_collector.rb

@@ -2,7 +2,7 @@
 # Author:: Adam Leff (<adamleff@chef.io>)
 # Author:: Ryan Cragun (<ryan@chef.io>)
 #
-# Copyright:: Copyright 2012-2017, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -428,7 +428,7 @@ class Chef
         @all_resource_reports << OpenStruct.new(
           resource: resource_report.new_resource,
           action: resource_report.action,
-          report_data: resource_report.to_hash
+          report_data: resource_report.to_h
         )
       end
 

data/lib/chef/data_collector/resource_report.rb

@@ -2,7 +2,7 @@
 # Author:: Adam Leff (<adamleff@chef.io>)
 # Author:: Ryan Cragun (<ryan@chef.io>)
 #
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -65,7 +65,7 @@ class Chef
         %w{updated failed}.include?(status)
       end
 
-      def to_hash
+      def to_h
         hash = {
           "type"           => new_resource.resource_name.to_sym,
           "name"           => new_resource.name.to_s,
@@ -90,8 +90,8 @@ class Chef
 
         hash
       end
-      alias :to_h :to_hash
-      alias :for_json :to_hash
+      alias_method :to_hash, :to_h
+      alias_method :for_json, :to_h
 
       # We should be able to call the identity of a resource safely, but there
       # is an edge case where resources that have a lazy property that is both

data/lib/chef/encrypted_data_bag_item.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Seth Falcon (<seth@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -84,10 +84,12 @@ class Chef::EncryptedDataBagItem
     raise ArgumentError, "assignment not supported for #{self.class}"
   end
 
-  def to_hash
+  def to_h
     @enc_hash.keys.inject({}) { |hash, key| hash[key] = self[key]; hash }
   end
 
+  alias_method :to_hash, :to_h
+
   def self.encrypt_data_bag_item(plain_hash, secret)
     plain_hash.inject({}) do |h, (key, val)|
       h[key] = if key != "id"

data/lib/chef/environment.rb

@@ -117,7 +117,7 @@ class Chef
       @cookbook_versions[cookbook] = version
     end
 
-    def to_hash
+    def to_h
       result = {
         "name" => @name,
         "description" => @description,
@@ -130,8 +130,10 @@ class Chef
       result
     end
 
+    alias_method :to_hash, :to_h
+
     def to_json(*a)
-      Chef::JSONCompat.to_json(to_hash, *a)
+      Chef::JSONCompat.to_json(to_h, *a)
     end
 
     def update_from!(o)

data/lib/chef/file_content_management/deploy/mv_unix.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Lamont Granquist (<lamont@chef.io>)
-# Copyright:: Copyright 2013-2016, Chef Software Inc.
+# Copyright:: Copyright 2013-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -44,9 +44,6 @@ class Chef
 
           Chef::Log.trace("Applying mode = #{mode.to_s(8)}, uid = #{uid}, gid = #{gid} to #{src}")
 
-          # i own the inode, so should be able to at least chmod it
-          ::File.chmod(mode, src)
-
           # we may be running as non-root in which case because we are doing an mv we cannot preserve
           # the file modes.  after the mv we have a different inode and if we don't have rights to
           # chown/chgrp on the inode then we can't fix the ownership.
@@ -67,6 +64,10 @@ class Chef
             Chef::Log.warn("Could not set gid = #{gid} on #{src}, file modes not preserved")
           end
 
+          # i own the inode, so should be able to at least chmod it
+          # NOTE: this must come last due to POSIX stripping sticky mode bits on chown/chgrp
+          ::File.chmod(mode, src)
+
           Chef::Log.trace("Moving temporary file #{src} into place at #{dst}")
           FileUtils.mv(src, dst)
         end

data/lib/chef/handler.rb

@@ -1,6 +1,6 @@
 #--
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -259,7 +259,7 @@ class Chef
 
     # Return the Hash representation of the run_status
     def data
-      @run_status.to_hash
+      @run_status.to_h
     end
 
   end

data/lib/chef/json_compat.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Tim Hinderliter (<tim@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/key.rb

@@ -115,7 +115,7 @@ class Chef
                     regex: /^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z|infinity)$/)
     end
 
-    def to_hash
+    def to_h
       result = {
         @actor_field_name => @actor,
       }
@@ -127,8 +127,10 @@ class Chef
       result
     end
 
+    alias_method :to_hash, :to_h
+
     def to_json(*a)
-      Chef::JSONCompat.to_json(to_hash, *a)
+      Chef::JSONCompat.to_json(to_h, *a)
     end
 
     def create
@@ -155,7 +157,7 @@ class Chef
       result = chef_rest.post("#{api_base}/#{@actor}/keys", payload)
       # append the private key to the current key if the server returned one,
       # since the POST endpoint just returns uri and private_key if needed.
-      new_key = to_hash
+      new_key = to_h
       new_key["private_key"] = result["private_key"] if result["private_key"]
       Chef::Key.from_hash(new_key)
     end
@@ -175,12 +177,12 @@ class Chef
       # to @name.
       put_name = @name if put_name.nil?
 
-      new_key = chef_rest.put("#{api_base}/#{@actor}/keys/#{put_name}", to_hash)
+      new_key = chef_rest.put("#{api_base}/#{@actor}/keys/#{put_name}", to_h)
       # if the server returned a public_key, remove the create_key field, as we now have a key
       if new_key["public_key"]
         delete_create_key
       end
-      Chef::Key.from_hash(to_hash.merge(new_key))
+      Chef::Key.from_hash(to_h.merge(new_key))
     end
 
     def save

data/lib/chef/knife/bootstrap.rb

@@ -409,7 +409,13 @@ class Chef
         end
       end
 
-      # make sure policyfile values are set correctly
+      # Ensure options are valid by checking policyfile values.
+      #
+      # The method call will cause the program to exit(1) if:
+      #   * Only one of --policy-name and --policy-group is specified
+      #   * Policyfile options are set and --run-list is set as well
+      #
+      # @return [TrueClass] If options are valid.
       def validate_options!
         if incomplete_policyfile_options?
           ui.error("--policy-name and --policy-group must be specified together")

data/lib/chef/knife/client_edit.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,7 +37,7 @@ class Chef
           exit 1
         end
 
-        original_data = Chef::ApiClientV1.load(@client_name).to_hash
+        original_data = Chef::ApiClientV1.load(@client_name).to_h
         edited_client = edit_hash(original_data)
         if original_data != edited_client
           client = Chef::ApiClientV1.from_hash(edited_client)

data/lib/chef/knife/data_bag_show.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Seth Falcon (<seth@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software, Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -46,7 +46,7 @@ class Chef
                       raw = Chef::EncryptedDataBagItem.load(@name_args[0],
                                                             @name_args[1],
                                                             secret)
-                      format_for_display(raw.to_hash)
+                      format_for_display(raw.to_h)
                     elsif encrypted && !secret
                       ui.warn("Encrypted data bag detected, but no secret provided for decoding. Displaying encrypted data.")
                       format_for_display(raw_data)

data/lib/chef/knife/osc_user_edit.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -43,7 +43,7 @@ class Chef
           exit 1
         end
 
-        original_user = Chef::User.load(@user_name).to_hash
+        original_user = Chef::User.load(@user_name).to_h
         edited_user = edit_hash(original_user)
         if original_user != edited_user
           user = Chef::User.from_hash(edited_user)

data/lib/chef/knife/user_edit.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,7 +57,7 @@ EOF
           exit 1
         end
 
-        original_user = Chef::UserV1.load(@user_name).to_hash
+        original_user = Chef::UserV1.load(@user_name).to_h
         # DEPRECATION NOTE
         # Remove this if statement and corrosponding code post OSC 11 support.
         #

data/lib/chef/mixin/params_validate.rb

@@ -174,7 +174,9 @@ class Chef
           to_be.each do |tb|
             return true if value == tb
           end
-          raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key} must be equal to one of: #{to_be.join(", ")}!  You passed #{value.inspect}.")
+          # Ruby will print :something as something, which confuses users so make sure to print them as symbols
+          # by inspecting the value instead of just printing it
+          raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key} must be equal to one of: #{to_be.map { |v| v.inspect }.join(", ")}!  You passed #{value.inspect}.")
         end
       end
 
@@ -300,7 +302,7 @@ class Chef
           Array(regex).flatten.each do |r|
             return true if r.match(value.to_s)
           end
-          raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key}'s value #{value} does not match regular expression #{regex.inspect}")
+          raise Exceptions::ValidationFailed, _validation_message(key, "Property #{key}'s value #{value} does not match regular expression #{regex.inspect}")
         end
       end
 

data/lib/chef/node/attribute.rb

@@ -403,11 +403,11 @@ class Chef
       end
 
       def combined_override(*path)
-        immutablize(merge_overrides(path))
+        merge_overrides(path)
       end
 
       def combined_default(*path)
-        immutablize(merge_defaults(path))
+        merge_defaults(path)
       end
 
       def normal_unless(*args)
@@ -599,9 +599,9 @@ class Chef
         # In all other cases, replace merge_onto with merge_with
         else
           if merge_with.kind_of?(Hash)
-            Chef::Node::VividMash.new(merge_with)
+            Chef::Node::ImmutableMash.new(merge_with)
           elsif merge_with.kind_of?(Array)
-            Chef::Node::AttrArray.new(merge_with)
+            Chef::Node::ImmutableArray.new(merge_with)
           else
             merge_with
           end

data/lib/chef/org.rb

@@ -58,7 +58,7 @@ class Chef
                     arg, kind_of: String)
     end
 
-    def to_hash
+    def to_h
       result = {
         "name" => @name,
         "full_name" => @full_name,
@@ -68,20 +68,22 @@ class Chef
       result
     end
 
+    alias_method :to_hash, :to_h
+
     def to_json(*a)
-      Chef::JSONCompat.to_json(to_hash, *a)
+      Chef::JSONCompat.to_json(to_h, *a)
     end
 
     def create
       payload = { name: name, full_name: full_name }
       new_org = chef_rest.post("organizations", payload)
-      Chef::Org.from_hash(to_hash.merge(new_org))
+      Chef::Org.from_hash(to_h.merge(new_org))
     end
 
     def update
       payload = { name: name, full_name: full_name }
       new_org = chef_rest.put("organizations/#{name}", payload)
-      Chef::Org.from_hash(to_hash.merge(new_org))
+      Chef::Org.from_hash(to_h.merge(new_org))
     end
 
     def destroy

data/lib/chef/policy_builder/policyfile.rb

@@ -3,7 +3,7 @@
 # Author:: Tim Hinderliter (<tim@chef.io>)
 # Author:: Christopher Walters (<cw@chef.io>)
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -56,7 +56,7 @@ class Chef
         # interface we need to properly send this through to
         # events.run_list_expanded as it is expecting a RunListExpansion
         # object.
-        def to_hash
+        def to_h
           # It looks like version only gets populated in the expanded_run_list when
           # using a little used feature of roles to version lock cookbooks, so
           # version is not reliable in here anyway (places like Automate UI are
@@ -73,8 +73,10 @@ class Chef
           data_collector_hash
         end
 
+        alias_method :to_hash, :to_h
+
         def to_json(*opts)
-          to_hash.to_json(*opts)
+          to_h.to_json(*opts)
         end
       end