Class: Chef::Provider::Service::Windows

Inherits:
Chef::Provider::Service show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/provider/service/windows.rb

Constant Summary collapse

AUTO_START =

Win32::Service.get_start_type

'auto start'
DISABLED = 
'disabled'
RUNNING =

Win32::Service.get_current_state

'running'
STOPPED = 
'stopped'
CONTINUE_PENDING = 
'continue pending'
PAUSE_PENDING = 
'pause pending'
PAUSED = 
'paused'
START_PENDING = 
'start pending'
STOP_PENDING = 
'stop pending'
TIMEOUT = 
60

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods inherited from Chef::Provider::Service

#action_disable, #action_enable, #action_reload, #action_restart, #action_start, #action_stop, #define_resource_requirements, #initialize, #load_new_resource_state, #reload_service, #shared_resource_requirements

Methods included from Mixin::Command

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

Methods included from Mixin::Command::Windows

#popen4

Methods included from Mixin::Command::Unix

#popen4

Methods inherited from Chef::Provider

#action_nothing, #cleanup_after_converge, #converge_by, #define_resource_requirements, #events, #initialize, #node, #process_resource_requirements, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, #whyrun_mode?

Methods included from DSL::Recipe

#build_resource, #declare_resource, #describe_self_for_error, #evaluate_resource_definition, #has_resource_definition?, #have_resource_class_for?, #method_missing, #resource_class_for

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Constructor Details

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::DSL::Recipe

Instance Method Details

#disable_service ⇒ Object 



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

def disable_service
  if Win32::Service.exists?(@new_resource.service_name)
    if start_type == AUTO_START
      Win32::Service.configure(
        :service_name => @new_resource.service_name,
        :start_type => Win32::Service::DISABLED
      )
      @new_resource.updated_by_last_action(true)
    else
      Chef::Log.debug "#{@new_resource} already disabled - nothing to do"
    end
  else
    Chef::Log.debug "#{@new_resource} does not exist - nothing to do"
  end
end

#enable_service ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/chef/provider/service/windows.rb', line 129

def enable_service
  if Win32::Service.exists?(@new_resource.service_name)
    if start_type == AUTO_START
      Chef::Log.debug "#{@new_resource} already enabled - nothing to do"
    else
      Win32::Service.configure(
        :service_name => @new_resource.service_name,
        :start_type => Win32::Service::AUTO_START
      )
      @new_resource.updated_by_last_action(true)
    end
  else
    Chef::Log.debug "#{@new_resource} does not exist - nothing to do"
  end
end

#load_current_resource ⇒ Object 



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

def load_current_resource
  @current_resource = Chef::Resource::Service.new(@new_resource.name)
  @current_resource.service_name(@new_resource.service_name)
  @current_resource.running(current_state == RUNNING)
  Chef::Log.debug "#{@new_resource} running: #{@current_resource.running}"
  @current_resource.enabled(start_type == AUTO_START)
  Chef::Log.debug "#{@new_resource} enabled: #{@current_resource.enabled}"
  @current_resource
end

#restart_service ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/chef/provider/service/windows.rb', line 114

def restart_service
  if Win32::Service.exists?(@new_resource.service_name)
    if @new_resource.restart_command
      Chef::Log.debug "#{@new_resource} restarting service using the given restart_command"
      shell_out!(@new_resource.restart_command)
    else
      stop_service
      start_service
    end
    @new_resource.updated_by_last_action(true)
  else
    Chef::Log.debug "#{@new_resource} does not exist - nothing to do"
  end
end

#start_service ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/chef/provider/service/windows.rb', line 60

def start_service
  if Win32::Service.exists?(@new_resource.service_name)
    state = current_state
    if state == RUNNING
      Chef::Log.debug "#{@new_resource} already started - nothing to do"
    elsif state == START_PENDING
      Chef::Log.debug "#{@new_resource} already sent start signal - waiting for start"
      wait_for_state(RUNNING)
    elsif state == STOPPED
      if @new_resource.start_command
        Chef::Log.debug "#{@new_resource} starting service using the given start_command"
        shell_out!(@new_resource.start_command)
      else
        spawn_command_thread do
          Win32::Service.start(@new_resource.service_name)
        end
        wait_for_state(RUNNING)
      end
      @new_resource.updated_by_last_action(true)
    else
      raise Chef::Exceptions::Service, "Service #{@new_resource} can't be started from state [#{state}]"
    end
  else
    Chef::Log.debug "#{@new_resource} does not exist - nothing to do"
  end
end

#stop_service ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/chef/provider/service/windows.rb', line 87

def stop_service
  if Win32::Service.exists?(@new_resource.service_name)
    state = current_state
    if state == RUNNING
      if @new_resource.stop_command
        Chef::Log.debug "#{@new_resource} stopping service using the given stop_command"
        shell_out!(@new_resource.stop_command)
      else
        spawn_command_thread do
          Win32::Service.stop(@new_resource.service_name)
        end
        wait_for_state(STOPPED)
      end
      @new_resource.updated_by_last_action(true)
    elsif state == STOPPED
      Chef::Log.debug "#{@new_resource} already stopped - nothing to do"
    elsif state == STOP_PENDING
      Chef::Log.debug "#{@new_resource} already sent stop signal - waiting for stop"
      wait_for_state(STOPPED)
    else
      raise Chef::Exceptions::Service, "Service #{@new_resource} can't be stopped from state [#{state}]"
    end
  else
    Chef::Log.debug "#{@new_resource} does not exist - nothing to do"
  end
end

#whyrun_supported? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/chef/provider/service/windows.rb', line 46

def whyrun_supported?
  false
end