Class: Command

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

Overview

Command

execution of system commands

Keys

  • :input The input of the commands.

  • :timeout The timeout in seconds.

    a value of zero is to infinite timeout.
defaults to zero

  • :directory The working directory for the command.

    defaults to the current directory

  • :exit_code The exit code of the command

  • :output The output contains the stdout output of the command

  • :error The error contains stderr output of the command

  • :machine The name of the machine the command executed on

  • :user The user name

  • :start_time

  • :end_time

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(command) ⇒ Command

Returns a new instance of Command.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/base/command.rb', line 38

def initialize(command)
  self[:input] = ""
  self[:timeout] = 0
  self[:directory] = ""
  self[:exit_code] = 0
  self[:output] = ""
  self[:error] = ""
  self[:machine] = ""
  self[:user] = ""
  self[:start_time] = nil
  self[:end_time] = nil

  self[:input] = command if command.is_a?(String)

  if command.is_a?(Hash)
    command.each { |k, v| self[k.to_sym] = v }
    self[:start_time] = Time.parse(self[:start_time]) if key?(:start_time) && !self[:start_time].nil?
    self[:end_time] = Time.parse(self[:end_time]) if key?(:end_time) && !self[:end_time].nil?
  end
end

Class Method Details

.dev_root ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/base/command.rb', line 195

def self.dev_root
  %w[DEV_HOME DEV_ROOT].each do |v|
    return ENV[v].gsub('\\', "/") unless ENV[v].nil?
  end
  home
end

.error(command) ⇒ Object 



228
229
230
231
232
233
234
 
# File 'lib/base/command.rb', line 228

def self.error(command)
  cmd = Command.new(command)
  cmd[:ignore_failure] = true
  cmd[:quiet] = true
  cmd.execute
  cmd[:error]
end

.execute(command, working_directory = "") ⇒ Object 



202
203
204
205
206
207
208
209
210
 
# File 'lib/base/command.rb', line 202

def self.execute(command, working_directory = "")
  cmd = Command.new({ input: command, quiet: true }) if command.is_a?(String)
  cmd[:directory] = working_directory if command.is_a?(String)
  cmd = command if command.is_a?(Command)
  cmd = Command.new(command) if command.is_a?(Hash)
  cmd.execute
  cmd[:exit_code]
  cmd
end

.executes?(command) ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
95
 
# File 'lib/base/command.rb', line 87

def self.executes?(command)
  cmd = Command.new({ input: command, quiet: true, ignore_failure: true })
  cmd.execute
  if (cmd[:exit_code]).zero?
    true
  else
    false
  end
end

.exit_code(command) ⇒ Object 



212
213
214
215
216
217
218
 
# File 'lib/base/command.rb', line 212

def self.exit_code(command)
  cmd = Command.new(command)
  cmd[:ignore_failure] = true
  cmd[:quiet] = true
  cmd.execute
  cmd[:exit_code]
end

.home ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/base/command.rb', line 185

def self.home
  %w[USERPROFILE HOME].each do |v|
    return ENV[v].gsub('\\', "/") unless ENV[v].nil?
  end
  dir = "~"
  dir = ENV["HOME"] unless ENV["HOME"].nil?
  dir = ENV["USERPROFILE"].gsub('\\', "/") unless ENV["USERPROFILE"].nil?
  dir
end

.machine ⇒ Object 



173
174
175
176
177
178
179
 
# File 'lib/base/command.rb', line 173

def self.machine
  return ENV["COMPUTERNAME"] unless ENV["COMPUTERNAME"].nil?

  machine = `hostname`
  machine = machine.split(".")[0] if machine.include?(".")
  machine.strip
end

.output(command) ⇒ Object 



220
221
222
223
224
225
226
 
# File 'lib/base/command.rb', line 220

def self.output(command)
  cmd = Command.new(command)
  cmd[:ignore_failure] = true
  cmd[:quiet] = true
  cmd.execute
  cmd[:output]
end

.user ⇒ Object 



181
182
183
 
# File 'lib/base/command.rb', line 181

def self.user
  ENV["USER"].nil? ? ENV["USERNAME"] : ENV["USER"]
end

Instance Method Details

#error ⇒ Object 



83
84
85
 
# File 'lib/base/command.rb', line 83

def error
  self[:error]
end

#execute(value = nil) ⇒ Object

TODO: add log of execution



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/base/command.rb', line 98

def execute(value = nil)
  puts (self[:input]).to_s if defined?(DEBUG)

  value.each { |k, v| self[k] = v } if !value.nil? && value.is_a?(Hash)

  pwd = Dir.pwd
  self[:directory] = pwd if !key?(:directory) || self[:directory].length.zero?

  if (self[:timeout]).positive?
    puts "#{self[:input]} (#{self[:directory]}) timeout #{self[:timeout]}" unless quiet?
  else
    puts "#{self[:input]} (#{self[:directory]})" unless quiet?
  end

  self[:machine] = Command.machine
  self[:user] = Command.user

  self[:start_time] = Time.now
  timer = Timer.new

  Dir.chdir(self[:directory]) do
    if self[:input].include?("<%") && self[:input].include?("%>")
      ruby = self[:input].gsub("<%", "").gsub("%>", "")

      begin
        self[:output] = eval(ruby)
      rescue StandardError
        self[:exit_code] = 1
        self[:error] = "unable to eval(#{ruby})"
      end

      self[:elapsed] = timer.elapsed_str
      self[:end_time] = Time.now
    else
      begin
        if self[:timeout] <= 0
          self[:output], self[:error], status = Open3.capture3(self[:input])
          self[:exit_code] = status.to_i
          self[:elapsed] = timer.elapsed_str
          self[:end_time] = Time.now
        else
          require_relative "timeout"
          result = run_with_timeout(self[:directory], self[:input], self[:timeout], 2)
          self[:output] = result[0]
          self[:exit_code] = result[1]
          self[:elapsed] = timer.elapsed_str
          self[:end_time] = Time.now

          if timer.elapsed >= self[:timeout]
            self[:exit_code] = 1
            self[:error] = "#{self[:error]}timed out"
          end
        end
      rescue Exception => e
        self[:elapsed] = timer.elapsed_str
        self[:end_time] = Time.now
        self[:error] = "Exception: #{e}"
        self[:exit_code] = 1
      end
    end
  end

  if self[:exit_code] != 0
    unless quiet?
      puts "exit_code=#{self[:exit_code]}"
      puts self[:output]
      puts self[:error]
    end
    if !key?(:ignore_failure) || !self[:ignore_failure]
      raise "#{self[:input]} failed\n#{self[:output]}\n#{self[:error]}"
    end
  end
  self
end

#exit_code ⇒ Object 



75
76
77
 
# File 'lib/base/command.rb', line 75

def exit_code
  self[:exit_code]
end

#format_property(name, value) ⇒ Object 



270
271
272
273
274
275
276
277
 
# File 'lib/base/command.rb', line 270

def format_property(name, value)
  if Environment.default.colorize?
    require "ansi/code"
    "#{name}: " + ANSI.yellow + ANSI.bright + value.to_s.strip + ANSI.reset
  else
    "#{name}: #{value}"
  end
end

#getFormattedTimeSpan(timespan) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/base/command.rb', line 236

def getFormattedTimeSpan(timespan)
  result = ""
  seconds = timespan.round
  if seconds > 99
    minutes = (seconds / 60).round
    result = "#{minutes}m"
  else
    result = "#{seconds}s" # 99s
  end
  result.fix(3)
end

#info ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/base/command.rb', line 279

def info
  result = "#{format_property("input".fix(15), self[:input])}\n"
  result = "#{result}#{format_property("directory".fix(15), self[:directory])}\n"
  result = "#{result}#{format_property("exit_code".fix(15), self[:exit_code])}\n"
  result = result + format_property("duration".fix(15),
                                    getFormattedTimeSpan(self[:end_time] - self[:start_time])) + "\n"
  output = [""]
  output = self[:output].strip.split("\n") unless self[:output].nil?
  if output.length <= 1
    result = "#{result}#{format_property("output".fix(15), output[0])}\n"
    # result=result + format_property('output'.fix(15),'') + "\n" if(output.length==0)
    # result=result + format_property('output'.fix(15),output) + "\n" if(output.length==1)
  else
    result = "#{result}#{format_property("output".fix(15), "")}\n"
    output.each do |line|
      result = "#{result}#{" ".fix(16)}#{line}\n"
    end
  end
  error = [""]
  error = self[:error].strip.split("\n") unless self[:error].nil?
  if error.length <= 1
    result = "#{result}#{format_property("error".fix(15), error[0])}\n"
    # result=result + format_property('error'.fix(15),'') + "\n" if(error.length==0)
    # result=result + format_property('error'.fix(15),error) + "\n" if(error.length==1)
  else
    result = "#{result}#{format_property("error".fix(15), "")}\n"
    error.each do |line|
      result = "#{result}#{" ".fix(16)}#{line}\n"
    end
  end
end

#open(filename = "") ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/base/command.rb', line 63

def open(filename = "")
  @filename = filename if filename.length.positive?
  clear
  JSON.parse(IO.read(@filename)).each { |k, v| self[k.to_sym] = v }
  self[:start_time] = Time.parse(self[:start_time]) if key?(:start_time)
  self[:end_time] = Time.parse(self[:end_time]) if key?(:end_time)
end

#output ⇒ Object 



79
80
81
 
# File 'lib/base/command.rb', line 79

def output
  self[:output]
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/base/command.rb', line 71

def quiet?
  (key?(:quiet) && self[:quiet])
end

#save(filename) ⇒ Object 



59
60
61
 
# File 'lib/base/command.rb', line 59

def save(filename)
  File.open(filename, "w") { |f| f.write(to_json) }
end

#summary(include_directory = false) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/base/command.rb', line 248

def summary(include_directory = false)
  duration = ""
  duration = getFormattedTimeSpan(self[:end_time] - self[:start_time])
  if Environment.default.colorize?
    require "ansi/code"
    cduration = ANSI.reset + duration
    # code=ANSI.green + '+ ' + ANSI.reset
    # code=ANSI.red   + '- ' + ANSI.reset if exit_code != 0
    cinput = ANSI.reset + self[:input] + ANSI.reset
    cinput = ANSI.red + self[:input] + ANSI.reset if exit_code != 0
    cdirectory = ""
    cdirectory = "(#{self[:directory]})" if include_directory
    "  #{cduration} #{cinput} #{cdirectory}"
  else
    code = " "
    code = "X" if exit_code != 0
    sdirectory = ""
    sdirectory = "(#{self[:directory]})" if include_directory
    "#{code} #{duration} #{self[:input]} #{sdirectory}"
  end
end

#to_html ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/base/command.rb', line 311

def to_html
  if (self[:exit_code]).zero?
    [
      '<div><table><tr><td width="20"></td><td><pre>',
      self[:input],
      "</pre></td></tr></table></div>",
    ].join
  else
    [
      '<div><table><tr><td width="20"></td><td><pre>',
      self[:input],
      '</pre><table><tr><td width="20"></td><td><table>',
      map do |k, v|
        ["<tr><td><strong>#{k}</strong></td>",
         v.respond_to?(:to_html) ? v.to_html : "<td><span><pre>#{v}</pre></span></td></tr>"]
      end,
      "</table>",
      "</td></tr></table></td></tr></table></div>",
    ].join
  end
end