Class: Chef::Provider::Service::Freebsd

Inherits:
Init show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/provider/service/freebsd.rb

Instance Attribute Summary collapse

Attributes inherited from Init

#init_command

Attributes inherited from Simple

#status_load_success

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods inherited from Init

#reload_service, supports?

Methods inherited from Simple

#reload_service, #shared_resource_requirements

Methods inherited from Chef::Provider::Service

#enableable?, #load_new_resource_state, #mask_service, #reload_service, #shared_resource_requirements, #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, #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) ⇒ Freebsd

Returns a new instance of Freebsd.



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

def initialize(new_resource, run_context)
  super
  @enabled_state_found = false
  @init_command = nil
  if ::TargetIO::File.exist?("/etc/rc.d/#{new_resource.service_name}")
    @init_command = "/etc/rc.d/#{new_resource.service_name}"
  elsif ::TargetIO::File.exist?("/usr/local/etc/rc.d/#{new_resource.service_name}")
    @init_command = "/usr/local/etc/rc.d/#{new_resource.service_name}"
  end
end

Instance Attribute Details

#enabled_state_found ⇒ Object (readonly)

Returns the value of attribute enabled_state_found.



27
28
29
 
# File 'lib/chef/provider/service/freebsd.rb', line 27

def enabled_state_found
  @enabled_state_found
end

Instance Method Details

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  shared_resource_requirements

  requirements.assert(:start, :enable, :reload, :restart) do |a|
    a.assertion { init_command }
    a.failure_message Chef::Exceptions::Service, "#{new_resource}: unable to locate the rc.d script"
    a.whyrun("Assuming rc.d script will be installed by a previous action.")
  end

  requirements.assert(:all_actions) do |a|
    a.assertion { enabled_state_found }
    # for consistency with original behavior, this will not fail in non-whyrun mode;
    # rather it will silently set enabled state=>false
    a.whyrun "Unable to determine enabled/disabled state, assuming this will be correct for an actual run.  Assuming disabled."
  end

  requirements.assert(:start, :enable, :reload, :restart) do |a|
    a.assertion { !service_enable_variable_name.nil? }
    a.failure_message Chef::Exceptions::Service, "Could not find the service name in #{init_command} and rcvar"
    # No recovery in whyrun mode - the init file is present but not correct.
  end
end

#disable_service ⇒ Object 



114
115
116
 
# File 'lib/chef/provider/service/freebsd.rb', line 114

def disable_service
  set_service_enable("NO") if current_resource.enabled
end

#enable_service ⇒ Object 



110
111
112
 
# File 'lib/chef/provider/service/freebsd.rb', line 110

def enable_service
  set_service_enable("YES") unless current_resource.enabled
end

#load_current_resource ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/chef/provider/service/freebsd.rb', line 44

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

  return current_resource unless init_command

  logger.trace("#{current_resource} found at #{init_command}")

  @status_load_success = true
  determine_current_status! # see Chef::Provider::Service::Simple

  determine_enabled_status!
  current_resource
end

#restart_service ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/chef/provider/service/freebsd.rb', line 98

def restart_service
  if new_resource.restart_command
    super
  elsif supports[:restart]
    shell_out!("#{init_command} fastrestart", default_env: false)
  else
    stop_service
    sleep 1
    start_service
  end
end

#start_service ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/chef/provider/service/freebsd.rb', line 82

def start_service
  if new_resource.start_command
    super
  else
    shell_out!("#{init_command} faststart", default_env: false)
  end
end

#stop_service ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/chef/provider/service/freebsd.rb', line 90

def stop_service
  if new_resource.stop_command
    super
  else
    shell_out!("#{init_command} faststop", default_env: false)
  end
end