chef 14.2.0 → 14.3.37

data/lib/chef/resource.rb

@@ -469,7 +469,7 @@ class Chef
       if arg.nil?
         @guard_interpreter || @default_guard_interpreter
       else
-        set_or_return(:guard_interpreter, arg, :kind_of => Symbol)
+        set_or_return(:guard_interpreter, arg, kind_of: Symbol)
       end
     end
 
@@ -691,7 +691,7 @@ class Chef
       safe_ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS
       safe_ivars.each do |iv|
         key = iv.to_s.sub(/^@/, "").to_sym
-        next if result.has_key?(key)
+        next if result.key?(key)
         result[key] = instance_variable_get(iv)
       end
       result
@@ -1161,12 +1161,28 @@ class Chef
         end
     end
 
+    # Set or return if this resource is in preview mode.
+    #
+    # This is used in Chef core as part of the process of migrating resources
+    # from a cookbook into core. It should be set to `true` when a cookbook
+    # resource is added to core, and then removed (set to `false`) in the next
+    # major release.
+    #
+    # @param value [nil, Boolean] If nil, get the current value. If not nil, set
+    #   the value of the flag.
+    # @return [Boolean]
+    def self.preview_resource(value = nil)
+      @preview_resource = false unless defined?(@preview_resource)
+      @preview_resource = value unless value.nil?
+      @preview_resource
+    end
+
     #
     # Internal Resource Interface (for Chef)
     #
 
-    FORBIDDEN_IVARS = [:@run_context, :@logger, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
-    HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@logger, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
+    FORBIDDEN_IVARS = [:@run_context, :@logger, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated].freeze
+    HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@logger, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated].freeze
 
     include Chef::Mixin::ConvertToClassName
     extend Chef::Mixin::ConvertToClassName
@@ -1305,6 +1321,12 @@ class Chef
         remove_canonical_dsl
       end
 
+      # If a resource is in preview mode, set allow_cookbook_override on all its
+      # mappings by default.
+      if preview_resource && !options.include?(:allow_cookbook_override)
+        options[:allow_cookbook_override] = true
+      end
+
       result = Chef.resource_handler_map.set(name, self, options, &block)
       Chef::DSL::Resources.add_resource_dsl(name)
       result

data/lib/chef/resource/chef_handler.rb

@@ -15,6 +15,8 @@
 # limitations under the License.
 #
 
+require "chef/resource"
+
 class Chef
   class Resource
     class ChefHandler < Chef::Resource

data/lib/chef/resource/chocolatey_config.rb

@@ -0,0 +1,83 @@
+#
+# Copyright:: 2018, Chef Software, Inc.
+#
+# 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.
+#
+
+class Chef
+  class Resource
+    class ChocolateyConfig < Chef::Resource
+      preview_resource true
+      resource_name :chocolatey_config
+
+      description "Use the chocolatey_config resource to add or remove Chocolatey configuration keys."
+      introduced "14.3"
+
+      property :config_key, String, name_property: true,
+               description: "The name of the config. The resource's name will be used if this isn't provided."
+
+      property :value, String,
+               description: "The value to set."
+
+      load_current_value do
+        current_val = fetch_config_element(config_key)
+        current_value_does_not_exist! if current_val.nil?
+
+        config_key config_key
+        value current_val
+      end
+
+      # @param [String] id the config name
+      # @return [String] the element's value field
+      def fetch_config_element(id)
+        require "rexml/document"
+        config_file = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\config\\chocolatey.config"
+        raise "Could not find the Chocolatey config at #{config_file}!" unless ::File.exist?(config_file)
+
+        contents = REXML::Document.new(::File.read(config_file))
+        data = REXML::XPath.first(contents, "//config/add[@key=\"#{id}\"]")
+        data ? data.attribute("value").to_s : nil # REXML just returns nil if it can't find anything so avoid an undefined method error
+      end
+
+      action :set do
+        description "Sets a Chocolatey config value."
+
+        raise "#{new_resource}: When adding a Chocolatey config you must pass the 'value' property!" unless new_resource.value
+
+        converge_if_changed do
+          shell_out!(choco_cmd("set"))
+        end
+      end
+
+      action :unset do
+        description "Unsets a Chocolatey config value."
+
+        if current_resource
+          converge_by("unset Chocolatey config '#{new_resource.config_key}'") do
+            shell_out!(choco_cmd("unset"))
+          end
+        end
+      end
+
+      action_class do
+        # @param [String] action the name of the action to perform
+        # @return [String] the choco config command string
+        def choco_cmd(action)
+          cmd = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\bin\\choco config #{action} --name #{new_resource.config_key}"
+          cmd << " --value #{new_resource.value}" if action == "set"
+          cmd
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/chocolatey_source.rb

@@ -0,0 +1,95 @@
+#
+# Copyright:: 2018, Chef Software, Inc.
+#
+# 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.
+#
+
+class Chef
+  class Resource
+    class ChocolateySource < Chef::Resource
+      preview_resource true
+      resource_name :chocolatey_source
+
+      description "Use the chocolatey_source resource to add or remove Chocolatey sources."
+      introduced "14.3"
+
+      property :source_name, String, name_property: true,
+               description: "The name of the source to add. The resource's name will be used if this isn't provided."
+
+      property :source, String,
+               description: "The source URL."
+
+      property :bypass_proxy, [TrueClass, FalseClass], default: false,
+               description: "Whether or not to bypass the system's proxy settings to access the source."
+
+      property :priority, Integer, default: 0,
+               description: "The priority level of the source."
+
+      load_current_value do
+        element = fetch_source_element(source_name)
+        current_value_does_not_exist! if element.nil?
+
+        source_name element["id"]
+        source element["value"]
+        bypass_proxy element["bypassProxy"] == "true"
+        priority element["priority"].to_i
+      end
+
+      # @param [String] id the source name
+      # @return [REXML::Attributes] finds the source element with the
+      def fetch_source_element(id)
+        require "rexml/document"
+
+        config_file = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\config\\chocolatey.config"
+        raise "Could not find the Chocolatey config at #{config_file}!" unless ::File.exist?(config_file)
+
+        config_contents = REXML::Document.new(::File.read(config_file))
+        data = REXML::XPath.first(config_contents, "//sources/source[@id=\"#{id}\"]")
+        data ? data.attributes : nil # REXML just returns nil if it can't find anything so avoid an undefined method error
+      end
+
+      action :add do
+        description "Adds a Chocolatey source."
+
+        raise "#{new_resource}: When adding a Chocolatey source you must pass the 'source' property!" unless new_resource.source
+
+        converge_if_changed do
+          shell_out!(choco_cmd("add"))
+        end
+      end
+
+      action :remove do
+        description "Removes a Chocolatey source."
+
+        if current_resource
+          converge_by("remove Chocolatey source '#{new_resource.source_name}'") do
+            shell_out!(choco_cmd("remove"))
+          end
+        end
+      end
+
+      action_class do
+        # @param [String] action the name of the action to perform
+        # @return [String] the choco source command string
+        def choco_cmd(action)
+          cmd = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\bin\\choco source #{action} -n \"#{new_resource.source_name}\""
+          if action == "add"
+            cmd << " -s #{new_resource.source} --priority=#{new_resource.priority}"
+            cmd << " --bypassproxy" if new_resource.bypass_proxy
+          end
+          cmd
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/cron.rb

@@ -55,7 +55,7 @@ class Chef
         set_or_return(
           :minute,
           converted_arg,
-          :kind_of => String
+          kind_of: String
         )
       end
 
@@ -72,7 +72,7 @@ class Chef
         set_or_return(
           :hour,
           converted_arg,
-          :kind_of => String
+          kind_of: String
         )
       end
 
@@ -89,7 +89,7 @@ class Chef
         set_or_return(
           :day,
           converted_arg,
-          :kind_of => String
+          kind_of: String
         )
       end
 
@@ -106,7 +106,7 @@ class Chef
         set_or_return(
           :month,
           converted_arg,
-          :kind_of => String
+          kind_of: String
         )
       end
 
@@ -130,7 +130,7 @@ class Chef
         set_or_return(
           :weekday,
           converted_arg,
-          :kind_of => [String, Symbol]
+          kind_of: [String, Symbol]
         )
       end
 

data/lib/chef/resource/dsc_script.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 
+require "chef/resource"
 require "chef/exceptions"
 require "chef/dsl/powershell"
 
@@ -45,59 +46,59 @@ class Chef
 
       def code(arg = nil)
         if arg && command
-          raise ArgumentError, "Only one of 'code' and 'command' attributes may be specified"
+          raise ArgumentError, "Only one of 'code' and 'command' properties may be specified"
         end
         if arg && configuration_name
-          raise ArgumentError, "The 'code' and 'command' attributes may not be used together"
+          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
         end
         set_or_return(
           :code,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
       def configuration_name(arg = nil)
         if arg && code
-          raise ArgumentError, "Attribute `configuration_name` may not be set if `code` is set"
+          raise ArgumentError, "Property `configuration_name` may not be set if `code` is set"
         end
         set_or_return(
           :configuration_name,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
       def command(arg = nil)
         if arg && code
-          raise ArgumentError, "The 'code' and 'command' attributes may not be used together"
+          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
         end
         set_or_return(
           :command,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
       def configuration_data(arg = nil)
         if arg && configuration_data_script
-          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' attributes may not be used together"
+          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
         end
         set_or_return(
           :configuration_data,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
       def configuration_data_script(arg = nil)
         if arg && configuration_data
-          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' attributes may not be used together"
+          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
         end
         set_or_return(
           :configuration_data_script,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 

data/lib/chef/resource/execute.rb

@@ -52,7 +52,7 @@ class Chef
         set_or_return(
           :command,
           arg,
-          :kind_of => [ String, Array ]
+          kind_of: [ String, Array ]
         )
       end
       property :umask, [ String, Integer ]

data/lib/chef/resource/file/verification.rb

@@ -113,7 +113,7 @@ class Chef
           if @command.include?("%{file}")
             raise ArgumentError, "The %{file} expansion for verify commands has been removed. Please use %{path} instead."
           end
-          command = @command % { :path => path }
+          command = @command % { path: path }
           interpreter = Chef::GuardInterpreter.for_resource(@parent_resource, command, @command_opts)
           interpreter.evaluate
         end

data/lib/chef/resource/freebsd_package.rb

@@ -46,7 +46,7 @@ class Chef
       #
       # @return [Boolean] do we support pkgng
       def supports_pkgng?
-        ships_with_pkgng? || !!shell_out_compact!("make", "-V", "WITH_PKGNG", :env => nil).stdout.match(/yes/i)
+        ships_with_pkgng? || !!shell_out!("make", "-V", "WITH_PKGNG", env: nil).stdout.match(/yes/i)
       end
 
       private
@@ -63,6 +63,8 @@ class Chef
                     elsif supports_pkgng?
                       Chef::Provider::Package::Freebsd::Pkgng
                     else
+                      Chef.deprecated(:freebsd_package_provider, "The freebsd_package provider for pkg (Chef::Provider::Package::Freebsd::Pkg) is deprecated and will be removed from Chef core in 15.0 (April 2019).")
+
                       Chef::Provider::Package::Freebsd::Pkg
                     end
       end

data/lib/chef/resource/group.rb

@@ -41,7 +41,7 @@ class Chef
         set_or_return(
           :members,
           converted_members,
-          :kind_of => [ Array ]
+          kind_of: [ Array ]
         )
       end
 
@@ -52,7 +52,7 @@ class Chef
         set_or_return(
           :excluded_members,
           converted_members,
-          :kind_of => [ Array ]
+          kind_of: [ Array ]
         )
       end
 

data/lib/chef/resource/homebrew_package.rb

@@ -30,7 +30,8 @@ class Chef
       description "Use the homebrew_package resource to manage packages for the macOS platform."
       introduced "12.0"
 
-      property :homebrew_user, [ String, Integer ]
+      property :homebrew_user, [ String, Integer ],
+               description: "The name of the Homebrew owner to be used by the chef-client when executing a command."
 
     end
   end

data/lib/chef/resource/homebrew_tap.rb

@@ -49,7 +49,7 @@ class Chef
                default: "/usr/local/bin/brew"
 
       property :owner, String,
-               description: "The owner of the homebrew installation",
+               description: "The owner of the homebrew installation.",
                default: lazy { find_homebrew_username }
 
       action :tap do