Class: Chef::Provider::Service

Inherits:
Chef::Provider show all
Extended by:
ChefUtils::DSL::Service
Includes:
ChefUtils::DSL::Service
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

Direct Known Subclasses

Aix, Simple, Solaris, Windows

Defined Under Namespace

Modules: ServicePriorityInit Classes: Aix, AixInit, Arch, Debian, Freebsd, Gentoo, Init, Insserv, Invokercd, Macosx, Openbsd, Redhat, Simple, Solaris, Systemd, Upstart, Windows

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #current_resource, #logger, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #introduced, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, 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::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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 Mixin::PowershellExec

#powershell_exec

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

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!, #resources, #with_run_context

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 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/chef/provider/service.rb', line 96

def action_disable
  if current_resource.enabled
    converge_by("disable service #{new_resource}") do
      disable_service
      logger.info("#{new_resource} disabled")
    end
  else
    logger.trace("#{new_resource} already disabled - nothing to do")
  end
  load_new_resource_state
  new_resource.enabled(false)
end

#action_enable ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/chef/provider/service.rb', line 83

def action_enable
  if current_resource.enabled
    logger.trace("#{new_resource} already enabled - nothing to do")
  else
    converge_by("enable service #{new_resource}") do
      enable_service
      logger.info("#{new_resource} enabled")
    end
  end
  load_new_resource_state
  new_resource.enabled(true)
end

#action_mask ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/chef/provider/service.rb', line 109

def action_mask
  if current_resource.masked
    logger.trace("#{new_resource} already masked - nothing to do")
  else
    converge_by("mask service #{new_resource}") do
      mask_service
      logger.info("#{new_resource} masked")
    end
  end
  load_new_resource_state
  new_resource.masked(true)
end

#action_reload ⇒ Object 



170
171
172
173
174
175
176
177
178
 
# File 'lib/chef/provider/service.rb', line 170

def action_reload
  if current_resource.running
    converge_by("reload service #{new_resource}") do
      reload_service
      logger.info("#{new_resource} reloaded")
    end
  end
  load_new_resource_state
end

#action_restart ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/chef/provider/service.rb', line 161

def action_restart
  converge_by("restart service #{new_resource}") do
    restart_service
    logger.info("#{new_resource} restarted")
  end
  load_new_resource_state
  new_resource.running(true)
end

#action_start ⇒ Object 



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

def action_start
  unless current_resource.running
    converge_by("start service #{new_resource}") do
      start_service
      logger.info("#{new_resource} started")
    end
  else
    logger.trace("#{new_resource} already running - nothing to do")
  end
  load_new_resource_state
  new_resource.running(true)
end

#action_stop ⇒ Object 



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

def action_stop
  if current_resource.running
    converge_by("stop service #{new_resource}") do
      stop_service
      logger.info("#{new_resource} stopped")
    end
  else
    logger.trace("#{new_resource} already stopped - nothing to do")
  end
  load_new_resource_state
  new_resource.running(false)
end

#action_unmask ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/chef/provider/service.rb', line 122

def action_unmask
  if current_resource.masked
    converge_by("unmask service #{new_resource}") do
      unmask_service
      logger.info("#{new_resource} unmasked")
    end
  else
    logger.trace("#{new_resource} already unmasked - nothing to do")
  end
  load_new_resource_state
  new_resource.masked(false)
end

#define_resource_requirements ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/chef/provider/service.rb', line 73

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"
    # if a service is not declared to support reload, that won't
    # typically change during the course of a run - so no whyrun
    # alternative here.
  end
end

#disable_service ⇒ Object

Raises:



184
185
186
 
# File 'lib/chef/provider/service.rb', line 184

def disable_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :disable"
end

#enable_service ⇒ Object

Raises:



180
181
182
 
# File 'lib/chef/provider/service.rb', line 180

def enable_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :enable"
end

#load_current_resource ⇒ Object 



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

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.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/chef/provider/service.rb', line 49

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

Raises:



188
189
190
 
# File 'lib/chef/provider/service.rb', line 188

def mask_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :mask"
end

#reload_service ⇒ Object

Raises:



208
209
210
 
# File 'lib/chef/provider/service.rb', line 208

def reload_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :reload"
end

#restart_service ⇒ Object

Raises:



204
205
206
 
# File 'lib/chef/provider/service.rb', line 204

def restart_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :restart"
end

#shared_resource_requirements ⇒ Object 



69
70
71
 
# File 'lib/chef/provider/service.rb', line 69

def shared_resource_requirements
  user_services_requirements
end

#start_service ⇒ Object

Raises:



196
197
198
 
# File 'lib/chef/provider/service.rb', line 196

def start_service
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :start"
end

#stop_service ⇒ Object

Raises:



200
201
202
 
# File 'lib/chef/provider/service.rb', line 200

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

Raises:



192
193
194
 
# File 'lib/chef/provider/service.rb', line 192

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



62
63
64
65
66
67
 
# File 'lib/chef/provider/service.rb', line 62

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