|
| 1 | +require_relative 'test_helper' |
| 2 | +require 'open3' |
| 3 | +require 'tmpdir' |
| 4 | +require 'json' |
| 5 | +require 'rbconfig' |
| 6 | +require 'fileutils' |
| 7 | + |
| 8 | +class CallgrindHarnessTest < Minitest::Test |
| 9 | + ROOT = File.expand_path('..', __dir__) |
| 10 | + |
| 11 | + # Pretend to be a Linux process running under Callgrind (or not). |
| 12 | + def fake_platform(host_os: 'linux', comm: 'callgrind-amd64') |
| 13 | + <<~STUB |
| 14 | + require 'rbconfig' |
| 15 | + RbConfig::CONFIG['host_os'] = #{host_os.inspect} |
| 16 | + File.singleton_class.prepend(Module.new do |
| 17 | + def read(path, *args, **kwargs) |
| 18 | + path == '/proc/self/comm' ? #{(comm + "\n").inspect} : super |
| 19 | + end |
| 20 | + end) |
| 21 | + STUB |
| 22 | + end |
| 23 | + |
| 24 | + def load_harness(**platform) |
| 25 | + script = fake_platform(**platform) + "require #{File.join(ROOT, 'harness/callgrind').inspect}" |
| 26 | + env = { 'RUBYOPT' => nil, 'BUNDLE_GEMFILE' => nil, 'BUNDLER_SETUP' => nil } |
| 27 | + Open3.capture3(env, RbConfig.ruby, '-e', script, chdir: ROOT) |
| 28 | + end |
| 29 | + |
| 30 | + def run_harness(env = {}, fail_at: nil) |
| 31 | + Dir.mktmpdir do |dir| |
| 32 | + # Fake a global gem so tests do not install a native extension. |
| 33 | + gem_lib = File.join(dir, 'gems', 'lib') |
| 34 | + FileUtils.mkdir_p(gem_lib) |
| 35 | + File.write(File.join(gem_lib, 'valgrind.rb'), <<~RUBY) |
| 36 | + module Valgrind |
| 37 | + def self.callgrind_stop_instrumentation; $events << 'stop'; end |
| 38 | + def self.callgrind_start_instrumentation; $events << 'start'; end |
| 39 | + def self.callgrind_zero_stats; $events << 'zero'; end |
| 40 | + def self.callgrind_dump_stats(name); $events << "dump:" + name; end |
| 41 | + end |
| 42 | + RUBY |
| 43 | + script = fake_platform + <<~RUBY |
| 44 | + require 'json' |
| 45 | + $events = [] |
| 46 | + require #{File.join(ROOT, 'lib/harness/extra').inspect} |
| 47 | + def ensure_global_gem(name) |
| 48 | + raise 'wrong gem' unless name == 'valgrind' |
| 49 | + $LOAD_PATH << #{gem_lib.inspect} |
| 50 | + end |
| 51 | + require #{File.join(ROOT, 'harness/callgrind').inspect} |
| 52 | + def return_results(warmup, bench) |
| 53 | + $events << ['results', warmup.size, bench.size] |
| 54 | + end |
| 55 | + calls = 0 |
| 56 | + begin |
| 57 | + run_benchmark(3, ignored_keyword: true) do |
| 58 | + calls += 1 |
| 59 | + $events << 'work' |
| 60 | + raise 'workload failed' if calls == #{fail_at.inspect} |
| 61 | + end |
| 62 | + rescue => e |
| 63 | + $events << e.message |
| 64 | + end |
| 65 | + puts JSON.generate($events) |
| 66 | + RUBY |
| 67 | + clean_env = { |
| 68 | + 'RUBYOPT' => nil, 'BUNDLE_GEMFILE' => nil, 'BUNDLER_SETUP' => nil, |
| 69 | + 'WARMUP_ITRS' => '2', 'MIN_BENCH_ITRS' => nil, |
| 70 | + 'RESULT_JSON_PATH' => File.join(dir, 'results.json') |
| 71 | + }.merge(env) |
| 72 | + out, err, status = Open3.capture3(clean_env, RbConfig.ruby, '-I', dir, '-e', script, chdir: ROOT) |
| 73 | + assert status.success?, "#{out}\n#{err}" |
| 74 | + JSON.parse(out.lines.last) |
| 75 | + end |
| 76 | + end |
| 77 | + |
| 78 | + def test_profiles_hint_iterations_after_warmup |
| 79 | + assert_equal ['stop', 'stop', 'work', 'work', 'start', 'zero', |
| 80 | + 'work', 'work', 'work', 'stop', 'dump:-e', ['results', 2, 3]], run_harness |
| 81 | + end |
| 82 | + |
| 83 | + def test_iteration_overrides_and_zero_warmup |
| 84 | + assert_equal ['stop', 'stop', 'start', 'zero', 'work', 'stop', 'dump:-e', ['results', 0, 1]], |
| 85 | + run_harness({ 'WARMUP_ITRS' => '0', 'MIN_BENCH_ITRS' => '1' }) |
| 86 | + end |
| 87 | + |
| 88 | + def test_failure_stops_and_dumps_without_results |
| 89 | + assert_equal ['stop', 'stop', 'work', 'work', 'start', 'zero', 'work', |
| 90 | + 'stop', 'dump:-e', 'workload failed'], run_harness({}, fail_at: 3) |
| 91 | + end |
| 92 | + |
| 93 | + def test_warmup_failure_never_starts_profiling |
| 94 | + assert_equal ['stop', 'stop', 'work', 'workload failed'], run_harness({}, fail_at: 1) |
| 95 | + end |
| 96 | + |
| 97 | + def test_invalid_counts_fail_before_workload |
| 98 | + assert_equal ['stop', 'MIN_BENCH_ITRS must be positive'], run_harness({ 'MIN_BENCH_ITRS' => '0' }) |
| 99 | + assert_equal ['stop', 'WARMUP_ITRS must be non-negative'], run_harness({ 'WARMUP_ITRS' => '-1' }) |
| 100 | + events = run_harness({ 'MIN_BENCH_ITRS' => 'invalid' }) |
| 101 | + assert_equal 2, events.size |
| 102 | + assert_match(/invalid value for Integer/, events.last) |
| 103 | + end |
| 104 | + |
| 105 | + def test_direct_execution_does_not_write_results |
| 106 | + refute run_harness({ 'RESULT_JSON_PATH' => nil }).any? { |event| event.is_a?(Array) } |
| 107 | + end |
| 108 | + |
| 109 | + def test_rejects_non_linux |
| 110 | + _, err, status = load_harness(host_os: 'darwin24') |
| 111 | + refute status.success? |
| 112 | + assert_match(/callgrind unsupported/, err) |
| 113 | + end |
| 114 | + |
| 115 | + def test_rejects_linux_without_callgrind |
| 116 | + %w[ruby memcheck-amd64-].each do |comm| |
| 117 | + _, err, status = load_harness(comm: comm) |
| 118 | + refute status.success?, comm |
| 119 | + assert_match(/must run under `valgrind --tool=callgrind`/, err) |
| 120 | + end |
| 121 | + end |
| 122 | +end |
0 commit comments