Add brew bundle services helper

Author: Bo98

Library/Homebrew/bundle.rb

@@ -25,6 +25,7 @@
 require "bundle/dumper"
 require "bundle/installer"
 require "bundle/lister"
+require "bundle/services"
 require "bundle/commands/install"
 require "bundle/commands/dump"
 require "bundle/commands/cleanup"
@@ -33,6 +34,7 @@
 require "bundle/commands/list"
 require "bundle/commands/add"
 require "bundle/commands/remove"
+require "bundle/commands/services"
 require "bundle/whalebrew_installer"
 require "bundle/whalebrew_dumper"
 require "bundle/vscode_extension_checker"

Library/Homebrew/bundle/bundle.rb

@@ -82,6 +82,22 @@ def exchange_uid_if_needed!(&block)
 
         return_value
       end
+
+      sig { returns(T::Hash[String, String]) }
+      def formula_version_map
+        formula_versions = {}
+        ENV.each do |key, value|
+          match = key.match(/^HOMEBREW_BUNDLE_EXEC_FORMULA_VERSION_(.+)$/)
+          next if match.blank?
+
+          formula_name = match[1]
+          next if formula_name.blank?
+
+          ENV.delete(key)
+          formula_versions[formula_name.downcase] = value
+        end
+        formula_versions
+      end
     end
   end
 end

Library/Homebrew/bundle/commands/exec.rb

@@ -109,18 +109,7 @@ def run(*args, global: false, file: nil, subcommand: "")
           end
 
           # Replace the formula versions from the environment variables
-          formula_versions = {}
-          ENV.each do |key, value|
-            match = key.match(/^HOMEBREW_BUNDLE_EXEC_FORMULA_VERSION_(.+)$/)
-            next if match.blank?
-
-            formula_name = match[1]
-            next if formula_name.blank?
-
-            ENV.delete(key)
-            formula_versions[formula_name.downcase] = value
-          end
-          formula_versions.each do |formula_name, formula_version|
+          Bundle.formula_version_map.each do |formula_name, formula_version|
             ENV.each do |key, value|
               opt = %r{/opt/#{formula_name}([/:$])}
               next unless value.match(opt)

Library/Homebrew/bundle/commands/services.rb

@@ -0,0 +1,27 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Homebrew
+  module Bundle
+    module Commands
+      module Services
+        sig { params(args: String, global: T::Boolean, file: T.nilable(String)).void }
+        def self.run(*args, global:, file:)
+          raise UsageError, "invalid `brew bundle services` arguments" if args.length != 1
+
+          parsed_entries = Brewfile.read(global:, file:).entries
+
+          subcommand = args.first
+          case subcommand
+          when "run"
+            Homebrew::Bundle::Services.run(parsed_entries)
+          when "stop"
+            Homebrew::Bundle::Services.stop(parsed_entries)
+          else
+            raise UsageError, "unknown bundle services subcommand: #{subcommand}"
+          end
+        end
+      end
+    end
+  end
+end

Library/Homebrew/bundle/services.rb

@@ -0,0 +1,82 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "formula"
+require "services/system"
+
+module Homebrew
+  module Bundle
+    module Services
+      sig {
+        params(
+          entries: T::Array[Homebrew::Bundle::Dsl::Entry],
+          _block:  T.proc.params(info: T::Hash[String, T.anything], service_file: Pathname).void,
+        ).void
+      }
+      private_class_method def self.map_entries(entries, &_block)
+        formula_versions = Bundle.formula_version_map
+
+        entries.filter_map do |entry|
+          next if entry.type != :brew
+
+          formula = Formula[entry.name]
+          next unless formula.any_version_installed?
+
+          version = formula_versions[entry.name.downcase]
+          prefix = formula.rack/version if version
+
+          service_file = if prefix&.directory?
+            if Homebrew::Services::System.launchctl?
+              prefix/"#{formula.plist_name}.plist"
+            else
+              prefix/"#{formula.service_name}.service"
+            end
+          end
+
+          unless service_file&.file?
+            prefix = formula.any_installed_prefix
+            next if prefix.nil?
+
+            service_file = if Homebrew::Services::System.launchctl?
+              prefix/"#{formula.plist_name}.plist"
+            else
+              prefix/"#{formula.service_name}.service"
+            end
+          end
+
+          next unless service_file.file?
+
+          # We parse from a command invocation so that brew wrappers can invoke special actions
+          # for the elevated nature of `brew services`
+          output = Utils.safe_popen_read(HOMEBREW_BREW_FILE, "services", "info", "--json", formula.full_name)
+          info = JSON.parse(output)
+
+          raise "Failed to get service info for #{entry.name}" if info.length != 1
+
+          yield info.first, service_file
+        end
+      end
+
+      sig { params(entries: T::Array[Homebrew::Bundle::Dsl::Entry]).void }
+      def self.run(entries)
+        map_entries(entries) do |info, service_file|
+          next if info["running"]
+
+          safe_system HOMEBREW_BREW_FILE, "services", "run", "--file=#{service_file}", info["name"]
+        end
+      end
+
+      sig { params(entries: T::Array[Homebrew::Bundle::Dsl::Entry]).void }
+      def self.stop(entries)
+        map_entries(entries) do |info, _service_file|
+          next unless info["loaded"]
+
+          # Try avoid services not started by `brew bundle services`
+          next if Homebrew::Services::System.launchctl? && info["registered"]
+
+          safe_system HOMEBREW_BREW_FILE, "services", "stop", info["name"]
+        end
+      end
+    end
+  end
+end

Library/Homebrew/cmd/bundle.rb

@@ -61,6 +61,12 @@ class Bundle < AbstractCommand
 
           `brew bundle env`:
           Print the environment variables that would be set in a `brew bundle exec` environment.
+
+          `brew bundle services run`:
+          Start services for formulae specified in the `Brewfile`.
+
+          `brew bundle services stop`:
+          Stop services for formulae specified in the `Brewfile`.
         EOS
         flag "--file=",
              description: "Read from or write to the `Brewfile` from this location. " \
@@ -133,7 +139,7 @@ def run
         require "bundle"
 
         subcommand = args.named.first.presence
-        if ["exec", "add", "remove"].exclude?(subcommand) && args.named.size > 1
+        if %w[exec add remove services].exclude?(subcommand) && args.named.size > 1
           raise UsageError, "This command does not take more than 1 subcommand argument."
         end
 
@@ -263,6 +269,9 @@ def run
           else
             Homebrew::Bundle::Commands::Remove.run(*named_args, type: selected_types.first, global:, file:)
           end
+        when "services"
+          _, *named_args = args.named
+          Homebrew::Bundle::Commands::Services.run(*named_args, global:, file:)
         else
           raise UsageError, "unknown subcommand: #{subcommand}"
         end

Library/Homebrew/services/commands/info.rb

@@ -53,6 +53,7 @@ def self.output(hash, verbose:)
           return out unless verbose
 
           out += "File: #{hash[:file]} #{pretty_bool(hash[:file].present?)}\n"
+          out += "Registered at login: #{pretty_bool(hash[:registered])}\n"
           out += "Command: #{hash[:command]}\n" unless hash[:command].nil?
           out += "Working directory: #{hash[:working_dir]}\n" unless hash[:working_dir].nil?
           out += "Root directory: #{hash[:root_dir]}\n" unless hash[:root_dir].nil?

Library/Homebrew/services/formula_wrapper.rb

@@ -201,6 +201,7 @@ def to_hash
           user:         owner,
           status:       status_symbol,
           file:         service_file_present? ? dest : service_file,
+          registered:   service_file_present?,
         }
 
         return hash unless service?

Library/Homebrew/test/services/commands/info_spec.rb

@@ -89,14 +89,15 @@
     it "returns verbose output" do
       out = "service ()\nRunning: true\n"
       out += "Loaded: true\nSchedulable: false\n"
-      out += "User: user\nPID: 42\nFile: /dev/null true\nCommand: /bin/command\n"
+      out += "User: user\nPID: 42\nFile: /dev/null true\nRegistered at login: true\nCommand: /bin/command\n"
       out += "Working directory: /working/dir\nRoot directory: /root/dir\nLog: /log/dir\nError log: /log/dir/error\n"
       out += "Interval: 3600s\nCron: 5 * * * *\n"
       formula = {
         name:           "service",
         user:           "user",
         status:         :started,
         file:           "/dev/null",
+        registered:     true,
         running:        true,
         loaded:         true,
         schedulable:    false,

Library/Homebrew/test/services/formula_wrapper_spec.rb

@@ -371,6 +371,7 @@
         loaded:       false,
         name:         "mysql",
         pid:          nil,
+        registered:   false,
         running:      false,
         schedulable:  nil,
         service_name: "plist-mysql-test",
@@ -384,13 +385,14 @@
       ENV["HOME"] = "/tmp_home"
       allow(Homebrew::Services::System).to receive_messages(launchctl?: true, systemctl?: false)
       expect(service).to receive(:service?).twice.and_return(false)
-      expect(service).to receive(:service_file_present?).and_return(true)
+      expect(service).to receive(:service_file_present?).twice.and_return(true)
       expected = {
         exit_code:    nil,
         file:         Pathname.new("/tmp_home/Library/LaunchAgents/homebrew.mysql.plist"),
         loaded:       false,
         name:         "mysql",
         pid:          nil,
+        registered:   true,
         running:      false,
         schedulable:  nil,
         service_name: "plist-mysql-test",
@@ -404,7 +406,7 @@
       ENV["HOME"] = "/tmp_home"
       allow(Homebrew::Services::System).to receive_messages(launchctl?: true, systemctl?: false)
       expect(service).to receive(:service?).twice.and_return(true)
-      expect(service).to receive(:service_file_present?).and_return(true)
+      expect(service).to receive(:service_file_present?).twice.and_return(true)
       expect(service).to receive(:load_service).twice.and_return(service_object)
       expected = {
         command:        "/bin/cmd",
@@ -417,6 +419,7 @@
         log_path:       nil,
         name:           "mysql",
         pid:            nil,
+        registered:     true,
         root_dir:       nil,
         running:        false,
         schedulable:    false,