Module: ParallelCucumber::Helper::Command

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

Defined Under Namespace

Classes: TimedOutError

Constant Summary collapse

ONE_SECOND = 
1

Class Method Summary collapse

Class Method Details

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

rubocop:disable Metrics/ParameterLists, Metrics/LineLength



19
20
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
 
# File 'lib/parallel_cucumber/helper/command.rb', line 19

def exec_command(env, desc, script, logger, log_decoration = {}, timeout: 30, capture: false, return_script_error: false) # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
  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"
  pstat = nil
  pout = nil
  capture &&= [''] # Pass by reference
  exception = nil

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

      unless out_reader.join(timeout)
        raise TimedOutError
      end

      graceful_process_shutdown(out_reader, pstat, pout, logger)

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

    logger << "#{completed}\n"

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

    capture_or_empty = capture ? capture.first : '' # Even '' is truthy
    return pstat.value.success? ? capture_or_empty : nil
  rescue TimedOutError => e
    force_kill_process_with_tree(out_reader, pstat, pout, full_script, logger, timeout)

    exception = e
  rescue => e
    logger.debug("Exception #{pstat ? pstat[:pid] : "pstat=#{pstat}=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 



79
80
81
82
83
84
85
86
 
# File 'lib/parallel_cucumber/helper/command.rb', line 79

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