Class: Chef::Provider::Service
- Inherits:
-
Chef::Provider
show all
- Includes:
- Mixin::Command
- Defined in:
- lib/chef/provider/service.rb,
lib/chef/provider/service/aix.rb,
lib/chef/provider/service/init.rb,
lib/chef/provider/service/debian.rb,
lib/chef/provider/service/macosx.rb,
lib/chef/provider/service/redhat.rb,
lib/chef/provider/service/simple.rb,
lib/chef/provider/service/aixinit.rb,
lib/chef/provider/service/freebsd.rb,
lib/chef/provider/service/insserv.rb,
lib/chef/provider/service/openbsd.rb,
lib/chef/provider/service/solaris.rb,
lib/chef/provider/service/upstart.rb,
lib/chef/provider/service/invokercd.rb
Defined Under Namespace
Modules: ServicePriorityInit
Classes: Aix, AixInit, Arch, Debian, Freebsd, Gentoo, Init, Insserv, Invokercd, Macosx, Openbsd, Redhat, Simple, Solaris, Systemd, Upstart, Windows
Constant Summary
Mixin::ShellOut::DEPRECATED_OPTIONS
Instance Attribute Summary
#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context
Instance Method Summary
collapse
#chdir_or_tmpdir, #handle_command_failures, #output_of_command, #run_command, #run_command_and_return_stdout_stderr, #run_command_with_systems_locale
#popen4
#popen4
#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?
#provided_as, #provides, #provides?
#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited
#const_missing, #deprecated_constants, #register_deprecated_lwrp_class
#descendants, #include, #included
#notifying_block, #subcontext_block
#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context
#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!
#powershell_out, #powershell_out!
#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
#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family
Constructor Details
#initialize(new_resource, run_context) ⇒ Service
Returns a new instance of Service.
33
34
35
36
|
# File 'lib/chef/provider/service.rb', line 33
def initialize(new_resource, run_context)
super
@enabled = nil
end
|
Instance Method Details
#action_disable ⇒ Object
100
101
102
103
104
105
106
107
108
109
110
111
|
# File 'lib/chef/provider/service.rb', line 100
def action_disable
if @current_resource.enabled
converge_by("disable service #{@new_resource}") do
disable_service
Chef::Log.info("#{@new_resource} disabled")
end
else
Chef::Log.debug("#{@new_resource} already disabled - nothing to do")
end
load_new_resource_state
@new_resource.enabled(false)
end
|
#action_enable ⇒ Object
87
88
89
90
91
92
93
94
95
96
97
98
|
# File 'lib/chef/provider/service.rb', line 87
def action_enable
if @current_resource.enabled
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
|
#action_mask ⇒ Object
113
114
115
116
117
118
119
120
121
122
123
124
|
# File 'lib/chef/provider/service.rb', line 113
def action_mask
if @current_resource.masked
Chef::Log.debug("#{@new_resource} already masked - nothing to do")
else
converge_by("mask service #{@new_resource}") do
mask_service
Chef::Log.info("#{@new_resource} masked")
end
end
load_new_resource_state
@new_resource.masked(true)
end
|
#action_reload ⇒ Object
174
175
176
177
178
179
180
181
182
|
# File 'lib/chef/provider/service.rb', line 174
def action_reload
if @current_resource.running
converge_by("reload service #{@new_resource}") do
reload_service
Chef::Log.info("#{@new_resource} reloaded")
end
end
load_new_resource_state
end
|
#action_restart ⇒ Object
165
166
167
168
169
170
171
172
|
# File 'lib/chef/provider/service.rb', line 165
def action_restart
converge_by("restart service #{@new_resource}") do
restart_service
Chef::Log.info("#{@new_resource} restarted")
end
load_new_resource_state
@new_resource.running(true)
end
|
#action_start ⇒ Object
139
140
141
142
143
144
145
146
147
148
149
150
|
# File 'lib/chef/provider/service.rb', line 139
def action_start
unless @current_resource.running
converge_by("start service #{@new_resource}") do
start_service
Chef::Log.info("#{@new_resource} started")
end
else
Chef::Log.debug("#{@new_resource} already running - nothing to do")
end
load_new_resource_state
@new_resource.running(true)
end
|
#action_stop ⇒ Object
152
153
154
155
156
157
158
159
160
161
162
163
|
# File 'lib/chef/provider/service.rb', line 152
def action_stop
if @current_resource.running
converge_by("stop service #{@new_resource}") do
stop_service
Chef::Log.info("#{@new_resource} stopped")
end
else
Chef::Log.debug("#{@new_resource} already stopped - nothing to do")
end
load_new_resource_state
@new_resource.running(false)
end
|
#action_unmask ⇒ Object
126
127
128
129
130
131
132
133
134
135
136
137
|
# File 'lib/chef/provider/service.rb', line 126
def action_unmask
if @current_resource.masked
converge_by("unmask service #{@new_resource}") do
unmask_service
Chef::Log.info("#{@new_resource} unmasked")
end
else
Chef::Log.debug("#{@new_resource} already unmasked - nothing to do")
end
load_new_resource_state
@new_resource.masked(false)
end
|
#define_resource_requirements ⇒ Object
77
78
79
80
81
82
83
84
85
|
# File 'lib/chef/provider/service.rb', line 77
def define_resource_requirements
requirements.assert(:reload) do |a|
a.assertion { supports[:reload] || @new_resource.reload_command }
a.failure_message Chef::Exceptions::UnsupportedAction, "#{self} does not support :reload"
end
end
|
#disable_service ⇒ Object
188
189
190
|
# File 'lib/chef/provider/service.rb', line 188
def disable_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :disable"
end
|
#enable_service ⇒ Object
184
185
186
|
# File 'lib/chef/provider/service.rb', line 184
def enable_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :enable"
end
|
#load_current_resource ⇒ Object
42
43
44
45
46
|
# File 'lib/chef/provider/service.rb', line 42
def load_current_resource
supports[:status] = false if supports[:status].nil?
supports[:reload] = false if supports[:reload].nil?
supports[:restart] = false if supports[:restart].nil?
end
|
#load_new_resource_state ⇒ Object
the new_resource#enabled and #running variables are not user input, but when we do (e.g.) action_enable we want to set new_resource.enabled so that the comparison between desired and current state produces the correct change in reporting. XXX?: the #nil? check below will likely fail if this is a cloned resource or if we just run multiple actions.
53
54
55
56
57
58
59
60
61
62
63
|
# File 'lib/chef/provider/service.rb', line 53
def load_new_resource_state
if @new_resource.enabled.nil?
@new_resource.enabled(@current_resource.enabled)
end
if @new_resource.running.nil?
@new_resource.running(@current_resource.running)
end
if @new_resource.masked.nil?
@new_resource.masked(@current_resource.masked)
end
end
|
#mask_service ⇒ Object
192
193
194
|
# File 'lib/chef/provider/service.rb', line 192
def mask_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :mask"
end
|
#reload_service ⇒ Object
212
213
214
|
# File 'lib/chef/provider/service.rb', line 212
def reload_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :reload"
end
|
#restart_service ⇒ Object
208
209
210
|
# File 'lib/chef/provider/service.rb', line 208
def restart_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :restart"
end
|
#shared_resource_requirements ⇒ Object
73
74
75
|
# File 'lib/chef/provider/service.rb', line 73
def shared_resource_requirements
user_services_requirements
end
|
#start_service ⇒ Object
200
201
202
|
# File 'lib/chef/provider/service.rb', line 200
def start_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :start"
end
|
#stop_service ⇒ Object
204
205
206
|
# File 'lib/chef/provider/service.rb', line 204
def stop_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :stop"
end
|
#supports ⇒ Object
29
30
31
|
# File 'lib/chef/provider/service.rb', line 29
def supports
@supports ||= new_resource.supports.dup
end
|
#unmask_service ⇒ Object
196
197
198
|
# File 'lib/chef/provider/service.rb', line 196
def unmask_service
raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :unmask"
end
|
#user_services_requirements ⇒ Object
subclasses should override this if they do implement user services
66
67
68
69
70
71
|
# File 'lib/chef/provider/service.rb', line 66
def user_services_requirements
requirements.assert(:all_actions) do |a|
a.assertion { @new_resource.user.nil? }
a.failure_message Chef::Exceptions::UnsupportedAction, "#{self} does not support user services"
end
end
|
#whyrun_supported? ⇒ Boolean
38
39
40
|
# File 'lib/chef/provider/service.rb', line 38
def whyrun_supported?
true
end
|