Class: Chef::Provider::Service

Inherits:
Chef::Provider show all
Includes:
Mixin::Command
Defined in:
lib/chef/provider/service.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/freebsd.rb,
lib/chef/provider/service/insserv.rb,
lib/chef/provider/service/solaris.rb,
lib/chef/provider/service/upstart.rb,
lib/chef/provider/service/invokercd.rb

Direct Known Subclasses

Simple, Solaris, Windows

Defined Under Namespace

Classes: Arch, Debian, Freebsd, Gentoo, Init, Insserv, Invokercd, Macosx, Redhat, Simple, Solaris, Systemd, Upstart, Windows

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::Command

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

Methods included from Mixin::Command::Unix

#popen4

Methods included from Mixin::Command::Windows

#popen4

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #cleanup_after_converge, #converge, #cookbook_name, #events, #load_current_resource, #node, #process_resource_requirements, #requirements, #resource_collection, #run_action, #whyrun_mode?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::EnforceOwnershipAndPermissions

#access_controls, #enforce_ownership_and_permissions

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #platform_family?, #search, #value_for_platform, #value_for_platform_family

Constructor Details

#initialize(new_resource, run_context) ⇒ Service

Returns a new instance of Service.


28
29
30
31
# File 'lib/chef/provider/service.rb', line 28

def initialize(new_resource, run_context)
  super
  @enabled = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Mixin::RecipeDefinitionDSLCore

Instance Method Details

#action_disableObject


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

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_enableObject


61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/chef/provider/service.rb', line 61

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_reloadObject


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

def action_reload
  if @current_resource.running
    converge_by("disable service #{@new_resource}") do
      reload_service
      Chef::Log.info("#{@new_resource} reloaded")
    end
  end
  load_new_resource_state
end

#action_restartObject


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

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_startObject


87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/chef/provider/service.rb', line 87

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_stopObject


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

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

#define_resource_requirementsObject


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

def define_resource_requirements
 requirements.assert(:reload) do |a|
   a.assertion { @new_resource.supports[:reload] || @new_resource.reload_command }
   a.failure_message Chef::Exceptions::UnsupportedAction, "#{self.to_s} 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_serviceObject


136
137
138
# File 'lib/chef/provider/service.rb', line 136

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

#enable_serviceObject


132
133
134
# File 'lib/chef/provider/service.rb', line 132

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

#load_new_resource_stateObject


37
38
39
40
41
42
43
44
45
46
# File 'lib/chef/provider/service.rb', line 37

def load_new_resource_state
   # If the user didn't specify a change in enabled state, 
   # it will be the same as the old resource
  if ( @new_resource.enabled.nil? )
    @new_resource.enabled(@current_resource.enabled)
  end
  if ( @new_resource.running.nil? )
    @new_resource.running(@current_resource.running)
  end
end

#reload_serviceObject


152
153
154
# File 'lib/chef/provider/service.rb', line 152

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

#restart_serviceObject


148
149
150
# File 'lib/chef/provider/service.rb', line 148

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

#shared_resource_requirementsObject


48
49
# File 'lib/chef/provider/service.rb', line 48

def shared_resource_requirements
end

#start_serviceObject


140
141
142
# File 'lib/chef/provider/service.rb', line 140

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

#stop_serviceObject


144
145
146
# File 'lib/chef/provider/service.rb', line 144

def stop_service
  raise Chef::Exceptions::UnsupportedAction, "#{self.to_s} does not support :stop"
end

#whyrun_supported?Boolean

Returns:

  • (Boolean)

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

def whyrun_supported?
  true
end