Module: Unix::Exec
Instance Attribute Summary
Attributes included from Beaker::CommandFactory
Instance Method Summary collapse
-
#add_env_var(key, val) ⇒ Object
Add the provided key/val to the current ssh environment.
-
#append_commands(command = '', user_ac = '', opts = {}) ⇒ String
Gets the specific append commands as needed for this host.
-
#clear_env_var(key) ⇒ Object
Delete the environment variable from the current ssh environment.
-
#delete_env_var(key, val) ⇒ Object
Delete the provided key/val from the current ssh environment.
- #echo(msg, abs = true) ⇒ Object
- #enable_remote_rsyslog(server = 'rsyslog.ops.puppetlabs.net', port = 514) ⇒ Object
-
#environment_string(env) ⇒ String
Construct the environment string for this command.
- #environment_variable_string_pair_array(env) ⇒ Object
-
#get_env_var(key) ⇒ Object
Return the value of a specific env var.
- #get_ip ⇒ Object
-
#mirror_env_to_profile_d(env_file) ⇒ Object
Converts the provided environment file to a new shell script in /etc/profile.d, then sources that file.
-
#mkdir_p(dir) ⇒ Boolean
Create the provided directory structure on the host.
-
#modified_at(file, timestamp = nil) ⇒ Object
Update ModifiedDate on a file.
-
#mv(orig, dest, rm = true) ⇒ Object
Move the origin to destination.
- #path ⇒ Object
-
#ping(target, attempts = 5) ⇒ Boolean
Attempt to ping the provided target hostname.
-
#prepend_commands(command = '', user_pc = '', opts = {}) ⇒ String
Gets the specific prepend commands as needed for this host.
-
#reboot(wait_time = 10, max_connection_tries = 9, uptime_retries = 18) ⇒ Object
Reboots the host, comparing uptime values to verify success Will throw an exception RebootFailure if it fails.
-
#rm_rf(path) ⇒ Object
Recursively remove the path provided.
-
#selinux_enabled? ⇒ Boolean
Checks if selinux is enabled.
-
#ssh_permit_user_environment ⇒ Result
private
Sets the PermitUserEnvironment setting & restarts the SSH service.
-
#ssh_service_restart ⇒ Result
Restarts the SSH service.
-
#ssh_set_user_environment(env) ⇒ Object
private
Fills the user SSH environment file.
- #touch(file, abs = true) ⇒ Object
-
#which(command) ⇒ String
First path it finds for the command executable.
Methods included from Beaker::CommandFactory
Instance Method Details
#add_env_var(key, val) ⇒ Object
Add the provided key/val to the current ssh environment
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/beaker/host/unix/exec.rb', line 164 def add_env_var key, val key = key.to_s env_file = self[:ssh_env_file] escaped_val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;') #see if the key/value pair already exists if exec(Beaker::Command.new("grep ^#{key}=.*#{escaped_val} #{env_file}"), :accept_all_exit_codes => true ).exit_code == 0 return #nothing to do here, key value pair already exists #see if the key already exists elsif exec(Beaker::Command.new("grep ^#{key}= #{env_file}"), :accept_all_exit_codes => true ).exit_code == 0 exec(Beaker::SedCommand.new(self['platform'], "s/^#{key}=/#{key}=#{escaped_val}:/", env_file)) else exec(Beaker::Command.new("echo \"#{key}=#{val}\" >> #{env_file}")) end #update the profile.d to current state #match it to the contents of ssh_env_file mirror_env_to_profile_d(env_file) end |
#append_commands(command = '', user_ac = '', opts = {}) ⇒ String
Gets the specific append commands as needed for this host
344 345 346 |
# File 'lib/beaker/host/unix/exec.rb', line 344 def append_commands(command = '', user_ac = '', opts = {}) user_ac end |
#clear_env_var(key) ⇒ Object
Delete the environment variable from the current ssh environment
215 216 217 218 219 220 221 222 223 |
# File 'lib/beaker/host/unix/exec.rb', line 215 def clear_env_var key key = key.to_s env_file = self[:ssh_env_file] #remove entire line exec(Beaker::SedCommand.new(self['platform'], "/^#{key}=.*$/d", env_file)) #update the profile.d to current state #match it to the contents of ssh_env_file mirror_env_to_profile_d(env_file) end |
#delete_env_var(key, val) ⇒ Object
Delete the provided key/val from the current ssh environment
187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/beaker/host/unix/exec.rb', line 187 def delete_env_var key, val key = key.to_s env_file = self[:ssh_env_file] val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;') #if the key only has that single value remove the entire line exec(Beaker::SedCommand.new(self['platform'], "/#{key}=#{val}$/d", env_file)) #value in middle of list exec(Beaker::SedCommand.new(self['platform'], "s/#{key}=\\(.*\\)[;:]#{val}/#{key}=\\1/", env_file)) #value in start of list exec(Beaker::SedCommand.new(self['platform'], "s/#{key}=#{val}[;:]/#{key}=/", env_file)) #update the profile.d to current state #match it to the contents of ssh_env_file mirror_env_to_profile_d(env_file) end |
#echo(msg, abs = true) ⇒ Object
66 67 68 |
# File 'lib/beaker/host/unix/exec.rb', line 66 def echo(msg, abs=true) (abs ? '/bin/echo' : 'echo') + " #{msg}" end |
#enable_remote_rsyslog(server = 'rsyslog.ops.puppetlabs.net', port = 514) ⇒ Object
387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/beaker/host/unix/exec.rb', line 387 def enable_remote_rsyslog(server = 'rsyslog.ops.puppetlabs.net', port = 514) if self['platform'] !~ /ubuntu/ @logger.warn "Enabling rsyslog is only implemented for ubuntu hosts" return end commands = [ "echo '*.* @#{server}:#{port}' >> /etc/rsyslog.d/51-sendrsyslogs.conf", 'systemctl restart rsyslog' ] commands.each do |command| exec(Beaker::Command.new(command)) end true end |
#environment_string(env) ⇒ String
Construct the environment string for this command
297 298 299 300 301 302 |
# File 'lib/beaker/host/unix/exec.rb', line 297 def environment_string env return '' if env.empty? env_array = self.environment_variable_string_pair_array( env ) environment_string = env_array.join(' ') "env #{environment_string}" end |
#environment_variable_string_pair_array(env) ⇒ Object
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/beaker/host/unix/exec.rb', line 304 def environment_variable_string_pair_array env env_array = [] env.each_key do |key| val = env[key] if val.is_a?(Array) val = val.join(':') else val = val.to_s end # doing this for the key itself & the upcase'd version allows us to remain # backwards compatible # TODO: (Next Major Version) get rid of upcase'd version key_str = key.to_s keys = [key_str] keys << key_str.upcase if key_str.upcase != key_str keys.each do |env_key| env_array << "#{env_key}=\"#{val}\"" end end env_array end |
#get_env_var(key) ⇒ Object
Return the value of a specific env var
206 207 208 209 |
# File 'lib/beaker/host/unix/exec.rb', line 206 def get_env_var key key = key.to_s exec(Beaker::Command.new("env | grep ^#{key}="), :accept_all_exit_codes => true).stdout.chomp end |
#get_ip ⇒ Object
88 89 90 91 92 93 94 |
# File 'lib/beaker/host/unix/exec.rb', line 88 def get_ip if self['platform'].include?('solaris') || self['platform'].include?('osx') execute("ifconfig -a inet| awk '/broadcast/ {print $2}' | cut -d/ -f1 | head -1").strip else execute("ip a | awk '/global/{print$2}' | cut -d/ -f1 | #{self['hypervisor'] == 'vagrant' ? 'tail' : 'head'} -1").strip end end |
#mirror_env_to_profile_d(env_file) ⇒ Object
Converts the provided environment file to a new shell script in /etc/profile.d, then sources that file. This is for sles based hosts.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/beaker/host/unix/exec.rb', line 139 def mirror_env_to_profile_d env_file if self[:platform] =~ /sles-/ @logger.debug("mirroring environment to /etc/profile.d on sles platform host") cur_env = exec(Beaker::Command.new("cat #{env_file}")).stdout shell_env = '' cur_env.each_line do |env_line| shell_env << "export #{env_line}" end #here doc it over exec(Beaker::Command.new("cat << EOF > #{self[:profile_d_env_file]}\n#{shell_env}EOF")) #set permissions exec(Beaker::Command.new("chmod +x #{self[:profile_d_env_file]}")) #keep it current exec(Beaker::Command.new("source #{self[:profile_d_env_file]}")) else #noop @logger.debug("will not mirror environment to /etc/profile.d on non-sles platform host") end end |
#mkdir_p(dir) ⇒ Boolean
Create the provided directory structure on the host
99 100 101 102 103 |
# File 'lib/beaker/host/unix/exec.rb', line 99 def mkdir_p dir cmd = "mkdir -p #{dir}" result = exec(Beaker::Command.new(cmd), :acceptable_exit_codes => [0, 1]) result.exit_code == 0 end |
#modified_at(file, timestamp = nil) ⇒ Object
Update ModifiedDate on a file
77 78 79 80 81 82 |
# File 'lib/beaker/host/unix/exec.rb', line 77 def modified_at(file, = nil) require 'date' time = ? DateTime.parse("#{}") : DateTime.now = time.strftime('%Y%m%d%H%M') execute("/bin/touch -mt #{} #{file}") end |
#mv(orig, dest, rm = true) ⇒ Object
Move the origin to destination. The destination is removed prior to moving.
115 116 117 118 |
# File 'lib/beaker/host/unix/exec.rb', line 115 def mv orig, dest, rm=true rm_rf dest unless !rm execute("mv #{orig} #{dest}") end |
#path ⇒ Object
84 85 86 |
# File 'lib/beaker/host/unix/exec.rb', line 84 def path '/bin:/usr/bin' end |
#ping(target, attempts = 5) ⇒ Boolean
Attempt to ping the provided target hostname
124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/beaker/host/unix/exec.rb', line 124 def ping target, attempts=5 try = 0 while try < attempts do result = exec(Beaker::Command.new("ping -c 1 #{target}"), :accept_all_exit_codes => true) if result.exit_code == 0 return true end try+=1 end result.exit_code == 0 end |
#prepend_commands(command = '', user_pc = '', opts = {}) ⇒ String
Gets the specific prepend commands as needed for this host
333 334 335 |
# File 'lib/beaker/host/unix/exec.rb', line 333 def prepend_commands(command = '', user_pc = '', opts = {}) user_pc end |
#reboot(wait_time = 10, max_connection_tries = 9, uptime_retries = 18) ⇒ Object
Reboots the host, comparing uptime values to verify success Will throw an exception RebootFailure if it fails
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/beaker/host/unix/exec.rb', line 14 def reboot(wait_time=10, max_connection_tries=9, uptime_retries=18) require 'time' begin original_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout original_boot_time_line = original_boot_time_str.lines.grep(/boot/).first raise Beaker::Host::RebootFailure, "Could not find system boot time using 'who -b': #{original_boot_time_str}" unless original_boot_time_line original_boot_time = Time.parse(original_boot_time_line) exec(Beaker::Command.new('/bin/systemctl reboot -i || reboot || /sbin/shutdown -r now'), :expect_connection_failure => true) rescue Beaker::Host::CommandFailure => e raise Beaker::Host::RebootFailure, "Command failed when attempting to reboot: #{e.}" rescue RuntimeError => e raise Beaker::Host::RebootFailure, "Unexpected exception in reboot: #{e.}" rescue ArgumentError => e raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.}" end attempts = 0 begin # give the host a little time to shutdown @logger.debug("Waiting #{wait_time} for host to shut down.") sleep wait_time current_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout current_boot_time = Time.parse(current_boot_time_str.lines.grep(/boot/).first) @logger.debug("Original Boot Time: #{original_boot_time}") @logger.debug("Current Boot Time: #{current_boot_time}") unless current_boot_time > original_boot_time raise Beaker::Host::RebootFailure, "Boot time did not reset. Reboot appears to have failed." end rescue Beaker::Host::RebootFailure => e attempts += 1 if attempts < uptime_retries @logger.debug("Boot time did not reset. Will retry #{uptime_retries - attempts} more times.") retry else raise end rescue Beaker::Host::CommandFailure => e raise Beaker::Host::RebootFailure, "Command failed when attempting to reboot: #{e.}" rescue RuntimeError => e raise Beaker::Host::RebootFailure, "Unexpected exception in reboot: #{e.}" rescue ArgumentError => e raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.}" end end |
#rm_rf(path) ⇒ Object
Recursively remove the path provided
107 108 109 |
# File 'lib/beaker/host/unix/exec.rb', line 107 def rm_rf path execute("rm -rf #{path}") end |
#selinux_enabled? ⇒ Boolean
Checks if selinux is enabled
383 384 385 |
# File 'lib/beaker/host/unix/exec.rb', line 383 def selinux_enabled?() exec(Beaker::Command.new("sudo selinuxenabled"), :accept_all_exit_codes => true).exit_code == 0 end |
#ssh_permit_user_environment ⇒ Result
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Sets the PermitUserEnvironment setting & restarts the SSH service.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/beaker/host/unix/exec.rb', line 252 def ssh_permit_user_environment case self['platform'] when /debian|ubuntu|cumulus|huaweios|archlinux/ directory = tmpdir() exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit")) exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config")) exec(Beaker::Command.new("echo '' >/etc/environment")) if self['platform'] =~ /ubuntu-20.04/ when /el-7|centos-7|redhat-7|oracle-7|scientific-7|eos-7|el-8|centos-8|redhat-8|oracle-8/ directory = tmpdir() exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit")) exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config")) when /el-|centos|fedora|redhat|oracle|scientific|eos/ directory = tmpdir() exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit")) exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config")) when /sles/ directory = tmpdir() exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit")) exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config")) when /solaris/ # kept solaris here because refactoring it into its own Host module # conflicts with the solaris hypervisor that already exists directory = tmpdir() exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit")) exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config")) when /(free|open)bsd/ exec(Beaker::Command.new("sudo perl -pi -e 's/^#?PermitUserEnvironment no/PermitUserEnvironment yes/' /etc/ssh/sshd_config"), {:pty => true} ) else raise ArgumentError, "Unsupported Platform: '#{self['platform']}'" end ssh_service_restart() end |
#ssh_service_restart ⇒ Result
Restarts the SSH service.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/beaker/host/unix/exec.rb', line 228 def ssh_service_restart case self['platform'] when /debian|ubuntu|cumulus|huaweios/ exec(Beaker::Command.new("service ssh restart")) when /el-7|centos-7|redhat-7|oracle-7|scientific-7|eos-7|el-8|centos-8|redhat-8|oracle-8|fedora-(1[4-9]|2[0-9]|3[0-9])|archlinux-/ exec(Beaker::Command.new("systemctl restart sshd.service")) when /el-|centos|fedora|redhat|oracle|scientific|eos/ exec(Beaker::Command.new("/sbin/service sshd restart")) when /sles/ exec(Beaker::Command.new("/usr/sbin/rcsshd restart")) when /solaris/ exec(Beaker::Command.new("svcadm restart svc:/network/ssh:default")) when /(free|open)bsd/ exec(Beaker::Command.new("sudo /etc/rc.d/sshd restart")) else raise ArgumentError, "Unsupported Platform: '#{self['platform']}'" end end |
#ssh_set_user_environment(env) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Fills the user SSH environment file.
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/beaker/host/unix/exec.rb', line 356 def ssh_set_user_environment(env) #ensure that ~/.ssh/environment exists ssh_env_file_dir = Pathname.new(self[:ssh_env_file]).dirname mkdir_p(ssh_env_file_dir) exec(Beaker::Command.new("chmod 0600 #{ssh_env_file_dir}")) exec(Beaker::Command.new("touch #{self[:ssh_env_file]}")) #add the constructed env vars to this host add_env_var('PATH', '$PATH') # FIXME if self['platform'] =~ /openbsd-(\d)\.?(\d)-(.+)/ version = "#{$1}.#{$2}" arch = $3 arch = 'amd64' if ['x64', 'x86_64'].include?(arch) add_env_var('PKG_PATH', "http://ftp.openbsd.org/pub/OpenBSD/#{version}/packages/#{arch}/") elsif self['platform'] =~ /solaris-10/ add_env_var('PATH', '/opt/csw/bin') end #add the env var set to this test host env.each_pair do |var, value| add_env_var(var, value) end end |
#touch(file, abs = true) ⇒ Object
70 71 72 |
# File 'lib/beaker/host/unix/exec.rb', line 70 def touch(file, abs=true) (abs ? '/bin/touch' : 'touch') + " #{file}" end |
#which(command) ⇒ String
First path it finds for the command executable
409 410 411 412 413 414 415 416 |
# File 'lib/beaker/host/unix/exec.rb', line 409 def which(command) which_command = "which #{command}" result = execute(which_command, :accept_all_exit_codes => true) return '' if result.empty? result end |