Class: Themigrator::Script

Inherits:
Object
  • Object
show all
Defined in:
lib/themigrator/script.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(script, log_file, attr = {}, &finish_cbk) ⇒ Script

new creates a new script but doesn’t start until called run Arguments:

  • script : Fullpath of the file to execute

  • log_file: Fullpath of the file to save the log

  • attr: Extra attributes that could be handy (not used internally by Script)

  • finish_cbk: A block that will receive the following arguments

    1 The script itself



15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/themigrator/script.rb', line 15

def initialize(script, log_file, attr = {}, &finish_cbk)
  @attr = attr
  @script = script
  @log_file = log_file
  @log_fd = File.open(@log_file, 'w', 0o600)
  @wd_dir = File.dirname(script)
  @pid = nil
  @thread = nil
  @start_time = Time.now
  @end_time = nil
  @finish_cbk = finish_cbk
end

Instance Attribute Details

#attr ⇒ Object (readonly)

Returns the value of attribute attr.



5
6
7
 
# File 'lib/themigrator/script.rb', line 5

def attr
  @attr
end

#log_file ⇒ Object (readonly)

Returns the value of attribute log_file.



5
6
7
 
# File 'lib/themigrator/script.rb', line 5

def log_file
  @log_file
end

#script ⇒ Object (readonly)

Returns the value of attribute script.



5
6
7
 
# File 'lib/themigrator/script.rb', line 5

def script
  @script
end

Instance Method Details

#exitcode ⇒ Object 



66
67
68
 
# File 'lib/themigrator/script.rb', line 66

def exitcode
  @thread.value
end

#invoke_cbks ⇒ Object 



57
58
59
 
# File 'lib/themigrator/script.rb', line 57

def invoke_cbks
  @finish_cbk.call(self)
end

#run ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/themigrator/script.rb', line 32

def run
  @thread = Thread.new do
    @pid = Process.spawn(@script,
                         err: @log_fd,
                         out: @log_fd,
                         chdir: @wd_dir)
    pid, status = Process.wait2(@pid)
    @end_time = Time.now
    close
    return_code = if status.signaled?
                    signal = Signal.list.find do |_k, v|
                      v == status.termsig
                    end
                    signal.nil? ? :unknown_signal : signal[0].downcase.to_sym
                  else
                    status.exitstatus
    end

    Thread.new { invoke_cbks } if @finish_cbk

    return_code
  end
  sleep 0
end

#run_time ⇒ Object 



28
29
30
 
# File 'lib/themigrator/script.rb', line 28

def run_time
  @end_time - @start_time if @end_time
end

#stop ⇒ Object 



70
71
72
73
74
75
76
 
# File 'lib/themigrator/script.rb', line 70

def stop
  if running?
    send_int
    send_kill if wait(5).nil?
    wait
  end
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/themigrator/script.rb', line 78

def success?
  exitcode.zero?
end

#wait(seconds = nil) ⇒ Object

Waits for the process to be over



62
63
64
 
# File 'lib/themigrator/script.rb', line 62

def wait(seconds = nil)
  @thread.join(seconds)
end