Class: Aruba::Processes::BasicProcess

Inherits:
Object
  • Object
show all
Defined in:
lib/aruba/processes/basic_process.rb

Overview

Basic Process

BasicProcess is not meant for direct use - BasicProcess.new - by users.

Direct Known Subclasses

DebugProcess, InProcess, SpawnProcess

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0) ⇒ BasicProcess

Returns a new instance of BasicProcess.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/aruba/processes/basic_process.rb', line 16

def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
  @cmd               = cmd
  @working_directory = working_directory
  @environment       = environment
  @main_class        = main_class
  @exit_status       = nil
  @stop_signal       = stop_signal
  @startup_wait_time = startup_wait_time

  @exit_timeout    = exit_timeout
  @io_wait_timeout = io_wait_timeout

  @started         = false
  @timed_out       = false
end

Instance Attribute Details

#environment ⇒ Object (readonly)

Returns the value of attribute environment.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def environment
  @environment
end

#exit_status ⇒ Object (readonly)

Returns the value of attribute exit_status.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def exit_status
  @exit_status
end

#exit_timeout ⇒ Object (readonly)

Returns the value of attribute exit_timeout.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def exit_timeout
  @exit_timeout
end

#io_wait_timeout ⇒ Object (readonly)

Returns the value of attribute io_wait_timeout.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def io_wait_timeout
  @io_wait_timeout
end

#main_class ⇒ Object (readonly)

Returns the value of attribute main_class.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def main_class
  @main_class
end

#startup_wait_time ⇒ Object (readonly)

Returns the value of attribute startup_wait_time.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def startup_wait_time
  @startup_wait_time
end

#working_directory ⇒ Object (readonly)

Returns the value of attribute working_directory.



14
15
16
 
# File 'lib/aruba/processes/basic_process.rb', line 14

def working_directory
  @working_directory
end

Instance Method Details

#after_run ⇒ Object

Hook which is run after command is run



116
 
# File 'lib/aruba/processes/basic_process.rb', line 116

def after_run; end

#before_run ⇒ Object

Hook which is run before command is run



113
 
# File 'lib/aruba/processes/basic_process.rb', line 113

def before_run; end

#close_io ⇒ Object

Raises:

  • (NotImplementedError) 


63
64
65
 
# File 'lib/aruba/processes/basic_process.rb', line 63

def close_io(*)
  raise NotImplementedError
end

#commandline ⇒ Object

Return command line



33
34
35
 
# File 'lib/aruba/processes/basic_process.rb', line 33

def commandline
  @cmd
end

#content ⇒ Object

Raises:

  • (NotImplementedError) 


75
76
77
 
# File 'lib/aruba/processes/basic_process.rb', line 75

def content
  raise NotImplementedError
end

#filesystem_status ⇒ Object

Raises:

  • (NotImplementedError) 


71
72
73
 
# File 'lib/aruba/processes/basic_process.rb', line 71

def filesystem_status
  raise NotImplementedError
end

#inspect ⇒ Object Also known as: to_s 



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/aruba/processes/basic_process.rb', line 118

def inspect
  out = stdout(:wait_for_io => 0) + stderr(:wait_for_io => 0)

  out = if out.length > 76
          out[0, 75] + ' ...'
        else
          out
        end

  format '#<%s:%s commandline="%s": output="%s">', self.class, self.object_id, commandline, out
end

#output(opts = {}) ⇒ Object

Output stderr and stdout



43
44
45
 
# File 'lib/aruba/processes/basic_process.rb', line 43

def output(opts = {})
  stdout(opts) + stderr(opts)
end

#pid ⇒ Object

Output pid of process

Raises:

  • (NotImplementedError) 


38
39
40
 
# File 'lib/aruba/processes/basic_process.rb', line 38

def pid
  raise NotImplementedError
end

#restart ⇒ Object

Restart a command



84
85
86
87
 
# File 'lib/aruba/processes/basic_process.rb', line 84

def restart
  stop
  start
end

#run! ⇒ Object

Deprecated. 


106
107
108
109
110
 
# File 'lib/aruba/processes/basic_process.rb', line 106

def run!
  Aruba.platform.deprecated('The use of "command#run!" is deprecated. You can simply use "command#start" instead.')

  start
end

#send_signal ⇒ Object

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/aruba/processes/basic_process.rb', line 67

def send_signal(*)
  raise NotImplementedError
end

#started? ⇒ Boolean

Was process already started

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/aruba/processes/basic_process.rb', line 95

def started?
  @started == true
end

#stderr ⇒ Object

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/aruba/processes/basic_process.rb', line 59

def stderr(*)
  raise NotImplementedError
end

#stdin ⇒ Object

Raises:

  • (NotImplementedError) 


51
52
53
 
# File 'lib/aruba/processes/basic_process.rb', line 51

def stdin(*)
  raise NotImplementedError
end

#stdout ⇒ Object

Raises:

  • (NotImplementedError) 


55
56
57
 
# File 'lib/aruba/processes/basic_process.rb', line 55

def stdout(*)
  raise NotImplementedError
end

#stopped? ⇒ Boolean

Was process already stopped

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/aruba/processes/basic_process.rb', line 90

def stopped?
  @started == false
end

#timed_out? ⇒ Boolean

Does the process failed to stop in time

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/aruba/processes/basic_process.rb', line 100

def timed_out?
  @timed_out == true
end

#wait ⇒ Object

Raises:

  • (NotImplementedError) 


79
80
81
 
# File 'lib/aruba/processes/basic_process.rb', line 79

def wait
  raise NotImplementedError
end

#write ⇒ Object

Raises:

  • (NotImplementedError) 


47
48
49
 
# File 'lib/aruba/processes/basic_process.rb', line 47

def write(*)
  raise NotImplementedError
end