chore: always use service arrays

Author: SMillerDev

.github/workflows/tests.yml

@@ -62,6 +62,7 @@ jobs:
       run: |
         brew services stop redis
         sleep 5
+        brew services run redis
         brew services restart redis
         brew services list | grep redis
         sleep 5

cmd/services.rb

@@ -65,33 +65,35 @@ def services
       custom_plist = args.file
     end
 
-    if ["list", "cleanup"].include?(subcommand)
+    if [*Service::Commands::List::TRIGGERS, *Service::Commands::Cleanup::TRIGGERS].include?(subcommand)
       raise UsageError, "The `#{subcommand}` subcommand does not accept a formula argument!" if formula
       raise UsageError, "The `#{subcommand}` subcommand does not accept the --all argument!" if args.all?
     end
 
-    target = if args.all?
+    targets = if args.all?
       Service::Formulae.available_services
     elsif formula
-      Service::FormulaWrapper.new(Formulary.factory(formula))
+      [Service::FormulaWrapper.new(Formulary.factory(formula))]
+    else
+      []
     end
 
     ENV["DBUS_SESSION_BUS_ADDRESS"] = ENV["HOMEBREW_DBUS_SESSION_BUS_ADDRESS"] if Service::System.systemctl?
 
     # Dispatch commands and aliases.
     case subcommand.presence
-    when nil, "list", "ls"
+    when *Service::Commands::List::TRIGGERS
       Service::Commands::List.run
-    when "cleanup", "clean", "cl", "rm"
+    when *Service::Commands::Cleanup::TRIGGERS
       Service::Commands::Cleanup.run
-    when "restart", "relaunch", "reload", "r"
-      Service::Commands::Restart.run(target, custom_plist, verbose: args.verbose?)
-    when "run"
-      Service::Commands::Run.run(target, verbose: args.verbose?)
-    when "start", "launch", "load", "s", "l"
-      Service::Commands::Start.run(target, custom_plist, verbose: args.verbose?)
-    when "stop", "unload", "terminate", "term", "t", "u"
-      Service::Commands::Stop.run(target, verbose: args.verbose?)
+    when *Service::Commands::Restart::TRIGGERS
+      Service::Commands::Restart.run(targets, custom_plist, verbose: args.verbose?)
+    when *Service::Commands::Run::TRIGGERS
+      Service::Commands::Run.run(targets, verbose: args.verbose?)
+    when *Service::Commands::Start::TRIGGERS
+      Service::Commands::Start.run(targets, custom_plist, verbose: args.verbose?)
+    when *Service::Commands::Stop::TRIGGERS
+      Service::Commands::Stop.run(targets, verbose: args.verbose?)
     else
       raise UsageError, "unknown subcommand: `#{subcommand}`"
     end

lib/service/commands/cleanup.rb

@@ -5,6 +5,8 @@ module Commands
     module Cleanup
       module_function
 
+      TRIGGERS = %w[cleanup clean cl rm].freeze
+
       def run
         cleaned = []
 

lib/service/commands/list.rb

@@ -7,6 +7,8 @@ module Commands
     module List
       module_function
 
+      TRIGGERS = [nil, "list", "ls"].freeze
+
       def run
         formulae = Formulae.services_list
         if formulae.empty?

lib/service/commands/restart.rb

@@ -5,9 +5,24 @@ module Commands
     module Restart
       module_function
 
-      def run(target, custom_plist, verbose:)
-        ServicesCli.check(target) &&
-          ServicesCli.restart(target, custom_plist, verbose: verbose)
+      TRIGGERS = %w[restart relaunch reload r].freeze
+
+      def run(targets, _custom_plist, verbose:)
+        return unless ServicesCli.check(targets)
+
+        ran = []
+        started = []
+        targets.select(&:loaded?).each do |service|
+          if service.service_file_present?
+            started << service
+          else
+            ran << service
+          end
+          ServicesCli.stop([service]) if service.loaded?
+        end
+
+        ServicesCli.run(ran) unless ran.empty?
+        ServicesCli.start(started) unless started.empty?
       end
     end
   end

lib/service/commands/run.rb

@@ -5,9 +5,11 @@ module Commands
     module Run
       module_function
 
-      def run(target, verbose:)
-        ServicesCli.check(target) &&
-          ServicesCli.run(target, verbose: verbose)
+      TRIGGERS = ["run"].freeze
+
+      def run(targets, verbose:)
+        ServicesCli.check(targets) &&
+          ServicesCli.run(targets, verbose: verbose)
       end
     end
   end

lib/service/commands/start.rb

@@ -5,9 +5,11 @@ module Commands
     module Start
       module_function
 
-      def run(target, custom_plist, verbose:)
-        ServicesCli.check(target) &&
-          ServicesCli.start(target, custom_plist, verbose: verbose)
+      TRIGGERS = %w[start launch load s l].freeze
+
+      def run(targets, custom_plist, verbose:)
+        ServicesCli.check(targets) &&
+          ServicesCli.start(targets, custom_plist, verbose: verbose)
       end
     end
   end

lib/service/commands/stop.rb

@@ -5,9 +5,11 @@ module Commands
     module Stop
       module_function
 
-      def run(target, verbose:)
-        ServicesCli.check(target) &&
-          ServicesCli.stop(target, verbose: verbose)
+      TRIGGERS = %w[stop unload terminate term t u].freeze
+
+      def run(targets, verbose:)
+        ServicesCli.check(targets) &&
+          ServicesCli.stop(targets, verbose: verbose)
       end
     end
   end

lib/service/formulae.rb

@@ -35,8 +35,7 @@ def services_list
 
         # If we have a file or a user defined, check if the service is running or errored.
         if formula[:user] && formula[:file]
-          formula[:status] =
-            Service::ServicesCli.service_get_operational_status(service)
+          formula[:status] = Service::ServicesCli.service_get_operational_status(service)
         end
 
         formula

lib/service/services_cli.rb

@@ -28,8 +28,9 @@ def running
     end
 
     # Check if formula has been found.
-    def check(target)
-      odie("Formula(e) missing, please provide a formula name or use --all") unless target
+    def check(targets)
+      raise UsageError, "Formula(e) missing, please provide a formula name or use --all" if targets.empty?
+
       true
     end
 
@@ -74,62 +75,43 @@ def remove_unused_service_files
       cleaned
     end
 
-    # Stop if loaded, then start or run again.
-    def restart(target, service_file = nil, verbose: false)
-      Array(target).each do |service|
-        was_run = service.loaded? && !service.service_file_present?
-
-        stop(service) if service.loaded?
-
-        if was_run
-          run(service)
-        else
-          start(service, service_file, verbose: verbose)
-        end
-      end
-    end
-
     # Run a service as defined in the formula. This does not clean the service file like `start` does.
-    def run(target, verbose: false)
-      if target.is_a?(Service)
-        if target.pid?
-          puts "Service `#{target.name}` already running, use `#{bin} restart #{target.name}` to restart."
-          return
-        elsif root?
-          puts "Service `#{target.name}` cannot be run (but can be started) as root."
-          return
+    def run(targets, verbose: false)
+      targets.each do |service|
+        if service.pid?
+          puts "Service `#{service.name}` already running, use `#{bin} restart #{service.name}` to restart."
+          next
+        elsif System.root?
+          puts "Service `#{service.name}` cannot be run (but can be started) as root."
+          next
         end
-      end
 
-      Array(target).each do |service|
         service_load(service, enable: false)
       end
     end
 
     # Start a service.
-    def start(target, service_file = nil, verbose: false)
+    def start(targets, service_file = nil, verbose: false)
       if service_file.present?
         file = Pathname.new service_file
         raise UsageError, "Provided service file does not exist" unless file.exist?
       end
 
-      if target.is_a?(Service)
-        if target.pid?
-          puts "Service `#{target.name}` already started, use `#{bin} restart #{target.name}` to restart."
-          return
+      targets.reject(&:pid?).each do |service|
+        if service.pid?
+          puts "Service `#{service.name}` already started, use `#{bin} restart #{service.name}` to restart."
+          next
         end
 
-        odie "Formula `#{target.name}` is not installed." unless target.installed?
+        odie "Formula `#{service.name}` is not installed." unless service.installed?
 
-        file ||= if target.service_file.exist? || System.systemctl? || target.formula.plist.blank?
+        file ||= if service.service_file.exist? || System.systemctl? || service.formula.plist.blank?
           nil
-        elsif target.formula.opt_prefix.exist? && (keg = Keg.for target.formula.opt_prefix) && keg.plist_installed?
-          service_file = Dir["#{keg}/*#{target.service_file.extname}"].first
+        elsif service.formula.opt_prefix.exist? && (keg = Keg.for service.formula.opt_prefix) && keg.plist_installed?
+          service_file = Dir["#{keg}/*#{service.service_file.extname}"].first
           Pathname.new service_file if service_file.present?
         end
-      end
 
-      Array(target).reject(&:pid?).each do |service|
         install_service_file(service, file)
 
         if file.blank? && verbose
@@ -146,20 +128,21 @@ def start(target, service_file = nil, verbose: false)
     end
 
     # Stop a service, or kill it if no service file is available.
-    def stop(target, verbose: false)
-      if target.is_a?(Service) && !target.loaded?
-        rm target.dest if target.dest.exist? # get rid of installed service file anyway, dude
-        if target.service_file_present?
-          odie <<~EOS
-            Service `#{target.name}` is started as `#{target.owner}`. Try:
-              #{"sudo " unless ServicesCli.root?}#{bin} stop #{target.name}
-          EOS
-        else
-          odie "Service `#{target.name}` is not started."
+    def stop(targets, verbose: false)
+      targets.each do |service|
+        unless service.loaded?
+          rm service.dest if service.dest.exist? # get rid of installed service file anyway, dude
+          if service.service_file_present?
+            odie <<~EOS
+              Service `#{service.name}` is started as `#{service.owner}`. Try:
+                #{"sudo " unless ServicesCli.root?}#{bin} stop #{service.name}
+            EOS
+          else
+            opoo "Service `#{service.name}` is not started."
+          end
+          next
         end
-      end
 
-      Array(target).select(&:loaded?).each do |service|
         puts "Stopping `#{service.name}`... (might take a while)"
         if System.systemctl?
           quiet_system System.systemctl, System.systemctl_scope, "stop", service.service_name

spec/homebrew/formula_wrapper_spec.rb

@@ -205,7 +205,7 @@
       allow(Service::System).to receive(:systemctl?).and_return(false)
       expect do
         service.generate_plist(nil)
-      end.to output("Could not read the plist for `mysql`!\n").to_stdout
+      end.to raise_error TestExit, "Could not read the plist for `mysql`!"
     end
   end
 end