chef 13.12.14 → 14.0.190

data/lib/chef/resource/openssl_rsa_public_key.rb

@@ -0,0 +1,73 @@
+#
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 "chef/resource"
+
+class Chef
+  class Resource
+    class OpensslRsaPublicKey < Chef::Resource
+      require "chef/mixin/openssl_helper"
+      include Chef::Mixin::OpenSSLHelper
+
+      resource_name :openssl_rsa_public_key
+
+      description "Use the openssl_rsa_public_key resource to generate RSA public key files given a RSA private key"
+      introduced "14.0"
+
+      property :path, String,
+               description: "The path to write the file to if different than the resource's name.",
+               name_property: true
+
+      property :private_key_path, String,
+               description: "The path to the private key."
+
+      property :private_key_content, String,
+               description: "The content of the private key including new lines. Used instead of private_key_path to avoid having to first write a key to disk."
+
+      property :private_key_pass, String,
+               description: "The passphrase of the provided private key."
+
+      property :owner, [String, nil],
+               description: "The owner of all files created by the resource."
+
+      property :group, [String, nil],
+               description: "The group of all files created by the resource."
+
+      property :mode, [Integer, String],
+               description: "The permission mode of all files created by the resource.",
+               default: "0640"
+
+      action :create do
+        description "Create the RSA public key."
+
+        raise ArgumentError, "You cannot specify both 'private_key_path' and 'private_key_content' properties at the same time." if new_resource.private_key_path && new_resource.private_key_content
+        raise ArgumentError, "You must specify the private key with either 'private_key_path' or 'private_key_content' properties." unless new_resource.private_key_path || new_resource.private_key_content
+        raise "#{new_resource.private_key_path} not a valid private RSA key or password is invalid" unless priv_key_file_valid?((new_resource.private_key_path || new_resource.private_key_content), new_resource.private_key_pass)
+
+        rsa_key_content = gen_rsa_pub_key((new_resource.private_key_path || new_resource.private_key_content), new_resource.private_key_pass)
+
+        declare_resource(:file, new_resource.path) do
+          action :create
+          owner new_resource.owner unless new_resource.owner.nil?
+          group new_resource.group unless new_resource.group.nil?
+          mode new_resource.mode
+          content rsa_key_content
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/osx_profile.rb

@@ -20,22 +20,21 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the osx_profile resource to manage configuration profiles (.mobileconfig files)
-    # on the macOS platform. The osx_profile resource installs profiles by using
-    # the uuidgen library to generate a unique ProfileUUID, and then using the
-    # profiles command to install the profile on the system.
-    #
-    # @since 12.7
     class OsxProfile < Chef::Resource
-      provides :osx_profile, os: "darwin"
-      provides :osx_config_profile, os: "darwin"
+      resource_name :osx_profile
+      provides :osx_profile
+      provides :osx_config_profile
 
-      identity_attr :profile_name
+      description "Use the osx_profile resource to manage configuration profiles (.mobileconfig files)"\
+                  " on the macOS platform. The osx_profile resource installs profiles by using"\
+                  " the uuidgen library to generate a unique ProfileUUID, and then using the"\
+                  " profiles command to install the profile on the system."
+      introduced "12.7"
 
       default_action :install
       allowed_actions :install, :remove
 
-      property :profile_name, String, name_property: true
+      property :profile_name, String, name_property: true, identity: true
       property :profile, [ String, Hash ]
       property :identifier, String
       property :path, String

data/lib/chef/resource/package.rb

@@ -21,15 +21,17 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the package resource to manage packages. When the package is installed from a local file (such as with RubyGems,
-    # dpkg, or RPM Package Manager), the file must be added to the node using the remote_file or cookbook_file resources.
-    #
-    # This resource is the base resource for several other resources used for package management on specific platforms.
-    # While it is possible to use each of these specific resources, it is recommended to use the package resource as often
-    # as possible.
     class Package < Chef::Resource
       resource_name :package
 
+      description "Use the package resource to manage packages. When the package is"\
+                  " installed from a local file (such as with RubyGems, dpkg, or RPM"\
+                  " Package Manager), the file must be added to the node using the remote_file"\
+                  " or cookbook_file resources.\n\nThis resource is the base resource for"\
+                  " several other resources used for package management on specific platforms."\
+                  " While it is possible to use each of these specific resources, it is"\
+                  " recommended to use the package resource as often as possible."
+
       default_action :install
       allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock
 

data/lib/chef/resource/pacman_package.rb

@@ -20,10 +20,11 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # Use the pacman_package resource to manage packages (using pacman) on the Arch Linux platform.
     class PacmanPackage < Chef::Resource::Package
       resource_name :pacman_package
-      provides :pacman_package, os: "linux"
+      provides :pacman_package
+
+      description "Use the pacman_package resource to manage packages (using pacman) on the Arch Linux platform."
     end
   end
 end

data/lib/chef/resource/paludis_package.rb

@@ -21,12 +21,12 @@ require "chef/provider/package/paludis"
 
 class Chef
   class Resource
-    # Use the paludis_package resource to manage packages for the Paludis platform.
-    #
-    # @since 12.1
     class PaludisPackage < Chef::Resource::Package
       resource_name :paludis_package
-      provides :paludis_package, os: "linux"
+      provides :paludis_package
+
+      description "Use the paludis_package resource to manage packages for the Paludis platform."
+      introduced "12.1"
 
       allowed_actions :install, :remove, :upgrade
 

data/lib/chef/resource/perl.rb

@@ -21,16 +21,18 @@ require "chef/provider/script"
 
 class Chef
   class Resource
-    # Use the perl resource to execute scripts using the Perl interpreter. This resource may also use any of the actions
-    # and properties that are available to the execute resource. Commands that are executed with this resource are (by
-    # their nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and
-    # only_if to guard this resource for idempotence.
     class Perl < Chef::Resource::Script
       def initialize(name, run_context = nil)
         super
         @interpreter = "perl"
       end
 
+      description "Use the perl resource to execute scripts using the Perl interpreter."\
+                  " This resource may also use any of the actions and properties that are"\
+                  " available to the execute resource. Commands that are executed with this"\
+                  " resource are (by their nature) not idempotent, as they are typically"\
+                  " unique to the environment in which they are run. Use not_if and only_if"\
+                  " to guard this resource for idempotence."
     end
   end
 end

data/lib/chef/resource/portage_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,14 +20,11 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # Use the portage_package resource to manage packages for the Gentoo platform.
     class PortagePackage < Chef::Resource::Package
       resource_name :portage_package
-      def initialize(name, run_context = nil)
-        super
-        @provider = Chef::Provider::Package::Portage
-      end
+      provides :portage_package
 
+      description "Use the portage_package resource to manage packages for the Gentoo platform."
     end
   end
 end

data/lib/chef/resource/powershell_package.rb

@@ -20,27 +20,23 @@ require "chef/mixin/uris"
 
 class Chef
   class Resource
-    # Use the powershell_package resource to install and manage packages via the Powershell Package Manager for the
-    # Microsoft Windows platform. The powershell_package resource requires administrative access, and a source must be
-    # configured in the Powershell Package Manager via the Register-PackageSource command
-    #
-    # @since 12.16
     class PowershellPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
-      provides :powershell_package, os: "windows"
+      resource_name :powershell_package
+      provides :powershell_package
 
-      allowed_actions :install, :remove
+      description "Use the powershell_package resource to install and manage packages via"\
+                  " the Powershell Package Manager for the Microsoft Windows platform. The"\
+                  " powershell_package resource requires administrative access, and a source"\
+                  " must be configured in the Powershell Package Manager via the Register-PackageSource command"
+      introduced "12.16"
 
-      def initialize(name, run_context = nil)
-        super
-        @resource_name = :powershell_package
-      end
+      allowed_actions :install, :remove
 
       property :package_name, [String, Array], coerce: proc { |x| [x].flatten }
-
       property :version, [String, Array], coerce: proc { |x| [x].flatten }
-
+      property :source, [String]
     end
   end
 end

data/lib/chef/resource/powershell_script.rb

@@ -19,17 +19,18 @@ require "chef/resource/windows_script"
 
 class Chef
   class Resource
-    # Use the powershell_script resource to execute a script using the Windows PowerShell interpreter, much like how the
-    # script and script-based resources—bash, csh, perl, python, and ruby—are used. The powershell_script is specific to
-    # the Microsoft Windows platform and the Windows PowerShell interpreter.
-    #
-    # The powershell_script resource creates and executes a temporary file (similar to how the script resource behaves),
-    # rather than running the command inline. Commands that are executed with this resource are (by their nature) not
-    # idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if to guard
-    # this resource for idempotence.
     class PowershellScript < Chef::Resource::WindowsScript
       provides :powershell_script, os: "windows"
 
+      description "Use the powershell_script resource to execute a script using the Windows PowerShell"\
+                  " interpreter, much like how the script and script-based resources—bash, csh, perl, python,"\
+                  " and ruby—are used. The powershell_script is specific to the Microsoft Windows platform"\
+                  " and the Windows PowerShell interpreter.\n\n The powershell_script resource creates and"\
+                  " executes a temporary file (similar to how the script resource behaves), rather than running"\
+                  " the command inline. Commands that are executed with this resource are (by their nature) not"\
+                  " idempotent, as they are typically unique to the environment in which they are run. Use not_if"\
+                  " and only_if to guard this resource for idempotence."
+
       def initialize(name, run_context = nil)
         super(name, run_context, :powershell_script, "powershell.exe")
         @convert_boolean_return = false

data/lib/chef/resource/python.rb

@@ -20,16 +20,17 @@ require "chef/provider/script"
 
 class Chef
   class Resource
-    # Use the python resource to execute scripts using the Python interpreter. This resource may also use any of the actions
-    # and properties that are available to the execute resource. Commands that are executed with this resource are (by
-    # their nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and
-    # only_if to guard this resource for idempotence.
     class Python < Chef::Resource::Script
       def initialize(name, run_context = nil)
         super
         @interpreter = "python"
       end
 
+      description "Use the python resource to execute scripts using the Python interpreter."\
+                  " This resource may also use any of the actions and properties that are available"\
+                  " to the execute resource. Commands that are executed with this resource are (by"\
+                  " their nature) not idempotent, as they are typically unique to the environment in"\
+                  " which they are run. Use not_if and only_if to guard this resource for idempotence."
     end
   end
 end

data/lib/chef/resource/reboot.rb

@@ -20,18 +20,17 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the reboot resource to reboot a node, a necessary step with some
-    # installations on certain platforms. This resource is supported for use on
-    # the Microsoft Windows, macOS, and Linux platforms.
-    #
-    # In using this resource via notifications, it's important to *only* use
-    # immediate notifications. Delayed notifications produce unintuitive and
-    # probably undesired results.
-    #
-    # @since 12.0
     class Reboot < Chef::Resource
       resource_name :reboot
 
+      description "Use the reboot resource to reboot a node, a necessary step with some"\
+                  " installations on certain platforms. This resource is supported for use on"\
+                  " the Microsoft Windows, macOS, and Linux platforms.\n"\
+                  "In using this resource via notifications, it's important to *only* use"\
+                  " immediate notifications. Delayed notifications produce unintuitive and"\
+                  " probably undesired results."
+      introduced "12.0"
+
       allowed_actions :request_reboot, :reboot_now, :cancel
       default_action :nothing # make sure people are quite clear what they want
 

data/lib/chef/resource/registry_key.rb

@@ -15,14 +15,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/provider/registry_key"
+
 require "chef/resource"
 require "chef/digester"
 
 class Chef
   class Resource
-    # Use the registry_key resource to create and delete registry keys in Microsoft Windows.
     class RegistryKey < Chef::Resource
+      resource_name :registry_key
+      provides :registry_key
+
+      description "Use the registry_key resource to create and delete registry keys in Microsoft Windows."
+      introduced "11.0"
+
       identity_attr :key
       state_attrs :values
 
@@ -62,8 +67,6 @@ class Chef
 
       def initialize(name, run_context = nil)
         super
-        @architecture = :machine
-        @recursive = false
         @key = name
         @values, @unscrubbed_values = [], []
       end
@@ -102,21 +105,8 @@ class Chef
         end
       end
 
-      def recursive(arg = nil)
-        set_or_return(
-          :recursive,
-          arg,
-          :kind_of => [TrueClass, FalseClass]
-        )
-      end
-
-      def architecture(arg = nil)
-        set_or_return(
-          :architecture,
-          arg,
-          :kind_of => Symbol
-        )
-      end
+      property :recursive, [TrueClass, FalseClass], default: false
+      property :architecture, Symbol, default: :machine, equal_to: [:machine, :x86_64, :i386]
 
       private
 

data/lib/chef/resource/remote_directory.rb

@@ -23,12 +23,14 @@ require "chef/mixin/securable"
 
 class Chef
   class Resource
-    # Use the remote_directory resource to incrementally transfer a directory from a cookbook to a node. The director
-    # that is copied from the cookbook should be located under COOKBOOK_NAME/files/default/REMOTE_DIRECTORY. The
-    # remote_directory resource will obey file specificity.
     class RemoteDirectory < Chef::Resource::Directory
       include Chef::Mixin::Securable
 
+      description "Use the remote_directory resource to incrementally transfer a directory"\
+                  " from a cookbook to a node. The director that is copied from the cookbook"\
+                  " should be located under COOKBOOK_NAME/files/default/REMOTE_DIRECTORY. The"\
+                  " remote_directory resource will obey file specificity."
+
       identity_attr :path
 
       state_attrs :files_owner, :files_group, :files_mode

data/lib/chef/resource/remote_file.rb

@@ -25,19 +25,15 @@ require "chef/mixin/uris"
 
 class Chef
   class Resource
-    # Use the remote_file resource to transfer a file from a remote location using file specificity. This resource is
-    # similar to the file resource.
     class RemoteFile < Chef::Resource::File
       include Chef::Mixin::Securable
 
+      description "Use the remote_file resource to transfer a file from a remote location"\
+                  " using file specificity. This resource is similar to the file resource."
+
       def initialize(name, run_context = nil)
         super
         @source = []
-        @use_etag = true
-        @use_last_modified = true
-        @ftp_active_mode = false
-        @headers = {}
-        @provider = Chef::Provider::RemoteFile
       end
 
       # source can take any of the following as arguments
@@ -74,13 +70,7 @@ class Chef
         end
       end
 
-      def checksum(args = nil)
-        set_or_return(
-          :checksum,
-          args,
-          :kind_of => String
-        )
-      end
+      property :checksum, String
 
       # Disable or enable ETag and Last Modified conditional GET. Equivalent to
       #   use_etag(true_or_false)
@@ -90,48 +80,17 @@ class Chef
         use_last_modified(true_or_false)
       end
 
-      def use_etag(args = nil)
-        set_or_return(
-          :use_etag,
-          args,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :use_etag, [ TrueClass, FalseClass ], default: true
 
       alias :use_etags :use_etag
 
-      def use_last_modified(args = nil)
-        set_or_return(
-          :use_last_modified,
-          args,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :use_last_modified, [ TrueClass, FalseClass ], default: true
 
-      def ftp_active_mode(args = nil)
-        set_or_return(
-          :ftp_active_mode,
-          args,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :ftp_active_mode, [ TrueClass, FalseClass ], default: false
 
-      def headers(args = nil)
-        set_or_return(
-          :headers,
-          args,
-          :kind_of => Hash
-        )
-      end
+      property :headers, Hash, default: lazy { Hash.new }
 
-      def show_progress(args = nil)
-        set_or_return(
-          :show_progress,
-          args,
-          :default => false,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :show_progress, [ TrueClass, FalseClass ], default: false
 
       property :remote_user, String
 
@@ -139,6 +98,8 @@ class Chef
 
       property :remote_password, String, sensitive: true
 
+      property :authentication, equal_to: [:remote, :local], default: :remote
+
       def after_created
         validate_identity_platform(remote_user, remote_password, remote_domain)
         identity = qualify_user(remote_user, remote_password, remote_domain)