Class: Raykit::Command

Inherits:
Object
  • Object
show all
Defined in:
lib/raykit/command.rb

Overview

Functionality to support executing and logging system commands

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(command, timeout = 0) ⇒ Command

Returns a new instance of Command.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/raykit/command.rb', line 33

def initialize(command,timeout=0)
    @@commands=Array.new
    init_defaults
    @command=command
    @timeout=timeout
    if(@command.length > 0)
        run
    end
    self
end

Instance Attribute Details

#command ⇒ Object

Returns the value of attribute command.



20
21
22
 
# File 'lib/raykit/command.rb', line 20

def command
  @command
end

#directory ⇒ Object

The working directory, defaults the current directory if not specified



15
16
17
 
# File 'lib/raykit/command.rb', line 15

def directory
  @directory
end

#elapsed ⇒ Object

The execution time in seconds



19
20
21
 
# File 'lib/raykit/command.rb', line 19

def elapsed
  @elapsed
end

#error ⇒ Object

Returns the value of attribute error.



20
21
22
 
# File 'lib/raykit/command.rb', line 20

def error
  @error
end

#exitstatus ⇒ Object

Returns the value of attribute exitstatus.



20
21
22
 
# File 'lib/raykit/command.rb', line 20

def exitstatus
  @exitstatus
end

#machine ⇒ Object

Returns the value of attribute machine.



21
22
23
 
# File 'lib/raykit/command.rb', line 21

def machine
  @machine
end

#output ⇒ Object

Returns the value of attribute output.



20
21
22
 
# File 'lib/raykit/command.rb', line 20

def output
  @output
end

#start_time ⇒ Object

The start time



17
18
19
 
# File 'lib/raykit/command.rb', line 17

def start_time
  @start_time
end

#timeout ⇒ Object

The timeout in seconds, defaults to 0 if not specified



13
14
15
 
# File 'lib/raykit/command.rb', line 13

def timeout
  @timeout
end

#user ⇒ Object

Returns the value of attribute user.



21
22
23
 
# File 'lib/raykit/command.rb', line 21

def user
  @user
end

Class Method Details

.parse(json) ⇒ Object 



139
140
141
142
143
 
# File 'lib/raykit/command.rb', line 139

def self.parse(json)
    cmd=Command.new('')
    cmd.from_hash(JSON.parse(json))
    cmd
end

Instance Method Details

#elapsed_str ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/raykit/command.rb', line 93

def elapsed_str()
    if(elapsed < 1.0)
        "%.0f" % (elapsed) + "s"
    else
        "%.0f" % (elapsed) + "s"
    end
end

#from_hash(hash) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/raykit/command.rb', line 126

def from_hash(hash)
    @command = hash["command"]
    @directory=hash["directory"]
    @timeout=hash["timeout"]
    @start_time=hash["start_time"]
    @elapsed=hash["elapsed"]
    @output=hash["output"]
    @error=hash["error"]
    @exitstatus=hash["exitstatus"]
    @user=hash["user"] if(hash.include?("user"))
    @machine=hash["machine"] if(hash.include?("machine"))
end

#init_defaults ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/raykit/command.rb', line 23

def init_defaults 
    @timeout=0
    @directory = Dir.pwd
    @output = ''
    @error = ''
    @exitstatus = 0
    @user = Environment.user
    @machine=Environment.machine
end

#run ⇒ Object 



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/raykit/command.rb', line 44

def run() 
    @start_time = Time.now
    timer = Timer.new
    if(@timeout == 0)
        @output,@error,process_status = Open3.capture3(@command) 
        @exitstatus=process_status.exitstatus
    else
        Open3.popen3(@command, :chdir=>@directory) { |stdin,stdout,stderr,thread|
            tick=2
            pid = thread.pid
            start = Time.now
            elapsed = Time.now-start
            while (elapsed) < @timeout and thread.alive?
                Kernel.select([stdout,stderr], nil, nil, tick)
                begin
                    @output << stdout.read_nonblock(BUFFER_SIZE)
                    @error << stderr.read_nonblock(BUFFER_SIZE)
                rescue IO::WaitReadable
                rescue EOFError
                    @exitstatus=thread.value.exitstatus
                    break
                end
                elapsed = Time.now-start
            end
            if thread.alive?
                if(Gem.win_platform?)
                    `taskkill /f /pid #{pid}`
                else
                    Process.kill("TERM", pid)
                end
                @exitstatus=5
            else
                @exitstatus=thread.value.exitstatus
            end
          }
    end
    @elapsed = timer.elapsed
    log_filename = Environment.get_dev_dir('log') + '/Raykit.Command/' + SecureRandom.uuid + '.json'
    log_dir = File.dirname(log_filename)
    FileUtils.mkdir_p(log_dir) if(!Dir.exists?(log_dir))
    File.open(log_filename, 'w') {|f| f.write(JSON.generate(to_hash)) }
    if(@exitstatus == 0)
        LOG.log('Raykit.Command',Logger::Severity::INFO,JSON.generate(to_hash))
    else
        LOG.log('Raykit.Command',Logger::Severity::ERROR,JSON.generate(to_hash))
    end
    @@commands.insert(-1,self)
end

#summary ⇒ Object 



101
102
103
104
105
106
107
108
 
# File 'lib/raykit/command.rb', line 101

def summary
    checkmark="\u2713"
    warning="\u26A0"
    error="\u0058"
    symbol=Rainbow(checkmark.encode('utf-8')).green
    symbol=Rainbow(error.encode('utf-8')).red if(@exitstatus!=0)
    puts symbol + "  " + elapsed_str.rjust(4) + " " + Rainbow(@command).yellow + " (#{@directory})"
end

#to_hash ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/raykit/command.rb', line 110

def to_hash()
    hash = Hash.new
    hash[:command] = @command
    hash[:directory] = @directory
    hash[:timeout] = @timeout
    hash[:start_time] = @start_time
    hash[:elapsed] = @elapsed
    hash[:output] = @output
    hash[:error] = @error
    hash[:exitstatus] = @exitstatus
    hash[:user] = @user
    hash[:machine] = @machine
    hash[:context] = "Raykit.Command"
    hash
end