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

Inherits:

Chef::Provider::Service

Object
Chef::Provider
Chef::Provider::Service
Chef::Provider::Service::Windows

show all

Includes:: Mixin::ShellOut, Win32ServiceConstants

Defined in:: lib/chef/provider/service/windows.rb

Constant Summary collapse

AUTO_START = Win32::Service.get_start_type

"auto start".freeze

MANUAL =

"demand start".freeze

DISABLED =

"disabled".freeze

RUNNING = Win32::Service.get_current_state

"running".freeze

STOPPED =

"stopped".freeze

CONTINUE_PENDING =

"continue pending".freeze

PAUSE_PENDING =

"pause pending".freeze

PAUSED =

"paused".freeze

START_PENDING =

"start pending".freeze

STOP_PENDING =

"stop pending".freeze

TIMEOUT =

SERVICE_RIGHT =

"SeServiceLogonRight".freeze

Constants included from Win32ServiceConstants

Instance Attribute Summary

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#action_configure_startup ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 246

def action_configure_startup
  startup_type = @new_resource.startup_type
  if current_startup_type != startup_type
    converge_by("set service #{@new_resource} startup type to #{startup_type}") do
      set_startup_type(startup_type)
    end
  else
    logger.trace("#{@new_resource} startup_type already #{startup_type} - nothing to do")
  end

  converge_delayed_start

  # Avoid changing enabled from true/false for now
  @new_resource.enabled(nil)
end

#action_disable ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 233

def action_disable
  if current_startup_type != :disabled
    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`

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

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

#disable_service ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 173

def disable_service
  if Win32::Service.exists?(@new_resource.service_name)
    set_startup_type(:disabled)
  else
    logger.trace "#{@new_resource} does not exist - nothing to do"
  end
end

#enable_service ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 165

def enable_service
  if Win32::Service.exists?(@new_resource.service_name)
    set_startup_type(:automatic)
  else
    logger.trace "#{@new_resource} does not exist - nothing to do"
  end
end

#load_current_resource ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 54

def load_current_resource
  @current_resource = Chef::Resource::WindowsService.new(new_resource.name)
  current_resource.service_name(new_resource.service_name)

  if Win32::Service.exists?(current_resource.service_name)
    current_resource.running(current_state == RUNNING)
    logger.trace "#{new_resource} running: #{current_resource.running}"
    case current_startup_type
    when :automatic
      current_resource.enabled(true)
    when :disabled
      current_resource.enabled(false)
    end
    logger.trace "#{new_resource} enabled: #{current_resource.enabled}"

    config_info = Win32::Service.config_info(current_resource.service_name)
    current_resource.service_type(get_service_type(config_info.service_type))    if config_info.service_type
    current_resource.startup_type(start_type_to_sym(config_info.start_type))     if config_info.start_type
    current_resource.error_control(get_error_control(config_info.error_control)) if config_info.error_control
    current_resource.binary_path_name(config_info.binary_path_name) if config_info.binary_path_name
    current_resource.load_order_group(config_info.load_order_group) if config_info.load_order_group
    current_resource.dependencies(config_info.dependencies)         if config_info.dependencies
    current_resource.run_as_user(config_info.service_start_name)    if config_info.service_start_name
    current_resource.display_name(config_info.display_name)         if config_info.display_name
    current_resource.delayed_start(current_delayed_start)           if current_delayed_start
  end

  current_resource
end

#restart_service ⇒ `Object`

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

def restart_service
  if Win32::Service.exists?(@new_resource.service_name)
    if @new_resource.restart_command
      logger.trace "#{@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
    logger.trace "#{@new_resource} does not exist - nothing to do"
  end
end

#start_service ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 84

def start_service
  if Win32::Service.exists?(@new_resource.service_name)
    configure_service_run_as_properties

    state = current_state
    if state == RUNNING
      logger.trace "#{@new_resource} already started - nothing to do"
    elsif state == START_PENDING
      logger.trace "#{@new_resource} already sent start signal - waiting for start"
      wait_for_state(RUNNING)
    elsif state == STOPPED
      if @new_resource.start_command
        logger.trace "#{@new_resource} starting service using the given start_command"
        shell_out!(@new_resource.start_command)
      else
        spawn_command_thread do
          begin
            Win32::Service.start(@new_resource.service_name)
          rescue SystemCallError => ex
            if ex.errno == ERROR_SERVICE_LOGON_FAILED
              logger.error ex.message
              raise Chef::Exceptions::Service,
                "Service #{@new_resource} did not start due to a logon failure (error #{ERROR_SERVICE_LOGON_FAILED}): possibly the specified user '#{@new_resource.run_as_user}' does not have the 'log on as a service' privilege, or the password is incorrect."
            else
              raise ex
            end
          end
        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
    logger.trace "#{@new_resource} does not exist - nothing to do"
  end
end

#stop_service ⇒ `Object`

# File 'lib/chef/provider/service/windows.rb', line 123

def stop_service
  if Win32::Service.exists?(@new_resource.service_name)
    state = current_state
    if state == RUNNING
      if @new_resource.stop_command
        logger.trace "#{@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
      logger.trace "#{@new_resource} already stopped - nothing to do"
    elsif state == STOP_PENDING
      logger.trace "#{@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
    logger.trace "#{@new_resource} does not exist - nothing to do"
  end
end

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

Constant Summary collapse

Constants included from Win32ServiceConstants

Instance Attribute Summary

Attributes inherited from Chef::Provider

Instance Method Summary collapse

Methods included from Mixin::ShellOut

Methods inherited from Chef::Provider::Service

Methods inherited from Chef::Provider

Methods included from Mixin::Provides

Methods included from Mixin::DescendantsTracker

Methods included from Mixin::LazyModuleInclude

Methods included from Mixin::PowershellOut

Methods included from Mixin::WindowsArchitectureHelper

Methods included from Mixin::PowershellExec

Methods included from DSL::Powershell

Methods included from DSL::RegistryHelper

Methods included from DSL::DataQuery

Methods included from EncryptedDataBagItem::CheckEncrypted

Methods included from DSL::PlatformIntrospection

Methods included from Mixin::NotifyingBlock

Methods included from DSL::DeclareResource

Constructor Details

Instance Method Details

#action_configure_startup ⇒ Object

#action_disable ⇒ Object

#action_enable ⇒ Object

#disable_service ⇒ Object

#enable_service ⇒ Object

#load_current_resource ⇒ Object

#restart_service ⇒ Object

#start_service ⇒ Object

#stop_service ⇒ Object