class RSpecBackgroundProcess::BackgroundProcess
Attributes
kill_timeout[R]
log_file[R]
name[R]
pid_file[R]
ready_timeout[R]
state_change_time[R]
state_log[R]
term_timeout[R]
working_directory[R]
Public Class Methods
new(name, cmd, args = [], working_directory = nil, options = {})
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 41 def initialize(name, cmd, args = [], working_directory = nil, options = {}) @name = name @exec = (Pathname.new(Dir.pwd) + cmd).cleanpath.to_s @args = args.map(&:to_s) @pid = nil @process = nil @state_log = [] case working_directory when Array working_directory = Dir.mktmpdir(working_directory.map(&:to_s)) when nil working_directory = Dir.mktmpdir(name.to_s) end @working_directory = Pathname.new(working_directory.to_s) @working_directory.directory? or @working_directory.mkdir @pid_file = @working_directory + "#{@name}.pid" @log_file = @working_directory + "out.log" @options = options reset_options(options) @fsm_lock = Mutex.new @_fsm = MicroMachine.new(:not_running) @state_change_time = Time.now.to_f @after_state_change = [] @_fsm.on(:any) do @state_change_time = Time.now.to_f puts "process is now #{@_fsm.state}" @after_state_change.each{|callback| callback.call(@_fsm.state)} end @_fsm.when(:starting, not_running: :starting ) @_fsm.on(:starting) do puts "starting: `#{command}`" puts "working directory: #{@working_directory}" puts "log file: #{@log_file}" end @_fsm.when(:started, starting: :running ) @_fsm.on(:running) do puts "running with pid: #{@pid}" end @_fsm.when(:stopped, running: :not_running, ready: :not_running ) @_fsm.when(:died, starting: :dead, running: :dead, ready: :dead ) # it is topped before marked failed @_fsm.when(:failed, not_running: :failed ) @_fsm.when(:verified, running: :ready, ready: :ready, ) @_fsm.when(:run_away, running: :jammed, ready: :jammed ) @template_renderer = options[:template_renderer] # make sure we stop on exit my_pid = Process.pid at_exit do stop if Process.pid == my_pid and running? #only run in master process end end
Public Instance Methods
after_state_change(&callback)
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 318 def after_state_change(&callback) @after_state_change << callback end
command()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 149 def command # update arguments with actual port numbers, working directories etc. (see template variables) Shellwords.join([@exec, *@args.map{|arg| render(arg)}]) end
dead?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 195 def dead? state == :dead end
exit_code()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 179 def exit_code @process.value.exitstatus if not running? and @process end
failed?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 199 def failed? state == :failed end
jammed?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 203 def jammed? state == :jammed end
pid()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 175 def pid @pid if starting? or running? end
puts(message)
click to toggle source
Calls superclass method
# File lib/rspec-background-process/background_process.rb, line 322 def puts(message) message = "#{name}: #{message}" @state_log << message super message if @logging end
ready?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 191 def ready? state == :ready end
refresh()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 211 def refresh puts 'refreshing' cwd = Dir.pwd begin Dir.chdir(@working_directory.to_s) @refresh_action.call(self) ensure Dir.chdir(cwd) end self end
render(str)
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 132 def render(str) if @template_renderer @template_renderer.call(template_variables, str) else str end end
reset_options(opts)
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 164 def reset_options(opts) @logging = opts[:logging] @ready_timeout = opts[:ready_timeout] || 10 @term_timeout = opts[:term_timeout] || 10 @kill_timeout = opts[:kill_timeout] || 10 @ready_test = opts[:ready_test] || ->(_){true} @refresh_action = opts[:refresh_action] || ->(_){restart} end
restart()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 223 def restart puts 'restarting' stop start end
running?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 183 def running? trigger? :stopped # if it can be stopped it must be running :D end
start()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 229 def start return self if trigger? :stopped trigger? :starting or raise StateError.new(self, 'start', state) trigger :starting @pid, @process = spawn fail "expected 2 values from #spawn, got: #{@pid}, #{@process}" unless @pid and @process @process_watcher = Thread.new do @process.join trigger :died end trigger :started self end
starting?()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 187 def starting? state == :starting end
state()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 207 def state lock_fsm{|fsm| fsm.state } end
stop()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 247 def stop return if trigger? :started trigger? :stopped or raise StateError.new(self, 'stop', state) # get rid of the watcher thread @process_watcher and @process_watcher.kill and @process_watcher.join catch :done do begin if @term_timeout > 0 puts "terminating process: #{@pid}" Process.kill("TERM", @pid) @process.join(@term_timeout) and throw :done puts "process #{@pid} did not terminate in time" end if @kill_timeout > 0 puts "killing process: #{@pid}" Process.kill("KILL", @pid) @process.join(@kill_timeout) and throw :done puts "process #{@pid} could not be killed!!!" end rescue Errno::ESRCH throw :done end trigger :run_away raise ProcessRunAwayError.new(self, @pid) end trigger :stopped self end
template_variables()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 140 def template_variables { /working directory/ => -> { working_directory }, /pid file/ => -> { pid_file }, /log file/ => -> { log_file }, /name/ => -> { name }, } end
to_s()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 328 def to_s "#{name}[#{@exec}](#{state})" end
wait_ready()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 281 def wait_ready trigger? :verified or raise StateError.new(self, 'wait ready', state) puts 'waiting ready' status = while_running do begin Timeout.timeout(@ready_timeout) do @ready_test.call(self) ? :ready : :failed end rescue Timeout::Error :ready_timeout end end case status when :failed puts "process failed to pass it's readiness test" stop trigger :failed raise ProcessReadyFailedError.new(self) when :ready_timeout puts "process not ready in time; see #{log_file} for detail" stop trigger :failed raise ProcessReadyTimeOutError.new(self) when Exception puts "process readiness check raised error: #{status}; see #{log_file} for detail" stop trigger :failed raise status else trigger :verified self end end
Private Instance Methods
daemonize(type = 'exec') { |_command| ... }
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 373 def daemonize(type = 'exec') Daemon.daemonize(@pid_file, @log_file) do |log| _command = command # render command log.truncate(0) Dir.chdir(@working_directory.to_s) # useful for testing ENV['PROCESS_SPAWN_TYPE'] = type yield _command end end
lock_fsm() { |_fsm| ... }
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 334 def lock_fsm @fsm_lock.synchronize{yield @_fsm} end
spawn()
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 346 def spawn daemonize('exec') do |command| # TODO: looks like exec is eating pending TERM (or other) signal and .start.stop may time out on TERM if signal was delivered before exec? Kernel.exec(command) end end
trigger(change)
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 338 def trigger(change) lock_fsm{|fsm| fsm.trigger(change)} end
trigger?(change)
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 342 def trigger?(change) lock_fsm{|fsm| fsm.trigger?(change)} end
while_running() { || ... }
click to toggle source
# File lib/rspec-background-process/background_process.rb, line 353 def while_running action = Thread.new do begin yield rescue => error error end end value = ThreadsWait.new.join(action, @process).value case value when Process::Status puts "process exited; see #{log_file} for detail" trigger :died raise ProcessExitedError.new(self, exit_code) end value end