Class: Chef::Provider::Service::Debian

Inherits:
Init show all
Defined in:
lib/chef/provider/service/debian.rb

Constant Summary collapse

UPDATE_RC_D_ENABLED_MATCHES = 
/\/rc[\dS].d\/S|not installed/i
UPDATE_RC_D_PRIORITIES = 
/\/rc([\dS]).d\/([SK])(\d\d)/i

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Init

#initialize, #reload_service, #restart_service, #start_service, #stop_service

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods inherited from Simple

#reload_service, #restart_service, #shared_resource_requirements, #start_service, #stop_service, #whyrun_supported?

Methods inherited from Chef::Provider::Service

#action_disable, #action_reload, #action_restart, #action_start, #action_stop, #initialize, #load_new_resource_state, #reload_service, #restart_service, #shared_resource_requirements, #start_service, #stop_service, #whyrun_supported?

Methods included from Mixin::Command

#chdir_or_tmpdir, #handle_command_failures, #output_of_command, #run_command, #run_command_and_return_stdout_stderr, #run_command_with_systems_locale

Methods included from Mixin::Command::Windows

#popen4

Methods included from Mixin::Command::Unix

#popen4

Methods inherited from Chef::Provider

#action_nothing, #cleanup_after_converge, #converge_by, #events, #initialize, #node, #process_resource_requirements, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, #whyrun_mode?, #whyrun_supported?

Methods included from DSL::Recipe

#build_resource, #declare_resource, #describe_self_for_error, #evaluate_resource_definition, #has_resource_definition?, #have_resource_class_for?, #method_missing, #resource_class_for

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Constructor Details

This class inherits a constructor from Chef::Provider::Service::Init

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::DSL::Recipe

Instance Method Details

#action_enable ⇒ Object

Override method from parent to ensure priority is up-to-date



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/chef/provider/service/debian.rb', line 113

def action_enable
  if @new_resource.priority.nil?
    priority_ok = true
  else
    priority_ok = @current_resource.priority == @new_resource.priority
  end
  if @current_resource.enabled and priority_ok
    Chef::Log.debug("#{@new_resource} already enabled - nothing to do")
  else
    converge_by("enable service #{@new_resource}") do
      enable_service
      Chef::Log.info("#{@new_resource} enabled")
    end
  end
  load_new_resource_state
  @new_resource.enabled(true)
end

#define_resource_requirements ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/chef/provider/service/debian.rb', line 37

def define_resource_requirements
  # do not call super here, inherit only shared_requirements
  shared_resource_requirements
  requirements.assert(:all_actions) do |a|
    update_rcd = "/usr/sbin/update-rc.d"
    a.assertion { ::File.exists? update_rcd }
    a.failure_message Chef::Exceptions::Service, "#{update_rcd} does not exist!"
    # no whyrun recovery - this is a base system component of debian
    # distros and must be present
  end

  requirements.assert(:all_actions) do |a|
    a.assertion { @priority_success }
    a.failure_message  Chef::Exceptions::Service, "/usr/sbin/update-rc.d -n -f #{@current_resource.service_name} failed - #{@rcd_status.inspect}"
    # This can happen if the service is not yet installed,so we'll fake it.
    a.whyrun ["Unable to determine priority of service, assuming service would have been correctly installed earlier in the run.",
              "Assigning temporary priorities to continue.",
              "If this service is not properly installed prior to this point, this will fail."] do
      temp_priorities = {"6"=>[:stop, "20"],
        "0"=>[:stop, "20"],
        "1"=>[:stop, "20"],
        "2"=>[:start, "20"],
        "3"=>[:start, "20"],
        "4"=>[:start, "20"],
        "5"=>[:start, "20"]}
      @current_resource.priority(temp_priorities)
    end
  end
end

#disable_service ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/chef/provider/service/debian.rb', line 146

def disable_service
  if @new_resource.priority.is_a? Integer
    # Stop processes in reverse order of start using '100 - start_priority'
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} remove")
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} stop #{100 - @new_resource.priority} 2 3 4 5 .")
  elsif @new_resource.priority.is_a? Hash
    # we call the same command regardless of we're enabling or disabling
    # users passing a Hash are responsible for setting their own stop priorities
    set_priority
  else
    # no priority, using '100 - 20 (update-rc.d default)' to stop in reverse order of start
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} remove")
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} stop 80 2 3 4 5 .")
  end
end

#enable_service ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/chef/provider/service/debian.rb', line 131

def enable_service
  if @new_resource.priority.is_a? Integer
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} remove")
    run_command(:command => "/usr/sbin/update-rc.d #{@new_resource.service_name} defaults #{@new_resource.priority} #{100 - @new_resource.priority}")
  elsif @new_resource.priority.is_a? Hash
    # we call the same command regardless of we're enabling or disabling
    # users passing a Hash are responsible for setting their own start priorities
    set_priority
  else # No priority, go with update-rc.d defaults
    run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} remove")
    run_command(:command => "/usr/sbin/update-rc.d #{@new_resource.service_name} defaults")
  end

end

#get_priority ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/chef/provider/service/debian.rb', line 67

def get_priority
  priority = {}

  @rcd_status = popen4("/usr/sbin/update-rc.d -n -f #{@current_resource.service_name} remove") do |pid, stdin, stdout, stderr|

    [stdout, stderr].each do |iop|
      iop.each_line do |line|
        if UPDATE_RC_D_PRIORITIES =~ line
          # priority[runlevel] = [ S|K, priority ]
          # S = Start, K = Kill
          # debian runlevels: 0 Halt, 1 Singleuser, 2 Multiuser, 3-5 == 2, 6 Reboot
          priority[$1] = [($2 == "S" ? :start : :stop), $3]
        end
        if line =~ UPDATE_RC_D_ENABLED_MATCHES
          enabled = true
        end
      end
    end
  end

  # Reduce existing priority back to an integer if appropriate, picking
  # runlevel 2 as a baseline
  if priority[2] && [2..5].all? { |runlevel| priority[runlevel] == priority[2] }
    priority = priority[2].last
  end

  unless @rcd_status.exitstatus == 0
    @priority_success = false
  end
  priority
end

#load_current_resource ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/chef/provider/service/debian.rb', line 28

def load_current_resource
  super
  @priority_success = true
  @rcd_status = nil
  @current_resource.priority(get_priority)
  @current_resource.enabled(service_currently_enabled?(@current_resource.priority))
  @current_resource
end

#service_currently_enabled?(priority) ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/chef/provider/service/debian.rb', line 99

def service_currently_enabled?(priority)
  enabled = false
  priority.each { |runlevel, arguments|
    Chef::Log.debug("#{@new_resource} runlevel #{runlevel}, action #{arguments[0]}, priority #{arguments[1]}")
    # if we are in a update-rc.d default startup runlevel && we start in this runlevel
    if %w[ 1 2 3 4 5 S ].include?(runlevel) && arguments[0] == :start
      enabled = true
    end
  }

  enabled
end

#set_priority ⇒ Object 



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/chef/provider/service/debian.rb', line 162

def set_priority
  args = ""
  @new_resource.priority.each do |level, o|
    action = o[0]
    priority = o[1]
    args += "#{action} #{priority} #{level} . "
  end
  run_command(:command => "/usr/sbin/update-rc.d -f #{@new_resource.service_name} remove")
  run_command(:command => "/usr/sbin/update-rc.d #{@new_resource.service_name} #{args}")
end