chef 14.2.0 → 14.3.37

data/lib/chef/powershell.rb

@@ -15,18 +15,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "ffi"
 require "chef/json_compat"
-require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
 
 class Chef
   class PowerShell
+    extend FFI::Library
 
     attr_reader :result
     attr_reader :errors
 
-    # Run a command under PowerShell via a managed (.NET) COM interop API.
-    # This implementation requires the managed dll to be registered on the
-    # target machine.
+    # Run a command under PowerShell via FFI
+    # This implementation requires the managed dll and native wrapper to be in the library search
+    # path on Windows (i.e. c:\windows\system32 or in the same location as ruby.exe).
     #
     # Requires: .NET Framework 4.0 or higher on the target machine.
     #
@@ -45,9 +46,10 @@ class Chef
     private
 
     def exec(script)
-      ps = WIN32OLE.new("Chef.PowerShell")
-      outcome = ps.ExecuteScript(script)
-      hashed_outcome = Chef::JSONCompat.parse(outcome)
+      FFI.ffi_lib "Chef.PowerShell.Wrapper.dll"
+      FFI.attach_function :execute_powershell, :ExecuteScript, [:string], :pointer
+      execution = FFI.execute_powershell(script).read_utf16string
+      hashed_outcome = Chef::JSONCompat.parse(execution)
       @result = Chef::JSONCompat.parse(hashed_outcome["result"])
       @errors = hashed_outcome["errors"]
     end

data/lib/chef/property.rb

@@ -121,9 +121,9 @@ class Chef
       options[:instance_variable_name] = options[:instance_variable_name].to_sym if options[:instance_variable_name]
 
       # Replace name_attribute with name_property
-      if options.has_key?(:name_attribute)
+      if options.key?(:name_attribute)
         # If we have both name_attribute and name_property and they differ, raise an error
-        if options.has_key?(:name_property)
+        if options.key?(:name_property)
           raise ArgumentError, "name_attribute and name_property are functionally identical and both cannot be specified on a property at once. Use just one on property #{self}"
         end
         # replace name_property with name_attribute in place
@@ -131,7 +131,7 @@ class Chef
         @options = options
       end
 
-      if options.has_key?(:default) && options.has_key?(:name_property)
+      if options.key?(:default) && options.key?(:name_property)
         raise ArgumentError, "A property cannot be both a name_property/name_attribute and have a default value. Use one or the other on property #{self}"
       end
 
@@ -208,7 +208,7 @@ class Chef
     # @return [Symbol]
     #
     def instance_variable_name
-      if options.has_key?(:instance_variable_name)
+      if options.key?(:instance_variable_name)
         options[:instance_variable_name]
       elsif name
         :"@#{name}"
@@ -224,7 +224,7 @@ class Chef
     # `nil`
     #
     def default
-      return options[:default] if options.has_key?(:default)
+      return options[:default] if options.key?(:default)
       return Chef::DelayedEvaluator.new { name } if name_property?
       nil
     end
@@ -246,7 +246,7 @@ class Chef
     # @return [Boolean]
     #
     def desired_state?
-      return true if !options.has_key?(:desired_state)
+      return true if !options.key?(:desired_state)
       options[:desired_state]
     end
 
@@ -265,7 +265,7 @@ class Chef
     # @return [Boolean]
     #
     def has_default?
-      options.has_key?(:default) || name_property?
+      options.key?(:default) || name_property?
     end
 
     #
@@ -403,7 +403,7 @@ class Chef
     def set(resource, value)
       value = set_value(resource, input_to_stored_value(resource, value))
 
-      if options.has_key?(:deprecated)
+      if options.key?(:deprecated)
         Chef.deprecated(:property, options[:deprecated])
       end
 
@@ -463,7 +463,7 @@ class Chef
     #   this property.
     #
     def coerce(resource, value)
-      if options.has_key?(:coerce)
+      if options.key?(:coerce)
         # nil is never coerced
         unless value.nil?
           value = exec_in_resource(resource, options[:coerce], value)
@@ -511,9 +511,9 @@ class Chef
       # if you specify one of them in modified_options it overrides anything in
       # the original options.
       options = self.options
-      if modified_options.has_key?(:name_property) ||
-          modified_options.has_key?(:name_attribute) ||
-          modified_options.has_key?(:default)
+      if modified_options.key?(:name_property) ||
+          modified_options.key?(:name_attribute) ||
+          modified_options.key?(:default)
         options = options.reject { |k, v| k == :name_attribute || k == :name_property || k == :default }
       end
       self.class.new(options.merge(modified_options))
@@ -599,8 +599,8 @@ class Chef
     #
     # @api private
     def explicitly_accepts_nil?(resource)
-      options.has_key?(:coerce) ||
-        (options.has_key?(:is) && Chef::Mixin::ParamsValidate.send(:_pv_is, { name => nil }, name, options[:is]))
+      options.key?(:coerce) ||
+        (options.key?(:is) && Chef::Mixin::ParamsValidate.send(:_pv_is, { name => nil }, name, options[:is]))
     rescue Chef::Exceptions::ValidationFailed, Chef::Exceptions::CannotValidateStaticallyError
       false
     end

data/lib/chef/provider/apt_update.rb

@@ -25,8 +25,8 @@ class Chef
     class AptUpdate < Chef::Provider
       provides :apt_update, platform_family: "debian"
 
-      APT_CONF_DIR = "/etc/apt/apt.conf.d"
-      STAMP_DIR = "/var/lib/apt/periodic"
+      APT_CONF_DIR = "/etc/apt/apt.conf.d".freeze
+      STAMP_DIR = "/var/lib/apt/periodic".freeze
 
       def load_current_resource
       end

data/lib/chef/provider/cron.rb

@@ -25,9 +25,9 @@ class Chef
 
       provides :cron, os: ["!aix", "!solaris2"]
 
-      SPECIAL_TIME_VALUES = [:reboot, :yearly, :annually, :monthly, :weekly, :daily, :midnight, :hourly]
-      CRON_ATTRIBUTES = [:minute, :hour, :day, :month, :weekday, :time, :command, :mailto, :path, :shell, :home, :environment]
-      WEEKDAY_SYMBOLS = [:sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday]
+      SPECIAL_TIME_VALUES = [:reboot, :yearly, :annually, :monthly, :weekly, :daily, :midnight, :hourly].freeze
+      CRON_ATTRIBUTES = [:minute, :hour, :day, :month, :weekday, :time, :command, :mailto, :path, :shell, :home, :environment].freeze
+      WEEKDAY_SYMBOLS = [:sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday].freeze
 
       CRON_PATTERN = /\A([-0-9*,\/]+)\s([-0-9*,\/]+)\s([-0-9*,\/]+)\s([-0-9*,\/]+|[a-zA-Z]{3})\s([-0-9*,\/]+|[a-zA-Z]{3})\s(.*)/
       SPECIAL_PATTERN = /\A(@(#{SPECIAL_TIME_VALUES.join('|')}))\s(.*)/

data/lib/chef/provider/cron/unix.rb

@@ -33,7 +33,7 @@ class Chef
         private
 
         def read_crontab
-          crontab = shell_out("/usr/bin/crontab -l", :user => @new_resource.user)
+          crontab = shell_out("/usr/bin/crontab -l", user: @new_resource.user)
           status = crontab.status.exitstatus
 
           logger.trace crontab.format_for_exception if status > 0
@@ -53,7 +53,7 @@ class Chef
           exit_status = 0
           error_message = ""
           begin
-            crontab_write = shell_out("/usr/bin/crontab #{tempcron.path}", :user => @new_resource.user)
+            crontab_write = shell_out("/usr/bin/crontab #{tempcron.path}", user: @new_resource.user)
             stderr = crontab_write.stderr
             exit_status = crontab_write.status.exitstatus
             # solaris9, 10 on some failures for example invalid 'mins' in crontab fails with exit code of zero :(

data/lib/chef/provider/dsc_resource.rb

@@ -169,7 +169,7 @@ class Chef
           "Invoke-DscResource #{switches}",
           output_format
         )
-        cmdlet.run!({}, { :timeout => new_resource.timeout })
+        cmdlet.run!({}, { timeout: new_resource.timeout })
       end
 
       def return_dsc_resource_result(result, property_name)

data/lib/chef/provider/dsc_script.rb

@@ -32,10 +32,10 @@ class Chef
         @dsc_resource = dsc_resource
         @resource_converged = false
         @operations = {
-          :set => Proc.new do |config_manager, document, shellout_flags|
+          set: Proc.new do |config_manager, document, shellout_flags|
             config_manager.set_configuration(document, shellout_flags)
           end,
-          :test => Proc.new do |config_manager, document, shellout_flags|
+          test: Proc.new do |config_manager, document, shellout_flags|
             config_manager.test_configuration(document, shellout_flags)
           end }
       end
@@ -86,9 +86,9 @@ class Chef
         config_manager = Chef::Util::DSC::LocalConfigurationManager.new(@run_context.node, config_directory)
 
         shellout_flags = {
-          :cwd => @dsc_resource.cwd,
-          :environment => @dsc_resource.environment,
-          :timeout => @dsc_resource.timeout,
+          cwd: @dsc_resource.cwd,
+          environment: @dsc_resource.environment,
+          timeout: @dsc_resource.timeout,
         }
 
         begin
@@ -113,9 +113,9 @@ class Chef
 
       def generate_configuration_document(config_directory, configuration_flags)
         shellout_flags = {
-          :cwd => @dsc_resource.cwd,
-          :environment => @dsc_resource.environment,
-          :timeout => @dsc_resource.timeout,
+          cwd: @dsc_resource.cwd,
+          environment: @dsc_resource.environment,
+          timeout: @dsc_resource.timeout,
         }
 
         generator = Chef::Util::DSC::ConfigurationGenerator.new(@run_context.node, config_directory)

data/lib/chef/provider/execute.rb

@@ -102,7 +102,7 @@ class Chef
         opts[:log_tag]     = new_resource.to_s
         if (logger.info? || live_stream?) && !sensitive?
           if run_context.events.formatter?
-            opts[:live_stream] = Chef::EventDispatch::EventsOutputStream.new(run_context.events, :name => :execute)
+            opts[:live_stream] = Chef::EventDispatch::EventsOutputStream.new(run_context.events, name: :execute)
           elsif stream_to_stdout?
             opts[:live_stream] = STDOUT
           end

data/lib/chef/provider/group/aix.rb

@@ -32,33 +32,33 @@ class Chef
         end
 
         def create_group
-          shell_out_compact!("mkgroup", set_options, new_resource.group_name)
+          shell_out!("mkgroup", set_options, new_resource.group_name)
           modify_group_members
         end
 
         def manage_group
           options = set_options
           if options.size > 0
-            shell_out_compact!("chgroup", options, new_resource.group_name)
+            shell_out!("chgroup", options, new_resource.group_name)
           end
           modify_group_members
         end
 
         def remove_group
-          shell_out_compact!("rmgroup", new_resource.group_name)
+          shell_out!("rmgroup", new_resource.group_name)
         end
 
         def add_member(member)
-          shell_out_compact!("chgrpmem", "-m", "+", member, new_resource.group_name)
+          shell_out!("chgrpmem", "-m", "+", member, new_resource.group_name)
         end
 
         def set_members(members)
           return if members.empty?
-          shell_out_compact!("chgrpmem", "-m", "=", members.join(","), new_resource.group_name)
+          shell_out!("chgrpmem", "-m", "=", members.join(","), new_resource.group_name)
         end
 
         def remove_member(member)
-          shell_out_compact!("chgrpmem", "-m", "-", member, new_resource.group_name)
+          shell_out!("chgrpmem", "-m", "-", member, new_resource.group_name)
         end
 
         def set_options

data/lib/chef/provider/group/dscl.rb

@@ -27,7 +27,7 @@ class Chef
           argdup = args.dup
           cmd = argdup.shift
           shellcmd = [ "dscl", ".", "-#{cmd}", argdup ]
-          status = shell_out_compact(shellcmd)
+          status = shell_out(shellcmd)
           stdout_result = ""
           stderr_result = ""
           status.stdout.each_line { |line| stdout_result << line }

data/lib/chef/provider/group/gpasswd.rb

@@ -39,18 +39,18 @@ class Chef
 
         def set_members(members)
           if members.empty?
-            shell_out_compact!("gpasswd", "-M", "", new_resource.group_name)
+            shell_out!("gpasswd", "-M", "", new_resource.group_name)
           else
-            shell_out_compact!("gpasswd", "-M", members.join(","), new_resource.group_name)
+            shell_out!("gpasswd", "-M", members.join(","), new_resource.group_name)
           end
         end
 
         def add_member(member)
-          shell_out_compact!("gpasswd", "-a", member, new_resource.group_name)
+          shell_out!("gpasswd", "-a", member, new_resource.group_name)
         end
 
         def remove_member(member)
-          shell_out_compact!("gpasswd", "-d", member, new_resource.group_name)
+          shell_out!("gpasswd", "-d", member, new_resource.group_name)
         end
       end
     end

data/lib/chef/provider/group/groupadd.rb

@@ -44,19 +44,19 @@ class Chef
 
         # Create the group
         def create_group
-          shell_out_compact!("groupadd", set_options, groupadd_options)
+          shell_out!("groupadd", set_options, groupadd_options)
           modify_group_members
         end
 
         # Manage the group when it already exists
         def manage_group
-          shell_out_compact!("groupmod", set_options)
+          shell_out!("groupmod", set_options)
           modify_group_members
         end
 
         # Remove the group
         def remove_group
-          shell_out_compact!("groupdel", new_resource.group_name)
+          shell_out!("groupdel", new_resource.group_name)
         end
 
         def modify_group_members

data/lib/chef/provider/group/groupmod.rb

@@ -32,7 +32,7 @@ class Chef
 
         # Create the group
         def create_group
-          shell_out_compact!("group", "add", set_options)
+          shell_out!("group", "add", set_options)
 
           add_group_members(new_resource.members)
         end
@@ -79,14 +79,14 @@ class Chef
 
         # Remove the group
         def remove_group
-          shell_out_compact!("group", "del", new_resource.group_name)
+          shell_out!("group", "del", new_resource.group_name)
         end
 
         # Adds a list of usernames to the group using `user mod`
         def add_group_members(members)
           logger.trace("#{new_resource} adding members #{members.join(', ')}") unless members.empty?
           members.each do |user|
-            shell_out_compact!("user", "mod", "-G", new_resource.group_name, user)
+            shell_out!("user", "mod", "-G", new_resource.group_name, user)
           end
         end
 
@@ -94,11 +94,11 @@ class Chef
         # "<name>_bak", create a new group with the same GID and
         # "<name>", then set correct members on that group
         def reset_group_membership
-          shell_out_compact!("group", "mod", "-n", "#{new_resource.group_name}_bak", new_resource.group_name)
+          shell_out!("group", "mod", "-n", "#{new_resource.group_name}_bak", new_resource.group_name)
 
-          shell_out_compact!("group", "add", set_options(overwrite_gid: true))
+          shell_out!("group", "add", set_options(overwrite_gid: true))
 
-          shell_out_compact!("group", "del", "#{new_resource.group_name}_bak")
+          shell_out!("group", "del", "#{new_resource.group_name}_bak")
         end
 
         # Little bit of magic as per Adam's useradd provider to pull and assign the command line flags

data/lib/chef/provider/group/pw.rb

@@ -48,24 +48,24 @@ class Chef
             command += [ "-M", new_resource.members.join(",") ]
           end
 
-          shell_out_compact!(command)
+          shell_out!(command)
         end
 
         # Manage the group when it already exists
         def manage_group
           member_options = set_members_options
           if member_options.empty?
-            shell_out_compact!("pw", "groupmod", set_options)
+            shell_out!("pw", "groupmod", set_options)
           else
             member_options.each do |option|
-              shell_out_compact!("pw", "groupmod", set_options, option)
+              shell_out!("pw", "groupmod", set_options, option)
             end
           end
         end
 
         # Remove the group
         def remove_group
-          shell_out_compact!("pw", "groupdel", new_resource.group_name)
+          shell_out!("pw", "groupdel", new_resource.group_name)
         end
 
         # Little bit of magic as per Adam's useradd provider to pull and assign the command line flags

data/lib/chef/provider/group/suse.rb

@@ -66,7 +66,7 @@ class Chef
         end
 
         def add_member(member)
-          shell_out_compact!("groupmod", "-A", member, new_resource.group_name)
+          shell_out!("groupmod", "-A", member, new_resource.group_name)
         end
 
         def to_remove(members)
@@ -74,7 +74,7 @@ class Chef
         end
 
         def remove_member(member)
-          shell_out_compact!("groupmod", "-R", member, new_resource.group_name)
+          shell_out!("groupmod", "-R", member, new_resource.group_name)
         end
 
       end

data/lib/chef/provider/group/usermod.rb

@@ -66,7 +66,7 @@ class Chef
         end
 
         def add_member(member)
-          shell_out_compact!("usermod", append_flags, new_resource.group_name, member)
+          shell_out!("usermod", append_flags, new_resource.group_name, member)
         end
 
         def remove_member(member)

data/lib/chef/provider/http_request.rb

@@ -37,7 +37,7 @@ class Chef
         # CHEF-4762: we expect a nil return value from Chef::HTTP for a "200 Success" response
         # and false for a "304 Not Modified" response
         modified = @http.head(
-          "#{new_resource.url}",
+          (new_resource.url).to_s,
           new_resource.headers
         )
         logger.info("#{new_resource} HEAD to #{new_resource.url} successful")
@@ -54,7 +54,7 @@ class Chef
 
           message = check_message(new_resource.message)
           body = @http.get(
-            "#{new_resource.url}",
+            (new_resource.url).to_s,
             new_resource.headers
           )
           logger.info("#{new_resource} GET to #{new_resource.url} successful")
@@ -67,7 +67,7 @@ class Chef
         converge_by("#{new_resource} PATCH to #{new_resource.url}") do
           message = check_message(new_resource.message)
           body = @http.patch(
-            "#{new_resource.url}",
+            (new_resource.url).to_s,
             message,
             new_resource.headers
           )
@@ -81,7 +81,7 @@ class Chef
         converge_by("#{new_resource} PUT to #{new_resource.url}") do
           message = check_message(new_resource.message)
           body = @http.put(
-            "#{new_resource.url}",
+            (new_resource.url).to_s,
             message,
             new_resource.headers
           )
@@ -95,7 +95,7 @@ class Chef
         converge_by("#{new_resource} POST to #{new_resource.url}") do
           message = check_message(new_resource.message)
           body = @http.post(
-            "#{new_resource.url}",
+            (new_resource.url).to_s,
             message,
             new_resource.headers
           )
@@ -108,7 +108,7 @@ class Chef
       def action_delete
         converge_by("#{new_resource} DELETE to #{new_resource.url}") do
           body = @http.delete(
-            "#{new_resource.url}",
+            (new_resource.url).to_s,
             new_resource.headers
           )
           new_resource.updated_by_last_action(true)