Class: Chef::Provider::Launchd

Inherits:
Chef::Provider show all
Extended by:
Forwardable
Defined in:
lib/chef/provider/launchd.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods inherited from Chef::Provider

action, #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, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #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::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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 Mixin::PowershellExec

#powershell_exec

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::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 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

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_create ⇒ Object 



58
59
60
 
# File 'lib/chef/provider/launchd.rb', line 58

def action_create
  manage_plist(:create)
end

#action_create_if_missing ⇒ Object 



62
63
64
 
# File 'lib/chef/provider/launchd.rb', line 62

def action_create_if_missing
  manage_plist(:create_if_missing)
end

#action_delete ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/chef/provider/launchd.rb', line 66

def action_delete
  # If you delete a service you want to make sure its not loaded or
  # the service will be in memory and you wont be able to stop it.
  if ::File.exists?(@path)
    manage_service(:disable)
  end
  manage_plist(:delete)
end

#action_disable ⇒ Object 



83
84
85
 
# File 'lib/chef/provider/launchd.rb', line 83

def action_disable
  manage_service(:disable)
end

#action_enable ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/chef/provider/launchd.rb', line 75

def action_enable
  if manage_plist(:create)
    manage_service(:restart)
  else
    manage_service(:enable)
  end
end

#action_restart ⇒ Object 



87
88
89
 
# File 'lib/chef/provider/launchd.rb', line 87

def action_restart
  manage_service(:restart)
end

#content ⇒ Object 



177
178
179
180
 
# File 'lib/chef/provider/launchd.rb', line 177

def content
  plist_hash = new_resource.plist_hash || gen_hash
  Plist::Emit.dump(plist_hash) unless plist_hash.nil?
end

#content? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/chef/provider/launchd.rb', line 173

def content?
  !!content
end

#cookbook_file_resource ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/chef/provider/launchd.rb', line 150

def cookbook_file_resource
  res = Chef::Resource::CookbookFile.new(@path, run_context)
  res.cookbook_name = cookbook if cookbook
  res.name(@path) if @path
  res.backup(backup) if backup
  res.group(group) if group
  res.mode(mode) if mode
  res.owner(owner) if owner
  res.source(source) if source
  res
end

#define_resource_requirements ⇒ Object 



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/chef/provider/launchd.rb', line 162

def define_resource_requirements
  requirements.assert(
    :create, :create_if_missing, :delete, :enable, :disable
  ) do |a|
    type = new_resource.type
    a.assertion { %w{daemon agent}.include?(type.to_s) }
    error_msg = "type must be daemon or agent."
    a.failure_message Chef::Exceptions::ValidationFailed, error_msg
  end
end

#file_resource ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/chef/provider/launchd.rb', line 139

def file_resource
  res = Chef::Resource::File.new(@path, run_context)
  res.name(@path) if @path
  res.backup(backup) if backup
  res.content(content) if content?
  res.group(group) if group
  res.mode(mode) if mode
  res.owner(owner) if owner
  res
end

#gen_hash ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/chef/provider/launchd.rb', line 182

def gen_hash
  return nil unless new_resource.program || new_resource.program_arguments

  {
    "label" => "Label",
    "program" => "Program",
    "program_arguments" => "ProgramArguments",
    "abandon_process_group" => "AbandonProcessGroup",
    "debug" => "Debug",
    "disabled" => "Disabled",
    "enable_globbing" => "EnableGlobbing",
    "enable_transactions" => "EnableTransactions",
    "environment_variables" => "EnvironmentVariables",
    "exit_timeout" => "ExitTimeout",
    "ld_group" => "GroupName",
    "hard_resource_limits" => "HardreSourceLimits",
    "inetd_compatibility" => "inetdCompatibility",
    "init_groups" => "InitGroups",
    "keep_alive" => "KeepAlive",
    "launch_events" => "LaunchEvents",
    "launch_only_once" => "LaunchOnlyOnce",
    "limit_load_from_hosts" => "LimitLoadFromHosts",
    "limit_load_to_hosts" => "LimitLoadToHosts",
    "limit_load_to_session_type" => "LimitLoadToSessionType",
    "low_priority_io" => "LowPriorityIO",
    "mach_services" => "MachServices",
    "nice" => "Nice",
    "on_demand" => "OnDemand",
    "process_type" => "ProcessType",
    "queue_directories" => "QueueDirectories",
    "root_directory" => "RootDirectory",
    "run_at_load" => "RunAtLoad",
    "sockets" => "Sockets",
    "soft_resource_limits" => "SoftResourceLimits",
    "standard_error_path" => "StandardErrorPath",
    "standard_in_path" => "StandardInPath",
    "standard_out_path" => "StandardOutPath",
    "start_calendar_interval" => "StartCalendarInterval",
    "start_interval" => "StartInterval",
    "start_on_mount" => "StartOnMount",
    "throttle_interval" => "ThrottleInterval",
    "time_out" => "TimeOut",
    "umask" => "Umask",
    "username" => "UserName",
    "wait_for_debugger" => "WaitForDebugger",
    "watch_paths" => "WatchPaths",
    "working_directory" => "WorkingDirectory",
  }.each_with_object({}) do |(key, val), memo|
    memo[val] = new_resource.send(key) if new_resource.send(key)
  end
end

#gen_path_from_type ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/chef/provider/launchd.rb', line 50

def gen_path_from_type
  types = {
    "daemon" => "/Library/LaunchDaemons/#{label}.plist",
    "agent" => "/Library/LaunchAgents/#{label}.plist",
  }
  types[type]
end

#load_current_resource ⇒ Object 



45
46
47
48
 
# File 'lib/chef/provider/launchd.rb', line 45

def load_current_resource
  current_resource = Chef::Resource::Launchd.new(new_resource.name)
  @path = path ? path : gen_path_from_type
end

#manage_agent?(action) ⇒ Boolean

Returns:

  • (Boolean) 


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

def manage_agent?(action)
  # Gets UID of console_user and converts to string.
  console_user = Etc.getpwuid(::File.stat("/dev/console").uid).name
  root = console_user == "root"
  agent = type == "agent"
  invalid_action = %i{delete disable enable restart}.include?(action)
  lltstype = ""
  if new_resource.limit_load_to_session_type
    lltstype = new_resource.limit_load_to_session_type
  end
  invalid_type = lltstype != "LoginWindow"
  if root && agent && invalid_action && invalid_type
    logger.trace("#{label}: Aqua LaunchAgents shouldn't be loaded as root")
    return false
  end
  true
end

#manage_plist(action) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/chef/provider/launchd.rb', line 91

def manage_plist(action)
  return unless manage_agent?(action)

  if source
    res = cookbook_file_resource
  else
    res = file_resource
  end
  res.run_action(action)
  new_resource.updated_by_last_action(true) if res.updated?
  res.updated
end

#manage_service(action) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/chef/provider/launchd.rb', line 104

def manage_service(action)
  return unless manage_agent?(action)

  res = service_resource
  res.run_action(action)
  new_resource.updated_by_last_action(true) if res.updated?
end

#service_resource ⇒ Object 



130
131
132
133
134
135
136
137
 
# File 'lib/chef/provider/launchd.rb', line 130

def service_resource
  res = Chef::Resource::MacosxService.new(label, run_context)
  res.name(label) if label
  res.service_name(label) if label
  res.plist(@path) if @path
  res.session_type(session_type) if session_type
  res
end