Module: ParallelCucumber::Helper::Command

Defined in:
lib/parallel_cucumber/helper/command.rb

Defined Under Namespace

Classes: TimedOutError

Constant Summary collapse

ONE_SECOND = 
1
STACKTRACE_COLLECTION_TIMEOUT = 
10

Class Method Summary collapse

Class Method Details

.exec_command(env, desc, script, logger, log_decoration = {}, timeout: 30, capture: false, return_script_error: false, return_on_timeout: false, collect_stacktrace: false) ⇒ Object

rubocop:disable Metrics/ParameterLists, Metrics/LineLength



21
22
23
24
25
26
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/parallel_cucumber/helper/command.rb', line 21

def exec_command(env, desc, script, logger, log_decoration = {},
                 timeout: 30, capture: false, return_script_error: false,
                 return_on_timeout: false, collect_stacktrace: false
)
  block_name = ''
  if log_decoration['worker_block']
    if log_decoration['start'] || log_decoration['end']
      block_name = "#{"#{env['TEST_USER']}-w#{env['WORKER_INDEX']}>"} #{desc}"
    end
  end

  logger << format(log_decoration['start'] + "\n", block_name) if log_decoration['start']
  full_script = "#{script} 2>&1"
  env_string = env.map { |k, v| "#{k}=#{v}" }.sort.join(' ')
  logger << "== Running command `#{full_script}` at #{Time.now}\n== with environment variables: #{env_string}\n"
  wait_thread = nil
  pout = nil
  capture &&= [''] # Pass by reference
  exception = nil
  command_pid = nil

  begin
    completed = begin
      pin, pout, wait_thread = Open3.popen2e(env, full_script)
      command_pid = wait_thread[:pid].to_s
      logger << "Command has pid #{command_pid}\n"
      pin.close
      out_reader = Thread.new do
        output_reader(pout, wait_thread, logger, capture)
      end

      unless out_reader.join(timeout)
        raise TimedOutError
      end

      graceful_process_shutdown(out_reader, wait_thread, pout, logger)

      wait_thread.value # reap already-terminated child.
      "Command completed #{wait_thread.value} at #{Time.now}"
    end

    logger << "#{completed}\n"

    raise "Script returned #{wait_thread.value.exitstatus}" unless wait_thread.value.success? || return_script_error

    capture_or_empty = capture ? capture.first : '' # Even '' is truthy
    return wait_thread.value.success? ? capture_or_empty : nil
  rescue TimedOutError => e
    process_tree = Helper::Processes.ps_tree
    send_usr1_to_process_with_tree(command_pid, full_script, logger, process_tree) if collect_stacktrace
    force_kill_process_with_tree(out_reader, wait_thread, pout, full_script, logger, timeout, process_tree, command_pid)

    return capture.first if return_on_timeout

    exception = e
  rescue => e
    logger.debug("Exception #{wait_thread ? wait_thread[:pid] : "wait_thread=#{wait_thread}=nil"}")
    trace = e.backtrace.join("\n\t").sub("\n\t", ": #{$ERROR_INFO}#{e.class ? " (#{e.class})" : ''}\n\t")
    logger.error("Threw for #{full_script}, caused #{trace}")

    exception = e
  ensure
    logger << format(log_decoration['end'] + "\n", block_name) if log_decoration['end']
  end
  logger.error("*** UNUSUAL TERMINATION FOR: #{script}")

  raise exception
end

.log_until_incomplete_line(logger, out_string) ⇒ Object

rubocop:enable Metrics/ParameterLists, Metrics/LineLength



91
92
93
94
95
96
97
98
 
# File 'lib/parallel_cucumber/helper/command.rb', line 91

def log_until_incomplete_line(logger, out_string)
  loop do
    line, out_string = out_string.split(/\n/, 2)
    return line || '' unless out_string
    logger << line
    logger << "\n"
  end
end

.wrap_block(log_decoration, block_name, logger) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/parallel_cucumber/helper/command.rb', line 6

def wrap_block(log_decoration, block_name, logger)
  [$stdout, $stderr].each(&:flush)
  logger << format(log_decoration['start'] + "\n", block_name) if log_decoration['start']
  [$stdout, $stderr].each(&:flush)
  yield
ensure
  [$stdout, $stderr].each(&:flush)
  logger << format(log_decoration['end'] + "\n", block_name) if log_decoration['end']
  [$stdout, $stderr].each(&:flush)
end