Class: SSHKit::Command
- Inherits:
-
Object
- Object
- SSHKit::Command
- Defined in:
- lib/sshkit/command.rb
Overview
Constant Summary collapse
- Failed =
Class.new(SSHKit::StandardError)
Instance Attribute Summary collapse
-
#args ⇒ Object
readonly
Returns the value of attribute args.
-
#command ⇒ Object
readonly
Returns the value of attribute command.
-
#exit_status ⇒ Object
Returns the value of attribute exit_status.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#started ⇒ Object
Returns the value of attribute started.
-
#started_at ⇒ Object
readonly
Returns the value of attribute started_at.
-
#stderr ⇒ Object
Returns the value of attribute stderr.
-
#stdout ⇒ Object
Returns the value of attribute stdout.
Instance Method Summary collapse
- #complete? ⇒ Boolean (also: #finished?)
- #failure? ⇒ Boolean (also: #failed?)
- #host ⇒ Object
-
#initialize(*args) ⇒ Command
constructor
Initialize a new Command object.
- #runtime ⇒ Object
- #started? ⇒ Boolean
- #success? ⇒ Boolean (also: #successful?)
- #to_hash ⇒ Object
- #to_s ⇒ Object
- #uuid ⇒ Object
Constructor Details
#initialize(*args) ⇒ Command
Initialize a new Command object
command name, with optional variadaric args nothing in stdin or stdout
47 48 49 50 51 52 53 54 55 |
# File 'lib/sshkit/command.rb', line 47 def initialize(*args) raise ArgumentError, "May not pass no arguments to Command.new" if args.empty? @options = .merge(args.) @command = args.shift.to_s.strip.to_sym @args = args @options.symbolize_keys! sanitize_command! @stdout, @stderr = String.new, String.new end |
Instance Attribute Details
#args ⇒ Object (readonly)
Returns the value of attribute args.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def args @args end |
#command ⇒ Object (readonly)
Returns the value of attribute command.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def command @command end |
#exit_status ⇒ Object
Returns the value of attribute exit_status.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def exit_status @exit_status end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def @options end |
#started ⇒ Object
Returns the value of attribute started.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def started @started end |
#started_at ⇒ Object (readonly)
Returns the value of attribute started_at.
36 37 38 |
# File 'lib/sshkit/command.rb', line 36 def started_at @started_at end |
#stderr ⇒ Object
Returns the value of attribute stderr.
38 39 40 |
# File 'lib/sshkit/command.rb', line 38 def stderr @stderr end |
#stdout ⇒ Object
Returns the value of attribute stdout.
38 39 40 |
# File 'lib/sshkit/command.rb', line 38 def stdout @stdout end |
Instance Method Details
#complete? ⇒ Boolean Also known as: finished?
57 58 59 |
# File 'lib/sshkit/command.rb', line 57 def complete? !exit_status.nil? end |
#failure? ⇒ Boolean Also known as: failed?
80 81 82 |
# File 'lib/sshkit/command.rb', line 80 def failure? exit_status.to_i > 0 end |
#host ⇒ Object
120 121 122 |
# File 'lib/sshkit/command.rb', line 120 def host [:host] end |
#runtime ⇒ Object
96 97 98 99 |
# File 'lib/sshkit/command.rb', line 96 def runtime return nil unless complete? @finished_at - @started_at end |
#started? ⇒ Boolean
62 63 64 |
# File 'lib/sshkit/command.rb', line 62 def started? started end |
#success? ⇒ Boolean Also known as: successful?
75 76 77 |
# File 'lib/sshkit/command.rb', line 75 def success? exit_status.nil? ? false : exit_status.to_i == 0 end |
#to_hash ⇒ Object
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/sshkit/command.rb', line 101 def to_hash { command: self.to_s, args: args, options: , exit_status: exit_status, stdout: stdout, stderr: stderr, started_at: @started_at, finished_at: @finished_at, runtime: runtime, uuid: uuid, started: started?, finished: finished?, successful: successful?, failed: failed? } end |
#to_s ⇒ Object
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 |
# File 'lib/sshkit/command.rb', line 124 def to_s return command.to_s if command.match /\s/ String.new.tap do |cs| if [:in] cs << sprintf("cd %s && ", [:in]) end unless SSHKit.config.default_env.empty? if [:env].is_a? Hash [:env] = SSHKit.config.default_env.merge([:env]) end end if [:env] cs << '( ' [:env].each do |k,v| cs << k.to_s.upcase cs << "=" cs << v.to_s cs << ' ' end end if [:user] cs << "sudo su #{[:user]} -c " end if [:run_in_background] cs << 'nohup ' end cs << SSHKit.config.command_map[command.to_sym] if args.any? cs << ' ' cs << args.join(' ') end if [:run_in_background] cs << ' > /dev/null &' end if [:env] cs << ' )' end end end |
#uuid ⇒ Object
71 72 73 |
# File 'lib/sshkit/command.rb', line 71 def uuid @uuid ||= Digest::SHA1.hexdigest(SecureRandom.random_bytes(10))[0..7] end |