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

Instance Attribute Summary

Attributes inherited from Init

#init_command

Attributes inherited from Simple

#status_load_success

Attributes inherited from Chef::Provider

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Init

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

Methods inherited from Simple

#reload_service, #restart_service, #shared_resource_requirements, #start_service, #stop_service

Methods inherited from Chef::Provider::Service

#action_disable, #action_mask, #action_reload, #action_restart, #action_start, #action_stop, #action_unmask, #initialize, #load_new_resource_state, #mask_service, #reload_service, #restart_service, #shared_resource_requirements, #start_service, #stop_service, #supports, #unmask_service, #user_services_requirements

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, use_inline_resources, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, #direct_descendants, direct_descendants, #find_descendants_by_name, find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

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

Class Method Details

.supports?(resource, action) ⇒ Boolean

Returns:

  • (Boolean)

32
33
34
# File 'lib/chef/provider/service/debian.rb', line 32

def self.supports?(resource, action)
  Chef::Platform::ServiceHelpers.config_for_service(resource.service_name).include?(:initd)
end

Instance Method Details

#action_enableObject

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


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

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 && 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_requirementsObject


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/chef/provider/service/debian.rb', line 43

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 { @so_priority.exitstatus == 0 }
    a.failure_message Chef::Exceptions::Service, "/usr/sbin/update-rc.d -n -f #{current_resource.service_name} failed - #{@so_priority.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_serviceObject


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

def disable_service
  if new_resource.priority.is_a? Integer
    # Stop processes in reverse order of start using '100 - start_priority'
    shell_out!("/usr/sbin/update-rc.d -f #{new_resource.service_name} remove")
    shell_out!("/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
    shell_out!("/usr/sbin/update-rc.d -f #{new_resource.service_name} remove")
    shell_out!("/usr/sbin/update-rc.d -f #{new_resource.service_name} stop 80 2 3 4 5 .")
  end
end

#enable_serviceObject


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

def enable_service
  if new_resource.priority.is_a? Integer
    shell_out!("/usr/sbin/update-rc.d -f #{new_resource.service_name} remove")
    shell_out!("/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
    shell_out!("/usr/sbin/update-rc.d -f #{new_resource.service_name} remove")
    shell_out!("/usr/sbin/update-rc.d #{new_resource.service_name} defaults")
  end
end

#get_priorityObject


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
98
99
# File 'lib/chef/provider/service/debian.rb', line 73

def get_priority
  priority = {}

  @so_priority = shell_out!("/usr/sbin/update-rc.d -n -f #{current_resource.service_name} remove")

  [@so_priority.stdout, @so_priority.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

  # 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

  priority
end

#load_current_resourceObject


36
37
38
39
40
41
# File 'lib/chef/provider/service/debian.rb', line 36

def load_current_resource
  super
  current_resource.priority(get_priority)
  current_resource.enabled(service_currently_enabled?(current_resource.priority))
  current_resource
end

#service_currently_enabled?(priority) ⇒ Boolean

Returns:

  • (Boolean)

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

def service_currently_enabled?(priority)
  enabled = false
  priority.each do |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
  end

  enabled
end

#set_priorityObject


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

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