chef 12.19.36 → 14.14.25

data/lib/chef/resource/csh.rb

@@ -22,6 +22,12 @@ require "chef/provider/script"
 class Chef
   class Resource
     class Csh < Chef::Resource::Script
+      description "Use the csh resource to execute scripts using the csh interpreter."\
+                  " This resource may also use any of the actions and properties that are"\
+                  " available to the execute resource. Commands that are executed with this"\
+                  " resource are (by their nature) not idempotent, as they are typically"\
+                  " unique to the environment in which they are run. Use not_if and only_if"\
+                  " to guard this resource for idempotence."
 
       def initialize(name, run_context = nil)
         super

data/lib/chef/resource/directory.rb

@@ -2,7 +2,7 @@
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright 2008-2017, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,14 +19,19 @@
 #
 
 require "chef/resource"
-require "chef/provider/directory"
 require "chef/mixin/securable"
 
 class Chef
   class Resource
     class Directory < Chef::Resource
+      resource_name :directory
 
-      identity_attr :path
+      description "Use the directory resource to manage a directory, which is a hierarchy"\
+                  " of folders that comprises all of the information stored on a computer."\
+                  " The root directory is the top-level, under which the rest of the directory"\
+                  " is organized. The directory resource uses the name property to specify the"\
+                  " path to a location in a directory. Typically, permission to access that"\
+                  " location in the directory is required."
 
       state_attrs :group, :mode, :owner
 
@@ -35,28 +40,12 @@ class Chef
       default_action :create
       allowed_actions :create, :delete
 
-      def initialize(name, run_context = nil)
-        super
-        @path = name
-        @recursive = false
-      end
-
-      def recursive(arg = nil)
-        set_or_return(
-          :recursive,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
-
-      def path(arg = nil)
-        set_or_return(
-          :path,
-          arg,
-          :kind_of => String
-        )
-      end
+      property :path, String, name_property: true, identity: true,
+               description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
 
+      property :recursive, [ TrueClass, FalseClass ],
+               description: "Create or delete parent directories recursively. For the owner, group, and mode properties, the value of this property applies only to the leaf directory.",
+               default: false
     end
   end
 end

data/lib/chef/resource/dmg_package.rb

@@ -0,0 +1,171 @@
+#
+# Author:: Joshua Timberman (<jtimberman@chef.io>)
+# Copyright:: 2011-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.
+#
+
+require "chef/resource"
+
+class Chef
+  class Resource
+    class DmgPackage < Chef::Resource
+      resource_name :dmg_package
+      provides(:dmg_package) { true }
+
+      description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]."
+      introduced "14.0"
+
+      property :app, String,
+               description: "The name of the application as it appears in the /Volumes directory if it differs from the resource block's name.",
+               name_property: true
+
+      property :source, String,
+               description: "The remote URL that is used to download the .dmg file, if specified."
+
+      property :file, String,
+               description: "The full path to the .dmg file on the local system."
+
+      property :owner, String,
+               description: "The user that should own the package installation."
+
+      property :destination, String,
+               description: "The directory to copy the .app into.",
+               default: "/Applications"
+
+      property :checksum, String,
+               description: "The sha256 checksum of the .dmg file to download."
+
+      property :volumes_dir, String,
+               description: "The directory under /Volumes where the dmg is mounted if it differs from the name of the .dmg file.",
+               default: lazy { |r| r.app }, default_description: "The value passed for the application name."
+
+      property :dmg_name, String,
+               description: "The name of the .dmg file if it differs from that of the app, or if the name has spaces.",
+               desired_state: false,
+               default: lazy { |r| r.app }, default_description: "The value passed for the application name."
+
+      property :type, String,
+               description: "The type of package.",
+               equal_to: %w{app pkg mpkg},
+               default: "app", desired_state: false
+
+      property :package_id, String,
+               description: "The package ID that is registered with pkgutil when a pkg or mpkg is installed."
+
+      property :dmg_passphrase, String,
+               description: "Specify a passphrase to be used to decrypt the .dmg file during the mount process.",
+               desired_state: false
+
+      property :accept_eula, [TrueClass, FalseClass],
+               description: "Specify whether to accept the EULA. Certain dmgs require acceptance of EULA before mounting.",
+               default: false, desired_state: false
+
+      property :headers, Hash,
+               description: "Allows custom HTTP headers (like cookies) to be set on the remote_file resource.",
+               desired_state: false
+
+      property :allow_untrusted, [TrueClass, FalseClass],
+               description: "Allow installation of packages that do not have trusted certificates.",
+               default: false, desired_state: false
+
+      load_current_value do |new_resource|
+        if ::File.directory?("#{new_resource.destination}/#{new_resource.app}.app")
+          Chef::Log.info "#{new_resource.app} is already installed. To upgrade, remove \"#{new_resource.destination}/#{new_resource.app}.app\""
+        elsif shell_out("pkgutil --pkg-info '#{new_resource.package_id}'").exitstatus == 0
+          Chef::Log.info "#{new_resource.app} is already installed. To upgrade, try \"sudo pkgutil --forget '#{new_resource.package_id}'\""
+        else
+          current_value_does_not_exist! # allows us to check for current_resource.nil? below
+        end
+      end
+
+      action :install do
+        description "Installs the application."
+
+        if current_resource.nil?
+          if new_resource.source
+            remote_file dmg_file do
+              source new_resource.source
+              headers new_resource.headers if new_resource.headers
+              checksum new_resource.checksum if new_resource.checksum
+            end
+          end
+
+          ruby_block "attach #{dmg_file}" do
+            block do
+              raise "This DMG package requires EULA acceptance. Add 'accept_eula true' to dmg_package resource to accept the EULA during installation." if software_license_agreement? && !new_resource.accept_eula
+
+              attach_cmd = new_resource.accept_eula ? "yes | " : ""
+              attach_cmd << "/usr/bin/hdiutil attach #{passphrase_cmd} '#{dmg_file}' -nobrowse -mountpoint '/Volumes/#{new_resource.volumes_dir}'"
+
+              shell_out!(attach_cmd, env: { "PAGER" => "true" })
+            end
+            not_if { dmg_attached? }
+          end
+
+          case new_resource.type
+          when "app"
+            execute "rsync --force --recursive --links --perms --executability --owner --group --times '/Volumes/#{new_resource.volumes_dir}/#{new_resource.app}.app' '#{new_resource.destination}'" do
+              user new_resource.owner if new_resource.owner
+            end
+
+            file "#{new_resource.destination}/#{new_resource.app}.app/Contents/MacOS/#{new_resource.app}" do
+              mode "0755"
+              ignore_failure true
+            end
+          when "mpkg", "pkg"
+            install_cmd = "installation_file=$(ls '/Volumes/#{new_resource.volumes_dir}' | grep '.#{new_resource.type}$') && sudo installer -pkg \"/Volumes/#{new_resource.volumes_dir}/$installation_file\" -target /"
+            install_cmd += " -allowUntrusted" if new_resource.allow_untrusted
+
+            execute install_cmd do
+              # Prevent cfprefsd from holding up hdiutil detach for certain disk images
+              environment("__CFPREFERENCES_AVOID_DAEMON" => "1")
+            end
+          end
+
+          execute "/usr/bin/hdiutil detach '/Volumes/#{new_resource.volumes_dir}' || /usr/bin/hdiutil detach '/Volumes/#{new_resource.volumes_dir}' -force"
+        end
+      end
+
+      action_class do
+        # @return [String] the path to the dmg file
+        def dmg_file
+          @dmg_file ||= begin
+            if new_resource.file.nil?
+              "#{Chef::Config[:file_cache_path]}/#{new_resource.dmg_name}.dmg"
+            else
+              new_resource.file
+            end
+          end
+        end
+
+        # @return [String] the hdiutil flag for handling DMGs with a password
+        def passphrase_cmd
+          @passphrase_cmd ||= new_resource.dmg_passphrase ? "-passphrase #{new_resource.dmg_passphrase}" : ""
+        end
+
+        # @return [Boolean] does the DMG require a software license agreement
+        def software_license_agreement?
+          # example hdiutil imageinfo output: http://rubular.com/r/0xvOaA6d8B
+          /Software License Agreement: true/.match?(shell_out!("/usr/bin/hdiutil imageinfo #{passphrase_cmd} '#{dmg_file}'").stdout)
+        end
+
+        # @return [Boolean] is the dmg file currently attached?
+        def dmg_attached?
+          # example hdiutil imageinfo output: http://rubular.com/r/CDcqenkixg
+          /image-path.*#{dmg_file}/.match?(shell_out!("/usr/bin/hdiutil info #{passphrase_cmd}").stdout)
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/dnf_package.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2016-2017, Chef Software Inc.
+# Copyright:: Copyright 2016-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,40 +27,52 @@ class Chef
 
       resource_name :dnf_package
 
-      allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache
+      # all rhel variants >= 8 will use DNF
+      provides :package, platform_family: "rhel", platform_version: ">= 8"
+
+      # fedora >= 22 uses DNF
+      provides :package, platform: "fedora", platform_version: ">= 22"
 
-      provides :package, platform_family: %w{rhel fedora} do
-        which("dnf") && shell_out("rpm -q dnf").stdout =~ /^dnf-[1-9]/
+      # amazon will eventually use DNF
+      provides :package, platform: "amazon" do
+        which("dnf")
       end
 
       provides :dnf_package
 
+      description "Use the dnf_package resource to install, upgrade, and remove packages with DNF for Fedora platforms. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
+      introduced "12.18"
+
+      allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache
+
       # Install a specific arch
-      property :arch, [String, Array], coerce: proc { |x| [x].flatten }
+      property :arch, [String, Array],
+               description: "The architecture of the package to be installed or upgraded. This value can also be passed as part of the package name.",
+               coerce: proc { |x| [x].flatten }
 
       # Flush the in-memory available/installed cache, this does not flush the dnf caches on disk
-      property :flush_cache,
-        Hash,
-        default: { before: false, after: false },
-        coerce: proc { |v|
-          if v.is_a?(Hash)
-            v
-          elsif v.is_a?(Array)
-            v.each_with_object({}) { |arg, obj| obj[arg] = true }
-          elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
-            { before: v, after: v }
-          elsif v == :before
-            { before: true, after: false }
-          elsif v == :after
-            { after: true, before: false }
-          end
-        }
+      property :flush_cache, Hash,
+               description: "Flush the in-memory cache before or after a DNF operation that installs, upgrades, or removes a package. DNF automatically synchronizes remote metadata to a local cache. The chef-client creates a copy of the local cache, and then stores it in-memory during the chef-client run. The in-memory cache allows packages to be installed during the chef-client run without the need to continue synchronizing the remote metadata to the local cache while the chef-client run is in-progress.",
+               default: { before: false, after: false },
+               coerce: proc { |v|
+                         if v.is_a?(Hash)
+                           v
+                         elsif v.is_a?(Array)
+                           v.each_with_object({}) { |arg, obj| obj[arg] = true }
+                         elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
+                           { before: v, after: v }
+                         elsif v == :before
+                           { before: true, after: false }
+                         elsif v == :after
+                           { after: true, before: false }
+                         end
+                       }
 
       def allow_downgrade(arg = nil)
         if !arg.nil?
           Chef.deprecated(:dnf_package_allow_downgrade, "the allow_downgrade property on the dnf_package provider is not used, DNF supports downgrades by default.")
         end
-        false
+        true
       end
     end
   end

data/lib/chef/resource/dpkg_package.rb

@@ -22,9 +22,12 @@ class Chef
   class Resource
     class DpkgPackage < Chef::Resource::Package
       resource_name :dpkg_package
-      provides :dpkg_package, os: "linux"
+      provides :dpkg_package
 
-      property :source, [ String, Array, nil ]
+      description "Use the dpkg_package resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
+
+      property :source, [ String, Array, nil ],
+               description: "The path to a package in the local file system."
     end
   end
 end

data/lib/chef/resource/dsc_resource.rb

@@ -20,7 +20,11 @@ require "chef/dsl/powershell"
 class Chef
   class Resource
     class DscResource < Chef::Resource
-      provides :dsc_resource, os: "windows"
+      resource_name :dsc_resource
+      provides :dsc_resource
+
+      description "The dsc_resource resource allows any DSC resource to be used in a Chef recipe, as well as any custom resources that have been added to your Windows PowerShell environment. Microsoft frequently adds new resources to the DSC resource collection."
+      introduced "12.2"
 
       # This class will check if the object responds to
       # to_text. If it does, it will call that as opposed
@@ -49,7 +53,6 @@ class Chef
         super
         @properties = ToTextHash.new
         @resource = nil
-        @reboot_action = :nothing
       end
 
       def resource(value = nil)
@@ -68,13 +71,9 @@ class Chef
         end
       end
 
-      def module_version(arg = nil)
-        set_or_return(
-          :module_version,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :module_version, String,
+               introduced: "12.21",
+               description: "The version number of the module to use. PowerShell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the module_name."
 
       def property(property_name, value = nil)
         if not property_name.is_a?(Symbol)
@@ -99,21 +98,13 @@ class Chef
       # If the set method of the DSC resource indicate that a reboot
       # is necessary, reboot_action provides the mechanism for a reboot to
       # be requested.
-      def reboot_action(value = nil)
-        if value
-          @reboot_action = value
-        else
-          @reboot_action
-        end
-      end
+      property :reboot_action, Symbol, default: :nothing, equal_to: [:nothing, :reboot_now, :request_reboot],
+                introduced: "12.6",
+                description: "Use to request an immediate reboot or to queue a reboot using the :reboot_now (immediate reboot) or :request_reboot (queued reboot) actions built into the reboot resource."
 
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => [ Integer ]
-        )
-      end
+      property :timeout, Integer,
+               introduced: "12.6",
+               description: "The amount of time (in seconds) a command is to wait before timing out."
 
       private
 

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"
 
@@ -24,7 +25,10 @@ class Chef
     class DscScript < Chef::Resource
       include Chef::DSL::Powershell
 
-      provides :dsc_script, os: "windows"
+      resource_name :dsc_script
+      provides :dsc_script
+
+      description "Many DSC resources are comparable to built-in Chef resources. For example, both DSC and Chef have file, package, and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct comparison to a resource in Chef, such as the Archive resource, a custom DSC resource, an existing DSC script that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC configuration directly within a Chef recipe."
 
       default_action :run
 
@@ -35,59 +39,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
 
@@ -104,37 +108,17 @@ class Chef
         end
       end
 
-      def flags(arg = nil)
-        set_or_return(
-          :flags,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
+      property :flags, Hash,
+               description: "Pass parameters to the DSC script that is specified by the command property. Parameters are defined as key-value pairs, where the value of each key is the parameter to pass. This property may not be used in the same recipe as the code property."
 
-      def cwd(arg = nil)
-        set_or_return(
-          :cwd,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :cwd, String,
+               description: "The current working directory."
 
-      def environment(arg = nil)
-        set_or_return(
-          :environment,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
+      property :environment, Hash,
+               description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}). (These variables must exist for a command to be run successfully)."
 
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => [ Integer ]
-        )
-      end
+      property :timeout, Integer,
+               description: "The amount of time (in seconds) a command is to wait before timing out."
     end
   end
 end