Class: Aruba::Processes::SpawnProcess

Inherits:
BasicProcess show all
Defined in:
lib/aruba/processes/spawn_process.rb

Overview

Spawn a process for command

‘SpawnProcess` is not meant for direct use - `SpawnProcess.new` - by users. Only it’s public methods are part of the public API of aruba, e.g. ‘#stdin`, `#stdout`.

Instance Attribute Summary

Attributes inherited from BasicProcess

#environment, #exit_status, #exit_timeout, #io_wait_timeout, #main_class, #startup_wait_time, #stop_signal, #working_directory

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicProcess

#after_run, #arguments, #before_run, #command, #commandline, #empty?, #inspect, #output, #restart, #started?, #stopped?, #timed_out?

Constructor Details

#initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = Aruba.platform.environment_variables.hash_from_env, main_class = nil, stop_signal = nil, startup_wait_time = 0) ⇒ SpawnProcess

Create process

Parameters:

  • cmd (String) —

    Command string

  • exit_timeout (Numeric) —

    The timeout until we expect the command to be finished

  • io_wait_timeout (Numeric) —

    The timeout until we expect the io to be finished

  • working_directory (String) —

    The directory where the command will be executed

  • environment (Hash) (defaults to: Aruba.platform.environment_variables.hash_from_env) —

    Environment variables

  • main_class (Class) (defaults to: nil) —

    E.g. Cli::App::Runner

  • stop_signal (String) (defaults to: nil) —

    Name of signal to send to stop process. E.g. ‘HUP’.

  • startup_wait_time (Numeric) (defaults to: 0) —

    The amount of seconds to wait after Aruba has started a command.



51
52
53
54
55
56
57
58
59
 
# File 'lib/aruba/processes/spawn_process.rb', line 51

def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, # rubocop:disable Metrics/ParameterLists
               environment = Aruba.platform.environment_variables.hash_from_env,
               main_class = nil, stop_signal = nil, startup_wait_time = 0)
  super

  @process      = nil
  @stdout_cache = nil
  @stderr_cache = nil
end

Class Method Details

.match?(_mode) ⇒ Boolean

Use as default launcher

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/aruba/processes/spawn_process.rb', line 22

def self.match?(_mode)
  true
end

Instance Method Details

#close_io(name) ⇒ Object

Close io



168
169
170
171
172
 
# File 'lib/aruba/processes/spawn_process.rb', line 168

def close_io(name)
  return if stopped?

  @process.io.public_send(name.to_sym).close
end

#content ⇒ String

Content of command

Returns:

  • (String) —

    The content of the script/command. This might be binary output as string if your command is a binary executable.



254
255
256
 
# File 'lib/aruba/processes/spawn_process.rb', line 254

def content
  File.read command_path
end

#filesystem_status ⇒ Aruba::Platforms::FilesystemStatus

Return file system stats for the given command

Returns:



245
246
247
 
# File 'lib/aruba/processes/spawn_process.rb', line 245

def filesystem_status
  Aruba.platform.filesystem_status.new(command_path)
end

#interactive? ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/aruba/processes/spawn_process.rb', line 258

def interactive?
  true
end

#pid ⇒ Object

Output pid of process

This is the PID of the spawned process.



224
225
226
 
# File 'lib/aruba/processes/spawn_process.rb', line 224

def pid
  @process.pid
end

#send_signal(signal) ⇒ Object

Send command a signal

Parameters:

  • signal (String) —

    The signal, i.e. ‘TERM’



232
233
234
235
236
237
238
239
 
# File 'lib/aruba/processes/spawn_process.rb', line 232

def send_signal(signal)
  error_message = %(Command "#{commandline}" with PID "#{pid}" has already stopped.)
  raise CommandAlreadyStoppedError, error_message if @process.exited?

  Process.kill signal, pid
rescue Errno::ESRCH
  raise CommandAlreadyStoppedError, error_message
end

#start {|SpawnProcess| ... } ⇒ Object

Run the command

Yields:



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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aruba/processes/spawn_process.rb', line 66

def start
  if started?
    error_message =
      "Command \"#{commandline}\" has already been started." \
      " Please `#stop` the command first and `#start` it again." \
      " Alternatively use `#restart`."
    raise CommandAlreadyStartedError, error_message
  end

  @started = true

  @process = ChildProcess.build(*command_string.to_a)
  @stdout_file = Tempfile.new("aruba-stdout-")
  @stderr_file = Tempfile.new("aruba-stderr-")

  @stdout_file.sync = true
  @stderr_file.sync = true

  @stdout_file.set_encoding("ASCII-8BIT")
  @stderr_file.set_encoding("ASCII-8BIT")

  @exit_status = nil
  @duplex      = true

  before_run

  @process.io.stdout = @stdout_file
  @process.io.stderr = @stderr_file
  @process.duplex    = @duplex
  @process.cwd       = @working_directory

  @process.environment.update(environment)

  begin
    Aruba.platform.with_environment(environment) do
      @process.start
      sleep startup_wait_time
    end
  rescue ChildProcess::LaunchError => e
    raise LaunchError, "It tried to start #{commandline}. " + e.message
  end

  after_run

  yield self if block_given?
end

#stderr(opts = {}) ⇒ String

Access to stderr of process

Parameters:

  • opts (Hash) (defaults to: {}) —

    Options

  • [Integer] (Hash) —

    a customizable set of options

Returns:

  • (String) —

    The content of stderr



149
150
151
152
153
154
155
156
 
# File 'lib/aruba/processes/spawn_process.rb', line 149

def stderr(opts = {})
  return @stderr_cache if stopped?

  wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
    @process.io.stderr.flush
    open(@stderr_file.path).read
  end
end

#stdin ⇒ Object

Access to stdin of process



114
115
116
117
118
 
# File 'lib/aruba/processes/spawn_process.rb', line 114

def stdin
  return if @process.exited?

  @process.io.stdin
end

#stdout(opts = {}) ⇒ String

Access to stdout of process

Parameters:

  • opts (Hash) (defaults to: {}) —

    Options

  • [Integer] (Hash) —

    a customizable set of options

Returns:

  • (String) —

    The content of stdout



130
131
132
133
134
135
136
137
 
# File 'lib/aruba/processes/spawn_process.rb', line 130

def stdout(opts = {})
  return @stdout_cache if stopped?

  wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
    @process.io.stdout.flush
    open(@stdout_file.path).read
  end
end

#stop ⇒ Object

Stop command



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/aruba/processes/spawn_process.rb', line 175

def stop(*)
  return @exit_status if stopped?

  begin
    @process.poll_for_exit(@exit_timeout)
  rescue ChildProcess::TimeoutError
    @timed_out = true
  end

  terminate
end

#terminate ⇒ Object

Terminate command



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/aruba/processes/spawn_process.rb', line 193

def terminate
  return @exit_status if stopped?

  unless @process.exited?
    if @stop_signal
      # send stop signal ...
      send_signal @stop_signal
      # ... and set the exit status
      wait
    else
      begin
        @process.stop
      rescue Errno::EPERM # This can occur on MacOS
        nil
      end
    end
  end

  @exit_status = @process.exit_code

  @stdout_cache = read_temporary_output_file @stdout_file
  @stderr_cache = read_temporary_output_file @stderr_file

  @started = false

  @exit_status
end

#wait ⇒ Object

Wait for command to finish



188
189
190
 
# File 'lib/aruba/processes/spawn_process.rb', line 188

def wait
  @process.wait
end

#write(input) ⇒ Object 



158
159
160
161
162
163
164
165
 
# File 'lib/aruba/processes/spawn_process.rb', line 158

def write(input)
  return if stopped?

  @process.io.stdin.write(input)
  @process.io.stdin.flush

  self
end