Port prof to use AbstractCommand
This commit is contained in:
parent
5364b6ef03
commit
2dceb65b42
@ -1,65 +1,67 @@
|
||||
# typed: true
|
||||
# typed: strict
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "abstract_command"
|
||||
require "cli/parser"
|
||||
|
||||
module Homebrew
|
||||
module_function
|
||||
module DevCmd
|
||||
class Prof < AbstractCommand
|
||||
sig { override.returns(CLI::Parser) }
|
||||
def raw_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
description <<~EOS
|
||||
Run Homebrew with a Ruby profiler. For example, `brew prof readall`.
|
||||
EOS
|
||||
switch "--stackprof",
|
||||
description: "Use `stackprof` instead of `ruby-prof` (the default)."
|
||||
|
||||
sig { returns(CLI::Parser) }
|
||||
def prof_args
|
||||
Homebrew::CLI::Parser.new do
|
||||
description <<~EOS
|
||||
Run Homebrew with a Ruby profiler. For example, `brew prof readall`.
|
||||
EOS
|
||||
switch "--stackprof",
|
||||
description: "Use `stackprof` instead of `ruby-prof` (the default)."
|
||||
|
||||
named_args :command, min: 1
|
||||
end
|
||||
end
|
||||
|
||||
def prof
|
||||
args = prof_args.parse
|
||||
|
||||
Homebrew.install_bundler_gems!(groups: ["prof"], setup_path: false)
|
||||
|
||||
brew_rb = (HOMEBREW_LIBRARY_PATH/"brew.rb").resolved_path
|
||||
FileUtils.mkdir_p "prof"
|
||||
cmd = args.named.first
|
||||
|
||||
case Commands.path(cmd)&.extname
|
||||
when ".rb"
|
||||
# expected file extension so we do nothing
|
||||
when ".sh"
|
||||
raise UsageError, <<~EOS
|
||||
`#{cmd}` is a Bash command!
|
||||
Try `hyperfine` for benchmarking instead.
|
||||
EOS
|
||||
else
|
||||
raise UsageError, "`#{cmd}` is an unknown command!"
|
||||
end
|
||||
|
||||
Homebrew.setup_gem_environment!
|
||||
|
||||
if args.stackprof?
|
||||
with_env HOMEBREW_STACKPROF: "1" do
|
||||
system(*HOMEBREW_RUBY_EXEC_ARGS, brew_rb, *args.named)
|
||||
named_args :command, min: 1
|
||||
end
|
||||
end
|
||||
|
||||
sig { override.void }
|
||||
def run
|
||||
Homebrew.install_bundler_gems!(groups: ["prof"], setup_path: false)
|
||||
|
||||
brew_rb = (HOMEBREW_LIBRARY_PATH/"brew.rb").resolved_path
|
||||
FileUtils.mkdir_p "prof"
|
||||
cmd = args.named.first
|
||||
|
||||
case Commands.path(cmd)&.extname
|
||||
when ".rb"
|
||||
# expected file extension so we do nothing
|
||||
when ".sh"
|
||||
raise UsageError, <<~EOS
|
||||
`#{cmd}` is a Bash command!
|
||||
Try `hyperfine` for benchmarking instead.
|
||||
EOS
|
||||
else
|
||||
raise UsageError, "`#{cmd}` is an unknown command!"
|
||||
end
|
||||
|
||||
Homebrew.setup_gem_environment!
|
||||
|
||||
if args[:stackprof?]
|
||||
with_env HOMEBREW_STACKPROF: "1" do
|
||||
system(*HOMEBREW_RUBY_EXEC_ARGS, brew_rb, *args.named)
|
||||
end
|
||||
output_filename = "prof/d3-flamegraph.html"
|
||||
safe_system "stackprof --d3-flamegraph prof/stackprof.dump > #{output_filename}"
|
||||
else
|
||||
output_filename = "prof/call_stack.html"
|
||||
safe_system "ruby-prof", "--printer=call_stack", "--file=#{output_filename}", brew_rb, "--", *args.named
|
||||
end
|
||||
|
||||
exec_browser output_filename
|
||||
rescue OptionParser::InvalidOption => e
|
||||
ofail e
|
||||
|
||||
# The invalid option could have been meant for the subcommand.
|
||||
# Suggest `brew prof list -r` -> `brew prof -- list -r`
|
||||
args = ARGV - ["--"]
|
||||
puts "Try `brew prof -- #{args.join(" ")}` instead."
|
||||
end
|
||||
output_filename = "prof/d3-flamegraph.html"
|
||||
safe_system "stackprof --d3-flamegraph prof/stackprof.dump > #{output_filename}"
|
||||
else
|
||||
output_filename = "prof/call_stack.html"
|
||||
safe_system "ruby-prof", "--printer=call_stack", "--file=#{output_filename}", brew_rb, "--", *args.named
|
||||
end
|
||||
|
||||
exec_browser output_filename
|
||||
rescue OptionParser::InvalidOption => e
|
||||
ofail e
|
||||
|
||||
# The invalid option could have been meant for the subcommand.
|
||||
# Suggest `brew prof list -r` -> `brew prof -- list -r`
|
||||
args = ARGV - ["--"]
|
||||
puts "Try `brew prof -- #{args.join(" ")}` instead."
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,10 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "cmd/shared_examples/args_parse"
|
||||
|
||||
RSpec.describe "brew prof" do
|
||||
it_behaves_like "parseable arguments"
|
||||
require "dev-cmd/prof"
|
||||
|
||||
RSpec.describe Homebrew::DevCmd::Prof do
|
||||
describe "integration tests", :integration_test, :needs_network do
|
||||
after do
|
||||
FileUtils.rm_rf HOMEBREW_LIBRARY_PATH/"prof"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user