Class: Command

Inherits:
Hash
  • Object
show all
Defined in:
lib/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.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/command.rb', line 29

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

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

       if(command.kind_of?(Hash))
       	command.each{|k,v|
       		self[k.to_sym]=v
       	}
       end
end

Class Method Details

.dev_root ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/command.rb', line 161

def self.dev_root
  ["DEV_HOME","DEV_ROOT"].each {|v|
    return ENV[v].gsub('\\','/') unless ENV[v].nil?
  }
  dir=home
  #dir=ENV["DEV_ROOT"].gsub('\\','/') unless ENV["DEV_ROOT"].nil?
 return dir
end

.exit_code(command) ⇒ Object 



170
171
172
173
174
175
176
 
# File 'lib/command.rb', line 170

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

.home ⇒ Object 



151
152
153
154
155
156
157
158
159
 
# File 'lib/command.rb', line 151

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

.machine ⇒ Object 



137
138
139
140
141
142
143
144
145
 
# File 'lib/command.rb', line 137

def self.machine
  if !ENV['COMPUTERNAME'].nil? 
return ENV['COMPUTERNAME']
	  end

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

.output(command) ⇒ Object 



178
179
180
181
182
183
184
 
# File 'lib/command.rb', line 178

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

.user ⇒ Object 



147
148
149
 
# File 'lib/command.rb', line 147

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

Instance Method Details

#execute(value = nil) ⇒ Object 



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
92
93
94
95
96
97
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
 
# File 'lib/command.rb', line 57

def execute value=nil

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

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

   if(self[:timeout] > 0)
     puts "#{self[:input]} (#{self[:directory]}) timeout #{self[:timeout].to_s}" if(!quiet?)
   else
	  puts "#{self[:input]} (#{self[:directory]})" if(!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 
 		  	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.rb'
           #puts run_with_timeout(self[:input], self[:timeout], 1).to_s
           #self[:output] = run_with_timeout(self[:input], self[:timeout], 1)
           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.to_s
 			  self[:exit_code]=1
 		  end
 		end
   end
      

   if(self[:exit_code] != 0)
     if(!quiet?)
   	  puts "exit_code=#{self[:exit_code]}"
   	  puts self[:output]
   	  puts self[:error]
     end
   	if(!self.has_key?(:ignore_failure) || !self[:ignore_failure])
   		raise "#{self[:input]} failed" 
   	end #unless (self.has_key?(:ignore_failure) && self[:ignore_failure]==true)
   end
     
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/command.rb', line 53

def quiet?
  (self.has_key?(:quiet) && self[:quiet])
end

#summary ⇒ Object 



186
187
188
 
# File 'lib/command.rb', line 186

def summary
  "#{self[:exit_code].to_s} #{self[:input]} (#{self[:directory]})"
end

#to_html ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/command.rb', line 190

def to_html
  if self[:exit_code] == 0
  [
  	'<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 { |k, v| ["<tr><td><strong>#{k}</strong></td>", v.respond_to?(:to_html) ? v.to_html : "<td><span><pre>#{v}</pre></span></td></tr>"] },
    '</table>',
    '</td></tr></table></td></tr></table></div>'
  ].join
  end
end