chef 15.3.14-universal-mingw32 → 15.4.45-universal-mingw32

data/lib/chef/provider.rb

@@ -272,11 +272,17 @@ class Chef
         raise ArgumentError, "converge_if_changed must be passed a block!"
       end
 
-      properties = new_resource.class.state_properties.map(&:name) if properties.empty?
-      properties = properties.map(&:to_sym)
+      properties =
+        if properties.empty?
+          new_resource.class.state_properties
+        else
+          properties.map { |property| new_resource.class.properties[property] }
+        end
+
       if current_resource
         # Collect the list of modified properties
-        specified_properties = properties.select { |property| new_resource.property_is_set?(property) }
+        specified_properties = properties.select { |property| property.is_set?(new_resource) || property.has_default? }
+        specified_properties = specified_properties.map(&:name).map(&:to_sym)
         modified = specified_properties.select { |p| new_resource.send(p) != current_resource.send(p) }
         if modified.empty?
           properties_str = if new_resource.sensitive
@@ -309,15 +315,15 @@ class Chef
       else
         # The resource doesn't exist. Mark that we are *creating* this, and
         # write down any properties we are setting.
-        property_size = properties.map(&:size).max
+        property_size = properties.map(&:name).map(&:to_sym).map(&:size).max
         created = properties.map do |property|
-          default = " (default value)" unless new_resource.property_is_set?(property)
-          properties_str = if new_resource.sensitive || new_resource.class.properties[property].sensitive?
+          default = " (default value)" unless property.is_set?(new_resource)
+          properties_str = if new_resource.sensitive || property.sensitive?
                              "(suppressed sensitive property)"
                            else
-                             new_resource.send(property).inspect
+                             new_resource.send(property.name.to_sym).inspect
                            end
-          "  set #{property.to_s.ljust(property_size)} to #{properties_str}#{default}"
+          "  set #{property.name.to_sym.to_s.ljust(property_size)} to #{properties_str}#{default}"
         end
 
         converge_by([ "create #{new_resource.identity}" ] + created, &converge_block)

data/lib/chef/provider/package/chocolatey.rb

@@ -210,7 +210,7 @@ class Chef
         # @return [String] options from new_resource or empty string
         def cmd_args(include_source: true)
           cmd_args = [ new_resource.options ]
-          cmd_args.push([ "-source", new_resource.source ]) if new_resource.source && include_source
+          cmd_args += common_options(include_source: include_source)
           cmd_args
         end
 
@@ -227,8 +227,8 @@ class Chef
             available_versions =
               begin
                 cmd = [ "list", "-r", pkg ]
-                cmd.push( [ "-source", new_resource.source ] ) if new_resource.source
-                cmd.push( new_resource.options ) if new_resource.options
+                cmd += common_options
+                cmd.push( new_resource.list_options ) if new_resource.list_options
 
                 raw = parse_list_output(*cmd)
                 raw.keys.each_with_object({}) do |name, available|
@@ -272,6 +272,14 @@ class Chef
         def lowercase_names(names)
           names.map(&:downcase)
         end
+
+        def common_options(include_source: true)
+          args = []
+          args.push( [ "-source", new_resource.source ] ) if new_resource.source && include_source
+          args.push( [ "--user", new_resource.user ] ) if new_resource.user
+          args.push( [ "--password", new_resource.password ]) if new_resource.password
+          args
+        end
       end
     end
   end

data/lib/chef/provider/package/dnf/python_helper.rb

@@ -38,9 +38,14 @@ class Chef
 
           def dnf_command
             # platform-python is used for system tools on RHEL 8 and is installed under /usr/libexec
-            @dnf_command ||= which("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
-              shell_out("#{f} -c 'import dnf'").exitstatus == 0
-            end + " #{DNF_HELPER}"
+            @dnf_command ||= begin
+              cmd = which("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
+                shell_out("#{f} -c 'import dnf'").exitstatus == 0
+              end
+              raise Chef::Exceptions::Package, "cannot find dnf libraries, you may need to use yum_package" unless cmd
+
+              "#{cmd} #{DNF_HELPER}"
+            end
           end
 
           def start

data/lib/chef/provider/package/windows/exe.rb

@@ -64,7 +64,7 @@ class Chef
                 unattended_flags,
                 expand_options(new_resource.options),
                 "& exit %%%%ERRORLEVEL%%%%",
-              ].join(" "), timeout: new_resource.timeout, returns: new_resource.returns, sensitive: new_resource.sensitive
+              ].join(" "), default_env: false, timeout: new_resource.timeout, returns: new_resource.returns, sensitive: new_resource.sensitive
             )
           end
 
@@ -73,7 +73,7 @@ class Chef
             uninstall_entries.select { |entry| [uninstall_version].flatten.include?(entry.display_version) }
               .map(&:uninstall_string).uniq.each do |uninstall_string|
                 logger.trace("Registry provided uninstall string for #{new_resource} is '#{uninstall_string}'")
-                shell_out!(uninstall_command(uninstall_string), timeout: new_resource.timeout, returns: new_resource.returns)
+                shell_out!(uninstall_command(uninstall_string), default_env: false, timeout: new_resource.timeout, returns: new_resource.returns)
               end
           end
 

data/lib/chef/provider/package/windows/msi.rb

@@ -70,14 +70,14 @@ class Chef
           def install_package
             # We could use MsiConfigureProduct here, but we'll start off with msiexec
             logger.trace("#{new_resource} installing MSI package '#{new_resource.source}'")
-            shell_out!("msiexec /qn /i \"#{new_resource.source}\" #{expand_options(new_resource.options)}", timeout: new_resource.timeout, returns: new_resource.returns)
+            shell_out!("msiexec /qn /i \"#{new_resource.source}\" #{expand_options(new_resource.options)}", default_env: false, timeout: new_resource.timeout, returns: new_resource.returns)
           end
 
           def remove_package
             # We could use MsiConfigureProduct here, but we'll start off with msiexec
             if !new_resource.source.nil? && ::File.exist?(new_resource.source)
               logger.trace("#{new_resource} removing MSI package '#{new_resource.source}'")
-              shell_out!("msiexec /qn /x \"#{new_resource.source}\" #{expand_options(new_resource.options)}", timeout: new_resource.timeout, returns: new_resource.returns)
+              shell_out!("msiexec /qn /x \"#{new_resource.source}\" #{expand_options(new_resource.options)}", default_env: false, timeout: new_resource.timeout, returns: new_resource.returns)
             else
               uninstall_version = new_resource.version || installed_version
               uninstall_entries.select { |entry| [uninstall_version].flatten.include?(entry.display_version) }
@@ -86,7 +86,7 @@ class Chef
                   uninstall_string += expand_options(new_resource.options)
                   uninstall_string += " /q" unless uninstall_string.downcase =~ %r{ /q}
                   logger.trace("#{new_resource} removing MSI package version using '#{uninstall_string}'")
-                  shell_out!(uninstall_string, timeout: new_resource.timeout, returns: new_resource.returns)
+                  shell_out!(uninstall_string, default_env: false, timeout: new_resource.timeout, returns: new_resource.returns)
                 end
             end
           end

data/lib/chef/provider/package/yum/python_helper.rb

@@ -40,9 +40,14 @@ class Chef
           YUM_HELPER = ::File.expand_path(::File.join(::File.dirname(__FILE__), "yum_helper.py")).freeze
 
           def yum_command
-            @yum_command ||= which("platform-python", "python", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
-              shell_out("#{f} -c 'import yum'").exitstatus == 0
-            end + " #{YUM_HELPER}"
+            @yum_command ||= begin
+              cmd = which("platform-python", "python", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
+                shell_out("#{f} -c 'import yum'").exitstatus == 0
+              end
+              raise Chef::Exceptions::Package, "cannot find yum libraries, you may need to use dnf_package" unless cmd
+
+              "#{cmd} #{YUM_HELPER}"
+            end
           end
 
           def start

data/lib/chef/provider/service/windows.rb

@@ -273,7 +273,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
     Win32::Service.configure(new_config)
     logger.info "#{new_resource} configured."
 
-    grant_service_logon(new_resource.run_as_user) if new_resource.run_as_user.casecmp("localsystem") != 0
+    grant_service_logon(new_resource.run_as_user) if new_resource.run_as_user != "localsystem"
   end
 
   #

data/lib/chef/resource/apt_repository.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: 2016-2017, Chef Software, Inc.
+# Copyright:: 2016-2019, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,8 +35,9 @@ class Chef
           components ['nginx']
         end
         ```
-         Enable Ubuntu multiverse repositories
-         ```ruby
+
+        Enable Ubuntu multiverse repositories
+        ```ruby
         apt_repository 'security-ubuntu-multiverse' do
           uri          'http://security.ubuntu.com/ubuntu'
           distribution 'trusty-security'
@@ -44,14 +45,16 @@ class Chef
           deb_src      true
         end
         ```
-         Add the Nginx PPA, autodetect the key and repository url
-         ```ruby
+
+        Add the Nginx PPA, autodetect the key and repository url
+        ```ruby
         apt_repository 'nginx-php' do
           uri          'ppa:nginx/stable'
         end
         ```
-         Add the JuJu PPA, grab the key from the keyserver, and add source repo
-         ```ruby
+
+        Add the JuJu PPA, grab the key from the keyserver, and add source repo
+        ```ruby
         apt_repository 'juju' do
           uri 'http://ppa.launchpad.net/juju/stable/ubuntu'
           components ['main']
@@ -62,8 +65,9 @@ class Chef
           deb_src true
         end
         ```
-         Add repository that requires multiple keys to authenticate packages
-         ```ruby
+
+        Add repository that requires multiple keys to authenticate packages
+        ```ruby
         apt_repository 'rundeck' do
           uri 'https://dl.bintray.com/rundeck/rundeck-deb'
           distribution '/'
@@ -72,8 +76,9 @@ class Chef
           action :add
         end
         ```
-         Add the Cloudera Repo of CDH4 packages for Ubuntu 12.04 on AMD64
-         ```ruby
+
+        Add the Cloudera Repo of CDH4 packages for Ubuntu 12.04 on AMD64
+        ```ruby
         apt_repository 'cloudera' do
           uri          'http://archive.cloudera.com/cdh4/ubuntu/precise/amd64/cdh'
           arch         'amd64'
@@ -82,8 +87,9 @@ class Chef
           key          'http://archive.cloudera.com/debian/archive.key'
         end
         ```
-         Remove a repository from the list
-         ```ruby
+
+        Remove a repository from the list
+        ```ruby
         apt_repository 'zenoss' do
           action :remove
         end

data/lib/chef/resource/apt_update.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) 2016-2017, Chef Software Inc.
+# Copyright:: Copyright (c) 2016-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,6 +26,20 @@ class Chef
 
       description "Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms."
       introduced "12.7"
+      examples <<~DOC
+        Update the Apt repository at a specified interval
+        ```ruby
+        apt_update 'all platforms' do
+        frequency 86400
+        action :periodic
+        end
+        ```
+
+        Update the Apt repository at the start of a Chef Infra Client run
+        ```ruby
+        apt_update 'update'
+        ```
+      DOC
 
       # allow bare apt_update with no name
       property :name, String, default: ""

data/lib/chef/resource/archive_file.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2017-2018, Chef Software Inc.
+# Copyright:: Copyright 2017-2019, Chef Software Inc.
 # Author:: Jamie Winsor (<jamie@vialstudios.com>)
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
@@ -30,6 +30,15 @@ class Chef
 
       introduced "15.0"
       description "Use the archive_file resource to extract archive files to disk. This resource uses the libarchive library to extract multiple archive formats including tar, gzip, bzip, and zip formats."
+      examples <<~DOC
+        Extract a zip file to a specified directory
+        ```ruby
+        archive_file 'Precompiled.zip' do
+          path '/tmp/Precompiled.zip'
+          destination '/srv/files'
+        end
+        ```
+      DOC
 
       property :path, String,
         name_property: true,

data/lib/chef/resource/build_essential.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2008-2018, Chef Software, Inc.
+# Copyright:: 2008-2019, 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.
@@ -24,6 +24,19 @@ class Chef
 
       description "Use the build_essential resource to install packages required for compiling C software from source."
       introduced "14.0"
+      examples <<~DOC
+        Install compilation packages
+        ```ruby
+        build_essential
+        ```
+
+        Install compilation packages during the compilation phase
+        ```ruby
+        build_essential 'Install compilation tools' do
+          compile_time true
+        end
+        ```
+      DOC
 
       # this allows us to use build_essential without setting a name
       property :name, String, default: ""

data/lib/chef/resource/chocolatey_config.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2018, Chef Software, Inc.
+# Copyright:: 2018-2019, 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.
@@ -21,6 +21,22 @@ class Chef
 
       description "Use the chocolatey_config resource to add or remove Chocolatey configuration keys."
       introduced "14.3"
+      examples <<~DOC
+        Set the Chocolatey cacheLocation config
+        ```ruby
+        chocolatey_config 'Set cacheLocation config' do
+          config_key 'cacheLocation'
+          value 'C:\temp\choco'
+        end
+        ```
+
+        Unset a Chocolatey config
+        ```ruby
+        chocolatey_config 'BogusConfig' do
+          action :unset
+        end
+        ```
+      DOC
 
       property :config_key, String, name_property: true,
                description: "An optional property to set the config key name if it differs from the resource block's name."

data/lib/chef/resource/chocolatey_feature.rb

@@ -21,6 +21,21 @@ class Chef
 
       description "Use the chocolatey_feature resource to enable and disable Chocolatey features."
       introduced "15.1"
+      examples <<~DOC
+        Enable the checksumFiles Chocolatey feature
+        ```ruby
+        chocolatey_feature 'checksumFiles' do
+          action :enable
+        end
+        ```
+
+        Disable the checksumFiles Chocolatey feature
+        ```ruby
+        chocolatey_feature 'checksumFiles' do
+          action :disable
+        end
+        ```
+      DOC
 
       property :feature_name, String, name_property: true,
                description: "The name of the Chocolatey feature to enable or disable."

data/lib/chef/resource/chocolatey_package.rb

@@ -26,6 +26,22 @@ class Chef
 
       description "Use the chocolatey_package resource to manage packages using Chocolatey on the Microsoft Windows platform."
       introduced "12.7"
+      examples <<~DOC
+        Install a Chocolatey package
+        ```ruby
+        chocolatey_package 'name of package' do
+          action :install
+        end
+        ```
+
+        Install a package with options with Chocolatey's ``--checksum`` option
+        ```ruby
+        chocolatey_package 'name of package' do
+          options '--checksum 1234567890'
+          action :install
+        end
+        ```
+      DOC
 
       allowed_actions :install, :upgrade, :remove, :purge, :reconfig
 
@@ -33,6 +49,18 @@ class Chef
       property :options, [String, Array],
         description: "One (or more) additional options that are passed to the command."
 
+      property :list_options, String,
+        introduced: "15.3",
+        description: "One (or more) additional list options that are passed to the command."
+
+      property :user, String,
+        introduced: "15.3",
+        description: "The username to authenticate feeds."
+
+      property :password, String,
+        introduced: "15.3",
+        description: "The password to authenticate to the source."
+
       property :package_name, [String, Array],
         description: "The name of the package. Default value: the name of the resource block.",
         coerce: proc { |x| [x].flatten }
@@ -41,9 +69,11 @@ class Chef
         description: "The version of a package to be installed or upgraded.",
         coerce: proc { |x| [x].flatten }
 
+      # In the choco if we have the feature useEnhancedExitCodes turned on, then choco will provide enhanced exit codes(2: no results).
+      # Choco exit codes https://chocolatey.org/docs/commandsinfo#exit-codes
       property :returns, [Integer, Array],
         description: "The exit code(s) returned a chocolatey package that indicate success.",
-        default: [ 0 ], desired_state: false,
+        default: [ 0, 2 ], desired_state: false,
         introduced: "12.18"
     end
   end

data/lib/chef/resource/chocolatey_source.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2018, Chef Software, Inc.
+# Copyright:: 2018-2019, 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.
@@ -21,6 +21,22 @@ class Chef
 
       description "Use the chocolatey_source resource to add, remove, enable, or disable Chocolatey sources."
       introduced "14.3"
+      examples <<~DOC
+        Add a Chocolatey source
+        ```ruby
+        chocolatey_source 'MySource' do
+          source 'http://example.com/something'
+          action :add
+        end
+        ```
+
+        Remove a Chocolatey source
+        ```ruby
+        chocolatey_source 'MySource' do
+          action :remove
+        end
+        ```
+      DOC
 
       property :source_name, String, name_property: true,
                description: "An optional property to set the source name if it differs from the resource block's name."