chef 14.15.6 → 18.1.0

data/lib/chef/resource/msu_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright 2008-2016, 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,34 +16,50 @@
 # limitations under the License.
 #
 
-require "chef/resource/package"
-require "chef/mixin/uris"
+require_relative "package"
+require_relative "../mixin/uris"
 
 class Chef
   class Resource
     class MsuPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
-      resource_name :msu_package
       provides :msu_package
 
-      description "Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
+      description "Use the **msu_package** resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
       introduced "12.17"
 
       allowed_actions :install, :remove
       default_action :install
 
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      # This is the same property as the main package resource except it has the skip docs set to true
+      # This resource abuses the package resource by storing the versions of all the cabs in the MSU file
+      # in the version attribute from load current value even though those aren't technically the version of the
+      # msu. Since the user wouldn't actually set this we don't want it on the docs site.
+      property :version, [String, Array],
+        skip_docs: true,
+        description: "The version of a package to be installed or upgraded."
+
       property :source, String,
-               description: "The local file path or URL for the MSU 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 }
+        description: "The local file path or URL for the MSU 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 }
 
       property :checksum, String, desired_state: false,
                description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."
+
+      property :timeout, [String, Integer],
+        default: 3600,
+        description: "The amount of time (in seconds) to wait before timing out.",
+        desired_state: false
     end
   end
 end

data/lib/chef/resource/notify_group.rb

@@ -0,0 +1,72 @@
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "../resource"
+
+class Chef
+  class Resource
+    class NotifyGroup < Chef::Resource
+      provides :notify_group
+
+      description "The notify_group resource does nothing, and always fires notifications which are set on it.  Use it to DRY blocks of notifications that are common to multiple resources, and provide a single target for other resources to notify.  Unlike most resources, its default action is :nothing."
+      introduced "15.8"
+      examples <<~DOC
+        Wire up a notification from a service resource to stop and start the service with a 60 second delay.
+
+        ```ruby
+        service "crude" do
+          action [ :enable, :start ]
+        end
+
+        chef_sleep "60" do
+          action :nothing
+        end
+
+        # Example code for a hypothetical badly behaved service that requires
+        # 60 seconds between a stop and start in order to restart the service
+        # (due to race conditions, bleeding connections down, resources that only
+        # slowly unlock in the background, or other poor software behaviors that
+        # are sometimes encountered).
+        #
+        notify_group "crude_stop_and_start" do
+          notifies :stop, "service[crude]", :immediately
+          notifies :sleep, "chef_sleep[60]", :immediately
+          notifies :start, "service[crude]", :immediately
+        end
+
+        template "/etc/crude/crude.conf" do
+          source "crude.conf.erb"
+          variables node["crude"]
+          notifies :run, "notify_group[crude_stop_and_start]", :immediately
+        end
+        ```
+      DOC
+
+      action :run do
+        new_resource.updated_by_last_action(true)
+      end
+
+      # This is deliberate.  Users should be sending a single notification to a notify_group resource which then
+      # distributes multiple notifications.  Having a notify_group run by default is unnecessary indirection and
+      # should be replaced by just running the resources in order.  If resources need to be batch run multiple times
+      # per invocation then the resources themselves are not properly declarative idempotent resources, and the user
+      # is attempting to turn Chef into an imperative language using this construct and/or the batch of resources
+      # need to be turned into a custom resource.
+      #
+      default_action :nothing
+    end
+  end
+end

data/lib/chef/resource/ohai.rb

@@ -2,6 +2,7 @@
 # Author:: Michael Leinartas (<mleinartas@gmail.com>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
 # Copyright:: Copyright 2010-2016, Michael Leinartas
+# Copyright:: Copyright (c) Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,25 +18,81 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+require "ohai" unless defined?(Ohai::System)
 
 class Chef
   class Resource
     class Ohai < Chef::Resource
-      resource_name :ohai
+
       provides :ohai
 
-      description "Use the ohai resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the chef-client run."
+      description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{ChefUtils::Dist::Infra::PRODUCT} run."
+
+      examples <<~DOC
+      Reload All Ohai Plugins
+
+      ```ruby
+      ohai 'reload' do
+        action :reload
+      end
+      ```
+
+      Reload A Single Ohai Plugin
+
+      ```ruby
+      ohai 'reload' do
+        plugin 'ipaddress'
+        action :reload
+      end
+      ```
 
-      property :ohai_name,
-               deprecated: true,
-               name_property: true, introduced: "12.17"
+      Reload Ohai after a new user is created
+
+      ```ruby
+      ohai 'reload_passwd' do
+        action :nothing
+        plugin 'etc'
+      end
+
+      user 'daemon_user' do
+        home '/dev/null'
+        shell '/sbin/nologin'
+        system true
+        notifies :reload, 'ohai[reload_passwd]', :immediately
+      end
+
+      ruby_block 'just an example' do
+        block do
+          # These variables will now have the new values
+          puts node['etc']['passwd']['daemon_user']['uid']
+          puts node['etc']['passwd']['daemon_user']['gid']
+        end
+      end
+      ```
+      DOC
 
       property :plugin, String,
-               description: "The name of an Ohai plugin to be reloaded. If this property is not specified, the chef-client will reload all plugins."
+        description: "Specific Ohai attribute data to reload. This property behaves similar to specifying attributes when running Ohai on the command line and takes the attribute that you wish to reload instead of the actual plugin name. For instance, you can pass `ipaddress` to reload `node['ipaddress']` even though that data comes from the `Network` plugin. If this property is not specified, #{ChefUtils::Dist::Infra::PRODUCT} will reload all plugins."
+
+      def load_current_resource
+        true
+      end
+
+      action :reload do
+        converge_by("re-run ohai and merge results into node attributes") do
+          ohai = ::Ohai::System.new
 
-      default_action :reload
-      allowed_actions :reload
+          # If new_resource.plugin is nil, ohai will reload all the plugins
+          # Otherwise it will only reload the specified plugin
+          # Note that any changes to plugins, or new plugins placed on
+          # the path are picked up by ohai.
+          ohai.all_plugins new_resource.plugin
+          node.automatic_attrs.merge! ohai.data
+          logger.info("#{new_resource} reloaded")
+        end
+      end
     end
   end
 end

data/lib/chef/resource/ohai_hint.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2011-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");
@@ -15,31 +15,63 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class OhaiHint < Chef::Resource
-      resource_name :ohai_hint
+
       provides(:ohai_hint) { true }
 
-      description "Use the ohai_hint resource to aid in configuration detection by passing hint data to Ohai."
+      description "Use the **ohai_hint** resource to aid in configuration detection by passing hint data to Ohai."
       introduced "14.0"
+      examples <<~DOC
+      **Create a hint file**
+
+      ```ruby
+      ohai_hint 'example' do
+        content a: 'test_content'
+      end
+      ```
+
+      **Create a hint file with a name that does not match the resource name**
+
+      ```ruby
+      ohai_hint 'example' do
+        hint_name 'custom'
+      end
+      ```
+
+      **Create a hint file that is not loaded at compile time**
+
+      ```ruby
+      ohai_hint 'example' do
+        compile_time false
+      end
+      ```
+
+      **Delete a hint file**
+
+      ```ruby
+      ohai_hint 'example' do
+        action :delete
+      end
+      ```
+      DOC
 
       property :hint_name, String,
-               description: "An optional property to set the hint name if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property to set the hint name if it differs from the resource block's name.",
+        name_property: true
 
       property :content, Hash,
-               description: "Values to include in the hint file."
+        description: "Values to include in the hint file."
 
+      # override compile_time property to default to true
       property :compile_time, [TrueClass, FalseClass],
-               description: "Determines whether or not the resource is executed during the compile time phase.",
-               default: true, desired_state: false
-
-      action :create do
-        description "Create an Ohai hint file."
+        description: "Determines whether or not the resource is executed during the compile time phase.",
+        default: true, desired_state: false
 
+      action :create, description: "Create an Ohai hint file." do
         directory ::Ohai::Config.ohai.hints_path.first do
           action :create
           recursive true
@@ -51,9 +83,7 @@ class Chef
         end
       end
 
-      action :delete do
-        description "Delete an Ohai hint file."
-
+      action :delete, description: "Delete an Ohai hint file." do
         file ohai_hint_file_path(new_resource.hint_name) do
           action :delete
           notifies :reload, ohai[reload ohai post hint removal]
@@ -79,15 +109,8 @@ class Chef
         # @return [JSON] json representation of the content of an empty string if content was nil
         def format_content(content)
           return "" if content.nil? || content.empty?
-          JSON.pretty_generate(content)
-        end
-      end
 
-      # this resource forces itself to run at compile_time
-      def after_created
-        return unless compile_time
-        Array(action).each do |action|
-          run_action(action)
+          JSON.pretty_generate(content)
         end
       end
     end

data/lib/chef/resource/openbsd_package.rb

@@ -2,7 +2,7 @@
 # Authors:: AJ Christensen (<aj@chef.io>)
 #           Richard Manyanza (<liseki@nyikacraftsmen.com>)
 #           Scott Bonds (<scott@ggr.com>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # Copyright:: Copyright 2014-2016, Richard Manyanza, Scott Bonds
 # License:: Apache License, Version 2.0
 #
@@ -19,20 +19,43 @@
 # limitations under the License.
 #
 
-require "chef/resource/package"
-require "chef/provider/package/openbsd"
-require "chef/mixin/shell_out"
+require_relative "package"
+require_relative "../provider/package/openbsd"
 
 class Chef
   class Resource
     class OpenbsdPackage < Chef::Resource::Package
-      include Chef::Mixin::ShellOut
-
-      resource_name :openbsd_package
+      provides :openbsd_package
       provides :package, os: "openbsd"
 
-      description "Use the openbsd_package resource to manage packages for the OpenBSD platform."
+      description "Use the **openbsd_package** resource to manage packages for the OpenBSD platform."
       introduced "12.1"
+      examples <<~DOC
+        **Install a package**
+
+        ```ruby
+        openbsd_package 'name of package' do
+          action :install
+        end
+        ```
+
+        **Remove a package**
+
+        ```ruby
+        openbsd_package 'name of package' do
+          action :remove
+        end
+        ```
+      DOC
+
+      allowed_actions :install, :remove
+
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
     end
   end
 end

data/lib/chef/resource/openssl_dhparam.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2009-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");
@@ -15,48 +15,78 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class OpensslDhparam < Chef::Resource
-      require "chef/mixin/openssl_helper"
+      require_relative "../mixin/openssl_helper"
       include Chef::Mixin::OpenSSLHelper
 
-      resource_name :openssl_dhparam
       provides(:openssl_dhparam) { true }
 
-      description "Use the openssl_dhparam resource to generate dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten."
+      description "Use the **openssl_dhparam** resource to generate `dhparam.pem` files. If a valid `dhparam.pem` file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid `dhparam.pem` file, it will be overwritten."
       introduced "14.0"
+      examples <<~DOC
+        **Create a dhparam file**
+
+        ```ruby
+        openssl_dhparam '/etc/httpd/ssl/dhparam.pem'
+        ```
+
+        **Create a dhparam file with a specific key length**
+
+        ```ruby
+        openssl_dhparam '/etc/httpd/ssl/dhparam.pem' do
+          key_length 4096
+        end
+        ```
+
+        **Create a dhparam file with specific user/group ownership**
+
+        ```ruby
+        openssl_dhparam '/etc/httpd/ssl/dhparam.pem' do
+          owner 'www-data'
+          group 'www-data'
+        end
+        ```
+
+        **Manually specify the dhparam file path**
+
+        ```ruby
+        openssl_dhparam 'httpd_dhparam' do
+          path '/etc/httpd/ssl/dhparam.pem'
+        end
+        ```
+      DOC
 
       property :path, String,
-               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
+        name_property: true
 
       property :key_length, Integer,
-               equal_to: [1024, 2048, 4096, 8192],
-               validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
-               description: "The desired bit length of the generated key.",
-               default: 2048
+        equal_to: [1024, 2048, 4096, 8192],
+        validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
+        description: "The desired bit length of the generated key.",
+        default: 2048
 
       property :generator, Integer,
-               equal_to: [2, 5],
-               validation_message: "generator must be either 2 or 5.",
-               description: "The desired Diffie-Hellmann generator.",
-               default: 2
+        equal_to: [2, 5],
+        validation_message: "generator must be either 2 or 5.",
+        description: "The desired Diffie-Hellmann generator.",
+        default: 2
 
-      property :owner, String,
-               description: "The owner applied to all files created by the resource."
+      property :owner, [String, Integer],
+        description: "The owner applied to all files created by the resource."
 
-      property :group, String,
-               description: "The group ownership applied to all files created by the resource."
+      property :group, [String, Integer],
+        description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode applied to all files created by the resource.",
-               default: "0640"
+        description: "The permission mode applied to all files created by the resource.",
+        default: "0640"
 
-      action :create do
-        description "Create the dhparam file."
+      action :create, description: "Create the `dhparam.pem` file." do
         dhparam_content = nil
         unless dhparam_pem_valid?(new_resource.path)
           dhparam_content = gen_dhparam(new_resource.key_length, new_resource.generator).to_pem

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # Author:: Julien Huon
 # License:: Apache License, Version 2.0
 #
@@ -16,55 +16,77 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class OpensslEcPrivateKey < Chef::Resource
-      require "chef/mixin/openssl_helper"
+      require_relative "../mixin/openssl_helper"
       include Chef::Mixin::OpenSSLHelper
 
-      preview_resource true
-      resource_name :openssl_ec_private_key
+      provides :openssl_ec_private_key
 
-      description "Use the openssl_ec_private_key resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
+      description "Use the **openssl_ec_private_key** resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
       introduced "14.4"
+      examples <<~DOC
+        **Generate a new ec privatekey with prime256v1 key curve and default des3 cipher**
+
+        ```ruby
+        openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
+          key_curve 'prime256v1'
+          key_pass 'something'
+          action :create
+        end
+        ```
+
+        **Generate a new ec private key with prime256v1 key curve and aes-128-cbc cipher**
+
+        ```ruby
+        openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
+          key_curve 'prime256v1'
+          key_cipher 'aes-128-cbc'
+          key_pass 'something'
+          action :create
+        end
+        ```
+      DOC
 
       property :path, String,
-               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
+        name_property: true
 
       property :key_curve, String,
-               equal_to: %w{secp384r1 secp521r1 prime256v1 secp224r1 secp256k1},
-               description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.",
-               default: "prime256v1"
+        equal_to: %w{secp384r1 secp521r1 prime256v1 secp224r1 secp256k1},
+        description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.",
+        default: "prime256v1"
 
       property :key_pass, String,
-               description: "The desired passphrase for the key."
+        description: "The desired passphrase for the key."
 
       property :key_cipher, String,
-               equal_to: OpenSSL::Cipher.ciphers,
-               validation_message: "key_cipher must be a cipher known to openssl. Run `openssl list-cipher-algorithms` to see available options.",
-               description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
-               default: "des3"
+        description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
+        default: lazy { "des3" },
+        default_description: "des3",
+        callbacks: {
+          "key_cipher must be a cipher known to openssl. Run `openssl list-cipher-algorithms` to see available options." =>
+            proc { |v| OpenSSL::Cipher.ciphers.include?(v) },
+        }
 
-      property :owner, String,
-               description: "The owner applied to all files created by the resource."
+      property :owner, [String, Integer],
+        description: "The owner applied to all files created by the resource."
 
-      property :group, String,
-               description: "The group ownership applied to all files created by the resource."
+      property :group, [String, Integer],
+        description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode applied to all files created by the resource.",
-               default: "0600"
+        description: "The permission mode applied to all files created by the resource.",
+        default: "0600"
 
       property :force, [TrueClass, FalseClass],
-               description: "Force creation of the key even if the same key already exists on the node.",
-               default: false, desired_state: false
-
-      action :create do
-        description "Generate the ec private key"
+        description: "Force creation of the key even if the same key already exists on the node.",
+        default: false, desired_state: false
 
+      action :create, description: "Generate the EC private key file." do
         unless new_resource.force || priv_key_file_valid?(new_resource.path, new_resource.key_pass)
           converge_by("Create an EC private key #{new_resource.path}") do
             log "Generating an #{new_resource.key_curve} "\