chef 18.9.4 → 18.11.11

data/lib/chef/resource/chef_handler.rb

@@ -27,149 +27,149 @@ class Chef
       description "Use the **chef_handler** resource to enable handlers during a #{ChefUtils::Dist::Infra::PRODUCT} run. The resource allows arguments to be passed to #{ChefUtils::Dist::Infra::PRODUCT}, which then applies the conditions defined by the custom handler to the node attribute data collected during a #{ChefUtils::Dist::Infra::PRODUCT} run, and then processes the handler based on that data.\nThe **chef_handler** resource is typically defined early in a node's run-list (often being the first item). This ensures that all of the handlers will be available for the entire #{ChefUtils::Dist::Infra::PRODUCT} run."
       introduced "14.0"
       examples <<~'DOC'
-      **Enable the 'MyHandler' handler**
+        **Enable the 'MyHandler' handler**
 
-      The following example shows how to enable a fictional 'MyHandler' handler which is located on disk at `/etc/chef/my_handler.rb`. The handler will be configured to run with Chef Infra Client and will be passed values to the handler's initializer method:
+        The following example shows how to enable a fictional 'MyHandler' handler which is located on disk at `/etc/chef/my_handler.rb`. The handler will be configured to run with Chef Infra Client and will be passed values to the handler's initializer method:
 
-      ```ruby
-      chef_handler 'MyHandler' do
-        source '/etc/chef/my_handler.rb' # the file should already be at this path
-        arguments path: '/var/chef/reports'
-        action :enable
-      end
-      ```
+        ```ruby
+        chef_handler 'MyHandler' do
+          source '/etc/chef/my_handler.rb' # the file should already be at this path
+          arguments path: '/var/chef/reports'
+          action :enable
+        end
+        ```
 
-      **Enable handlers during the compile phase**
+        **Enable handlers during the compile phase**
 
-      ```ruby
-      chef_handler 'Chef::Handler::JsonFile' do
-        source 'chef/handler/json_file'
-        arguments path: '/var/chef/reports'
-        action :enable
-        compile_time true
-      end
-      ```
+        ```ruby
+        chef_handler 'Chef::Handler::JsonFile' do
+          source 'chef/handler/json_file'
+          arguments path: '/var/chef/reports'
+          action :enable
+          compile_time true
+        end
+        ```
 
-      **Handle only exceptions**
+        **Handle only exceptions**
 
-      ```ruby
-      chef_handler 'Chef::Handler::JsonFile' do
-        source 'chef/handler/json_file'
-        arguments path: '/var/chef/reports'
-        type exception: true
-        action :enable
-      end
-      ```
+        ```ruby
+        chef_handler 'Chef::Handler::JsonFile' do
+          source 'chef/handler/json_file'
+          arguments path: '/var/chef/reports'
+          type exception: true
+          action :enable
+        end
+        ```
 
-      **Cookbook Versions (a custom handler)**
+        **Cookbook Versions (a custom handler)**
 
-      [@juliandunn](https://github.com/juliandunn) created a custom report handler that logs all of the cookbooks and cookbook versions that were used during a Chef Infra Client run, and then reports after the run is complete.
+        [@juliandunn](https://github.com/juliandunn) created a custom report handler that logs all of the cookbooks and cookbook versions that were used during a Chef Infra Client run, and then reports after the run is complete.
 
-      cookbook_versions.rb:
+        cookbook_versions.rb:
 
-      The following custom handler defines how cookbooks and cookbook versions that are used during a Chef Infra Client run will be compiled into a report using the `Chef::Log` class in Chef Infra Client:
+        The following custom handler defines how cookbooks and cookbook versions that are used during a Chef Infra Client run will be compiled into a report using the `Chef::Log` class in Chef Infra Client:
 
-      ```ruby
-      require 'chef/log'
+        ```ruby
+        require 'chef/log'
 
-      module Chef
-        class CookbookVersionsHandler < Chef::Handler
-          def report
-            cookbooks = run_context.cookbook_collection
-            Chef::Log.info('Cookbooks and versions run: #{cookbooks.map {|x| x.name.to_s + ' ' + x.version }}')
+        module Chef
+          class CookbookVersionsHandler < Chef::Handler
+            def report
+              cookbooks = run_context.cookbook_collection
+              Chef::Log.info('Cookbooks and versions run: #{cookbooks.map {|x| x.name.to_s + ' ' + x.version }}')
+            end
           end
         end
-      end
-      ```
+        ```
 
-      default.rb:
+        default.rb:
 
-      The following recipe is added to the run-list for every node on which a list of cookbooks and versions will be generated as report output after every Chef Infra Client run.
+        The following recipe is added to the run-list for every node on which a list of cookbooks and versions will be generated as report output after every Chef Infra Client run.
 
-      ```ruby
-      cookbook_file '/etc/chef/cookbook_versions.rb' do
-        source 'cookbook_versions.rb'
-        action :create
-      end
+        ```ruby
+        cookbook_file '/etc/chef/cookbook_versions.rb' do
+          source 'cookbook_versions.rb'
+          action :create
+        end
 
-      chef_handler 'Chef::CookbookVersionsHandler' do
-        source '/etc/chef/cookbook_versions.rb'
-        type report: true
-        action :enable
-      end
-      ```
+        chef_handler 'Chef::CookbookVersionsHandler' do
+          source '/etc/chef/cookbook_versions.rb'
+          type report: true
+          action :enable
+        end
+        ```
 
-      This recipe will generate report output similar to the following:
+        This recipe will generate report output similar to the following:
 
-      ```
-      [2013-11-26T03:11:06+00:00] INFO: Chef Infra Client Run complete in 0.300029878 seconds
-      [2013-11-26T03:11:06+00:00] INFO: Running report handlers
-      [2013-11-26T03:11:06+00:00] INFO: Cookbooks and versions run: ["cookbook_versions_handler 1.0.0"]
-      [2013-11-26T03:11:06+00:00] INFO: Report handlers complete
-      ```
+        ```
+        [2013-11-26T03:11:06+00:00] INFO: Chef Infra Client Run complete in 0.300029878 seconds
+        [2013-11-26T03:11:06+00:00] INFO: Running report handlers
+        [2013-11-26T03:11:06+00:00] INFO: Cookbooks and versions run: ["cookbook_versions_handler 1.0.0"]
+        [2013-11-26T03:11:06+00:00] INFO: Report handlers complete
+        ```
 
-      **JsonFile Handler**
+        **JsonFile Handler**
 
-      The JsonFile handler is available from the `chef_handler` cookbook and can be used with exceptions and reports. It serializes run status data to a JSON file. This handler may be enabled in one of the following ways.
+        The JsonFile handler is available from the `chef_handler` cookbook and can be used with exceptions and reports. It serializes run status data to a JSON file. This handler may be enabled in one of the following ways.
 
-      By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:
+        By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:
 
-      ```ruby
-      require 'chef/handler/json_file'
-      report_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')
-      exception_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')
-      ```
+        ```ruby
+        require 'chef/handler/json_file'
+        report_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')
+        exception_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')
+        ```
 
-      By using the `chef_handler` resource in a recipe, similar to the following:
+        By using the `chef_handler` resource in a recipe, similar to the following:
 
-      ```ruby
-      chef_handler 'Chef::Handler::JsonFile' do
-        source 'chef/handler/json_file'
-        arguments path: '/var/chef/reports'
-        action :enable
-      end
-      ```
+        ```ruby
+        chef_handler 'Chef::Handler::JsonFile' do
+          source 'chef/handler/json_file'
+          arguments path: '/var/chef/reports'
+          action :enable
+        end
+        ```
 
-      After it has run, the run status data can be loaded and inspected via Interactive Ruby (IRb):
+        After it has run, the run status data can be loaded and inspected via Interactive Ruby (IRb):
 
-      ```
-      irb(main):002:0> require 'json' => true
-      irb(main):003:0> require 'chef' => true
-      irb(main):004:0> r = JSON.parse(IO.read('/var/chef/reports/chef-run-report-20110322060731.json')) => ... output truncated
-      irb(main):005:0> r.keys => ['end_time', 'node', 'updated_resources', 'exception', 'all_resources', 'success', 'elapsed_time', 'start_time', 'backtrace']
-      irb(main):006:0> r['elapsed_time'] => 0.00246
-      ```
+        ```
+        irb(main):002:0> require 'json' => true
+        irb(main):003:0> require 'chef' => true
+        irb(main):004:0> r = JSON.parse(IO.read('/var/chef/reports/chef-run-report-20110322060731.json')) => ... output truncated
+        irb(main):005:0> r.keys => ['end_time', 'node', 'updated_resources', 'exception', 'all_resources', 'success', 'elapsed_time', 'start_time', 'backtrace']
+        irb(main):006:0> r['elapsed_time'] => 0.00246
+        ```
 
-      Register the JsonFile handler
+        Register the JsonFile handler
 
-      ```ruby
-      chef_handler 'Chef::Handler::JsonFile' do
-        source 'chef/handler/json_file'
-        arguments path: '/var/chef/reports'
-        action :enable
-      end
-      ```
+        ```ruby
+        chef_handler 'Chef::Handler::JsonFile' do
+          source 'chef/handler/json_file'
+          arguments path: '/var/chef/reports'
+          action :enable
+        end
+        ```
 
-      **ErrorReport Handler**
+        **ErrorReport Handler**
 
-      The ErrorReport handler is built into Chef Infra Client and can be used for both exceptions and reports. It serializes error report data to a JSON file. This handler may be enabled in one of the following ways.
+        The ErrorReport handler is built into Chef Infra Client and can be used for both exceptions and reports. It serializes error report data to a JSON file. This handler may be enabled in one of the following ways.
 
-      By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:
+        By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:
 
-      ```ruby
-      require 'chef/handler/error_report'
-      report_handlers << Chef::Handler::ErrorReport.new
-      exception_handlers << Chef::Handler::ErrorReport.new
-      ```
+        ```ruby
+        require 'chef/handler/error_report'
+        report_handlers << Chef::Handler::ErrorReport.new
+        exception_handlers << Chef::Handler::ErrorReport.new
+        ```
 
-      By using the `chef_handler` resource in a recipe, similar to the following:
+        By using the `chef_handler` resource in a recipe, similar to the following:
 
-      ```ruby
-      chef_handler 'Chef::Handler::ErrorReport' do
-        source 'chef/handler/error_report'
-        action :enable
-      end
-      ```
+        ```ruby
+        chef_handler 'Chef::Handler::ErrorReport' do
+          source 'chef/handler/error_report'
+          action :enable
+        end
+        ```
       DOC
 
       property :class_name, String,

data/lib/chef/resource/chef_vault_secret.rb

@@ -65,7 +65,7 @@ class Chef
       property :search, String, default: "*:*", desired_state: false,
         description: "Search query that would match the same used for the clients, gets stored as a field in the item."
 
-      property :raw_data, [Hash, Mash], default: {},
+      property :raw_data, [Hash, Mash], default: {}, sensitive: true,
         description: "The raw data, as a Ruby Hash, that will be stored in the item."
 
       property :environment, [String, NilClass], desired_state: false,

data/lib/chef/resource/chocolatey_config.rb

@@ -23,26 +23,26 @@ class Chef
       description "Use the **chocolatey_config** resource to add or remove Chocolatey configuration keys. Note: The Chocolatey package manager is not installed on Windows by default. You will need to install it prior to using this resource by adding the [Chocolatey cookbook](https://supermarket.chef.io/cookbooks/chocolatey/) to your node's run list."
       introduced "14.3"
       examples <<~DOC
-      **Set the Chocolatey cacheLocation config**:
+        **Set the Chocolatey cacheLocation config**:
 
-      ```ruby
-      chocolatey_config 'Set cacheLocation config' do
-        config_key 'cacheLocation'
-        value 'C:\\temp\\choco'
-      end
-      ```
+        ```ruby
+        chocolatey_config 'Set cacheLocation config' do
+          config_key 'cacheLocation'
+          value 'C:\\temp\\choco'
+        end
+        ```
 
-      **Unset a Chocolatey config**:
+        **Unset a Chocolatey config**:
 
-      ```ruby
-      chocolatey_config 'BogusConfig' do
-        action :unset
-      end
-      ```
+        ```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."
+        description: "An optional property to set the config key name if it differs from the resource block's name."
 
       property :value, String,
         description: "The value to set."

data/lib/chef/resource/chocolatey_feature.rb

@@ -40,7 +40,7 @@ class Chef
       DOC
 
       property :feature_name, String, name_property: true,
-               description: "The name of the Chocolatey feature to enable or disable."
+        description: "The name of the Chocolatey feature to enable or disable."
 
       property :feature_state, [TrueClass, FalseClass], default: false, skip_docs: true
 

data/lib/chef/resource/chocolatey_installer.rb

@@ -1,3 +1,6 @@
+require "cgi" unless defined?(CGI)
+require "uri" unless defined?(URI)
+
 class Chef
   class Resource
     class ChocolateyInstaller < Chef::Resource
@@ -6,48 +9,48 @@ class Chef
       description "Use the chocolatey_installer resource to ensure that Chocolatey itself is installed to your specification. Use the Chocolatey Feature resource to customize your install. Then use the Chocolatey Package resource to install packages on Windows via Chocolatey."
       introduced "18.3"
       examples <<~DOC
-          **Install Chocolatey**
+        **Install Chocolatey**
 
-          ```ruby
-          chocolatey_installer 'latest' do
-            action :install
-          end
-          ```
+        ```ruby
+        chocolatey_installer 'latest' do
+          action :install
+        end
+        ```
 
-          **Uninstall Chocolatey**
+        **Uninstall Chocolatey**
 
-          ```ruby
-          chocolatey_installer 'Some random verbiage' do
-            action :uninstall
-          end
-          ```
+        ```ruby
+        chocolatey_installer 'Some random verbiage' do
+          action :uninstall
+        end
+        ```
 
-          **Install Chocolatey with Parameters**
+        **Install Chocolatey with Parameters**
 
-          ```ruby
-          chocolatey_installer 'latest' do
-            action :install
-            download_url "https://www.contoso.com/foo"
-            chocolatey_version '2.12.24'
-          end
-          ```
+        ```ruby
+        chocolatey_installer 'latest' do
+          action :install
+          download_url "https://www.contoso.com/foo"
+          chocolatey_version '2.12.24'
+        end
+        ```
 
           ```ruby
           chocolatey_installer 'latest' do
             action :install
-            download_url "c:\\foo\foo.nupkg"
+            download_url "c:\\foo\\foo.nupkg"
             chocolatey_version '2.12.24'
           end
           ```
 
-          **Upgrade Chocolatey with Parameters**
+        **Upgrade Chocolatey with Parameters**
 
-          ```ruby
-          chocolatey_installer 'latest' do
-            action :upgrade
-            chocolatey_version '2.12.24'
-          end
-          ```
+        ```ruby
+        chocolatey_installer 'latest' do
+          action :upgrade
+          chocolatey_version '2.12.24'
+        end
+        ```
       DOC
 
       allowed_actions :install, :uninstall, :upgrade
@@ -70,7 +73,7 @@ class Chef
       property :proxy_user, String,
         description: "The username to use to build a proxy credential with. Will be consumed by the proxy_credential property if both this property and proxy_password are set"
 
-      property :proxy_password, String,
+      property :proxy_password, String, sensitive: true,
         description: "The password to use to build a proxy credential with. Will be consumed by the proxy_credential property if both this property and proxy_user are set"
 
       load_current_value do
@@ -91,6 +94,25 @@ class Chef
         Gem::Version.new(get_choco_version)
       end
 
+      def download_url_path
+        return download_url if download_url.match?(%r{^[a-zA-Z]:[\\/]}) || download_url.start_with?("\\\\")
+
+        ::URI.parse(download_url).path
+      rescue URI::InvalidURIError
+        download_url
+      end
+
+      def download_url_script?
+        ::File.extname(download_url_path).casecmp(".ps1") == 0
+      end
+
+      def download_destination
+        filename = ::File.basename(::CGI.unescape(download_url_path.to_s))
+        filename = "chocolatey.nupkg" if filename.empty? || ["/", "\\", "."].include?(filename)
+
+        Chef::Util::PathHelper.join(ChefConfig::Config.etc_chef_dir(windows: true), filename)
+      end
+
       def define_resource_requirements
         requirements.assert(:install, :upgrade).each do |a|
           a.assertion do
@@ -133,16 +155,14 @@ class Chef
           if new_resource.download_url
             Chef::Log.info("Using custom download URL for Chocolatey installation: #{new_resource.download_url}")
             # If it's a PowerShell script, execute it directly (original behavior)
-            if new_resource.download_url.downcase.end_with?(".ps1")
+            if download_url_script?
               powershell_exec("Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('#{new_resource.download_url}'))").error!
             else
               # Assume it's a direct link to a nupkg or other file and handle accordingly
-              chef_dir = ChefConfig::Config.etc_chef_dir(windows: true)
+              destination = download_destination
 
-              # Let PowerShell handle the filename - it will use the server's suggested filename
-              # from Content-Disposition header, or fall back to the URL path
-              powershell_exec("Invoke-WebRequest '#{new_resource.download_url}' -OutFile '#{chef_dir}'").error!
-              Chef::Log.info("Downloaded file from #{new_resource.download_url} to #{chef_dir}")
+              powershell_exec("Invoke-WebRequest '#{new_resource.download_url}' -OutFile '#{destination}'").error!
+              Chef::Log.info("Downloaded file from #{new_resource.download_url} to #{destination}")
             end
           else
             powershell_exec("Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))").error!
@@ -151,11 +171,9 @@ class Chef
       end
 
       action :upgrade, description: "Upgrades the Chocolatey package manager" do
-        if new_resource.chocolatey_version
-          proposed_version = Gem::Version.new(new_resource.chocolatey_version)
-        else
-          proposed_version = nil
-        end
+        proposed_version = if new_resource.chocolatey_version
+                             Gem::Version.new(new_resource.chocolatey_version)
+                           end
 
         if new_resource.download_url
           powershell_exec("Set-Item -path env:ChocolateyDownloadUrl -Value #{new_resource.download_url}")
@@ -193,7 +211,7 @@ class Chef
       end
 
       action :uninstall, description: "Uninstall Chocolatey package manager" do
-        path = "c:\\programdata\\chocolatey\\bin"
+        path = 'c:\\programdata\\chocolatey\\bin'
         if File.exists?(path)
           converge_by("Uninstall Choco") do
             powershell_code = <<~CODE
@@ -219,4 +237,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/resource/chocolatey_package.rb

@@ -59,7 +59,7 @@ class Chef
         introduced: "15.3",
         description: "The username to authenticate feeds."
 
-      property :password, String,
+      property :password, String, sensitive: true,
         introduced: "15.3",
         description: "The password to authenticate to the source."
 

data/lib/chef/resource/chocolatey_source.rb

@@ -41,42 +41,42 @@ class Chef
       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."
+        description: "An optional property to set the source name if it differs from the resource block's name."
 
       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."
+        description: "Whether or not to bypass the system's proxy settings to access the source."
 
       property :admin_only, [TrueClass, FalseClass], default: false,
-               description: "Whether or not to set the source to be accessible to only admins.",
-               introduced: "15.1"
+        description: "Whether or not to set the source to be accessible to only admins.",
+        introduced: "15.1"
 
       property :allow_self_service, [TrueClass, FalseClass], default: false,
-               description: "Whether or not to set the source to be used for self service.",
-               introduced: "15.1"
+        description: "Whether or not to set the source to be used for self service.",
+        introduced: "15.1"
 
       property :priority, Integer, default: 0,
-               description: "The priority level of the source."
+        description: "The priority level of the source."
 
       property :disabled, [TrueClass, FalseClass], default: false, desired_state: false, skip_docs: true
 
       property :username, String,
-               description: "The username to use when authenticating against the source",
-               introduced: "17.7"
+        description: "The username to use when authenticating against the source",
+        introduced: "17.7"
 
       property :password, String, sensitive: true, desired_state: false,
-               description: "The password to use when authenticating against the source",
-               introduced: "17.7"
+        description: "The password to use when authenticating against the source",
+        introduced: "17.7"
 
       property :cert, String,
-               description: "The certificate to use when authenticating against the source",
-               introduced: "17.7"
+        description: "The certificate to use when authenticating against the source",
+        introduced: "17.7"
 
       property :cert_password, String, sensitive: true, desired_state: false,
-               description: "The password for the certificate to use when authenticating against the source",
-               introduced: "17.7"
+        description: "The password for the certificate to use when authenticating against the source",
+        introduced: "17.7"
 
       load_current_value do
         element = fetch_source_element(source_name)

data/lib/chef/resource/cron/_cron_shared.rb

@@ -87,8 +87,6 @@ property :time_out, Hash,
     end
   }
 
-private
-
 # Convert weekday input value into crontab format that
 # could be written in the crontab
 # @return [Integer, String] A weekday formed as per the user inputs.