chef 10.12.0 → 10.14.0.beta.1

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

@@ -30,23 +30,27 @@ class Chef
         def load_current_resource
           @current_resource = Chef::Resource::Service.new(@new_resource.name)
           @current_resource.service_name(@new_resource.service_name)
-
+          @rcd_script_found = true
+          @enabled_state_found = false
           # Determine if we're talking about /etc/rc.d or /usr/local/etc/rc.d
           if ::File.exists?("/etc/rc.d/#{current_resource.service_name}")
             @init_command = "/etc/rc.d/#{current_resource.service_name}"
           elsif ::File.exists?("/usr/local/etc/rc.d/#{current_resource.service_name}")
             @init_command = "/usr/local/etc/rc.d/#{current_resource.service_name}"
           else
-            raise Chef::Exceptions::Service, "#{@new_resource}: unable to locate the rc.d script"
+            @rcd_script_found = false 
+            return
           end
           Chef::Log.debug("#{@current_resource} found at #{@init_command}")
-
           determine_current_status!
-
-          if ::File.exists?("/etc/rc.conf")
+          # Default to disabled if the service doesn't currently exist
+          # at all 
+          var_name = service_enable_variable_name
+          if ::File.exists?("/etc/rc.conf") && var_name
             read_rc_conf.each do |line|
               case line
-              when /#{Regexp.escape(service_enable_variable_name)}="(\w+)"/
+              when /#{Regexp.escape(var_name)}="(\w+)"/
+                @enabled_state_found = true
                 if $1 =~ /[Yy][Ee][Ss]/
                   @current_resource.enabled true
                 elsif $1 =~ /[Nn][Oo][Nn]?[Oo]?[Nn]?[Ee]?/
@@ -57,11 +61,34 @@ class Chef
           end
           unless @current_resource.enabled
             Chef::Log.debug("#{@new_resource.name} enable/disable state unknown")
+            @current_resource.enabled false
           end
 
           @current_resource
         end
 
+        def define_resource_requirements
+          super
+
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @rcd_script_found } 
+            a.failure_message Chef::Exceptions::Service, "#{@new_resource}: unable to locate the rc.d script"
+          end
+
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @enabled_state_found }  
+            # for consistentcy with original behavior, this will not fail in non-whyrun mode; 
+            # rather it will silently set enabled state=>false
+            a.whyrun "Unable to determine enabled/disabled state, assuming this will be correct for an actual run.  Assuming disabled." 
+          end
+
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @rcd_script_found && service_enable_variable_name != nil } 
+            a.failure_message Chef::Exceptions::Service, "Could not find the service name in #{@init_command} and rcvar"
+            # No recovery in whyrun mode - the init file is present but not correct.
+          end
+        end
+
         def start_service
           if @new_resource.start_command
             super
@@ -80,6 +107,7 @@ class Chef
 
         def restart_service
           if @new_resource.restart_command
+
             super
           elsif @new_resource.supports[:restart]
             shell_out!("#{@init_command} fastrestart")
@@ -100,21 +128,29 @@ class Chef
           end
         end
 
-
         # The variable name used in /etc/rc.conf for enabling this service
         def service_enable_variable_name
           # Look for name="foo" in the shell script @init_command. Use this for determining the variable name in /etc/rc.conf
           # corresponding to this service
           # For example: to enable the service mysql-server with the init command /usr/local/etc/rc.d/mysql-server, you need
-          # to set mysql_enable="YES" in /etc/rc.conf
-          makefile = ::File.open(@init_command)
-          makefile.each do |line|
-            case line
-            when /^name="?(\w+)"?/
-              return $1 + "_enable"
+          # to set mysql_enable="YES" in /etc/rc.conf$
+          if @rcd_script_found   
+            ::File.open(@init_command) do |rcscript|
+              rcscript.each_line do |line|
+                if line =~ /^name="?(\w+)"?/
+                  return $1 + "_enable"
+                end
+              end
             end
+            # some scripts support multiple instances through symlinks such as openvpn.
+            # We should get the service name from rcvar.
+            Chef::Log.debug("name=\"service\" not found at #{@init_command}. falling back to rcvar")
+            sn = shell_out!("#{@init_command} rcvar").stdout[/(\w+_enable)=/, 1]
+            return sn
           end
-          raise Chef::Exceptions::Service, "Could not find name=\"service\" line in #{@init_command}"
+          # Fallback allows us to keep running in whyrun mode when
+          # the script does not exist.
+          @new_resource.service_name
         end
 
         def set_service_enable(value)

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

@@ -25,13 +25,12 @@ class Chef::Provider::Service::Gentoo < Chef::Provider::Service::Init
 
     @new_resource.supports[:status] = true
     @new_resource.supports[:restart] = true
-
+    @found_script = false
     super
-    
-    raise Chef::Exceptions::Service unless ::File.exists?("/sbin/rc-update")
-    
+
     @current_resource.enabled(
       Dir.glob("/etc/runlevels/**/#{@current_resource.service_name}").any? do |file|
+        @found_script = true
         exists = ::File.exists? file
         readable = ::File.readable? file
         Chef::Log.debug "#{@new_resource} exists: #{exists}, readable: #{readable}"
@@ -42,6 +41,21 @@ class Chef::Provider::Service::Gentoo < Chef::Provider::Service::Init
 
     @current_resource
   end
+
+  def define_resource_requirements
+    requirements.assert(:all_actions) do |a|
+      a.assertion { ::File.exists?("/sbin/rc-update") } 
+      a.failure_message Chef::Exceptions::Service, "/sbin/rc-update does not exist"
+      # no whyrun recovery -t his is a core component whose presence is
+      # unlikely to be affected by what we do in the course of a chef run
+    end
+
+    requirements.assert(:all_actions) do |a|
+      a.assertion { @found_script }
+      # No failure, just informational output from whyrun 
+      a.whyrun "Could not find service #{@new_resource.service_name} under any runlevel"
+    end
+  end
   
   def enable_service()
     run_command(:command => "/sbin/rc-update add #{@new_resource.service_name} default")

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

@@ -33,6 +33,19 @@ class Chef
           @init_command = "/etc/init.d/#{@new_resource.service_name}"
         end
 
+        def define_resource_requirements
+          # do not call super here, inherit only shared_requirements
+          shared_resource_requirements
+          requirements.assert(:start, :stop, :restart, :reload) do |a|
+            a.assertion { ::File.exist?(@init_command) }
+            a.failure_message(Chef::Exceptions::Service, "#{@init_command} does not exist!")
+            a.whyrun("Init script '#{@init_command}' doesn't exist, assuming a prior action would have created it.") do
+              # blindly assume that the service exists but is stopped in why run mode:
+              @status_load_success = false
+            end
+          end
+        end
+ 
         def start_service
           if @new_resource.start_command
             super

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

@@ -33,18 +33,42 @@ class Chef
         def load_current_resource
           @current_resource = Chef::Resource::Service.new(@new_resource.name)
           @current_resource.service_name(@new_resource.service_name)
+          @plist_size = 0
           @plist = find_service_plist
           set_service_status
 
           @current_resource
         end
 
-        def enable_service
-          raise Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :enable"
-        end
+        def define_resource_requirements
+          #super
+          requirements.assert(:enable) do |a| 
+            a.failure_message Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :enable"
+          end
+
+          requirements.assert(:disable) do |a| 
+            a.failure_message Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :disable"
+          end
+
+          requirements.assert(:reload) do |a| 
+            a.failure_message Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :reload"
+          end
+
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @plist_size < 2 } 
+            a.failure_message Chef::Exceptions::Service, "Several plist files match service name. Please use full service name."
+          end
+
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @plist_size > 0 } 
+            # No failrue here in original code - so we also will not
+            # fail. Instead warn that the service is potentially missing
+            a.whyrun "Assuming that the service would have been previously installed and is currently disabled." do 
+              @current_resource.enabled(false)
+              @current_resource.running(false)
+            end
+          end
 
-        def disable_service
-          raise Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :disable"
         end
 
         def start_service
@@ -81,11 +105,10 @@ class Chef
           end
         end
 
-        def reload_service
-          raise Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :reload"
-        end
 
         def set_service_status
+          return if @plist == nil
+
           @current_resource.enabled(!@plist.nil?)
 
           if @current_resource.enabled
@@ -111,12 +134,8 @@ class Chef
             entries = Dir.glob("#{::File.expand_path(dir)}/*#{@current_resource.service_name}*.plist")
             entries.any? ? results << entries : results
           end
-
           plists.flatten!
-          if plists.size > 1
-            raise Chef::Exceptions::Service, "Several plist files match service name. Please use full service name."
-          end
-
+          @plist_size = plists.size
           plists.first
         end
       end

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

@@ -25,25 +25,43 @@ class Chef
     class Service
       class Redhat < Chef::Provider::Service::Init
         include Chef::Mixin::ShellOut
-        
+
         CHKCONFIG_ON = /\d:on/
-        
+        CHKCONFIG_MISSING = /No such/
+
         def initialize(new_resource, run_context)
           super
            @init_command = "/sbin/service #{@new_resource.service_name}"
            @new_resource.supports[:status] = true
-         end
-        
-        def load_current_resource
-          unless ::File.exists? "/sbin/chkconfig"
-            raise Chef::Exceptions::Service, "/sbin/chkconfig does not exist!"
+           @service_missing = false
+        end
+
+        def define_resource_requirements
+          shared_resource_requirements
+
+          requirements.assert(:all_actions) do |a|
+            chkconfig_file = "/sbin/chkconfig"
+            a.assertion { ::File.exists? chkconfig_file  }
+            a.failure_message Chef::Exceptions::Service, "#{chkconfig_file} does not exist!"
           end
-          
+
+          requirements.assert(:all_actions) do |a|
+            a.assertion { !@service_missing }
+            a.failure_message Chef::Exceptions::Service, "#{@new_resource}: unable to locate the init.d script!"
+            a.whyrun "Assuming service would be disabled. The init script is not presently installed." 
+          end
+        end
+
+        def load_current_resource
           super
-          
-          chkconfig = shell_out!("/sbin/chkconfig --list #{@current_resource.service_name}", :returns => [0,1])
-          @current_resource.enabled(!!(chkconfig.stdout =~ CHKCONFIG_ON))
-          @current_resource        
+
+          if ::File.exists?("/sbin/chkconfig")
+            chkconfig = shell_out!("/sbin/chkconfig --list #{@current_resource.service_name}", :returns => [0,1])
+            @current_resource.enabled(!!(chkconfig.stdout =~ CHKCONFIG_ON))
+            @service_missing = !!(chkconfig.stderr =~ CHKCONFIG_MISSING)
+          end 
+
+          @current_resource
         end
 
         def enable_service()
@@ -53,7 +71,6 @@ class Chef
         def disable_service()
           shell_out! "/sbin/chkconfig #{@new_resource.service_name} off"
         end
-        
       end
     end
   end

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

@@ -31,25 +31,65 @@ class Chef
           @current_resource = Chef::Resource::Service.new(@new_resource.name)
           @current_resource.service_name(@new_resource.service_name)
 
+          @status_load_success = true
+          @ps_command_failed = false
+
           determine_current_status!
 
           @current_resource
         end
 
-        def start_service
-          if @new_resource.start_command
-            shell_out!(@new_resource.start_command)
-          else
-            raise Chef::Exceptions::Service, "#{self.to_s} requires that start_command to be set"
+        def whyrun_supported?
+          true
+        end
+
+        def shared_resource_requirements
+          super
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { @status_load_success } 
+            a.whyrun ["Service status not available. Assuming a prior action would have installed the service.", "Assuming status of not running."]
           end
         end
 
-        def stop_service
-          if @new_resource.stop_command
-            shell_out!(@new_resource.stop_command)
-          else
-            raise Chef::Exceptions::Service, "#{self.to_s} requires that stop_command to be set"
+        def define_resource_requirements
+          # FIXME? need reload from service.rb
+          shared_resource_requirements
+          requirements.assert(:start) do |a|
+            a.assertion { @new_resource.start_command }
+            a.failure_message Chef::Exceptions::Service, "#{self.to_s} requires that start_command be set"
+          end
+          requirements.assert(:stop) do |a|
+            a.assertion { @new_resource.stop_command }
+            a.failure_message Chef::Exceptions::Service, "#{self.to_s} requires that stop_command be set"
+          end
+
+          requirements.assert(:restart) do |a|
+            a.assertion { @new_resource.restart_command  || ( @new_resource.start_command && @new_resource.stop_command ) }
+            a.failure_message Chef::Exceptions::Service, "#{self.to_s} requires a restart_command or both start_command and stop_command be set in order to perform a restart"
+          end
+
+          requirements.assert(:reload) do |a|
+            a.assertion { @new_resource.reload_command }
+            a.failure_message Chef::Exceptions::UnsupportedAction, "#{self.to_s} requires a reload_command be set in order to perform a reload"
+          end
+
+          requirements.assert(:all_actions) do |a|
+            a.assertion { @new_resource.status_command or @new_resource.supports[:status] or 
+              (!ps_cmd.nil? and !ps_cmd.empty?) } 
+            a.failure_message Chef::Exceptions::Service, "#{@new_resource} could not determine how to inspect the process table, please set this node's 'command.ps' attribute"
           end
+          requirements.assert(:all_actions) do |a| 
+            a.assertion { !@ps_command_failed } 
+            a.failure_message Chef::Exceptions::Service, "Command #{ps_cmd} failed to execute, cannot determine service current status"
+          end
+        end
+
+        def start_service
+          shell_out!(@new_resource.start_command)
+        end
+
+        def stop_service
+          shell_out!(@new_resource.stop_command)
         end
 
         def restart_service
@@ -63,11 +103,7 @@ class Chef
         end
 
         def reload_service
-          if @new_resource.reload_command
-            shell_out!(@new_resource.reload_command)
-          else
-            raise Chef::Exceptions::Service, "#{self.to_s} requires that reload_command to be set"
-          end
+          shell_out!(@new_resource.reload_command)
         end
 
       protected
@@ -80,29 +116,32 @@ class Chef
                 @current_resource.running true
                 Chef::Log.debug("#{@new_resource} is running")
               end
-            rescue Mixlib::ShellOut::ShellCommandFailed
+            rescue Mixlib::ShellOut::ShellCommandFailed, SystemCallError
+            # ShellOut sometimes throws different types of Exceptions than ShellCommandFailed.
+            # Temporarily catching different types of exceptions here until we get Shellout fixed.
+            # TODO: Remove the line before one we get the ShellOut fix.
+              @status_load_success = false
               @current_resource.running false
               nil
             end
 
           elsif @new_resource.supports[:status]
             Chef::Log.debug("#{@new_resource} supports status, running")
-
             begin
               if shell_out("#{@init_command} status").exitstatus == 0
                 @current_resource.running true
                 Chef::Log.debug("#{@new_resource} is running")
               end
-            rescue Mixlib::ShellOut::ShellCommandFailed
+            # ShellOut sometimes throws different types of Exceptions than ShellCommandFailed.
+            # Temporarily catching different types of exceptions here until we get Shellout fixed.
+            # TODO: Remove the line before one we get the ShellOut fix.
+            rescue Mixlib::ShellOut::ShellCommandFailed, SystemCallError
+              @status_load_success = false
               @current_resource.running false
               nil
             end
-          elsif
+          else
             Chef::Log.debug "#{@new_resource} falling back to process table inspection"
-            if ps_cmd.nil? or ps_cmd.empty?
-              raise Chef::Exceptions::Service, "#{@new_resource} could not determine how to inspect the process table, please set this nodes 'command.ps' attribute"
-            end
-
             r = Regexp.new(@new_resource.pattern)
             Chef::Log.debug "#{@new_resource} attempting to match '#{@new_resource.pattern}' (#{r.inspect}) against process list"
             begin
@@ -112,10 +151,14 @@ class Chef
                   break
                 end
               end
+
               @current_resource.running false unless @current_resource.running
               Chef::Log.debug "#{@new_resource} running: #{@current_resource.running}"
-            rescue Mixlib::ShellOut::ShellCommandFailed
-              raise Chef::Exceptions::Service, "Command #{ps_cmd} failed"
+            # ShellOut sometimes throws different types of Exceptions than ShellCommandFailed.
+            # Temporarily catching different types of exceptions here until we get Shellout fixed.
+            # TODO: Remove the line before one we get the ShellOut fix.
+            rescue Mixlib::ShellOut::ShellCommandFailed, SystemCallError
+              @ps_command_failed = true
             end
           end
         end