chef 13.12.14-universal-mingw32 → 14.0.190-universal-mingw32

data/lib/chef/resource/chocolatey_package.rb

@@ -20,15 +20,15 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # Use the chocolatey_package resource to manage packages using Chocolatey on the Microsoft Windows platform.
-    #
-    # @since 12.7
     class ChocolateyPackage < Chef::Resource::Package
-
       resource_name :chocolatey_package
-      provides :chocolatey_package, os: "windows"
+      provides :chocolatey_package
+
+      description "Use the chocolatey_package resource to manage packages using Chocolatey"\
+                  " on the Microsoft Windows platform."
+      introduced "12.7"
 
-      allowed_actions :install, :upgrade, :remove, :uninstall, :purge, :reconfig
+      allowed_actions :install, :upgrade, :remove, :purge, :reconfig
 
       # windows can't take Array options yet
       property :options, String

data/lib/chef/resource/cookbook_file.rb

@@ -24,20 +24,23 @@ require "chef/mixin/securable"
 
 class Chef
   class Resource
-    # Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path
-    # located on a host that is running the chef-client. The file is selected according to file specificity, which allows
-    # different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate),
-    # or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any
-    # platform.
-    #
-    # During a chef-client run, the checksum for each local file is calculated and then compared against the checksum for
-    # the same file as it currently exists in the cookbook on the Chef server. A file is not transferred when the checksums
-    # match. Only files that require an update are transferred from the Chef server to a node.
     class CookbookFile < Chef::Resource::File
       include Chef::Mixin::Securable
 
       resource_name :cookbook_file
 
+      description "Use the cookbook_file resource to transfer files from a sub-directory"\
+                  " of COOKBOOK_NAME/files/ to a specified path located on a host that is"\
+                  " running the chef-client. The file is selected according to file specificity,"\
+                  " which allows different source files to be used based on the hostname, host"\
+                  " platform (operating system, distro, or as appropriate), or platform version."\
+                  " Files that are located in the COOKBOOK_NAME/files/default sub-directory may be"\
+                  " used on any platform.\n\n"\
+                  "During a chef-client run, the checksum for each local file is calculated and then"\
+                  " compared against the checksum for the same file as it currently exists in the"\
+                  " cookbook on the Chef server. A file is not transferred when the checksums match."\
+                  " Only files that require an update are transferred from the Chef server to a node."
+
       property :source, [ String, Array ], default: lazy { ::File.basename(name) }
       property :cookbook, String
 

data/lib/chef/resource/cron.rb

@@ -18,14 +18,17 @@
 #
 
 require "chef/resource"
+require "chef/provider/cron" # do not remove. we actually need this below
 
 class Chef
   class Resource
-    # Use the cron resource to manage cron entries for time-based job scheduling. Properties for a schedule will default
-    # to * if not provided. The cron resource requires access to a crontab program, typically cron.
     class Cron < Chef::Resource
+      resource_name :cron
+      provides :cron
 
-      identity_attr :command
+      description "Use the cron resource to manage cron entries for time-based job scheduling."\
+                  " Properties for a schedule will default to * if not provided. The cron resource"\
+                  " requires access to a crontab program, typically cron."
 
       state_attrs :minute, :hour, :day, :month, :weekday, :user
 
@@ -39,14 +42,6 @@ class Chef
         @day = "*"
         @month = "*"
         @weekday = "*"
-        @command = nil
-        @user = "root"
-        @mailto = nil
-        @path = nil
-        @shell = nil
-        @home = nil
-        @time = nil
-        @environment = {}
       end
 
       def minute(arg = nil)
@@ -141,73 +136,17 @@ class Chef
         )
       end
 
-      def time(arg = nil)
-        set_or_return(
-          :time,
-          arg,
-          :equal_to => Chef::Provider::Cron::SPECIAL_TIME_VALUES
-        )
-      end
-
-      def mailto(arg = nil)
-        set_or_return(
-          :mailto,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def path(arg = nil)
-        set_or_return(
-          :path,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def home(arg = nil)
-        set_or_return(
-          :home,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def shell(arg = nil)
-        set_or_return(
-          :shell,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def command(arg = nil)
-        set_or_return(
-          :command,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def user(arg = nil)
-        set_or_return(
-          :user,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def environment(arg = nil)
-        set_or_return(
-          :environment,
-          arg,
-          :kind_of => Hash
-        )
-      end
+      property :time, Symbol, equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
+      property :mailto, String
+      property :path, String
+      property :home, String
+      property :shell, String
+      property :command, String, identity: true
+      property :user, String, default: "root"
+      property :environment, Hash, default: lazy { Hash.new }
 
       private
 
-      # On Ruby 1.8, Kernel#Integer will happily do this for you. On 1.9, no.
       def integerize(integerish)
         Integer(integerish)
       rescue TypeError

data/lib/chef/resource/csh.rb

@@ -21,11 +21,13 @@ require "chef/provider/script"
 
 class Chef
   class Resource
-    # 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.
     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

@@ -23,13 +23,16 @@ require "chef/mixin/securable"
 
 class Chef
   class Resource
-    # 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.
     class Directory < Chef::Resource
       resource_name :directory
 
+      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
 
       include Chef::Mixin::Securable

data/lib/chef/resource/dmg_package.rb

@@ -0,0 +1,161 @@
+#
+# 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
+
+      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 used by default for the /Volumes directory and the .app directory copied to /Applications.",
+               name_property: true
+
+      property :source, String,
+               description: "The remote URL for the dmg to download if specified."
+
+      property :file, String,
+               description: "The local dmg full file path."
+
+      property :owner, String,
+               description: "The owner 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 to download"
+
+      property :volumes_dir, String,
+               description: "The Directory under /Volumes where the dmg is mounted as not all dmgs are mounted into a /Volumes location matching the name of the dmg."
+
+      property :dmg_name, String,
+               description: "The name of the dmg if it is not the same as app, or if the name has spaces."
+
+      property :type, String,
+               description: "The type of package.",
+               equal_to: %w{app pkg mpkg},
+               default: "app"
+
+      property :installed, [TrueClass, FalseClass],
+               default: false, desired_state: false
+
+      property :package_id, String,
+               description: "The package id registered with pkgutil when a pkg or mpkg is installed"
+
+      property :dmg_passphrase, String,
+               description: "Specify a passphrase to use to unencrypt the dmg while mounting."
+
+      property :accept_eula, [TrueClass, FalseClass],
+               description: "Specify whether to accept the EULA. Certain dmgs require acceptance of EULA before mounting.",
+               default: false
+
+      property :headers, [Hash, nil],
+               description: "Allows custom HTTP headers (like cookies) to be set on the remote_file resource.",
+               default: nil
+
+      property :allow_untrusted, [TrueClass, FalseClass],
+               description: "Allows packages with untrusted certs to be installed.",
+               default: false
+
+      load_current_value do |new_resource|
+        if ::File.directory?("#{new_resource.destination}/#{new_resource.app}.app")
+          Chef::Log.info "Already installed; to upgrade, remove \"#{new_resource.destination}/#{new_resource.app}.app\""
+          installed true
+        elsif shell_out("pkgutil --pkgs='#{new_resource.package_id}'").exitstatus == 0
+          Chef::Log.info "Already installed; to upgrade, try \"sudo pkgutil --forget '#{new_resource.package_id}'\""
+          installed true
+        else
+          installed false
+        end
+      end
+
+      action :install do
+        description "Installs the application."
+
+        unless current_resource.installed
+
+          volumes_dir = new_resource.volumes_dir ? new_resource.volumes_dir : new_resource.app
+          dmg_name = new_resource.dmg_name ? new_resource.dmg_name : new_resource.app
+
+          if new_resource.source
+            declare_resource(:remote_file, "#{dmg_file} - #{new_resource.name}") do
+              path dmg_file
+              source new_resource.source
+              headers new_resource.headers if new_resource.headers
+              checksum new_resource.checksum if new_resource.checksum
+            end
+          end
+
+          passphrase_cmd = new_resource.dmg_passphrase ? "-passphrase #{new_resource.dmg_passphrase}" : ""
+          ruby_block "attach #{dmg_file}" do
+            block do
+              cmd = shell_out("hdiutil imageinfo #{passphrase_cmd} '#{dmg_file}' | grep -q 'Software License Agreement: true'")
+              software_license_agreement = cmd.exitstatus == 0
+              raise "Requires EULA Acceptance; add 'accept_eula true' to package resource" if software_license_agreement && !new_resource.accept_eula
+              accept_eula_cmd = new_resource.accept_eula ? "echo Y | PAGER=true" : ""
+              shell_out!("#{accept_eula_cmd} hdiutil attach #{passphrase_cmd} '#{dmg_file}' -mountpoint '/Volumes/#{volumes_dir}' -quiet")
+            end
+            not_if "hdiutil info #{passphrase_cmd} | grep -q 'image-path.*#{dmg_file}'"
+          end
+
+          case new_resource.type
+          when "app"
+            declare_resource(:execute, "rsync --force --recursive --links --perms --executability --owner --group --times '/Volumes/#{volumes_dir}/#{new_resource.app}.app' '#{new_resource.destination}'") do
+              user new_resource.owner if new_resource.owner
+            end
+
+            declare_resource(:file, "#{new_resource.destination}/#{new_resource.app}.app/Contents/MacOS/#{new_resource.app}") do
+              mode "755"
+              ignore_failure true
+            end
+          when "mpkg", "pkg"
+            install_cmd = "installation_file=$(ls '/Volumes/#{volumes_dir}' | grep '.#{new_resource.type}$') && sudo installer -pkg \"/Volumes/#{volumes_dir}/$installation_file\" -target /"
+            install_cmd += " -allowUntrusted" if new_resource.allow_untrusted
+
+            declare_resource(:execute, install_cmd) do
+              # Prevent cfprefsd from holding up hdiutil detach for certain disk images
+              environment("__CFPREFERENCES_AVOID_DAEMON" => "1")
+            end
+          end
+
+          declare_resource(:execute, "hdiutil detach '/Volumes/#{volumes_dir}' || hdiutil detach '/Volumes/#{volumes_dir}' -force")
+        end
+      end
+
+      action_class do
+        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
+      end
+    end
+  end
+end

data/lib/chef/resource/dnf_package.rb

@@ -21,19 +21,12 @@ require "chef/mixin/shell_out"
 
 class Chef
   class Resource
-    # 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.
-    #
-    # @since 12.18
     class DnfPackage < Chef::Resource::Package
       extend Chef::Mixin::Which
       extend Chef::Mixin::ShellOut
 
       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"
 
@@ -47,6 +40,16 @@ class Chef
 
       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 }
 

data/lib/chef/resource/dpkg_package.rb

@@ -20,11 +20,13 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # 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.
     class DpkgPackage < Chef::Resource::Package
       resource_name :dpkg_package
-      provides :dpkg_package, os: "linux"
+      provides :dpkg_package
+
+      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 ]
     end

data/lib/chef/resource/dsc_resource.rb

@@ -19,13 +19,15 @@ require "chef/dsl/powershell"
 
 class Chef
   class Resource
-    # 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.
-    #
-    # @since 12.2
     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
@@ -54,7 +56,6 @@ class Chef
         super
         @properties = ToTextHash.new
         @resource = nil
-        @reboot_action = :nothing
       end
 
       def resource(value = nil)
@@ -73,13 +74,7 @@ class Chef
         end
       end
 
-      def module_version(arg = nil)
-        set_or_return(
-          :module_version,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :module_version, String
 
       def property(property_name, value = nil)
         if not property_name.is_a?(Symbol)
@@ -104,21 +99,9 @@ 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]
 
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => [ Integer ]
-        )
-      end
+      property :timeout, Integer
 
       private