Class: Homebrew::Service
Overview
The Service class implements the DSL methods used in a formula’s
service
block and stores related instance variables. Most of these methods
also return the related instance variable when no argument is provided.
Constant Summary collapse
- RUN_TYPE_IMMEDIATE =
:immediate
- RUN_TYPE_INTERVAL =
:interval
- RUN_TYPE_CRON =
:cron
- PROCESS_TYPE_BACKGROUND =
:background
- PROCESS_TYPE_STANDARD =
:standard
- PROCESS_TYPE_INTERACTIVE =
:interactive
- PROCESS_TYPE_ADAPTIVE =
:adaptive
- KEEP_ALIVE_KEYS =
[:always, :successful_exit, :crashed, :path].freeze
Class Method Summary collapse
-
.deserialize(api_hash) ⇒ Hash
Turn the service API hash values back into what is expected by the formula DSL.
-
.replace_placeholders(string) ⇒ String
Replace API path placeholders with local paths.
Instance Method Summary collapse
-
#command ⇒ Array<String>?
-
#command? ⇒ Boolean
-
#cron(value = nil) ⇒ Hash?
-
#default_cron_values ⇒ Hash{Symbol => Integer, String}
-
#default_plist_name ⇒ String
-
#default_service_name ⇒ String
-
#environment_variables(variables = {}) ⇒ Hash{Symbol => String}?
-
#error_log_path(path = nil) ⇒ String?
-
#f ⇒ Formula
-
#initialize(formula, &block) ⇒ Service
constructor
sig { params(formula: Formula).void }.
-
#input_path(path = nil) ⇒ String?
-
#interval(value = nil) ⇒ Integer?
-
#keep_alive(value = nil) ⇒ Hash{Symbol => T.untyped}?
-
#keep_alive? ⇒ Boolean
Returns a
Boolean
describing if a service is set to be kept alive. -
#launch_only_once(value = nil) ⇒ Boolean?
-
#log_path(path = nil) ⇒ String?
-
#macos_legacy_timers(value = nil) ⇒ Boolean?
-
#manual_command ⇒ String
Returns the
String
command to run manually instead of the service. -
#name(macos: nil, linux: nil) ⇒ void
-
#parse_cron(cron_statement) ⇒ Hash{Symbol => Integer, String}
-
#plist_name ⇒ String
-
#process_type(value = nil) ⇒ Symbol?
-
#require_root(value = nil) ⇒ Boolean?
-
#requires_root? ⇒ Boolean
Returns a
Boolean
describing if a service requires root access. -
#restart_delay(value = nil) ⇒ Integer?
-
#root_dir(path = nil) ⇒ String?
-
#run(command = nil, macos: nil, linux: nil) ⇒ Array?
-
#run_at_load(value = nil) ⇒ Boolean?
-
#run_type(value = nil) ⇒ Symbol?
-
#serialize ⇒ Hash
Prepare the service hash for inclusion in the formula API JSON.
-
#service_name ⇒ String
-
#sockets(value = nil) ⇒ Hash{Symbol => String}?
-
#std_service_path_env ⇒ String
-
#timed? ⇒ Boolean
Returns a
Boolean
describing if a service is timed. -
#to_plist ⇒ String
Returns a
String
plist. -
#to_systemd_timer ⇒ String
Returns a
String
systemd unit timer. -
#to_systemd_unit ⇒ String
Returns a
String
systemd unit. -
#working_dir(path = nil) ⇒ String?
Methods included from OnSystem::MacOSAndLinux
Constructor Details
#initialize(formula, &block) ⇒ Service
sig { params(formula: Formula).void }
26 27 28 29 30 31 32 |
# File 'service.rb', line 26 def initialize(formula, &block) @formula = formula @run_type = RUN_TYPE_IMMEDIATE @run_at_load = true @environment_variables = {} instance_eval(&block) if block end |
Class Method Details
.deserialize(api_hash) ⇒ Hash
Turn the service API hash values back into what is expected by the formula DSL.
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 |
# File 'service.rb', line 540 def self.deserialize(api_hash) hash = {} hash[:name] = api_hash["name"].transform_keys(&:to_sym) if api_hash.key?("name") # The service hash might not have a "run" command if it only documents # an existing service file with the "name" command. return hash unless api_hash.key?("run") hash[:run] = case api_hash["run"] when String replace_placeholders(api_hash["run"]) when Array api_hash["run"].map(&method(:replace_placeholders)) when Hash api_hash["run"].to_h do |key, elem| run_cmd = if elem.is_a?(Array) elem.map(&method(:replace_placeholders)) else replace_placeholders(elem) end [key.to_sym, run_cmd] end else raise ArgumentError, "Unexpected run command: #{api_hash["run"]}" end hash[:keep_alive] = api_hash["keep_alive"].transform_keys(&:to_sym) if api_hash.key?("keep_alive") if api_hash.key?("environment_variables") hash[:environment_variables] = api_hash["environment_variables"].to_h do |key, value| [key.to_sym, replace_placeholders(value)] end end %w[run_type process_type].each do |key| next unless (value = api_hash[key]) hash[key.to_sym] = value.to_sym end %w[working_dir root_dir input_path log_path error_log_path].each do |key| next unless (value = api_hash[key]) hash[key.to_sym] = replace_placeholders(value) end %w[interval cron launch_only_once require_root restart_delay macos_legacy_timers sockets].each do |key| next if (value = api_hash[key]).nil? hash[key.to_sym] = value end hash end |
.replace_placeholders(string) ⇒ String
Replace API path placeholders with local paths.
599 600 601 602 603 |
# File 'service.rb', line 599 def self.replace_placeholders(string) string.gsub(HOMEBREW_PREFIX_PLACEHOLDER, HOMEBREW_PREFIX) .gsub(HOMEBREW_CELLAR_PLACEHOLDER, HOMEBREW_CELLAR) .gsub(HOMEBREW_HOME_PLACEHOLDER, Dir.home) end |
Instance Method Details
#command ⇒ Array<String>?
349 350 351 |
# File 'service.rb', line 349 def command @run&.map(&:to_s)&.map { |arg| arg.start_with?("~") ? File.(arg) : arg } end |
#command? ⇒ Boolean
354 355 356 |
# File 'service.rb', line 354 def command? @run.present? end |
#cron(value = nil) ⇒ Hash?
268 269 270 271 272 273 274 275 |
# File 'service.rb', line 268 def cron(value = nil) case value when nil @cron when String @cron = parse_cron(T.must(value)) end end |
#default_cron_values ⇒ Hash{Symbol => Integer, String}
278 279 280 281 282 283 284 285 286 |
# File 'service.rb', line 278 def default_cron_values { Month: "*", Day: "*", Weekday: "*", Hour: "*", Minute: "*", } end |
#default_plist_name ⇒ String
40 41 42 |
# File 'service.rb', line 40 def default_plist_name "homebrew.mxcl.#{@formula.name}" end |
#default_service_name ⇒ String
50 51 52 |
# File 'service.rb', line 50 def default_service_name "homebrew.#{@formula.name}" end |
#environment_variables(variables = {}) ⇒ Hash{Symbol => String}?
324 325 326 327 328 329 |
# File 'service.rb', line 324 def environment_variables(variables = {}) case variables when Hash @environment_variables = variables.transform_values(&:to_s) end end |
#error_log_path(path = nil) ⇒ String?
134 135 136 137 138 139 140 141 |
# File 'service.rb', line 134 def error_log_path(path = nil) case path when nil @error_log_path when String, Pathname @error_log_path = path.to_s end end |
#input_path(path = nil) ⇒ String?
114 115 116 117 118 119 120 121 |
# File 'service.rb', line 114 def input_path(path = nil) case path when nil @input_path when String, Pathname @input_path = path.to_s end end |
#interval(value = nil) ⇒ Integer?
258 259 260 261 262 263 264 265 |
# File 'service.rb', line 258 def interval(value = nil) case value when nil @interval when Integer @interval = value end end |
#keep_alive(value = nil) ⇒ Hash{Symbol => T.untyped}?
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'service.rb', line 147 def keep_alive(value = nil) case value when nil @keep_alive when true, false @keep_alive = { always: value } when Hash hash = T.cast(value, Hash) unless (hash.keys - KEEP_ALIVE_KEYS).empty? raise TypeError, "Service#keep_alive allows only #{KEEP_ALIVE_KEYS}" end @keep_alive = value end end |
#keep_alive? ⇒ Boolean
Returns a Boolean
describing if a service is set to be kept alive.
207 208 209 |
# File 'service.rb', line 207 def keep_alive? @keep_alive.present? && @keep_alive[:always] != false end |
#launch_only_once(value = nil) ⇒ Boolean?
212 213 214 215 216 217 218 219 |
# File 'service.rb', line 212 def launch_only_once(value = nil) case value when nil @launch_only_once when true, false @launch_only_once = value end end |
#log_path(path = nil) ⇒ String?
124 125 126 127 128 129 130 131 |
# File 'service.rb', line 124 def log_path(path = nil) case path when nil @log_path when String, Pathname @log_path = path.to_s end end |
#macos_legacy_timers(value = nil) ⇒ Boolean?
332 333 334 335 336 337 338 339 |
# File 'service.rb', line 332 def macos_legacy_timers(value = nil) case value when nil @macos_legacy_timers when true, false @macos_legacy_timers = value end end |
#manual_command ⇒ String
Returns the String
command to run manually instead of the service.
361 362 363 364 365 366 367 |
# File 'service.rb', line 361 def manual_command vars = @environment_variables.except(:PATH) .map { |k, v| "#{k}=\"#{v}\"" } out = vars + T.must(command).map { |arg| Utils::Shell.sh_quote(arg) } if command? out.join(" ") end |
#name(macos: nil, linux: nil) ⇒ void
This method returns an undefined value.
60 61 62 63 64 65 |
# File 'service.rb', line 60 def name(macos: nil, linux: nil) raise TypeError, "Service#name expects at least one String" if [macos, linux].none?(String) @plist_name = macos if macos @service_name = linux if linux end |
#parse_cron(cron_statement) ⇒ Hash{Symbol => Integer, String}
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'service.rb', line 289 def parse_cron(cron_statement) parsed = default_cron_values case cron_statement when "@hourly" parsed[:Minute] = 0 when "@daily" parsed[:Minute] = 0 parsed[:Hour] = 0 when "@weekly" parsed[:Minute] = 0 parsed[:Hour] = 0 parsed[:Weekday] = 0 when "@monthly" parsed[:Minute] = 0 parsed[:Hour] = 0 parsed[:Day] = 1 when "@yearly", "@annually" parsed[:Minute] = 0 parsed[:Hour] = 0 parsed[:Day] = 1 parsed[:Month] = 1 else cron_parts = cron_statement.split raise TypeError, "Service#parse_cron expects a valid cron syntax" if cron_parts.length != 5 [:Minute, :Hour, :Day, :Month, :Weekday].each_with_index do |selector, index| parsed[selector] = Integer(cron_parts.fetch(index)) if cron_parts.fetch(index) != "*" end end parsed end |
#plist_name ⇒ String
45 46 47 |
# File 'service.rb', line 45 def plist_name @plist_name ||= default_plist_name end |
#process_type(value = nil) ⇒ Symbol?
232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'service.rb', line 232 def process_type(value = nil) case value when nil @process_type when :background, :standard, :interactive, :adaptive @process_type = value when Symbol raise TypeError, "Service#process_type allows: " \ "'#{PROCESS_TYPE_BACKGROUND}'/'#{PROCESS_TYPE_STANDARD}'/" \ "'#{PROCESS_TYPE_INTERACTIVE}'/'#{PROCESS_TYPE_ADAPTIVE}'" end end |
#require_root(value = nil) ⇒ Boolean?
164 165 166 167 168 169 170 171 |
# File 'service.rb', line 164 def require_root(value = nil) case value when nil @require_root when true, false @require_root = value end end |
#requires_root? ⇒ Boolean
Returns a Boolean
describing if a service requires root access.
176 177 178 |
# File 'service.rb', line 176 def requires_root? @require_root.present? && @require_root == true end |
#restart_delay(value = nil) ⇒ Integer?
222 223 224 225 226 227 228 229 |
# File 'service.rb', line 222 def restart_delay(value = nil) case value when nil @restart_delay when Integer @restart_delay = value end end |
#root_dir(path = nil) ⇒ String?
104 105 106 107 108 109 110 111 |
# File 'service.rb', line 104 def root_dir(path = nil) case path when nil @root_dir when String, Pathname @root_dir = path.to_s end end |
#run(command = nil, macos: nil, linux: nil) ⇒ Array?
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'service.rb', line 74 def run(command = nil, macos: nil, linux: nil) # Save parameters for serialization if command @run_params = command elsif macos || linux @run_params = { macos: macos, linux: linux }.compact end command ||= on_system_conditional(macos: macos, linux: linux) case command when nil @run when String, Pathname @run = [command] when Array @run = command end end |
#run_at_load(value = nil) ⇒ Boolean?
181 182 183 184 185 186 187 188 |
# File 'service.rb', line 181 def run_at_load(value = nil) case value when nil @run_at_load when true, false @run_at_load = value end end |
#run_type(value = nil) ⇒ Symbol?
246 247 248 249 250 251 252 253 254 255 |
# File 'service.rb', line 246 def run_type(value = nil) case value when nil @run_type when :immediate, :interval, :cron @run_type = value when Symbol raise TypeError, "Service#run_type allows: '#{RUN_TYPE_IMMEDIATE}'/'#{RUN_TYPE_INTERVAL}'/'#{RUN_TYPE_CRON}'" end end |
#serialize ⇒ Hash
Prepare the service hash for inclusion in the formula API JSON.
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 |
# File 'service.rb', line 500 def serialize name_params = { macos: (plist_name if plist_name != default_plist_name), linux: (service_name if service_name != default_service_name), }.compact return { name: name_params }.compact_blank if @run_params.blank? cron_string = if @cron.present? [:Minute, :Hour, :Day, :Month, :Weekday] .map { |key| @cron[key].to_s } .join(" ") end sockets_string = "#{@sockets[:type]}://#{@sockets[:host]}:#{@sockets[:port]}" if @sockets.present? { name: name_params.presence, run: @run_params, run_type: @run_type, interval: @interval, cron: cron_string, keep_alive: @keep_alive, launch_only_once: @launch_only_once, require_root: @require_root, environment_variables: @environment_variables.presence, working_dir: @working_dir, root_dir: @root_dir, input_path: @input_path, log_path: @log_path, error_log_path: @error_log_path, restart_delay: @restart_delay, process_type: @process_type, macos_legacy_timers: @macos_legacy_timers, sockets: sockets_string, }.compact end |
#service_name ⇒ String
55 56 57 |
# File 'service.rb', line 55 def service_name @service_name ||= default_service_name end |
#sockets(value = nil) ⇒ Hash{Symbol => String}?
191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'service.rb', line 191 def sockets(value = nil) case value when nil @sockets when String match = T.must(value).match(%r{([a-z]+)://([a-z0-9.]+):([0-9]+)}i) raise TypeError, "Service#sockets a formatted socket definition as <type>://<host>:<port>" if match.blank? type, host, port = match.captures @sockets = { host: host, port: port, type: type } end end |
#std_service_path_env ⇒ String
344 345 346 |
# File 'service.rb', line 344 def std_service_path_env "#{HOMEBREW_PREFIX}/bin:#{HOMEBREW_PREFIX}/sbin:/usr/bin:/bin:/usr/sbin:/sbin" end |
#timed? ⇒ Boolean
Returns a Boolean
describing if a service is timed.
372 373 374 |
# File 'service.rb', line 372 def timed? @run_type == RUN_TYPE_CRON || @run_type == RUN_TYPE_INTERVAL end |
#to_plist ⇒ String
Returns a String
plist.
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'service.rb', line 379 def to_plist # command needs to be first because it initializes all other values base = { Label: plist_name, ProgramArguments: command, RunAtLoad: @run_at_load == true, } base[:LaunchOnlyOnce] = @launch_only_once if @launch_only_once == true base[:LegacyTimers] = @macos_legacy_timers if @macos_legacy_timers == true base[:TimeOut] = @restart_delay if @restart_delay.present? base[:ProcessType] = @process_type.to_s.capitalize if @process_type.present? base[:StartInterval] = @interval if @interval.present? && @run_type == RUN_TYPE_INTERVAL base[:WorkingDirectory] = File.(@working_dir) if @working_dir.present? base[:RootDirectory] = File.(@root_dir) if @root_dir.present? base[:StandardInPath] = File.(@input_path) if @input_path.present? base[:StandardOutPath] = File.(@log_path) if @log_path.present? base[:StandardErrorPath] = File.(@error_log_path) if @error_log_path.present? base[:EnvironmentVariables] = @environment_variables unless @environment_variables.empty? if keep_alive? if (always = @keep_alive[:always].presence) base[:KeepAlive] = always elsif @keep_alive.key?(:successful_exit) base[:KeepAlive] = { SuccessfulExit: @keep_alive[:successful_exit] } elsif @keep_alive.key?(:crashed) base[:KeepAlive] = { Crashed: @keep_alive[:crashed] } elsif @keep_alive.key?(:path) && @keep_alive[:path].present? base[:KeepAlive] = { PathState: @keep_alive[:path].to_s } end end if @sockets.present? base[:Sockets] = {} base[:Sockets][:Listeners] = { SockNodeName: @sockets[:host], SockServiceName: @sockets[:port], SockProtocol: @sockets[:type].upcase, SockFamily: "IPv4v6", } end if @cron.present? && @run_type == RUN_TYPE_CRON base[:StartCalendarInterval] = @cron.reject { |_, value| value == "*" } end # Adding all session types has as the primary effect that if you initialise it through e.g. a Background session # and you later "physically" sign in to the owning account (Aqua session), things shouldn't flip out. # Also, we're not checking @process_type here because that is used to indicate process priority and not # necessarily if it should run in a specific session type. Like database services could run with ProcessType # Interactive so they have no resource limitations enforced upon them, but they aren't really interactive in the # general sense. base[:LimitLoadToSessionType] = %w[Aqua Background LoginWindow StandardIO System] base.to_plist end |
#to_systemd_timer ⇒ String
Returns a String
systemd unit timer.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'service.rb', line 473 def to_systemd_timer timer = <<~EOS [Unit] Description=Homebrew generated timer for #{@formula.name} [Install] WantedBy=timers.target [Timer] Unit=#{service_name} EOS = [] << "Persistent=true" if @run_type == RUN_TYPE_CRON << "OnUnitActiveSec=#{@interval}" if @run_type == RUN_TYPE_INTERVAL if @run_type == RUN_TYPE_CRON minutes = (@cron[:Minute] == "*") ? "*" : format("%02d", @cron[:Minute]) hours = (@cron[:Hour] == "*") ? "*" : format("%02d", @cron[:Hour]) << "OnCalendar=#{@cron[:Weekday]}-*-#{@cron[:Month]}-#{@cron[:Day]} #{hours}:#{minutes}:00" end timer + .join("\n") end |
#to_systemd_unit ⇒ String
Returns a String
systemd unit.
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
# File 'service.rb', line 439 def to_systemd_unit unit = <<~EOS [Unit] Description=Homebrew generated unit for #{@formula.name} [Install] WantedBy=default.target [Service] EOS # command needs to be first because it initializes all other values cmd = command&.map { |arg| Utils::Shell.sh_quote(arg) } &.join(" ") = [] << "Type=#{(@launch_only_once == true) ? "oneshot" : "simple"}" << "ExecStart=#{cmd}" << "Restart=always" if @keep_alive.present? && @keep_alive[:always].present? << "RestartSec=#{restart_delay}" if @restart_delay.present? << "WorkingDirectory=#{File.(@working_dir)}" if @working_dir.present? << "RootDirectory=#{File.(@root_dir)}" if @root_dir.present? << "StandardInput=file:#{File.(@input_path)}" if @input_path.present? << "StandardOutput=append:#{File.(@log_path)}" if @log_path.present? << "StandardError=append:#{File.(@error_log_path)}" if @error_log_path.present? += @environment_variables.map { |k, v| "Environment=\"#{k}=#{v}\"" } if @environment_variables.present? unit + .join("\n") end |