chef 15.1.36-universal-mingw32 → 15.2.20-universal-mingw32

data/lib/chef/resource/apt_package.rb

@@ -28,21 +28,21 @@ class Chef
       description "Use the apt_package resource to manage packages on Debian and Ubuntu platforms."
 
       property :default_release, String,
-               description: "The default release. For example: stable.",
-               desired_state: false
+        description: "The default release. For example: stable.",
+        desired_state: false
 
       property :overwrite_config_files, [TrueClass, FalseClass],
-               introduced: "14.0",
-               description: "Overwrite existing configuration files with those supplied by the package, if prompted by APT.",
-               default: false
+        introduced: "14.0",
+        description: "Overwrite existing configuration files with those supplied by the package, if prompted by APT.",
+        default: false
 
       property :response_file, String,
-               description: "The direct path to the file used to pre-seed a package.",
-               desired_state: false
+        description: "The direct path to the file used to pre-seed a package.",
+        desired_state: false
 
       property :response_file_variables, Hash,
-               description: "A Hash of response file variables in the form of {'VARIABLE' => 'VALUE'}.",
-               default: lazy { Hash.new }, desired_state: false
+        description: "A Hash of response file variables in the form of {'VARIABLE' => 'VALUE'}.",
+        default: lazy { {} }, desired_state: false
 
     end
   end

data/lib/chef/resource/apt_preference.rb

@@ -29,21 +29,21 @@ class Chef
       introduced "13.3"
 
       property :package_name, String,
-               name_property: true,
-               description: "An optional property to set the package name if it differs from the resource block's name.",
-               regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/],
-               validation_message: "The provided package name is not valid. Package names can only contain alphanumeric characters as well as _, -, +, or *!"
+        name_property: true,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/],
+        validation_message: "The provided package name is not valid. Package names can only contain alphanumeric characters as well as _, -, +, or *!"
 
       property :glob, String,
-               description: "Pin by glob() expression or with regular expressions surrounded by /."
+        description: "Pin by glob() expression or with regular expressions surrounded by /."
 
       property :pin, String,
-               description: "The package version or repository to pin.",
-               required: true
+        description: "The package version or repository to pin.",
+        required: true
 
       property :pin_priority, [String, Integer],
-               description: "Sets the Pin-Priority for a package.",
-               required: true
+        description: "Sets the Pin-Priority for a package.",
+        required: true
 
       default_action :add
       allowed_actions :add, :remove

data/lib/chef/resource/apt_repository.rb

@@ -27,57 +27,120 @@ class Chef
       description "Use the apt_repository resource to specify additional APT repositories. Adding a new repository will update the APT package cache immediately."
       introduced "12.9"
 
+      examples <<~DOC
+        Add repository with basic settings
+         ```ruby
+        apt_repository 'nginx' do
+          uri        'http://nginx.org/packages/ubuntu/'
+          components ['nginx']
+        end
+        ```
+         Enable Ubuntu multiverse repositories
+         ```ruby
+        apt_repository 'security-ubuntu-multiverse' do
+          uri          'http://security.ubuntu.com/ubuntu'
+          distribution 'trusty-security'
+          components   ['multiverse']
+          deb_src      true
+        end
+        ```
+         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
+        apt_repository 'juju' do
+          uri 'http://ppa.launchpad.net/juju/stable/ubuntu'
+          components ['main']
+          distribution 'trusty'
+          key 'C8068B11'
+          keyserver 'keyserver.ubuntu.com'
+          action :add
+          deb_src true
+        end
+        ```
+         Add repository that requires multiple keys to authenticate packages
+         ```ruby
+        apt_repository 'rundeck' do
+          uri 'https://dl.bintray.com/rundeck/rundeck-deb'
+          distribution '/'
+          key ['379CE192D401AB61', 'http://rundeck.org/keys/BUILD-GPG-KEY-Rundeck.org.key']
+          keyserver 'keyserver.ubuntu.com'
+          action :add
+        end
+        ```
+         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'
+          distribution 'precise-cdh4'
+          components   ['contrib']
+          key          'http://archive.cloudera.com/debian/archive.key'
+        end
+        ```
+         Remove a repository from the list
+         ```ruby
+        apt_repository 'zenoss' do
+          action :remove
+        end
+        ```
+      DOC
+
       # There's a pile of [ String, nil, FalseClass ] types in these properties.
       # This goes back to Chef 12 where String didn't default to nil and we had to do
       # it ourself, which required allowing that type as well. We've cleaned up the
       # defaults, but since we allowed users to pass nil here we need to continue
       # to allow that so don't refactor this however tempting it is
       property :repo_name, String,
-               regex: [/^[^\/]+$/],
-               description: "An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces.",
-               validation_message: "repo_name property cannot contain a forward slash '/'",
-               introduced: "14.1", name_property: true
+        regex: [%r{^[^/]+$}],
+        description: "An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces.",
+        validation_message: "repo_name property cannot contain a forward slash '/'",
+        introduced: "14.1", name_property: true
 
       property :uri, String,
-               description: "The base of the Debian distribution."
+        description: "The base of the Debian distribution."
 
       property :distribution, [ String, nil, FalseClass ],
-               description: "Usually a distribution's codename, such as trusty, xenial or bionic. Default value: the codename of the node's distro.",
-               default: lazy { node["lsb"]["codename"] }, default_description: "The LSB codename of the host such as 'bionic'."
+        description: "Usually a distribution's codename, such as trusty, xenial or bionic. Default value: the codename of the node's distro.",
+        default: lazy { node["lsb"]["codename"] }, default_description: "The LSB codename of the host such as 'bionic'."
 
       property :components, Array,
-               description: "Package groupings, such as 'main' and 'stable'.",
-               default: lazy { [] }
+        description: "Package groupings, such as 'main' and 'stable'.",
+        default: lazy { [] }
 
       property :arch, [String, nil, FalseClass],
-               description: "Constrain packages to a particular CPU architecture such as 'i386' or 'amd64'."
+        description: "Constrain packages to a particular CPU architecture such as 'i386' or 'amd64'."
 
       property :trusted, [TrueClass, FalseClass],
-               description: "Determines whether you should treat all packages from this repository as authenticated regardless of signature.",
-               default: false
+        description: "Determines whether you should treat all packages from this repository as authenticated regardless of signature.",
+        default: false
 
       property :deb_src, [TrueClass, FalseClass],
-               description: "Determines whether or not to add the repository as a source repo as well.",
-               default: false
+        description: "Determines whether or not to add the repository as a source repo as well.",
+        default: false
 
       property :keyserver, [String, nil, FalseClass],
-               description: "The GPG keyserver where the key for the repo should be retrieved.",
-               default: "keyserver.ubuntu.com"
+        description: "The GPG keyserver where the key for the repo should be retrieved.",
+        default: "keyserver.ubuntu.com"
 
       property :key, [String, Array, nil, FalseClass],
-               description: "If a keyserver is provided, this is assumed to be the fingerprint; otherwise it can be either the URI of GPG key for the repo, or a cookbook_file.",
-               default: lazy { [] }, coerce: proc { |x| x ? Array(x) : x }
+        description: "If a keyserver is provided, this is assumed to be the fingerprint; otherwise it can be either the URI of GPG key for the repo, or a cookbook_file.",
+        default: lazy { [] }, coerce: proc { |x| x ? Array(x) : x }
 
       property :key_proxy, [String, nil, FalseClass],
-               description: "If set, a specified proxy is passed to GPG via http-proxy=."
+        description: "If set, a specified proxy is passed to GPG via http-proxy=."
 
       property :cookbook, [String, nil, FalseClass],
-               description: "If key should be a cookbook_file, specify a cookbook where the key is located for files/default. Default value is nil, so it will use the cookbook where the resource is used.",
-               desired_state: false
+        description: "If key should be a cookbook_file, specify a cookbook where the key is located for files/default. Default value is nil, so it will use the cookbook where the resource is used.",
+        desired_state: false
 
       property :cache_rebuild, [TrueClass, FalseClass],
-               description: "Determines whether to rebuild the APT package cache.",
-               default: true, desired_state: false
+        description: "Determines whether to rebuild the APT package cache.",
+        default: true, desired_state: false
 
       default_action :add
       allowed_actions :add, :remove

data/lib/chef/resource/apt_update.rb

@@ -31,8 +31,8 @@ class Chef
       property :name, String, default: ""
 
       property :frequency, Integer,
-                description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.",
-                default: 86_400
+        description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.",
+        default: 86_400
 
       default_action :periodic
       allowed_actions :update, :periodic

data/lib/chef/resource/archive_file.rb

@@ -32,31 +32,31 @@ class Chef
       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."
 
       property :path, String,
-               name_property: true,
-               coerce: proc { |f| ::File.expand_path(f) },
-               description: "An optional property to set the file path to the archive to extract if it differs from the resource block's name."
+        name_property: true,
+        coerce: proc { |f| ::File.expand_path(f) },
+        description: "An optional property to set the file path to the archive to extract if it differs from the resource block's name."
 
       property :owner, String,
-               description: "The owner of the extracted files."
+        description: "The owner of the extracted files."
 
       property :group, String,
-               description: "The group of the extracted files."
+        description: "The group of the extracted files."
 
       property :mode, [String, Integer],
-               description: "The mode of the extracted files.",
-               default: "755"
+        description: "The mode of the extracted files.",
+        default: "755"
 
       property :destination, String,
-               description: "The file path to extract the archive file to.",
-               required: true
+        description: "The file path to extract the archive file to.",
+        required: true
 
       property :options, [Array, Symbol],
-               description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default, this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.",
-               default: lazy { [:time] }
+        description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default, this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.",
+        default: lazy { [:time] }
 
       property :overwrite, [TrueClass, FalseClass, :auto],
-               description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
-               default: false
+        description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
+        default: false
 
       # backwards compatibility for the legacy cookbook names
       alias_method :extract_options, :options

data/lib/chef/resource/build_essential.rb

@@ -29,8 +29,8 @@ class Chef
       property :name, String, default: ""
 
       property :compile_time, [TrueClass, FalseClass],
-               description: "Install the build essential packages at compile time.",
-               default: false, desired_state: false
+        description: "Install the build essential packages at compile time.",
+        default: false, desired_state: false
 
       action :install do
 
@@ -79,7 +79,7 @@ class Chef
           # Per OmniOS documentation, the gcc bin dir isn't in the default
           # $PATH, so add it to the running process environment
           # http://omnios.omniti.com/wiki.php/DevEnv
-          ENV["PATH"] = "#{ENV['PATH']}:/opt/gcc-4.7.2/bin"
+          ENV["PATH"] = "#{ENV["PATH"]}:/opt/gcc-4.7.2/bin"
         when "solaris2"
           package "autoconf"
           package "automake"
@@ -110,7 +110,7 @@ class Chef
           package %w{ gcc48 gcc48-c++ } if node["platform_version"].to_i < 12
         else
           Chef::Log.warn <<-EOH
-        The build_essential resource does not currently support the '#{node['platform_family']}'
+        The build_essential resource does not currently support the '#{node["platform_family"]}'
         platform family. Skipping...
           EOH
         end
@@ -134,6 +134,7 @@ class Chef
       # @return [void]
       def after_created
         return unless compile_time
+
         Array(action).each do |action|
           run_action(action)
         end

data/lib/chef/resource/cab_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Vasundhara Jagdale (<vasundhara.jagdale@msystechnologies.com>)
-# Copyright:: Copyright 2008-2016, Chef Software, Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,14 +32,14 @@ class Chef
 
       allowed_actions :install, :remove
 
-      property  :source, String,
-                description: "The local file path or URL for the CAB package.",
-                coerce: (proc do |s|
-                  unless s.nil?
-                    uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
-                  end
-                end),
-                default: lazy { |r| r.package_name }, default_description: "The package name."
+      property :source, String,
+        description: "The local file path or URL for the CAB package.",
+        coerce: (proc do |s|
+          unless s.nil?
+            uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
+          end
+        end),
+        default: lazy { package_name }, default_description: "The package name."
     end
   end
 end

data/lib/chef/resource/chef_gem.rb

@@ -37,14 +37,14 @@ class Chef
     class ChefGem < Chef::Resource::Package::GemPackage
       resource_name :chef_gem
 
-      property :gem_binary, default: "#{RbConfig::CONFIG['bindir']}/gem", default_description: "Chef's built-in gem binary.",
+      property :gem_binary, default: "#{RbConfig::CONFIG["bindir"]}/gem", default_description: "Chef's built-in gem binary.",
                             description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the #{Chef::Dist::CLIENT} will be installed.",
                             callbacks: {
-                 "The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG['bindir']}/gem" },
+                 "The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG["bindir"]}/gem" },
                }
       property :compile_time, [TrueClass, FalseClass],
-               description: "Controls the phase during which a gem is installed on a node. Set to 'true' to install a gem while the resource collection is being built (the 'compile phase'). Set to 'false' to install a gem while the #{Chef::Dist::CLIENT} is configuring the node (the 'converge phase').",
-               default: false, desired_state: false
+        description: "Controls the phase during which a gem is installed on a node. Set to 'true' to install a gem while the resource collection is being built (the 'compile phase'). Set to 'false' to install a gem while the #{Chef::Dist::CLIENT} is configuring the node (the 'converge phase').",
+        default: false, desired_state: false
 
       # force the resource to compile time if the compile time property has been set
       #

data/lib/chef/resource/chef_handler.rb

@@ -28,19 +28,19 @@ class Chef
       introduced "14.0"
 
       property :class_name, String,
-               description: "The name of the handler class (can be module name-spaced).",
-               name_property: true
+        description: "The name of the handler class. This can be module name-spaced.",
+        name_property: true
 
       property :source, String,
-               description: "The full path to the handler file. Can also be a gem path if the handler ships as part of a Ruby gem."
+        description: "The full path to the handler file. Can also be a gem path if the handler ships as part of a Ruby gem."
 
       property :arguments, [Array, Hash],
-               description: "Arguments to pass the handler's class initializer.",
-               default: lazy { [] }
+        description: "Arguments to pass the handler's class initializer.",
+        default: lazy { [] }
 
       property :type, Hash,
-               description: "The type of handler to register as, i.e. :report, :exception or both.",
-               default: { report: true, exception: true }
+        description: "The type of handler to register as, i.e. :report, :exception or both.",
+        default: { report: true, exception: true }
 
       # supports means a different thing in chef-land so we renamed it but
       # wanted to make sure we didn't break the world
@@ -67,6 +67,7 @@ class Chef
 
         new_resource.type.each do |type, enable|
           next unless enable
+
           register_handler(type, handler)
         end
       end

data/lib/chef/resource/chocolatey_config.rb

@@ -26,7 +26,7 @@ class Chef
                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."
+        description: "The value to set."
 
       load_current_value do
         current_val = fetch_config_element(config_key)
@@ -40,7 +40,7 @@ class Chef
       # @return [String] the element's value field
       def fetch_config_element(id)
         require "rexml/document" unless defined?(REXML::Document)
-        config_file = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\config\\chocolatey.config"
+        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))
@@ -72,7 +72,7 @@ class Chef
         # @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 = "#{ENV["ALLUSERSPROFILE"]}\\chocolatey\\bin\\choco config #{action} --name #{new_resource.config_key}"
           cmd << " --value #{new_resource.value}" if action == "set"
           cmd
         end

data/lib/chef/resource/chocolatey_feature.rb

@@ -39,7 +39,7 @@ class Chef
       # @return [String] the element's value field
       def fetch_feature_element(name)
         require "rexml/document" unless defined?(REXML::Document)
-        config_file = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\config\\chocolatey.config"
+        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))
@@ -71,7 +71,7 @@ class Chef
         # @param [String] action the name of the action to perform
         # @return [String] the choco feature command string
         def choco_cmd(action)
-          cmd = "#{ENV['ALLUSERSPROFILE']}\\chocolatey\\bin\\choco feature #{action} --name #{new_resource.feature_name}"
+          cmd = "#{ENV["ALLUSERSPROFILE"]}\\chocolatey\\bin\\choco feature #{action} --name #{new_resource.feature_name}"
           cmd
         end
       end

data/lib/chef/resource/chocolatey_package.rb

@@ -31,20 +31,20 @@ class Chef
 
       # windows can't take Array options yet
       property :options, String,
-                description: "One (or more) additional options that are passed to the command."
+        description: "One (or more) additional options that are passed to the command."
 
       property :package_name, [String, Array],
-                description: "The name of the package. Default value: the name of the resource block.",
-                coerce: proc { |x| [x].flatten }
+        description: "The name of the package. Default value: the name of the resource block.",
+        coerce: proc { |x| [x].flatten }
 
       property :version, [String, Array],
-                description: "The version of a package to be installed or upgraded.",
-                coerce: proc { |x| [x].flatten }
+        description: "The version of a package to be installed or upgraded.",
+        coerce: proc { |x| [x].flatten }
 
       property :returns, [Integer, Array],
-                description: "The exit code(s) returned a chocolatey package that indicate success.",
-                default: [ 0 ], desired_state: false,
-                introduced: "12.18"
+        description: "The exit code(s) returned a chocolatey package that indicate success.",
+        default: [ 0 ], desired_state: false,
+        introduced: "12.18"
     end
   end
 end