Class: TestRunner::Prebuild
- Inherits:
-
Object
- Object
- TestRunner::Prebuild
- Defined in:
- lib/test-runner/prebuild.rb
Constant Summary collapse
- DEFAULT_MEMORY_PER_JOB_MIB =
8192- ROOT_DIRECTORY =
'os-test-runner-prebuilds'.freeze
Instance Attribute Summary collapse
-
#log_path ⇒ Object
readonly
Returns the value of attribute log_path.
Instance Method Summary collapse
- #identity(test) ⇒ Object protected
-
#initialize(test_scripts, resource_pool:, state_dir:, memory_per_job_mib: DEFAULT_MEMORY_PER_JOB_MIB, system: NixCli::DEFAULT_SYSTEM, test_config_path: nil, repo_root: nil, root_directory: nil) ⇒ Prebuild
constructor
A new instance of Prebuild.
- #load_manifest(path, selected) ⇒ Object protected
- #open ⇒ Object
- #preparation_jobs ⇒ Object protected
- #with_cancellation ⇒ Object protected
Constructor Details
#initialize(test_scripts, resource_pool:, state_dir:, memory_per_job_mib: DEFAULT_MEMORY_PER_JOB_MIB, system: NixCli::DEFAULT_SYSTEM, test_config_path: nil, repo_root: nil, root_directory: nil) ⇒ Prebuild
Returns a new instance of Prebuild.
13 14 15 16 17 18 19 20 21 22 23 24 25 |
# File 'lib/test-runner/prebuild.rb', line 13 def initialize(test_scripts, resource_pool:, state_dir:, memory_per_job_mib: DEFAULT_MEMORY_PER_JOB_MIB, system: NixCli::DEFAULT_SYSTEM, test_config_path: nil, repo_root: nil, root_directory: nil) @scripts = test_scripts @pool = resource_pool @state_dir = state_dir @memory_per_job_mib = Integer(memory_per_job_mib) raise ArgumentError, 'prebuild-memory-per-job-mib must be positive' if @memory_per_job_mib <= 0 @nix = NixCli.new(system:, test_config_path:, repo_root:) runtime = ENV.fetch('XDG_RUNTIME_DIR', nil) runtime = Dir.tmpdir if runtime.nil? || runtime.empty? @root_directory = root_directory || File.join(runtime, "#{ROOT_DIRECTORY}-#{Process.uid}") end |
Instance Attribute Details
#log_path ⇒ Object (readonly)
Returns the value of attribute log_path.
11 12 13 |
# File 'lib/test-runner/prebuild.rb', line 11 def log_path @log_path end |
Instance Method Details
#identity(test) ⇒ Object (protected)
62 63 64 |
# File 'lib/test-runner/prebuild.rb', line 62 def identity(test) Digest::SHA256.hexdigest(JSON.generate([test.path, test.test_args || {}, test.template_args || {}])) end |
#load_manifest(path, selected) ⇒ Object (protected)
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/test-runner/prebuild.rb', line 93 def load_manifest(path, selected) manifest = JSON.parse(File.read(path)) unless manifest.is_a?(Array) && manifest.all? { |entry| entry.is_a?(Hash) } raise 'Invalid preparation manifest' end ids = manifest.map { |entry| entry['id'] } unless ids.uniq.length == ids.length && ids.sort == selected.keys.sort raise 'Preparation manifest has missing, duplicate, or unexpected tests' end manifest.each_with_object({}) do |entry, configs| json = entry.fetch('json') unless json.is_a?(String) && json.start_with?('/nix/store/') && File.file?(json) raise "Invalid prepared JSON store path for #{entry.fetch('id')}" end selected.fetch(entry.fetch('id')).each do |test| scripts = @scripts.select { |script| script.test == test } configs[test] = TestConfig.load(test, config_path: json).validate!(scripts) end end end |
#open ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/test-runner/prebuild.rb', line 27 def open prepared = @scripts.empty? return yield({}) if prepared FileUtils.mkdir_p(@state_dir) directory = Dir.mktmpdir('prebuild-', @state_dir) @log_path = File.join(directory, 'build.log') selected = @scripts.map(&:test).uniq.group_by { |test| identity(test) } requests = selected.map do |id, tests| test = tests.first { id:, path: test.path, testArgs: test.test_args || {}, templateArgs: test.template_args || {} } end File.write(File.join(directory, 'selection.json'), JSON.pretty_generate(requests)) File.write(log_path, "Preparation selection: #{JSON.generate(requests)}\n") jobs = preparation_jobs warn "Preparing #{requests.length} selected tests; build log: #{log_path}" File.open(log_path, 'a') { |file| file.puts(@capacity_message) } GcRoot.new(root_directory: @root_directory).open do |root| with_cancellation do @nix.build_test_batch(requests, root, max_jobs: jobs, log_path:) end configs = load_manifest(root, selected) warn "Preparation complete: #{configs.length} test configurations; starting runtime" prepared = true yield(configs) end rescue StandardError => e raise if prepared raise "Test preparation failed: #{e.}#{log_path ? "; build log: #{log_path}" : ''}" end |
#preparation_jobs ⇒ Object (protected)
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/test-runner/prebuild.rb', line 66 def preparation_jobs inherited = @nix.local_max_jobs available = @pool.prebuild_memory_mib @capacity_message = "Preparation capacity: #{@pool.prebuild_memory_status}; " \ "usable=#{available.inspect} MiB, estimate=#{@memory_per_job_mib} MiB/job, " \ "inherited Nix local max-jobs=#{inherited}" if inherited == 0 @capacity_message += '; max-jobs=0 (remote-only/substitution; remote memory is not sized)' warn @capacity_message return 0 end if available.nil? raise 'Unable to detect preparation memory; set --max-memory-mib to a usable capacity' end jobs = [inherited, available / @memory_per_job_mib].min if jobs <= 0 raise "Insufficient preparation memory: #{@capacity_message}; " \ 'adjust capacity, reserve, or --prebuild-memory-per-job-mib' end @capacity_message += "; preparation max-jobs=#{jobs}" warn @capacity_message jobs end |
#with_cancellation ⇒ Object (protected)
117 118 119 120 121 122 123 124 |
# File 'lib/test-runner/prebuild.rb', line 117 def with_cancellation handlers = %w[TERM HUP].to_h do |signal| [signal, Signal.trap(signal) { raise SignalException, signal }] end yield ensure handlers&.each { |signal, handler| Signal.trap(signal, handler) } end |