chef 14.15.6 → 18.1.0

data/lib/chef/resource/windows_workgroup.rb

@@ -15,40 +15,55 @@
 # limitations under the License.
 #
 
-require "chef/resource"
-require "chef/mixin/powershell_out"
+require_relative "../resource"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
     class WindowsWorkgroup < Chef::Resource
-      resource_name :windows_workgroup
-      provides :windows_workgroup
 
-      include Chef::Mixin::PowershellOut
+      provides :windows_workgroup
 
-      description "Use the windows_workgroup resource to join or change the workgroup of a Windows host."
+      description "Use the **windows_workgroup** resource to join or change the workgroup of a Windows host."
       introduced "14.5"
+      examples <<~DOC
+      **Join a workgroup**:
+
+      ```ruby
+      windows_workgroup 'myworkgroup'
+      ```
+
+      **Join a workgroup using a specific user**:
+
+      ```ruby
+      windows_workgroup 'myworkgroup' do
+        user 'Administrator'
+        password 'passw0rd'
+      end
+      ```
+      DOC
 
       property :workgroup_name, String,
-               description: "An optional property to set the workgroup name if it differs from the resource block's name.",
-               validation_message: "The 'workgroup_name' property must not contain spaces.",
-               regex: /^\S*$/, # no spaces
-               name_property: true
+        description: "An optional property to set the workgroup name if it differs from the resource block's name.",
+        validation_message: "The 'workgroup_name' property must not contain spaces.",
+        regex: /^\S*$/, # no spaces
+        name_property: true
 
       property :user, String,
-               description: "The local administrator user to use to change the workgroup. Required if using the password property.",
-               desired_state: false
+        description: "The local administrator user to use to change the workgroup. Required if using the `password` property.",
+        desired_state: false
 
       property :password, String,
-               description: "The password for the local administrator user. Required if using the user property.",
-               desired_state: false
+        description: "The password for the local administrator user. Required if using the `user` property.",
+        sensitive: true,
+        desired_state: false
 
       property :reboot, Symbol,
-               equal_to: [:never, :request_reboot, :reboot_now],
-               validation_message: "The reboot property accepts :immediate (reboot as soon as the resource completes), :delayed (reboot once the Chef run completes), and :never (Don't reboot)",
-               description: "Controls the system reboot behavior post workgroup joining. Reboot immediately, after the Chef run completes, or never. Note that a reboot is necessary for changes to take effect.",
-               coerce: proc { |x| clarify_reboot(x) },
-               default: :immediate, desired_state: false
+        equal_to: %i{never request_reboot reboot_now},
+        validation_message: "The reboot property accepts :immediate (reboot as soon as the resource completes), :delayed (reboot once the #{ChefUtils::Dist::Infra::PRODUCT} run completes), and :never (Don't reboot)",
+        description: "Controls the system reboot behavior post workgroup joining. Reboot immediately, after the #{ChefUtils::Dist::Infra::PRODUCT} run completes, or never. Note that a reboot is necessary for changes to take effect.",
+        coerce: proc { |x| clarify_reboot(x) },
+        default: :immediate, desired_state: false
 
       # This resource historically took `:immediate` and `:delayed` as arguments to the reboot property but then
       # tried to shove that straight to the `reboot` resource which objected strenuously. We need to convert these
@@ -67,16 +82,16 @@ class Chef
       end
 
       # define this again so we can default it to true. Otherwise failures print the password
+      # FIXME: this should now be unnecessary with the password property itself marked sensitive?
       property :sensitive, [TrueClass, FalseClass],
-               default: true, desired_state: false
+        default: true, desired_state: false
 
-      action :join do
-        description "Update the workgroup."
+      action :join, description: "Update the workgroup." do
 
         unless workgroup_member?
           converge_by("join workstation workgroup #{new_resource.workgroup_name}") do
-            ps_run = powershell_out(join_command)
-            raise "Failed to join the workgroup #{new_resource.workgroup_name}: #{ps_run.stderr}}" if ps_run.error?
+            ps_run = powershell_exec(join_command)
+            raise "Failed to join the workgroup #{new_resource.workgroup_name}: #{ps_run.errors}}" if ps_run.error?
 
             unless new_resource.reboot == :never
               reboot "Reboot to join workgroup #{new_resource.workgroup_name}" do
@@ -102,9 +117,10 @@ class Chef
 
         # @return [Boolean] is the node a member of the workgroup specified in the resource
         def workgroup_member?
-          node_workgroup = powershell_out!("(Get-WmiObject -Class Win32_ComputerSystem).Workgroup")
+          node_workgroup = powershell_exec!("(Get-WmiObject -Class Win32_ComputerSystem).Workgroup")
           raise "Failed to determine if system already a member of workgroup #{new_resource.workgroup_name}" if node_workgroup.error?
-          node_workgroup.stdout.downcase.strip == new_resource.workgroup_name.downcase
+
+          String(node_workgroup.result).downcase.strip == new_resource.workgroup_name.downcase
         end
       end
     end

data/lib/chef/resource/yum_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: AJ Christensen (<aj@chef.io>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,62 +16,145 @@
 # limitations under the License.
 #
 
-require "chef/resource/package"
+require_relative "package"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
     class YumPackage < Chef::Resource::Package
-      resource_name :yum_package
-      provides :package, platform_family: %w{rhel fedora amazon}
 
-      description "Use the yum_package resource to install, upgrade, and remove packages with Yum"\
-                  " for the Red Hat and CentOS platforms. The yum_package resource is able to resolve"\
-                  " provides data for packages much like Yum 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."
+      provides :yum_package
+      provides :package, platform_family: "fedora_derived"
+
+      description "Use the **yum_package** resource to install, upgrade, and remove packages with Yum for the Red Hat and CentOS platforms. The yum_package resource is able to resolve `provides` data for packages much like Yum 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. Note: Support for using file names to install packages (as in `yum_package '/bin/sh'`) is not available because the volume of data required to parse for this is excessive."
+      examples <<~DOC
+        **Install an exact version**:
+
+        ```ruby
+        yum_package 'netpbm = 10.35.58-8.el8'
+        ```
+
+        **Install a minimum version**:
+
+        ```ruby
+        yum_package 'netpbm >= 10.35.58-8.el8'
+        ```
+
+        **Install a minimum version using the default action**:
+
+        ```ruby
+        yum_package 'netpbm'
+        ```
+
+        **Install a version without worrying about the exact release**:
+
+        ```ruby
+        yum_package 'netpbm-10.35*'
+        ```
+
+
+        **To install a package**:
+
+        ```ruby
+        yum_package 'netpbm' do
+          action :install
+        end
+        ```
+
+        **To install a partial minimum version**:
+
+        ```ruby
+        yum_package 'netpbm >= 10'
+        ```
+
+        **To install a specific architecture**:
+
+        ```ruby
+        yum_package 'netpbm' do
+          arch 'i386'
+        end
+        ```
+
+        or:
+
+        ```ruby
+        yum_package 'netpbm.x86_64'
+        ```
+
+        **To install a specific version-release**
+
+        ```ruby
+        yum_package 'netpbm' do
+          version '10.35.58-8.el8'
+        end
+        ```
+
+        **Handle cookbook_file and yum_package resources in the same recipe**:
+
+        When a **cookbook_file** resource and a **yum_package** resource are
+        both called from within the same recipe, use the `flush_cache` attribute
+        to dump the in-memory Yum cache, and then use the repository immediately
+        to ensure that the correct package is installed:
+
+        ```ruby
+        cookbook_file '/etc/yum.repos.d/custom.repo' do
+          source 'custom'
+          mode '0755'
+        end
+
+        yum_package 'pkg-that-is-only-in-custom-repo' do
+          action :install
+          flush_cache [ :before ]
+        end
+        ```
+      DOC
+
+      allowed_actions :install, :upgrade, :remove, :purge, :lock, :unlock
 
       # XXX: the coercions here are due to the provider promiscuously updating the properties on the
       # new_resource which causes immutable modification exceptions when passed an immutable node array.
       #
       # <lecture>
       # THIS is why updating the new_resource in a provider is so terrible, and is equivalent to methods scribbling over
-      # its own arguments as unintended side-effects (and why functional languages that don't allow modifcations
+      # its own arguments as unintended side-effects (and why functional languages that don't allow modifications
       # of variables eliminate entire classes of bugs).
       # </lecture>
       property :package_name, [ String, Array ],
-               description: "One of the following: the name of a package, the name of a package and its architecture, the name of a dependency.",
-               identity: true, coerce: proc { |x| x.is_a?(Array) ? x.to_a : x }
+        description: "One of the following: the name of a package, the name of a package and its architecture, the name of a dependency.",
+        identity: true, coerce: proc { |x| x.is_a?(Array) ? x.to_a : x }
 
       property :version, [ String, Array ],
-               description: "The version of a package to be installed or upgraded. This property is ignored when using the ':upgrade' action.",
-               coerce: proc { |x| x.is_a?(Array) ? x.to_a : x }
+        description: "The version of a package to be installed or upgraded. This property is ignored when using the `:upgrade` action.",
+        coerce: proc { |x| x.is_a?(Array) ? x.to_a : x }
 
       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.is_a?(Array) ? x.to_a : x }
+        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.is_a?(Array) ? x.to_a : x }
 
       property :flush_cache, Hash,
-               description: "Flush the in-memory cache before or after a Yum operation that installs, upgrades, or removes a package. Accepts a Hash in the form: { :before => true/false, :after => true/false } or an Array in the form [ :before, :after ].\nYum 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
-               }
-
-      property :allow_downgrade, [ true, false ],
-               description: "Downgrade a package to satisfy requested version requirements.",
-               default: false
-
-      property :yum_binary, String
+        description: "Flush the in-memory cache before or after a Yum operation that installs, upgrades, or removes a package. Accepts a Hash in the form: { :before => true/false, :after => true/false } or an Array in the form [ :before, :after ].\nYum automatically synchronizes remote metadata to a local cache. The #{ChefUtils::Dist::Infra::CLIENT} creates a copy of the local cache, and then stores it in-memory during the #{ChefUtils::Dist::Infra::CLIENT} run. The in-memory cache allows packages to be installed during the #{ChefUtils::Dist::Infra::CLIENT} run without the need to continue synchronizing the remote metadata to the local cache while the #{ChefUtils::Dist::Infra::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
+        }
+
+      property :allow_downgrade, [ TrueClass, FalseClass ],
+        description: "Allow downgrading a package to satisfy requested version requirements.",
+        default: true,
+        desired_state: false
+
+      property :yum_binary, String,
+        description: "The path to the yum binary."
     end
   end
 end

data/lib/chef/resource/yum_repository.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) 2016-2017 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,164 +16,190 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class YumRepository < Chef::Resource
-      resource_name :yum_repository
+
       provides(:yum_repository) { true }
 
-      description "Use the yum_repository resource to manage a Yum repository configuration"\
-                  " file located at /etc/yum.repos.d/repositoryid.repo on the local machine."\
-                  " This configuration file specifies which repositories to reference, how to"\
-                  " handle cached data, etc."
+      description "Use the **yum_repository** resource to manage a Yum repository configuration file located at `/etc/yum.repos.d/repositoryid.repo` on the local machine. This configuration file specifies which repositories to reference, how to handle cached data, etc."
       introduced "12.14"
+      examples <<~DOC
+      **Add an internal company repository**:
+
+      ```ruby
+      yum_repository 'OurCo' do
+        description 'OurCo yum repository'
+        mirrorlist 'http://artifacts.ourco.org/mirrorlist?repo=ourco-8&arch=$basearch'
+        gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-8'
+        action :create
+      end
+      ```
+
+      **Delete a repository**:
+
+      ```ruby
+      yum_repository 'CentOS-Media' do
+        action :delete
+      end
+      ```
+      DOC
 
       # http://linux.die.net/man/5/yum.conf as well as
       # http://dnf.readthedocs.io/en/latest/conf_ref.html
+      property :reposdir, String,
+        description: "The directory where the Yum repository files should be stored",
+        default: "/etc/yum.repos.d/",
+        introduced: "16.9"
+
       property :baseurl, [String, Array],
-               description: "URL to the directory where the Yum repository's 'repodata' directory lives. Can be an http://, https:// or a ftp:// URL. You can specify multiple URLs in one baseurl statement."
+        description: "URL to the directory where the Yum repository's `repodata` directory lives. Can be an `http://`, `https://` or a `ftp://` URLs. You can specify multiple URLs in one `baseurl` statement."
 
       property :clean_headers, [TrueClass, FalseClass],
-               description: "Specifies whether you want to purge the package data files that are downloaded from a Yum repository and held in a cache directory.",
-               deprecated: true,
-               default: false # deprecated
+        description: "Specifies whether you want to purge the package data files that are downloaded from a Yum repository and held in a cache directory.",
+        deprecated: true,
+        default: false
 
       property :clean_metadata, [TrueClass, FalseClass],
-               description: "Specifies whether you want to purge all of the packages downloaded from a Yum repository and held in a cache directory.",
-               default: true
+        description: "Specifies whether you want to purge all of the packages downloaded from a Yum repository and held in a cache directory.",
+        default: true
 
       property :cost, String, regex: /^\d+$/,
                description: "Relative cost of accessing this repository. Useful for weighing one repo's packages as greater/less than any other.",
                validation_message: "The cost property must be a numeric value!"
 
       property :description, String,
-               description: "Descriptive name for the repository channel and maps to the 'name' parameter in a repository .conf.",
-               default: "Yum Repository"
+        description: "Descriptive name for the repository channel and maps to the 'name' parameter in a repository .conf.",
+        default: "Yum Repository"
 
       property :enabled, [TrueClass, FalseClass],
-               description: "Specifies whether or not Yum should use this repository.",
-               default: true
+        description: "Specifies whether or not Yum should use this repository.",
+        default: true
 
       property :enablegroups, [TrueClass, FalseClass],
-               description: "Specifies whether Yum will allow the use of package groups for this repository."
+        description: "Specifies whether Yum will allow the use of package groups for this repository."
 
       property :exclude, String,
-               description: "List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. * and ?) are allowed."
+        description: "List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. * and ?) are allowed."
 
       property :failovermethod, String,
-               description: "Method to determine how to switch to a new server if the current one fails, which can either be ``roundrobin`` or ``priority``. ``roundrobin`` randomly selects a URL out of the list of URLs to start with and proceeds through each of them as it encounters a failure contacting the host. ``priority`` starts from the first ``baseurl`` listed and reads through them sequentially.",
-               equal_to: %w{priority roundrobin}
+        description: "Method to determine how to switch to a new server if the current one fails, which can either be `roundrobin` or `priority`. `roundrobin` randomly selects a URL out of the list of URLs to start with and proceeds through each of them as it encounters a failure contacting the host. `priority` starts from the first `baseurl` listed and reads through them sequentially.",
+        equal_to: %w{priority roundrobin}
 
       property :fastestmirror_enabled, [TrueClass, FalseClass],
-               description: "Specifies whether to use the fastest mirror from a repository configuration when more than one mirror is listed in that configuration."
+        description: "Specifies whether to use the fastest mirror from a repository configuration when more than one mirror is listed in that configuration."
 
       property :gpgcheck, [TrueClass, FalseClass],
-               description: "Specifies whether or not Yum should perform a GPG signature check on the packages received from a repository.",
-               default: true
+        description: "Specifies whether or not Yum should perform a GPG signature check on the packages received from a repository.",
+        default: true
 
       property :gpgkey, [String, Array],
-               description: "URL pointing to the ASCII-armored GPG key file for the repository. This is used if Yum needs a public key to verify a package and the required key hasn't been imported into the RPM database. If this option is set, Yum will automatically import the key from the specified URL. Multiple URLs may be specified in the same manner as the baseurl option. If a GPG key is required to install a package from a repository, all keys specified for that repository will be installed.\nMultiple URLs may be specified in the same manner as the baseurl option. If a GPG key is required to install a package from a repository, all keys specified for that repository will be installed."
+        description: "URL pointing to the ASCII-armored GPG key file for the repository. This is used if Yum needs a public key to verify a package and the required key hasn't been imported into the RPM database. If this option is set, Yum will automatically import the key from the specified URL. Multiple URLs may be specified in the same manner as the baseurl option. If a GPG key is required to install a package from a repository, all keys specified for that repository will be installed.\nMultiple URLs may be specified in the same manner as the baseurl option. If a GPG key is required to install a package from a repository, all keys specified for that repository will be installed."
 
       property :http_caching, String, equal_to: %w{packages all none},
-               description: "Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does. This option can take the following values: all (all HTTP downloads should be cached), packages (only RPM package downloads should be cached, but not repository metadata downloads), or none (no HTTP downloads should be cached)"
+               description: "Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does. This option can take the following values:\n - `all` means all HTTP downloads should be cached\n - `packages` means only RPM package downloads should be cached, but not repository metadata downloads\n - `none` means no HTTP downloads should be cached.\n\nThe default value of `all` is recommended unless you are experiencing caching related issues."
 
       property :include_config, String,
-               description: "An external configuration file using the format 'url://to/some/location'."
+        description: "An external configuration file using the format `url://to/some/location`."
 
       property :includepkgs, String,
-               description: "Inverse of exclude property. This is a list of packages you want to use from a repository. If this option lists only one package then that is all Yum will ever see from the repository."
+        description: "Inverse of exclude property. This is a list of packages you want to use from a repository. If this option lists only one package then that is all Yum will ever see from the repository."
 
       property :keepalive, [TrueClass, FalseClass],
-               description: "Determines whether or not HTTP/1.1 ``keep-alive`` should be used with this repository."
+        description: "Determines whether or not HTTP/1.1 `keep-alive` should be used with this repository."
 
       property :make_cache, [TrueClass, FalseClass],
-               description: "Determines whether package files downloaded by Yum stay in cache directories. By using cached data, you can carry out certain operations without a network connection.",
-               default: true
+        description: "Determines whether package files downloaded by Yum stay in cache directories. By using cached data, you can carry out certain operations without a network connection.",
+        default: true
+
+      property :makecache_fast, [TrueClass, FalseClass],
+        description: "if make_cache is true, uses `yum makecache fast`, which downloads only the minimum amount of data required. Useful over slower connections and when disk space is at a premium.",
+        default: false
 
       property :max_retries, [String, Integer],
-               description: "Number of times any attempt to retrieve a file should retry before returning an error. Setting this to '0' makes Yum try forever."
+        description: "Number of times any attempt to retrieve a file should retry before returning an error. Setting this to `0` makes Yum try forever."
 
       property :metadata_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/, /never/],
-               description: "Time (in seconds) after which the metadata will expire. If the current metadata downloaded is less than the value specified, then Yum will not update the metadata against the repository. If you find that Yum is not downloading information on updates as often as you would like lower the value of this option. You can also change from the default of using seconds to using days, hours or minutes by appending a 'd', 'h' or 'm' respectively. The default is six hours to compliment yum-updates running once per hour. It is also possible to use the word ``never``, meaning that the metadata will never expire. Note: When using a metalink file, the metalink must always be newer than the metadata for the repository due to the validation, so this timeout also applies to the metalink file.",
-               validation_message: "The metadata_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with 'd', 'h', or 'm'!"
+               description: "Time (in seconds) after which the metadata will expire. If the current metadata downloaded is less than the value specified, then Yum will not update the metadata against the repository. If you find that Yum is not downloading information on updates as often as you would like lower the value of this option. You can also change from the default of using seconds to using days, hours or minutes by appending a `d`, `h` or `m` respectively. The default is six hours to compliment yum-updates running once per hour. It is also possible to use the word `never`, meaning that the metadata will never expire. Note: When using a metalink file, the metalink must always be newer than the metadata for the repository due to the validation, so this timeout also applies to the metalink file.",
+               validation_message: "The metadata_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with `d`, `h`, or `m`!"
 
       property :metalink, String,
-               description: "Specifies a URL to a metalink file for the repomd.xml, a list of mirrors for the entire repository are generated by converting the mirrors for the repomd.xml file to a baseurl."
+        description: "Specifies a URL to a metalink file for the repomd.xml, a list of mirrors for the entire repository are generated by converting the mirrors for the repomd.xml file to a baseurl."
 
       property :mirror_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/],
-               description: "Time (in seconds) after which the mirrorlist locally cached will expire. If the current mirrorlist is less than this many seconds old then Yum will not download another copy of the mirrorlist, it has the same extra format as metadata_expire. If you find that Yum is not downloading the mirrorlists as often as you would like lower the value of this option. You can also change from the default of using seconds to using days, hours or minutes by appending a 'd', 'h' or 'm' respectively.",
-               validation_message: "The mirror_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with 'd', 'h', or 'm'!"
+               description: "Time (in seconds) after which the mirrorlist locally cached will expire. If the current mirrorlist is less than this many seconds old then Yum will not download another copy of the mirrorlist, it has the same extra format as metadata_expire. If you find that Yum is not downloading the mirrorlists as often as you would like lower the value of this option. You can also change from the default of using seconds to using days, hours or minutes by appending a `d`, `h` or `m` respectively.",
+               validation_message: "The mirror_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with `d`, `h`, or `m`!"
 
       property :mirrorlist_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/],
-               description: "Specifies the time (in seconds) after which the mirrorlist locally cached will expire. If the current mirrorlist is less than the value specified, then Yum will not download another copy of the mirrorlist. You can also change from the default of using seconds to using days, hours or minutes by appending a 'd', 'h' or 'm' respectively.",
-               validation_message: "The mirrorlist_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with 'd', 'h', or 'm'!"
+               description: "Specifies the time (in seconds) after which the mirrorlist locally cached will expire. If the current mirrorlist is less than the value specified, then Yum will not download another copy of the mirrorlist. You can also change from the default of using seconds to using days, hours or minutes by appending a `d`, `h` or `m` respectively.",
+               validation_message: "The mirrorlist_expire property must be a numeric value for time in seconds, the string 'never', or a numeric value appended with with `d`, `h`, or `m`!"
 
       property :mirrorlist, String,
-               description: "URL to a file containing a list of baseurls. This can be used instead of or with the baseurl option. Substitution variables, described below, can be used with this option."
+        description: "URL to a file containing a list of baseurls. This can be used instead of or with the baseurl option. Substitution variables, described below, can be used with this option."
 
       property :mode, [String, Integer],
-               description: "Permissions mode of .repo file on disk. This is useful for scenarios where secrets are in the repo file. If this value is set to '600', normal users will not be able to use Yum search, Yum info, etc.",
-               default: "0644"
+        description: "Permissions mode of .repo file on disk. This is useful for scenarios where secrets are in the repo file. If this value is set to `600`, normal users will not be able to use Yum search, Yum info, etc.",
+        default: "0644"
 
       property :options, Hash,
-               description: "Specifies the repository options."
+        description: "Specifies the repository options."
 
       property :password, String,
-               description: "Password to use with the username for basic authentication."
+        description: "Password to use with the username for basic authentication."
 
       property :priority, String, regex: /^(\d?[1-9]|[0-9][0-9])$/,
-               description: "Assigns a priority to a repository where the priority value is between '1' and '99' inclusive. Priorities are used to enforce ordered protection of repositories. Packages from repositories with a lower priority (higher numerical value) will never be used to upgrade packages that were installed from a repository with a higher priority (lower numerical value). The repositories with the lowest numerical priority number have the highest priority.",
+               description: "Assigns a priority to a repository where the priority value is between `1` and `99` inclusive. Priorities are used to enforce ordered protection of repositories. Packages from repositories with a lower priority (higher numerical value) will never be used to upgrade packages that were installed from a repository with a higher priority (lower numerical value). The repositories with the lowest numerical priority number have the highest priority.",
                validation_message: "The priority property must be a numeric value from 1-99!"
 
       property :proxy_password, String,
-               description: "Password for this proxy."
+        description: "Password for this proxy."
 
       property :proxy_username, String,
-               description: "Username to use for proxy."
+        description: "Username to use for proxy."
 
       property :proxy, String,
-               description: "URL to the proxy server that Yum should use."
+        description: "URL to the proxy server that Yum should use."
 
       property :repo_gpgcheck, [TrueClass, FalseClass],
-               description: "Determines whether or not Yum should perform a GPG signature check on the repodata from this repository."
+        description: "Determines whether or not Yum should perform a GPG signature check on the repodata from this repository."
 
       property :report_instanceid, [TrueClass, FalseClass],
-               description: "Determines whether to report the instance ID when using Amazon Linux AMIs and repositories."
+        description: "Determines whether to report the instance ID when using Amazon Linux AMIs and repositories."
 
-      property :repositoryid, String, regex: [/^[^\/]+$/],
+      property :repositoryid, String, regex: [%r{^[^/]+$}],
                description: "An optional property to set the repository name if it differs from the resource block's name.",
                validation_message: "repositoryid property cannot contain a forward slash '/'",
                name_property: true
 
       property :skip_if_unavailable, [TrueClass, FalseClass],
-               description: "Allow yum to continue if this repository cannot be contacted for any reason."
+        description: "Allow yum to continue if this repository cannot be contacted for any reason."
 
       property :source, String,
-               description: "Use a custom template source instead of the default one."
+        description: "Use a custom template source instead of the default one."
 
       property :sslcacert, String,
-               description: "Path to the directory containing the databases of the certificate authorities Yum should use to verify SSL certificates."
+        description: "Path to the directory containing the databases of the certificate authorities Yum should use to verify SSL certificates."
 
       property :sslclientcert, String,
-               description: "Path to the SSL client certificate Yum should use to connect to repos/remote sites."
+        description: "Path to the SSL client certificate Yum should use to connect to repos/remote sites."
 
       property :sslclientkey, String,
-               description: "Path to the SSL client key Yum should use to connect to repos/remote sites."
+        description: "Path to the SSL client key Yum should use to connect to repos/remote sites."
 
       property :sslverify, [TrueClass, FalseClass],
-               description: "Determines whether Yum will verify SSL certificates/hosts."
+        description: "Determines whether Yum will verify SSL certificates/hosts."
 
       property :throttle, [String, Integer],
-               description: "Enable bandwidth throttling for downloads."
+        description: "Enable bandwidth throttling for downloads."
 
       property :timeout, String, regex: /^\d+$/,
                description: "Number of seconds to wait for a connection before timing out. Defaults to 30 seconds. This may be too short of a time for extremely overloaded sites.",
                validation_message: "The timeout property must be a numeric value!"
 
       property :username, String,
-               description: "Username to use for basic authentication to a repository."
+        description: "Username to use for basic authentication to a repository."
 
       default_action :create
       allowed_actions :create, :remove, :makecache, :add, :delete