Class: Chef::Provider::Service::Simple

Inherits:
Chef::Provider::Service show all
Defined in:
lib/chef/provider/service/simple.rb

Direct Known Subclasses

Init, Macosx, Systemd, Upstart

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider::Service

#disable_service, #enable_service, #enableable?, #initialize, #load_new_resource_state, #mask_service, #supports, #unmask_service, #user_services_requirements

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, #initialize, #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

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

Instance Attribute Details

#status_load_success ⇒ Object (readonly)

this must be subclassed to be useful so does not directly implement :service



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

def status_load_success
  @status_load_success
end

Instance Method Details

#define_resource_requirements ⇒ Object 



51
52
53
54
55
56
57
58
59
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
 
# File 'lib/chef/provider/service/simple.rb', line 51

def define_resource_requirements
  # FIXME? need reload from service.rb
  shared_resource_requirements
  requirements.assert(:start) do |a|
    a.assertion { @new_resource.start_command }
    a.failure_message Chef::Exceptions::Service, "#{self} requires that start_command be set"
  end
  requirements.assert(:stop) do |a|
    a.assertion { @new_resource.stop_command }
    a.failure_message Chef::Exceptions::Service, "#{self} requires that stop_command be set"
  end

  requirements.assert(:restart) do |a|
    a.assertion { @new_resource.restart_command || ( @new_resource.start_command && @new_resource.stop_command ) }
    a.failure_message Chef::Exceptions::Service, "#{self} requires a restart_command or both start_command and stop_command be set in order to perform a restart"
  end

  requirements.assert(:reload) do |a|
    a.assertion { @new_resource.reload_command }
    a.failure_message Chef::Exceptions::UnsupportedAction, "#{self} requires a reload_command be set in order to perform a reload"
  end

  requirements.assert(:all_actions) do |a|
    a.assertion do
      @new_resource.status_command || supports[:status] ||
        (!ps_cmd.nil? && !ps_cmd.empty?)
    end
    a.failure_message Chef::Exceptions::Service, "#{@new_resource} could not determine how to inspect the process table, please set this node's 'command.ps' attribute"
  end
  requirements.assert(:all_actions) do |a|
    a.assertion { !@ps_command_failed }
    a.failure_message Chef::Exceptions::Service, "Command #{ps_cmd} failed to execute, cannot determine service current status"
  end
end

#load_current_resource ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/chef/provider/service/simple.rb', line 31

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

  @status_load_success = true
  @ps_command_failed = false

  determine_current_status!

  @current_resource
end

#reload_service ⇒ Object 



104
105
106
 
# File 'lib/chef/provider/service/simple.rb', line 104

def reload_service
  shell_out!(@new_resource.reload_command, default_env: false)
end

#restart_service ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'lib/chef/provider/service/simple.rb', line 94

def restart_service
  if @new_resource.restart_command
    shell_out!(@new_resource.restart_command, default_env: false)
  else
    stop_service
    sleep 1
    start_service
  end
end

#shared_resource_requirements ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/chef/provider/service/simple.rb', line 43

def shared_resource_requirements
  super
  requirements.assert(:all_actions) do |a|
    a.assertion { @status_load_success }
    a.whyrun ["Service status not available. Assuming a prior action would have installed the service.", "Assuming status of not running."]
  end
end

#start_service ⇒ Object 



86
87
88
 
# File 'lib/chef/provider/service/simple.rb', line 86

def start_service
  shell_out!(@new_resource.start_command, default_env: false)
end

#stop_service ⇒ Object 



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

def stop_service
  shell_out!(@new_resource.stop_command, default_env: false)
end