chef 15.3.14 → 15.4.45

data/lib/chef/resource/cron_d.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2008-2018, Chef Software, Inc.
+# Copyright:: 2008-2019, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,6 +26,51 @@ class Chef
 
       introduced "14.4"
       description "Use the cron_d resource to manage cron definitions in /etc/cron.d. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
+      examples <<~DOC
+        To run a program on the fifth hour of the day
+        ```ruby
+        cron_d 'noop' do
+          hour '5'
+          minute '0'
+          command '/bin/true'
+        end
+        ```
+
+        To run an entry if a folder exists
+        ```ruby
+        cron_d 'ganglia_tomcat_thread_max' do
+          command "/usr/bin/gmetric
+            -n 'tomcat threads max'
+            -t uint32
+            -v '/usr/local/bin/tomcat-stat
+            --thread-max'"
+          only_if { ::File.exist?('/home/jboss') }
+        end
+        ```
+
+        To run an entry every Saturday, 8:00 AM
+        ```ruby
+        cron_d 'name_of_cron_entry' do
+          minute '0'
+          hour '8'
+          weekday '6'
+          mailto 'admin@example.com'
+          action :create
+        end
+        ```
+
+        To run an entry at 8:00 PM, every weekday (Monday through Friday), but only in November
+        ```ruby
+        cron_d 'name_of_cron_entry' do
+          minute '0'
+          hour '20'
+          day '*'
+          month '11'
+          weekday '1-5'
+          action :create
+        end
+        ```
+      DOC
 
       # validate a provided value is between two other provided values
       # we also allow * as a valid input

data/lib/chef/resource/dmg_package.rb

@@ -25,6 +25,34 @@ class Chef
 
       description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]."
       introduced "14.0"
+      examples <<~DOC
+        Install Google Chrome via the DMG package
+        ```ruby
+        dmg_package 'Google Chrome' do
+          dmg_name 'googlechrome'
+          source   'https://dl-ssl.google.com/chrome/mac/stable/GGRM/googlechrome.dmg'
+          checksum '7daa2dc5c46d9bfb14f1d7ff4b33884325e5e63e694810adc58f14795165c91a'
+          action   :install
+        end
+        ```
+
+        Install Virtualbox from the .mpkg
+        ```ruby
+        dmg_package 'Virtualbox' do
+          source 'http://dlc.sun.com.edgesuite.net/virtualbox/4.0.8/VirtualBox-4.0.8-71778-OSX.dmg'
+          type   'mpkg'
+        end
+        ```
+
+        Install pgAdmin and automatically accept the EULA
+        ```ruby
+        dmg_package 'pgAdmin3' do
+          source   'http://wwwmaster.postgresql.org/redir/198/h/pgadmin3/release/v1.12.3/osx/pgadmin3-1.12.3.dmg'
+          checksum '9435f79d5b52d0febeddfad392adf82db9df159196f496c1ab139a6957242ce9'
+          accept_eula true
+        end
+        ```
+      DOC
 
       property :app, String,
         description: "The name of the application as it appears in the /Volumes directory if it differs from the resource block's name.",

data/lib/chef/resource/kernel_module.rb

@@ -15,11 +15,61 @@ class Chef
 
       description "Use the kernel_module resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
       introduced "14.3"
+      examples <<~DOC
+        Install and load a kernel module, and ensure it loads on reboot.
+        ```ruby
+        kernel_module 'loop'
+        ```
+        Install and load a kernel with a specific set of options, and ensure it loads on reboot. Consult kernel module
+        documentation for specific options that are supported.
+        ```ruby
+        kernel_module 'loop' do
+          options [
+            'max_loop=4',
+            'max_part=8'
+          ]
+        end
+        ```
+        Load a kernel module.
+        ```ruby
+        kernel_module 'loop' do
+          action :load
+        end
+        ```
+        Unload a kernel module and remove module config, so it doesn’t load on reboot.
+        ```ruby
+        kernel_module 'loop' do
+          action :uninstall
+        end
+        ```
+        Unload kernel module.
+        ```ruby
+        kernel_module 'loop' do
+          action :unload
+        end
+        ```
+        Blacklist a module from loading.
+        ```ruby
+        kernel_module 'loop' do
+          action :blacklist
+        end
+        ```
+        Disable a kernel module.
+        ```ruby
+        kernel_module 'loop' do
+          action :disable
+        end
+        ```
+      DOC
 
       property :modname, String,
         description: "An optional property to set the kernel module name if it differs from the resource block's name.",
         name_property: true, identity: true
 
+      property :options, Array,
+        description: "An optional property to set options for the kernel module.",
+        introduced: "15.4"
+
       property :load_dir, String,
         description: "The directory to load modules from.",
         default: "/etc/modules-load.d"
@@ -31,6 +81,13 @@ class Chef
       action :install do
         description "Load kernel module, and ensure it loads on reboot."
 
+        # create options file before loading the module
+        unless new_resource.options.nil?
+          file "#{new_resource.unload_dir}/options_#{new_resource.modname}.conf" do
+            content "options #{new_resource.modname} #{new_resource.options.join(" ")}\n"
+          end.run_action(:create)
+        end
+
         # load the module first before installing
         new_resource.run_action(:load)
 
@@ -64,6 +121,10 @@ class Chef
           notifies :run, "execute[update initramfs]", :delayed
         end
 
+        file "#{new_resource.unload_dir}/options_#{new_resource.modname}.conf" do
+          action :delete
+        end
+
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command

data/lib/chef/resource/sudo.rb

@@ -166,7 +166,7 @@ class Chef
             source new_resource.template
             mode "0440"
             variables new_resource.variables
-            verify "#{new_resource.visudo_binary} -cf %{path}" if visudo_present?
+            verify "cat #{new_resource.config_prefix}/sudoers %{path} | #{new_resource.visudo_binary} -cf -" if visudo_present?
             action :create
           end
         else
@@ -185,7 +185,7 @@ class Chef
                       setenv:             new_resource.setenv,
                       env_keep_add:       new_resource.env_keep_add,
                       env_keep_subtract:  new_resource.env_keep_subtract
-            verify "#{new_resource.visudo_binary} -cf %{path}" if visudo_present?
+            verify "cat #{new_resource.config_prefix}/sudoers %{path} | #{new_resource.visudo_binary} -cf -" if visudo_present?
             action :create
           end
         end

data/lib/chef/resource/windows_ad_join.rb

@@ -57,6 +57,10 @@ class Chef
         description: "Specifies a new hostname for the computer in the new domain.",
         introduced: "14.5"
 
+      property :workgroup_name, String,
+        description: "Specifies the name of a workgroup to which the computer is added to when it is removed from the domain. The default value is WORKGROUP. This property is only applicable to the :leave action.",
+        introduced: "15.0"
+
       # define this again so we can default it to true. Otherwise failures print the password
       property :sensitive, [TrueClass, FalseClass],
         default: true, desired_state: false
@@ -64,7 +68,7 @@ class Chef
       action :join do
         description "Join the Active Directory domain."
 
-        unless on_domain?
+        unless on_desired_domain?
           cmd = "$pswd = ConvertTo-SecureString \'#{new_resource.domain_password}\' -AsPlainText -Force;"
           cmd << "$credential = New-Object System.Management.Automation.PSCredential (\"#{new_resource.domain_user}@#{new_resource.domain_name}\",$pswd);"
           cmd << "Add-Computer -DomainName #{new_resource.domain_name} -Credential $credential"
@@ -92,12 +96,77 @@ class Chef
         end
       end
 
+      action :leave do
+        description "Leave the Active Directory domain."
+
+        if joined_to_domain?
+          cmd = ""
+          cmd << "$pswd = ConvertTo-SecureString \'#{new_resource.domain_password}\' -AsPlainText -Force;"
+          cmd << "$credential = New-Object System.Management.Automation.PSCredential (\"#{new_resource.domain_user}@#{new_resource.domain_name}\",$pswd);"
+          cmd << "Remove-Computer"
+          cmd << " -UnjoinDomainCredential $credential"
+          cmd << " -NewName \"#{new_resource.new_hostname}\"" if new_resource.new_hostname
+          cmd << " -WorkgroupName \"#{new_resource.workgroup_name}\"" if new_resource.workgroup_name
+          cmd << " -Force"
+
+          converge_by("leave Active Directory domain #{node_domain}") do
+            ps_run = powershell_out(cmd)
+            if ps_run.error?
+              if sensitive?
+                raise "Failed to leave the domain #{node_domain}: *suppressed sensitive resource output*"
+              else
+                raise "Failed to leave the domain #{node_domain}: #{ps_run.stderr}"
+              end
+            end
+
+            unless new_resource.reboot == :never
+              reboot "Reboot to leave domain #{new_resource.domain_name}" do
+                action clarify_reboot(new_resource.reboot)
+                reason "Reboot to leave domain #{new_resource.domain_name}"
+              end
+            end
+          end
+        end
+      end
+
       action_class do
-        def on_domain?
+        #
+        # @return [String] The domain name the node is joined to. When the node
+        #   is not joined to a domain this will return the name of the
+        #   workgroup the node is a member of.
+        #
+        def node_domain
           node_domain = powershell_out!("(Get-WmiObject Win32_ComputerSystem).Domain")
           raise "Failed to check if the system is joined to the domain #{new_resource.domain_name}: #{node_domain.stderr}}" if node_domain.error?
 
-          node_domain.stdout.downcase.strip == new_resource.domain_name.downcase
+          node_domain.stdout.downcase.strip
+        end
+
+        #
+        # @return [String] The workgroup the node is a member of. This will
+        #   return an empty string if the system is not a member of a
+        #   workgroup.
+        #
+        def node_workgroup
+          node_workgroup = powershell_out!("(Get-WmiObject Win32_ComputerSystem).Workgroup")
+          raise "Failed to check if the system is currently a member of a workgroup" if node_workgroup.error?
+
+          node_workgroup.stdout.downcase.strip
+        end
+
+        #
+        # @return [true, false] Whether or not the node is joined to ANY domain
+        #
+        def joined_to_domain?
+          node_workgroup.empty? && !node_domain.empty?
+        end
+
+        #
+        # @return [true, false] Whether or not the node is joined to the domain
+        #   defined by the resource :domain_name property.
+        #
+        def on_desired_domain?
+          node_domain == new_resource.domain_name.downcase
         end
 
         # This resource historically took `:immediate` and `:delayed` as arguments to the reboot property but then

data/lib/chef/resource/windows_service.rb

@@ -108,7 +108,7 @@ class Chef
         description: "Description of the service.",
         introduced: "14.0"
 
-      property :run_as_user, String, default: "LocalSystem"
+      property :run_as_user, String, default: "localsystem", coerce: proc { |x| x.downcase }
       property :run_as_password, String, default: ""
     end
   end

data/lib/chef/resource/windows_share.rb

@@ -38,7 +38,8 @@ class Chef
 
       # Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
       property :path, String,
-        description: "The path of the folder to share. Required when creating. If the share already exists on a different path then it is deleted and re-created."
+        description: "The path of the folder to share. Required when creating. If the share already exists on a different path then it is deleted and re-created.",
+        coerce: proc { |p| p.gsub!(%r{/}, "\\") || p }
 
       # Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters.
       property :description, String,

data/lib/chef/shell.rb

@@ -121,11 +121,11 @@ module Shell
     irb_conf[:IRB_RC] = lambda do |conf|
       m = conf.main
 
-      conf.prompt_c       = "chef#{leader(m)} > "
+      conf.prompt_c       = "#{Chef::Dist::EXEC}#{leader(m)} > "
       conf.return_format  = " => %s \n"
-      conf.prompt_i       = "chef#{leader(m)} (#{Chef::VERSION})> "
-      conf.prompt_n       = "chef#{leader(m)} ?> "
-      conf.prompt_s       = "chef#{leader(m)}%l> "
+      conf.prompt_i       = "#{Chef::Dist::EXEC}#{leader(m)} (#{Chef::VERSION})> "
+      conf.prompt_n       = "#{Chef::Dist::EXEC}#{leader(m)} ?> "
+      conf.prompt_s       = "#{Chef::Dist::EXEC}#{leader(m)}%l> "
       conf.use_tracer     = false
     end
   end

data/lib/chef/shell/ext.rb

@@ -211,8 +211,8 @@ module Shell
       desc "prints information about chef"
       def version
         puts "This is the #{Chef::Dist::SHELL}.\n" +
-          " Chef Version: #{::Chef::VERSION}\n" +
-          " https://www.chef.io/\n" +
+          " #{Chef::Dist::PRODUCT} Version: #{::Chef::VERSION}\n" +
+          " #{Chef::Dist::WEBSITE}\n" +
           " https://docs.chef.io/"
         :ucanhaz_automation
       end

data/lib/chef/train_transport.rb

@@ -100,7 +100,7 @@ class Chef
       tm_config = Chef::Config.target_mode
       protocol = tm_config.protocol
       train_config = tm_config.to_hash.select { |k| Train.options(protocol).key?(k) }
-      Chef::Log.trace("Using target mode options from Chef config file: #{train_config.keys.join(", ")}") if train_config
+      Chef::Log.trace("Using target mode options from #{Chef::Dist::PRODUCT} config file: #{train_config.keys.join(", ")}") if train_config
 
       # Load the credentials file, and place any valid settings into the train configuration
       credentials = load_credentials(tm_config.host)

data/lib/chef/version.rb

@@ -23,7 +23,7 @@ require_relative "version_string"
 
 class Chef
   CHEF_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = Chef::VersionString.new("15.3.14")
+  VERSION = Chef::VersionString.new("15.4.45")
 end
 
 #

data/spec/functional/resource/ifconfig_spec.rb

@@ -24,8 +24,6 @@ require "chef/mixin/shell_out"
 include_flag = !(%w{amazon debian aix}.include?(ohai[:platform_family]) || (ohai[:platform_family] == "rhel" && ohai[:platform_version].to_i < 7))
 
 describe Chef::Resource::Ifconfig, :requires_root, external: include_flag do
-  # This test does not work in travis because there is no eth0
-
   include Chef::Mixin::ShellOut
 
   let(:new_resource) do

data/spec/functional/resource/mount_spec.rb

@@ -25,13 +25,9 @@ require "tmpdir"
 include_flag = !(%w{debian rhel amazon aix solaris2}.include?(ohai[:platform_family]))
 
 describe Chef::Resource::Mount, :requires_root, external: include_flag do
-  # Disabled in travis because it refuses to let us mount a ramdisk. /dev/ramX does not
-  # exist even after loading the kernel module
-
   include Chef::Mixin::ShellOut
 
   # Platform specific setup, cleanup and validation helpers.
-
   def setup_device_for_mount
     # use ramdisk for creating a test device for mount.
     # This can cleaner if we have chef resource/provider for ramdisk.

data/spec/functional/util/powershell/cmdlet_spec.rb

@@ -88,7 +88,7 @@ describe Chef::Util::Powershell::Cmdlet, :windows_powershell_dsc_only do
     it "returns json format data" do
       result = cmdlet_alias_requires_switch_or_argument.run({}, {}, "ls")
       expect(result.succeeded?).to eq(true)
-      expect(lambda { Chef::JSONCompat.parse(result.return_value) }).not_to raise_error
+      expect { Chef::JSONCompat.parse(result.return_value) }.not_to raise_error
     end
   end
 
@@ -105,7 +105,7 @@ describe Chef::Util::Powershell::Cmdlet, :windows_powershell_dsc_only do
   context "when constructor is given invalid arguments" do
     let(:cmd_output_format) { :invalid }
     it "throws an exception if an invalid format is passed to the constructor" do
-      expect(lambda { simple_cmdlet }).to raise_error(ArgumentError)
+      expect { simple_cmdlet }.to raise_error(ArgumentError)
     end
   end
 end

data/spec/integration/knife/chef_repo_path_spec.rb

@@ -79,7 +79,8 @@ describe "chef_repo_path tests", :workstation do
         EOM
       end
 
-      it "knife list --local -Rfp --chef-repo-path chef_r~1 / grabs chef_repo2 stuff", :windows_only do
+      # "Skipping for BK... As Windows 2019 has 8dot3name disabled by default"
+      it "knife list --local -Rfp --chef-repo-path chef_r~1 / grabs chef_repo2 stuff", :windows_only, :skip_buildkite do
         Chef::Config.delete(:chef_repo_path)
         knife("list --local -Rfp --chef-repo-path #{path_to("chef_r~1")} /").should_succeed <<~EOM
           /clients/
@@ -101,7 +102,8 @@ describe "chef_repo_path tests", :workstation do
         EOM
       end
 
-      it "knife list --local -Rfp --chef-repo-path chef_r~1 / grabs chef_repo2 stuff", :windows_only do
+      # "Skipping for BK... As Windows 2019 has 8dot3name disabled by default"
+      it "knife list --local -Rfp --chef-repo-path chef_r~1 / grabs chef_repo2 stuff", :windows_only, :skip_buildkite do
         Chef::Config.delete(:chef_repo_path)
         knife("list -z -Rfp --chef-repo-path #{path_to("chef_r~1")} /").should_succeed <<~EOM
           /acls/

data/spec/integration/recipes/resource_converge_if_changed_spec.rb

@@ -53,9 +53,9 @@ describe "Resource::ActionClass#converge_if_changed" do
       context "and current_resource with state1=current, state2=current" do
         before :each do
           resource_class.load_current_value do
-            state1 "current_state1"
-            state2 "current_state2"
-            sensitive1 "current_dontprintme"
+            state1 "default_state1"
+            state2 "default_state2"
+            sensitive1 "default_dontprintme"
           end
         end
 
@@ -86,7 +86,7 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state1 to "new_state1" (was "current_state1")
+                -   set state1 to "new_state1" (was "default_state1")
             EOM
           end
         end
@@ -107,8 +107,8 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state1 to "new_state1" (was "current_state1")
-                -   set state2 to "new_state2" (was "current_state2")
+                -   set state1 to "new_state1" (was "default_state1")
+                -   set state2 to "new_state2" (was "default_state2")
             EOM
           end
         end
@@ -160,7 +160,7 @@ describe "Resource::ActionClass#converge_if_changed" do
           let(:converge_recipe) do
             <<-EOM
               #{resource_name} 'blah' do
-                state1 'current_state1'
+                state1 'default_state1'
                 state2 'new_state2'
               end
             EOM
@@ -172,7 +172,7 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state2 to "new_state2" (was "current_state2")
+                -   set state2 to "new_state2" (was "default_state2")
             EOM
           end
         end
@@ -181,8 +181,8 @@ describe "Resource::ActionClass#converge_if_changed" do
           let(:converge_recipe) do
             <<-EOM
               #{resource_name} 'blah' do
-                state1 'current_state1'
-                state2 'current_state2'
+                state1 'default_state1'
+                state2 'default_state2'
               end
             EOM
           end
@@ -344,8 +344,8 @@ describe "Resource::ActionClass#converge_if_changed" do
       context "and current_resource with state1=current, state2=current" do
         before :each do
           resource_class.load_current_value do
-            state1 "current_state1"
-            state2 "current_state2"
+            state1 "default_state1"
+            state2 "default_state2"
           end
         end
 
@@ -377,7 +377,7 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state1 to "new_state1" (was "current_state1")
+                -   set state1 to "new_state1" (was "default_state1")
             EOM
           end
         end
@@ -398,9 +398,9 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state1 to "new_state1" (was "current_state1")
+                -   set state1 to "new_state1" (was "default_state1")
                 - update default_identity1
-                -   set state2 to "new_state2" (was "current_state2")
+                -   set state2 to "new_state2" (was "default_state2")
             EOM
           end
         end
@@ -409,7 +409,7 @@ describe "Resource::ActionClass#converge_if_changed" do
           let(:converge_recipe) do
             <<-EOM
               #{resource_name} 'blah' do
-                state1 'current_state1'
+                state1 'default_state1'
                 state2 'new_state2'
               end
             EOM
@@ -421,7 +421,7 @@ describe "Resource::ActionClass#converge_if_changed" do
             expect(converged_recipe.stdout).to eq <<~EOM
               * #{resource_name}[blah] action create
                 - update default_identity1
-                -   set state2 to "new_state2" (was "current_state2")
+                -   set state2 to "new_state2" (was "default_state2")
             EOM
           end
         end
@@ -430,8 +430,8 @@ describe "Resource::ActionClass#converge_if_changed" do
           let(:converge_recipe) do
             <<-EOM
               #{resource_name} 'blah' do
-                state1 'current_state1'
-                state2 'current_state2'
+                state1 'default_state1'
+                state2 'default_state2'
               end
             EOM
           end