Class: Chef::Provider::Service

Inherits:
Chef::Provider show all
Extended by:
Chef::Platform::ServiceHelpers
Includes:
Chef::Platform::ServiceHelpers
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, #after_resource, #current_resource, #logger, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Chef::Platform::ServiceHelpers

config_for_service, service_resource_providers

Methods inherited from Chef::Provider

action, action_description, action_descriptions, #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, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #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::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::Secret

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

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::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

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 DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

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

Methods included from DSL::Compliance

#include_input, #include_profile, #include_waiver

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

#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:



198
199
200
 
# File 'lib/chef/provider/service.rb', line 198

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

#enable_service ⇒ Object

Raises:



194
195
196
 
# File 'lib/chef/provider/service.rb', line 194

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

#enableable?(action) ⇒ Boolean

This is a hook for subclasses to be able to tell the super class that a service is or is not enable-able. For example, on systemd, static and indirect units are not enable-able.

In addition, this method offloads the messaging to the user. If the method returns false, it should say why action couldn't be taken

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/chef/provider/service.rb', line 89

def enableable?(action)
  true
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:



202
203
204
 
# File 'lib/chef/provider/service.rb', line 202

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

#reload_service ⇒ Object

Raises:



222
223
224
 
# File 'lib/chef/provider/service.rb', line 222

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

#restart_service ⇒ Object

Raises:



218
219
220
 
# File 'lib/chef/provider/service.rb', line 218

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:



210
211
212
 
# File 'lib/chef/provider/service.rb', line 210

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

#stop_service ⇒ Object

Raises:



214
215
216
 
# File 'lib/chef/provider/service.rb', line 214

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:



206
207
208
 
# File 'lib/chef/provider/service.rb', line 206

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