Move default executable selection into ArgumentParser

Author: rafaelfranca

lib/argument_parser.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'shellwords'
+require 'rbconfig'
 
 class ArgumentParser
   Args = Struct.new(
@@ -19,8 +20,12 @@ class ArgumentParser
     keyword_init: true
   )
 
-  def self.parse(argv = ARGV)
-    new.parse(argv)
+  def self.parse(argv = ARGV, ruby_executable: RbConfig.ruby)
+    new(ruby_executable: ruby_executable).parse(argv)
+  end
+
+  def initialize(ruby_executable: RbConfig.ruby)
+    @ruby_executable = ruby_executable
   end
 
   def parse(argv)
@@ -140,11 +145,26 @@ def parse(argv)
       args.name_filters += argv
     end
 
+    # If -e is not specified, benchmark the current Ruby. Compare it with YJIT if available.
+    if args.executables.empty?
+      if have_yjit?(@ruby_executable) && !args.skip_yjit
+        args.executables["interp"] = [@ruby_executable]
+        args.executables["yjit"] = [@ruby_executable, "--yjit", *args.yjit_opts.shellsplit]
+      else
+        args.executables["ruby"] = [@ruby_executable]
+      end
+    end
+
     args
   end
 
   private
 
+  def have_yjit?(ruby)
+    ruby_version = `#{ruby} -v --yjit 2> #{File::NULL}`.strip
+    ruby_version.downcase.include?("yjit")
+  end
+
   def default_args
     Args.new(
       executables: {},

run_benchmarks.rb

@@ -15,11 +15,6 @@
 require_relative 'lib/benchmark_filter'
 require_relative 'lib/argument_parser'
 
-def have_yjit?(ruby)
-  ruby_version = `#{ruby} -v --yjit 2> #{File::NULL}`.strip
-  ruby_version.downcase.include?("yjit")
-end
-
 def mean(values)
   Stats.new(values).mean
 end
@@ -159,16 +154,6 @@ def run_benchmarks(ruby:, ruby_description:, categories:, name_filters:, out_pat
 
 args = ArgumentParser.parse(ARGV)
 
-# If -e is not specified, benchmark the current Ruby. Compare it with YJIT if available.
-if args.executables.empty?
-  if have_yjit?(RbConfig.ruby) && !args.skip_yjit
-    args.executables["interp"] = [RbConfig.ruby]
-    args.executables["yjit"] = [RbConfig.ruby, "--yjit", *args.yjit_opts.shellsplit]
-  else
-    args.executables["ruby"] = [RbConfig.ruby]
-  end
-end
-
 CPUConfig.configure_for_benchmarking(turbo: args.turbo)
 
 # Create the output directory

test/argument_parser_test.rb

@@ -34,21 +34,26 @@ def setup_mock_ruby(path)
 
   describe '#parse' do
     it 'returns default values when no arguments provided' do
-      parser = ArgumentParser.new
-      args = parser.parse([])
-
-      assert_equal({}, args.executables)
-      assert_equal File.expand_path("./data"), args.out_path
-      assert_nil args.out_override
-      assert_equal "harness", args.harness
-      assert_equal "", args.yjit_opts
-      assert_equal [], args.categories
-      assert_equal [], args.name_filters
-      assert_equal false, args.rss
-      assert_equal false, args.graph
-      assert_equal false, args.no_pinning
-      assert_equal false, args.turbo
-      assert_equal false, args.skip_yjit
+      mock_ruby = '/usr/bin/ruby'
+      parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+      # Stub to return false so we get a single 'ruby' executable
+      parser.stub :have_yjit?, false do
+        args = parser.parse([])
+
+        assert_equal({ 'ruby' => [mock_ruby] }, args.executables)
+        assert_equal File.expand_path("./data"), args.out_path
+        assert_nil args.out_override
+        assert_equal "harness", args.harness
+        assert_equal "", args.yjit_opts
+        assert_equal [], args.categories
+        assert_equal [], args.name_filters
+        assert_equal false, args.rss
+        assert_equal false, args.graph
+        assert_equal false, args.no_pinning
+        assert_equal false, args.turbo
+        assert_equal false, args.skip_yjit
+      end
     end
 
     describe '-e option' do
@@ -502,5 +507,95 @@ def setup_mock_ruby(path)
         assert_equal true, args.rss
       end
     end
+
+    describe 'default executables' do
+      it 'sets ruby executable when no -e option and no YJIT' do
+        mock_ruby = '/usr/bin/ruby'
+
+        parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+        parser.stub :have_yjit?, false do
+          args = parser.parse([])
+
+          assert_equal 1, args.executables.size
+          assert_equal [mock_ruby], args.executables['ruby']
+        end
+      end
+
+      it 'sets interp and yjit executables when no -e option and YJIT available' do
+        mock_ruby = '/usr/bin/ruby'
+
+        parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+        parser.stub :have_yjit?, true do
+          args = parser.parse([])
+
+          assert_equal 2, args.executables.size
+          assert_equal [mock_ruby], args.executables['interp']
+          assert_equal [mock_ruby, '--yjit'], args.executables['yjit']
+        end
+      end
+
+      it 'includes yjit_opts in default yjit executable' do
+        mock_ruby = '/usr/bin/ruby'
+
+        parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+        parser.stub :have_yjit?, true do
+          args = parser.parse(['--yjit_opts=--yjit-call-threshold=10'])
+
+          assert_equal 2, args.executables.size
+          assert_equal [mock_ruby], args.executables['interp']
+          assert_equal [mock_ruby, '--yjit', '--yjit-call-threshold=10'], args.executables['yjit']
+        end
+      end
+
+      it 'respects --skip-yjit flag when YJIT is available' do
+        mock_ruby = '/usr/bin/ruby'
+
+        parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+        parser.stub :have_yjit?, true do
+          args = parser.parse(['--skip-yjit'])
+
+          assert_equal 1, args.executables.size
+          assert_equal [mock_ruby], args.executables['ruby']
+        end
+      end
+
+      it 'does not set default executables when -e option is provided' do
+        mock_ruby = '/usr/bin/ruby'
+
+        parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+        parser.stub :have_yjit?, true do
+          args = parser.parse(['-e', 'custom::custom-ruby'])
+
+          assert_equal 1, args.executables.size
+          assert_equal ['custom-ruby'], args.executables['custom']
+        end
+      end
+
+      it 'does not set default executables when --chruby option is provided' do
+        Dir.mktmpdir do |tmpdir|
+          @temp_home = tmpdir
+          rubies_dir = File.join(tmpdir, '.rubies')
+          ruby_path = File.join(rubies_dir, '3.2.0/bin/ruby')
+          setup_mock_ruby(ruby_path)
+
+          ENV['HOME'] = tmpdir
+          mock_ruby = '/usr/bin/ruby'
+
+          parser = ArgumentParser.new(ruby_executable: mock_ruby)
+
+          parser.stub :have_yjit?, true do
+            args = parser.parse(['--chruby=test::3.2.0'])
+
+            assert_equal 1, args.executables.size
+            assert_equal ruby_path, args.executables['test'].first
+          end
+        end
+      end
+    end
   end
 end