chef 14.2.0 → 14.3.37

data/lib/chef/resource/log.rb

@@ -37,8 +37,13 @@ class Chef
                   " entry that is not built into the resource collection, use Chef::Log instead"\
                   " of the log resource.)"
 
-      property :message, String, name_property: true, identity: true
-      property :level, Symbol, equal_to: [ :debug, :info, :warn, :error, :fatal ], default: :info
+      property :message, String,
+               name_property: true, identity: true,
+               description: "The message to be added to a log file. If not specified we'll use the resource's name instead."
+
+      property :level, Symbol,
+               equal_to: [ :debug, :info, :warn, :error, :fatal ], default: :info,
+               description: "The logging level to display this message at."
 
       allowed_actions :write
       default_action :write

data/lib/chef/resource/mdadm.rb

@@ -32,14 +32,35 @@ class Chef
       default_action :create
       allowed_actions :create, :assemble, :stop
 
-      property :chunk, Integer, default: 16
-      property :devices, Array, default: lazy { [] }
-      property :exists, [ TrueClass, FalseClass ], default: false
-      property :level, Integer, default: 1
-      property :metadata, String, default: "0.90"
-      property :bitmap, String
-      property :raid_device, String, identity: true, name_property: true
-      property :layout, String
+      property :chunk, Integer,
+               default: 16,
+               description: "The chunk size. This property should not be used for a RAID 1 mirrored pair (i.e. when the level property is set to 1)."
+
+      property :devices, Array,
+               default: lazy { [] },
+               description: "The devices to be part of a RAID array."
+
+      property :exists, [ TrueClass, FalseClass ],
+               default: false,
+               description: "Indicates whether the RAID array exists."
+
+      property :level, Integer,
+               default: 1,
+               description: "The RAID level."
+
+      property :metadata, String,
+               default: "0.90",
+               description: "The superblock type for RAID metadata."
+
+      property :bitmap, String,
+                description: "The path to a file in which a write-intent bitmap is stored."
+
+      property :raid_device, String,
+               identity: true, name_property: true,
+               description: "The name of the RAID device. We'll use the resource's name if this isn't specified."
+
+      property :layout, String,
+               description: "The RAID5 parity algorithm. Possible values: left-asymmetric (or la), left-symmetric (or ls), right-asymmetric (or ra), or right-symmetric (or rs)."
     end
   end
 end

data/lib/chef/resource/ohai.rb

@@ -17,6 +17,8 @@
 # limitations under the License.
 #
 
+require "chef/resource"
+
 class Chef
   class Resource
     class Ohai < Chef::Resource

data/lib/chef/resource/ohai_hint.rb

@@ -15,6 +15,8 @@
 # limitations under the License.
 #
 
+require "chef/resource"
+
 class Chef
   class Resource
     class OhaiHint < Chef::Resource
@@ -32,11 +34,11 @@ class Chef
                description: "Values to include in the hint file."
 
       property :compile_time, [TrueClass, FalseClass],
-               description: "Should the resource execute during the compile time phase",
+               description: "Whether the resource will execute during the compile time phase or not.",
                default: true, desired_state: false
 
       action :create do
-        description "Create an Ohai hint file"
+        description "Create an Ohai hint file."
 
         declare_resource(:directory, ::Ohai::Config.ohai.hints_path.first) do
           action :create
@@ -50,7 +52,7 @@ class Chef
       end
 
       action :delete do
-        description "Delete an Ohai hint file"
+        description "Delete an Ohai hint file."
 
         declare_resource(:file, ohai_hint_file_path(new_resource.hint_name)) do
           action :delete

data/lib/chef/resource/openssl_dhparam.rb

@@ -59,7 +59,7 @@ class Chef
                default: "0640"
 
       action :create do
-        description "Create the dhparam file"
+        description "Create the dhparam file."
 
         unless dhparam_pem_valid?(new_resource.path)
           converge_by("Create a dhparam file #{new_resource.path}") do

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -68,6 +68,8 @@ class Chef
                default: false, desired_state: false
 
       action :create do
+        description "Create the RSA private key."
+
         return if new_resource.force || priv_key_file_valid?(new_resource.path, new_resource.key_pass)
 
         converge_by("create #{new_resource.key_length} bit RSA key #{new_resource.path}") do

data/lib/chef/resource/paludis_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Vasiliy Tolstov (<v.tolstov@selfip.ru>)
-# Copyright:: Copyright 2014-2016, Chef Software Inc.
+# Copyright:: Copyright 2014-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/resource/portage_package.rb

@@ -25,6 +25,8 @@ class Chef
       provides :portage_package
 
       description "Use the portage_package resource to manage packages for the Gentoo platform."
+
+      property :timeout, default: 3600
     end
   end
 end

data/lib/chef/resource/powershell_package.rb

@@ -37,6 +37,8 @@ class Chef
       property :package_name, [String, Array], coerce: proc { |x| [x].flatten }
       property :version, [String, Array], coerce: proc { |x| [x].flatten }
       property :source, [String]
+      property :skip_publisher_check, [true, false], default: false, introduced: "14.3",
+               description: "Skip validating module author."
     end
   end
 end

data/lib/chef/resource/powershell_package_source.rb

@@ -0,0 +1,165 @@
+# Author:: Tor Magnus Rakvåg (tm@intility.no)
+# Copyright:: 2018, Intility AS
+# 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"
+require "chef/json_compat"
+
+class Chef
+  class Resource
+    class PowershellPackageSource < Chef::Resource
+      preview_resource true
+      resource_name "powershell_package_source"
+
+      description "Use the powershell_package_source resource to register a powershell package repository."
+      introduced "14.3"
+
+      property :source_name, String,
+               description: "The name of the package source.",
+               name_property: true
+
+      property :url, String,
+               description: "The url to the package source.",
+               required: true
+
+      property :trusted, [TrueClass, FalseClass],
+               description: "Whether or not to trust packages from this source.",
+               default: false
+
+      property :provider_name, String,
+               equal_to: %w{ Programs msi NuGet msu PowerShellGet psl chocolatey },
+               validation_message: "The following providers are supported: 'Programs', 'msi', 'NuGet', 'msu', 'PowerShellGet', 'psl' or 'chocolatey'",
+               description: "The package management provider for the source. It supports the following providers: 'Programs', 'msi', 'NuGet', 'msu', 'PowerShellGet', 'psl' and 'chocolatey'.",
+               default: "NuGet"
+
+      property :publish_location, String,
+               description: "The url where modules will be published to for this source. Only valid if the provider is 'PowerShellGet'."
+
+      property :script_source_location, String,
+               description: "The url where scripts are located for this source. Only valid if the provider is 'PowerShellGet'."
+
+      property :script_publish_location, String,
+               description: "The location where scripts will be published to for this source. Only valid if the provider is 'PowerShellGet'."
+
+      load_current_value do
+        cmd = load_resource_state_script(name)
+        repo = powershell_out!(cmd)
+        status = Chef::JSONCompat.from_json(repo.stdout)
+        url status["url"].nil? ? "not_set" : status["url"]
+        trusted status["trusted"]
+        provider_name status["provider_name"]
+        publish_location status["publish_location"]
+        script_source_location status["script_source_location"]
+        script_publish_location status["script_publish_location"]
+      end
+
+      action :register do
+        description "Registers and updates the powershell package source."
+        # TODO: Ensure package provider is installed?
+        if psrepository_cmdlet_appropriate?
+          if package_source_exists?
+            converge_if_changed :url, :trusted, :publish_location, :script_source_location, :script_publish_location do
+              update_cmd = build_ps_repository_command("Set", new_resource)
+              res = powershell_out(update_cmd)
+              raise "Failed to update #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+            end
+          else
+            converge_by("register source: #{new_resource.source_name}") do
+              register_cmd = build_ps_repository_command("Register", new_resource)
+              res = powershell_out(register_cmd)
+              raise "Failed to register #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+            end
+          end
+        else
+          if package_source_exists?
+            converge_if_changed :url, :trusted, :provider_name do
+              update_cmd = build_package_source_command("Set", new_resource)
+              res = powershell_out(update_cmd)
+              raise "Failed to update #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+            end
+          else
+            converge_by("register source: #{new_resource.source_name}") do
+              register_cmd = build_package_source_command("Register", new_resource)
+              res = powershell_out(register_cmd)
+              raise "Failed to register #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+            end
+          end
+        end
+      end
+
+      action :unregister do
+        description "Unregisters the powershell package source."
+        if package_source_exists?
+          unregister_cmd = "Get-PackageSource -Name '#{new_resource.source_name}' | Unregister-PackageSource"
+          converge_by("unregister source: #{new_resource.source_name}") do
+            res = powershell_out(unregister_cmd)
+            raise "Failed to unregister #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+          end
+        end
+      end
+
+      action_class do
+        def package_source_exists?
+          cmd = powershell_out!("(Get-PackageSource -Name '#{new_resource.source_name}').Name")
+          cmd.stdout.downcase.strip == new_resource.source_name.downcase
+        end
+
+        def psrepository_cmdlet_appropriate?
+          new_resource.provider_name == "PowerShellGet"
+        end
+
+        def build_ps_repository_command(cmdlet_type, new_resource)
+          cmd = "#{cmdlet_type}-PSRepository -Name '#{new_resource.source_name}'"
+          cmd << " -SourceLocation '#{new_resource.url}'" if new_resource.url
+          cmd << " -InstallationPolicy '#{new_resource.trusted ? "Trusted" : "Untrusted"}'"
+          cmd << " -PublishLocation '#{new_resource.publish_location}'" if new_resource.publish_location
+          cmd << " -ScriptSourceLocation '#{new_resource.script_source_location}'" if new_resource.script_source_location
+          cmd << " -ScriptPublishLocation '#{new_resource.script_publish_location}'" if new_resource.script_publish_location
+          cmd
+        end
+
+        def build_package_source_command(cmdlet_type, new_resource)
+          cmd = "#{cmdlet_type}-PackageSource -Name '#{new_resource.source_name}'"
+          cmd << " -Location '#{new_resource.url}'" if new_resource.url
+          cmd << " -Trusted:#{new_resource.trusted ? "$true" : "$false"}"
+          cmd << " -ProviderName '#{new_resource.provider_name}'" if new_resource.provider_name
+          cmd
+        end
+      end
+    end
+
+    private
+
+    def load_resource_state_script(name)
+      <<-EOH
+        if(Get-PackageSource -Name '#{name}' -ErrorAction SilentlyContinue) {
+            if ((Get-PackageSource -Name '#{name}').ProviderName -eq 'PowerShellGet') {
+                (Get-PSRepository -Name '#{name}') | Select @{n='source_name';e={$_.Name}}, @{n='url';e={$_.SourceLocation}},
+                @{n='trusted';e={$_.Trusted}}, @{n='provider_name';e={$_.PackageManagementProvider}}, @{n='publish_location';e={$_.PublishLocation}},
+                @{n='script_source_location';e={$_.ScriptSourceLocation}}, @{n='script_publish_location';e={$_.ScriptPublishLocation}} | ConvertTo-Json
+            }
+            else {
+                (Get-PackageSource -Name '#{name}') | Select @{n='source_name';e={$_.Name}}, @{n='url';e={$_.Location}},
+                @{n='provider_name';e={$_.ProviderName}}, @{n='trusted';e={$_.IsTrusted}} | ConvertTo-Json
+            }
+        }
+        else {
+            "" | Select source_name, url, provider_name, trusted | ConvertTo-Json
+        }
+      EOH
+    end
+  end
+end

data/lib/chef/resource/powershell_script.rb

@@ -40,7 +40,7 @@ class Chef
         set_or_return(
           :convert_boolean_return,
           arg,
-          :kind_of => [ FalseClass, TrueClass ]
+          kind_of: [ FalseClass, TrueClass ]
         )
       end
 
@@ -52,7 +52,7 @@ class Chef
       # guard context and recipe resource context will have the
       # same behavior.
       def self.get_default_attributes(opts)
-        { :convert_boolean_return => true }
+        { convert_boolean_return: true }
       end
     end
   end

data/lib/chef/resource/registry_key.rb

@@ -82,7 +82,7 @@ class Chef
           end
 
           @values.each do |v|
-            raise ArgumentError, "Missing name key in RegistryKey values hash" unless v.has_key?(:name)
+            raise ArgumentError, "Missing name key in RegistryKey values hash" unless v.key?(:name)
             v.each_key do |key|
               raise ArgumentError, "Bad key #{key} in RegistryKey values hash" unless [:name, :type, :data].include?(key)
             end

data/lib/chef/resource/remote_directory.rb

@@ -63,7 +63,7 @@ class Chef
         set_or_return(
           :files_group,
           arg,
-          :regex => Chef::Config[:group_valid_regex]
+          regex: Chef::Config[:group_valid_regex]
         )
       end
 
@@ -71,7 +71,7 @@ class Chef
         set_or_return(
           :files_mode,
           arg,
-          :regex => /^\d{3,4}$/
+          regex: /^\d{3,4}$/
         )
       end
 
@@ -79,7 +79,7 @@ class Chef
         set_or_return(
           :files_owner,
           arg,
-          :regex => Chef::Config[:user_valid_regex]
+          regex: Chef::Config[:user_valid_regex]
         )
       end
     end

data/lib/chef/resource/remote_file.rb

@@ -48,8 +48,8 @@ class Chef
         arg = parse_source_args(args)
         ret = set_or_return(:source,
                             arg,
-                            { :callbacks => {
-                                :validate_source => method(:validate_source),
+                            { callbacks: {
+                                validate_source: method(:validate_source),
                               } })
         if ret.is_a? String
           Array(ret)

data/lib/chef/resource/resource_notification.rb

@@ -79,18 +79,18 @@ class Chef
         self.resource = matching_resource
 
       rescue Chef::Exceptions::ResourceNotFound => e
-        err = Chef::Exceptions::ResourceNotFound.new(<<-FAIL)
-resource #{notifying_resource} is configured to notify resource #{resource} with action #{action}, \
-but #{resource} cannot be found in the resource collection. #{notifying_resource} is defined in \
-#{notifying_resource.source_line}
+        err = Chef::Exceptions::ResourceNotFound.new(<<~FAIL)
+          resource #{notifying_resource} is configured to notify resource #{resource} with action #{action}, \
+          but #{resource} cannot be found in the resource collection. #{notifying_resource} is defined in \
+          #{notifying_resource.source_line}
         FAIL
         err.set_backtrace(e.backtrace)
         raise err
       rescue Chef::Exceptions::InvalidResourceSpecification => e
-        err = Chef::Exceptions::InvalidResourceSpecification.new(<<-F)
-Resource #{notifying_resource} is configured to notify resource #{resource} with action #{action}, \
-but #{resource.inspect} is not valid syntax to look up a resource in the resource collection. Notification \
-is defined near #{notifying_resource.source_line}
+        err = Chef::Exceptions::InvalidResourceSpecification.new(<<~F)
+          Resource #{notifying_resource} is configured to notify resource #{resource} with action #{action}, \
+          but #{resource.inspect} is not valid syntax to look up a resource in the resource collection. Notification \
+          is defined near #{notifying_resource.source_line}
         F
         err.set_backtrace(e.backtrace)
         raise err
@@ -112,18 +112,18 @@ is defined near #{notifying_resource.source_line}
         self.notifying_resource = matching_notifier
 
       rescue Chef::Exceptions::ResourceNotFound => e
-        err = Chef::Exceptions::ResourceNotFound.new(<<-FAIL)
-Resource #{resource} is configured to receive notifications from #{notifying_resource} with action #{action}, \
-but #{notifying_resource} cannot be found in the resource collection. #{resource} is defined in \
-#{resource.source_line}
+        err = Chef::Exceptions::ResourceNotFound.new(<<~FAIL)
+          Resource #{resource} is configured to receive notifications from #{notifying_resource} with action #{action}, \
+          but #{notifying_resource} cannot be found in the resource collection. #{resource} is defined in \
+          #{resource.source_line}
         FAIL
         err.set_backtrace(e.backtrace)
         raise err
       rescue Chef::Exceptions::InvalidResourceSpecification => e
-        err = Chef::Exceptions::InvalidResourceSpecification.new(<<-F)
-Resource #{resource} is configured to receive notifications from  #{notifying_resource} with action #{action}, \
-but #{notifying_resource.inspect} is not valid syntax to look up a resource in the resource collection. Notification \
-is defined near #{resource.source_line}
+        err = Chef::Exceptions::InvalidResourceSpecification.new(<<~F)
+          Resource #{resource} is configured to receive notifications from  #{notifying_resource} with action #{action}, \
+          but #{notifying_resource.inspect} is not valid syntax to look up a resource in the resource collection. Notification \
+          is defined near #{resource.source_line}
         F
         err.set_backtrace(e.backtrace)
         raise err

data/lib/chef/resource/rhsm_errata.rb

@@ -33,7 +33,7 @@ class Chef
                name_property: true
 
       action :install do
-        description "Installs a package for a specific errata ID"
+        description "Installs a package for a specific errata ID."
 
         execute "Install errata packages for #{new_resource.errata_id}" do
           command "yum update --advisory #{new_resource.errata_id} -y"

data/lib/chef/resource/rhsm_errata_level.rb

@@ -35,7 +35,7 @@ class Chef
                name_property: true
 
       action :install do
-        descripton "Install all packages of the specified errata level"
+        descripton "Install all packages of the specified errata level."
 
         yum_package "yum-plugin-security" do
           action :install