chef 13.6.4 → 13.7.16

data/lib/chef/property.rb

@@ -99,7 +99,7 @@ class Chef
       if options.has_key?(:name_attribute)
         # If we have both name_attribute and name_property and they differ, raise an error
         if options.has_key?(:name_property)
-          raise ArgumentError, "Cannot specify both name_property and name_attribute together on property #{self}."
+          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
         options = Hash[options.map { |k, v| k == :name_attribute ? [ :name_property, v ] : [ k, v ] }]
@@ -107,7 +107,7 @@ class Chef
       end
 
       if options.has_key?(:default) && options.has_key?(:name_property)
-        raise ArgumentError, "Cannot specify both default and name_property/name_attribute together on property #{self}"
+        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
 
       # Recursively freeze the default if it isn't a lazy value.
@@ -361,7 +361,7 @@ class Chef
       end
 
       if value.nil? && required?
-        raise Chef::Exceptions::ValidationFailed, "#{name} is required"
+        raise Chef::Exceptions::ValidationFailed, "#{name} is a required property"
       else
         value
       end
@@ -386,7 +386,7 @@ class Chef
       value = set_value(resource, input_to_stored_value(resource, value))
 
       if value.nil? && required?
-        raise Chef::Exceptions::ValidationFailed, "#{name} is required"
+        raise Chef::Exceptions::ValidationFailed, "#{name} is a required property"
       else
         value
       end
@@ -457,7 +457,7 @@ class Chef
     # options.
     #
     # @param resource [Chef::Resource] The resource we're validating against
-    #   (to provide context for the validate).
+    #   (to provide context for the validation).
     # @param value The value to validate.
     #
     # @raise Chef::Exceptions::ValidationFailed If the value is invalid for
@@ -514,18 +514,18 @@ class Chef
       # very confusing results.
       if property_redefines_method?
         resource_name = declared_in.respond_to?(:resource_name) ? declared_in.resource_name : declared_in
-        raise ArgumentError, "Property `#{name}` of resource `#{resource_name}` overwrites an existing method."
+        raise ArgumentError, "Property `#{name}` of resource `#{resource_name}` overwrites an existing method. A different name should be used for this property."
       end
 
       # We prefer this form because the property name won't show up in the
       # stack trace if you use `define_method`.
       declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1
         def #{name}(value=NOT_PASSED)
-          raise "Property `#{name}` of `\#{self}` was incorrectly passed a block.  Possible property-resource collision.  To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block_given?
+          raise "Property `#{name}` of `\#{self}` was incorrectly passed a block. Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block_given?
           self.class.properties[#{name.inspect}].call(self, value)
         end
         def #{name}=(value)
-          raise "Property `#{name}` of `\#{self}` was incorrectly passed a block.  Possible property-resource collision.  To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block_given?
+          raise "Property `#{name}` of `\#{self}` was incorrectly passed a block. Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block_given?
           self.class.properties[#{name.inspect}].set(self, value)
         end
       EOM

data/lib/chef/provider.rb

@@ -250,7 +250,13 @@ class Chef
           properties_str = if new_resource.sensitive
                              specified_properties.join(", ")
                            else
-                             specified_properties.map { |p| "#{p}=#{new_resource.send(p).inspect}" }.join(", ")
+                             specified_properties.map do |property|
+                               "#{property}=" << if new_resource.class.properties[property].sensitive?
+                                                   "(suppressed sensitive property)"
+                                                 else
+                                                   new_resource.send(property).inspect
+                                                 end
+                             end.join(", ")
                            end
           Chef::Log.debug("Skipping update of #{new_resource}: has not changed any of the specified properties #{properties_str}.")
           return false
@@ -259,7 +265,7 @@ class Chef
         # Print the pretty green text and run the block
         property_size = modified.map { |p| p.size }.max
         modified.map! do |p|
-          properties_str = if new_resource.sensitive
+          properties_str = if new_resource.sensitive || new_resource.class.properties[p].sensitive?
                              "(suppressed sensitive property)"
                            else
                              "#{new_resource.send(p).inspect} (was #{current_resource.send(p).inspect})"
@@ -274,7 +280,7 @@ class Chef
         property_size = properties.map { |p| p.size }.max
         created = properties.map do |property|
           default = " (default value)" unless new_resource.property_is_set?(property)
-          properties_str = if new_resource.sensitive
+          properties_str = if new_resource.sensitive || new_resource.class.properties[property].sensitive?
                              "(suppressed sensitive property)"
                            else
                              new_resource.send(property).inspect

data/lib/chef/provider/apt_preference.rb

@@ -24,7 +24,7 @@ require "chef/log"
 class Chef
   class Provider
     class AptPreference < Chef::Provider
-      provides :apt_preference, os: "linux", platform_family: "debian"
+      provides :apt_preference, platform_family: "debian"
 
       APT_PREFERENCE_DIR = "/etc/apt/preferences.d".freeze
 

data/lib/chef/provider/apt_repository.rb

@@ -27,7 +27,7 @@ class Chef
     class AptRepository < Chef::Provider
       include Chef::Mixin::ShellOut
 
-      provides :apt_repository, os: "linux", platform_family: "debian"
+      provides :apt_repository, platform_family: "debian"
 
       LIST_APT_KEYS = "apt-key list".freeze
       LIST_APT_KEY_FINGERPRINTS = "apt-key adv --list-public-keys --with-fingerprint --with-colons".freeze

data/lib/chef/provider/apt_update.rb

@@ -23,7 +23,7 @@ require "chef/dsl/declare_resource"
 class Chef
   class Provider
     class AptUpdate < Chef::Provider
-      provides :apt_update, os: "linux", platform_family: "debian"
+      provides :apt_update, platform_family: "debian"
 
       APT_CONF_DIR = "/etc/apt/apt.conf.d"
       STAMP_DIR = "/var/lib/apt/periodic"

data/lib/chef/provider/file.rb

@@ -339,7 +339,7 @@ class Chef
         if tempfile
           new_resource.verify.each do |v|
             if ! v.verify(tempfile.path)
-              raise Chef::Exceptions::ValidationFailed.new "Proposed content for #{new_resource.path} failed verification #{v}"
+              raise Chef::Exceptions::ValidationFailed.new "Proposed content for #{new_resource.path} failed verification #{new_resource.sensitive ? '[sensitive]' : v}"
             end
           end
         end

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

@@ -88,8 +88,12 @@ class Chef
 
         def gid_used?(gid)
           return false unless gid
-          groups_gids = safe_dscl("list", "/Groups", "gid")
-          !!( groups_gids =~ Regexp.new("#{Regexp.escape(gid.to_s)}\n") )
+          search_gids = safe_dscl("search", "/Groups", "PrimaryGroupID", gid.to_s)
+
+          # dscl -search should not return anything if the gid doesn't exist,
+          # but on the off-chance that it does, check whether the given gid is
+          # in the output.
+          !!(search_gids =~ /\b#{gid}\b/)
         end
 
         def set_gid

data/lib/chef/provider/ifconfig.rb

@@ -23,20 +23,14 @@ require "chef/resource/file"
 require "chef/exceptions"
 require "erb"
 
-#  Recipe example:
-#
-#    int = {Hash with your network settings...}
-#
-#    ifconfig  int['ip'] do
-#      ignore_failure  true
-#      device  int['dev']
-#      mask    int['mask']
-#      gateway int['gateway']
-#      mtu     int['mtu']
-#    end
-
 class Chef
   class Provider
+    # use the ifconfig resource to manage interfaces on *nix systems
+    #
+    # @example set a static ip on eth1
+    #   ifconfig '33.33.33.80' do
+    #     device 'eth1'
+    #   end
     class Ifconfig < Chef::Provider
       provides :ifconfig
 
@@ -57,30 +51,98 @@ class Chef
         @ifconfig_success = true
         @interfaces = {}
 
-        @status = shell_out("ifconfig")
-        @status.stdout.each_line do |line|
-          if !line[0..9].strip.empty?
-            @int_name = line[0..9].strip
-            @interfaces[@int_name] = { "hwaddr" => (line =~ /(HWaddr)/ ? ($') : "nil").strip.chomp }
-          else
-            @interfaces[@int_name]["inet_addr"] = (line =~ /inet addr:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /inet addr:/
-            @interfaces[@int_name]["bcast"] = (line =~ /Bcast:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Bcast:/
-            @interfaces[@int_name]["mask"] = (line =~ /Mask:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Mask:/
-            @interfaces[@int_name]["mtu"] = (line =~ /MTU:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /MTU:/
-            @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Metric:/
+        @ifconfig_version = nil
+
+        @net_tools_version = shell_out("ifconfig --version")
+        @net_tools_version.stderr.each_line do |line|
+          if line =~ /^net-tools (\d+.\d+)/
+            @ifconfig_version = line.match(/^net-tools (\d+.\d+)/)[1]
           end
+        end
+
+        if @ifconfig_version.nil?
+          raise "net-tools not found - this is required for ifconfig"
+        elsif @ifconfig_version.to_f < 2.0
+          # Example output for 1.60 is as follows: (sanitized but format intact)
+          # eth0      Link encap:Ethernet  HWaddr 00:00:00:00:00:00
+          #           inet addr:192.168.1.1  Bcast:192.168.0.1  Mask:255.255.248.0
+          #           inet6 addr: 0000::00:0000:0000:0000/64 Scope:Link
+          #           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          #           RX packets:65158911 errors:0 dropped:0 overruns:0 frame:0
+          #           TX packets:41723949 errors:0 dropped:0 overruns:0 carrier:0
+          #           collisions:0 txqueuelen:1000
+          #           RX bytes:42664658792 (39.7 GiB)  TX bytes:52722603938 (49.1 GiB)
+          #           Interrupt:30
+          @status = shell_out("ifconfig")
+          @status.stdout.each_line do |line|
+            if !line[0..9].strip.empty?
+              @int_name = line[0..9].strip
+              @interfaces[@int_name] = { "hwaddr" => (line =~ /(HWaddr)/ ? ($') : "nil").strip.chomp }
+            else
+              @interfaces[@int_name]["inet_addr"] = (line =~ /inet addr:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /inet addr:/
+              @interfaces[@int_name]["bcast"] = (line =~ /Bcast:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Bcast:/
+              @interfaces[@int_name]["mask"] = (line =~ /Mask:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Mask:/
+              @interfaces[@int_name]["mtu"] = (line =~ /MTU:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /MTU:/
+              @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Metric:/
+            end
 
-          next unless @interfaces.key?(new_resource.device)
-          @interface = @interfaces.fetch(new_resource.device)
-
-          current_resource.target(new_resource.target)
-          current_resource.device(new_resource.device)
-          current_resource.inet_addr(@interface["inet_addr"])
-          current_resource.hwaddr(@interface["hwaddr"])
-          current_resource.bcast(@interface["bcast"])
-          current_resource.mask(@interface["mask"])
-          current_resource.mtu(@interface["mtu"])
-          current_resource.metric(@interface["metric"])
+            next unless @interfaces.key?(new_resource.device)
+            @interface = @interfaces.fetch(new_resource.device)
+
+            current_resource.target(new_resource.target)
+            current_resource.device(new_resource.device)
+            current_resource.inet_addr(@interface["inet_addr"])
+            current_resource.hwaddr(@interface["hwaddr"])
+            current_resource.bcast(@interface["bcast"])
+            current_resource.mask(@interface["mask"])
+            current_resource.mtu(@interface["mtu"])
+            current_resource.metric(@interface["metric"])
+          end
+        elsif @ifconfig_version.to_f >= 2.0
+          # Example output for 2.10-alpha is as follows: (sanitized but format intact)
+          # eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
+          #       inet 192.168.1.1  netmask 255.255.240.0  broadcast 192.168.0.1
+          #       inet6 0000::0000:000:0000:0000  prefixlen 64  scopeid 0x20<link>
+          #       ether 00:00:00:00:00:00  txqueuelen 1000  (Ethernet)
+          #       RX packets 2383836  bytes 1642630840 (1.5 GiB)
+          #       RX errors 0  dropped 0  overruns 0  frame 0
+          #       TX packets 1244218  bytes 977339327 (932.0 MiB)
+          #       TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
+          @status = shell_out("ifconfig")
+          @status.stdout.each_line do |line|
+            addr_regex = /^(\w+):?(\d*):?\ .+$/
+            if line =~ addr_regex
+              if line.match(addr_regex).nil?
+                @int_name = "nil"
+              elsif line.match(addr_regex)[2] == ""
+                @int_name = line.match(addr_regex)[1]
+                @interfaces[@int_name] = Hash.new
+                @interfaces[@int_name]["mtu"] = (line =~ /mtu (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /mtu/ && @interfaces[@int_name]["mtu"].nil?
+              else
+                @int_name = "#{line.match(addr_regex)[1]}:#{line.match(addr_regex)[2]}"
+                @interfaces[@int_name] = Hash.new
+                @interfaces[@int_name]["mtu"] = (line =~ /mtu (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /mtu/ && @interfaces[@int_name]["mtu"].nil?
+              end
+            else
+              @interfaces[@int_name]["inet_addr"] = (line =~ /inet (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /inet/ && @interfaces[@int_name]["inet_addr"].nil?
+              @interfaces[@int_name]["bcast"] = (line =~ /broadcast (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /broadcast/ && @interfaces[@int_name]["bcast"].nil?
+              @interfaces[@int_name]["mask"] = (line =~ /netmask (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /netmask/ && @interfaces[@int_name]["mask"].nil?
+              @interfaces[@int_name]["hwaddr"] = (line =~ /ether (\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /ether/ && @interfaces[@int_name]["hwaddr"].nil?
+              @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Metric:/ && @interfaces[@int_name]["metric"].nil?
+            end
+
+            next unless @interfaces.key?(new_resource.device)
+            @interface = @interfaces.fetch(new_resource.device)
+
+            current_resource.target(new_resource.target)
+            current_resource.device(new_resource.device)
+            current_resource.inet_addr(@interface["inet_addr"])
+            current_resource.hwaddr(@interface["hwaddr"])
+            current_resource.bcast(@interface["bcast"])
+            current_resource.mask(@interface["mask"])
+            current_resource.mtu(@interface["mtu"])
+            current_resource.metric(@interface["metric"])
+          end
         end
         current_resource
       end

data/lib/chef/provider/launchd.rb

@@ -17,7 +17,6 @@
 #
 
 require "chef/provider"
-require "chef/resource/launchd"
 require "chef/resource/file"
 require "chef/resource/cookbook_file"
 require "chef/resource/macosx_service"

data/lib/chef/provider/log.rb

@@ -17,37 +17,27 @@
 #
 
 class Chef
-
   class Provider
-
     class Log
-
-      # Chef log provider, allows logging to chef's logs from recipes
+      # Chef log provider, allows logging to chef's logs
       class ChefLog < Chef::Provider
-
         provides :log
 
         # No concept of a 'current' resource for logs, this is a no-op
         #
-        # === Return
-        # true:: Always return true
+        # @return [true] Always returns true
         def load_current_resource
           true
         end
 
         # Write the log to Chef's log
         #
-        # === Return
-        # true:: Always return true
+        # @return [true] Always returns true
         def action_write
           Chef::Log.send(new_resource.level, new_resource.message)
           new_resource.updated_by_last_action(true) if Chef::Config[:count_log_resource_updates]
         end
-
       end
-
     end
-
   end
-
 end

data/lib/chef/provider/package/dnf.rb

@@ -148,7 +148,7 @@ class Chef
           @available_version[index]
         end
 
-        # @returns Array<Version>
+        # @return [Array<Version>]
         def installed_version(index)
           @installed_version ||= []
           @installed_version[index] ||= if new_resource.source

data/lib/chef/provider/package/smartos.rb

@@ -3,7 +3,7 @@
 #           Bryan McLellan (btm@loftninjas.org)
 #           Matthew Landauer (matthew@openaustralia.org)
 #           Ben Rockwood (benr@joyent.com)
-# Copyright:: Copyright 2009-2016, Bryan McLellan, Matthew Landauer
+# Copyright:: Copyright 2009-2018, Bryan McLellan, Matthew Landauer
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,7 +30,7 @@ class Chef
         attr_accessor :is_virtual_package
 
         provides :package, platform: "smartos"
-        provides :smartos_package, os: "solaris2", platform_family: "smartos"
+        provides :smartos_package, platform_family: "smartos"
 
         def load_current_resource
           Chef::Log.debug("#{new_resource} loading current resource")

data/lib/chef/provider/reboot.rb

@@ -21,9 +21,19 @@ require "chef/provider"
 
 class Chef
   class Provider
+    # 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.0
     class Reboot < Chef::Provider
       provides :reboot
 
+      # @return [void]
       def load_current_resource
         @current_resource ||= Chef::Resource::Reboot.new(new_resource.name)
         current_resource.reason(new_resource.reason)
@@ -31,6 +41,8 @@ class Chef
         current_resource
       end
 
+      # add a reboot to the node run_context
+      # @return [void]
       def request_reboot
         node.run_context.request_reboot(
           :delay_mins => new_resource.delay_mins,

data/lib/chef/provider/remote_directory.rb

@@ -153,7 +153,7 @@ class Chef
       #
       # FIXME: it should do breadth-first, see CHEF-5080 (please use a performant sort)
       #
-      # @return Array<String> The list of files to transfer
+      # @return [Array<String>] The list of files to transfer
       # @api private
       #
       def files_to_transfer

data/lib/chef/provider/remote_file/http.rb

@@ -61,12 +61,13 @@ class Chef
 
         def fetch
           http = Chef::HTTP::Simple.new(uri, http_client_opts)
+          tempfile = Chef::FileContentManagement::Tempfile.new(@new_resource).tempfile
           if want_progress?
-            tempfile = http.streaming_request_with_progress(uri, headers) do |size, total|
+            tempfile = http.streaming_request_with_progress(uri, headers, tempfile) do |size, total|
               events.resource_update_progress(new_resource, size, total, progress_interval)
             end
           else
-            tempfile = http.streaming_request(uri, headers)
+            tempfile = http.streaming_request(uri, headers, tempfile)
           end
           if tempfile
             update_cache_control_data(tempfile, http.last_response)

data/lib/chef/provider/service/solaris.rb

@@ -31,7 +31,7 @@ class Chef
           super
           @init_command   = "/usr/sbin/svcadm"
           @status_command = "/bin/svcs"
-          @maintenace     = false
+          @maintenance    = false
         end
 
         def load_current_resource
@@ -54,6 +54,8 @@ class Chef
         end
 
         def enable_service
+          # Running service status to update maintenance status to invoke svcadm clear
+          service_status
           shell_out!(default_init_command, "clear", @new_resource.service_name) if @maintenance
           enable_flags = [ "-s", @new_resource.options ].flatten.compact
           shell_out!(default_init_command, "enable", *enable_flags, @new_resource.service_name)
@@ -93,6 +95,9 @@ class Chef
           # dependency   require_all/error svc:/milestone/multi-user:default (online)
           # $
 
+          # Set the default value for maintenance
+          @maintenance = false
+
           # load output into hash
           status = {}
           cmd.stdout.each_line do |line|
@@ -101,7 +106,6 @@ class Chef
           end
 
           # check service state
-          @maintenance = false
           case status["state"]
           when "online"
             @current_resource.enabled(true)