Class: Beaker::Host
- Inherits:
-
Object
- Object
- Beaker::Host
- Defined in:
- lib/beaker/host.rb
Direct Known Subclasses
Defined Under Namespace
Classes: CommandFailure, PuppetConfigReader
Constant Summary collapse
- SELECT_TIMEOUT =
30
Instance Attribute Summary collapse
-
#defaults ⇒ Object
readonly
Returns the value of attribute defaults.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Class Method Summary collapse
Instance Method Summary collapse
- #+(other) ⇒ Object
- #[](k) ⇒ Object
- #[]=(k, v) ⇒ Object
- #close ⇒ Object
- #connection ⇒ Object
-
#determine_if_x86_64 ⇒ Boolean
Examine the host system to determine the architecture.
- #do_scp_from(source, target, options) ⇒ Object
-
#do_scp_to(source, target, options) ⇒ Object
scp files from the localhost to this test host, if a directory is provided it is recursively copied.
- #exec(command, options = {}) ⇒ Object
-
#get_ip ⇒ Object
Determine the ip address of this host.
-
#graceful_restarts? ⇒ Boolean
Mirrors the true/false value of the host’s ‘graceful-restarts’ property, or falls back to the value of
is_using_passenger?
if ‘graceful-restarts’ is nil, but only if this is not a PE run (foss only). - #has_key?(k) ⇒ Boolean
-
#hostname ⇒ Object
Return the public name of the particular host, which may be different then the name of the host provided in the configuration file as some provisioners create random, unique hostnames.
-
#initialize(name, options) ⇒ Host
constructor
A new instance of Host.
-
#ip ⇒ Object
Return the ip address of this host.
- #is_pe? ⇒ Boolean
-
#is_using_passenger? ⇒ Boolean
True if this is a PE run, or if the host’s ‘passenger’ property has been set.
-
#is_x86_64? ⇒ Boolean
True if x86_64, false otherwise.
- #log_prefix ⇒ Object
- #merge_defaults_for_type(options, type) ⇒ Object
-
#mkdir_p(dir) ⇒ Boolean
Create the provided directory structure on the host.
- #node_name ⇒ Object
- #pkg_initialize ⇒ Object
- #port_open?(port) ⇒ Boolean
-
#puppet(command = 'agent') ⇒ Object
Returning our PuppetConfigReader here allows users of the Host class to do things like ‘host.puppet` to query the ’main’ section or, if they want the configuration for a particular run type, ‘host.puppet(’agent’)‘.
-
#reachable_name ⇒ Object
Return the preferred method to reach the host, will use IP is available and then default to #hostname.
-
#to_s ⇒ Object
The #hostname of this host.
-
#to_str ⇒ Object
The #hostname of this host.
- #up? ⇒ Boolean
-
#use_service_scripts? ⇒ Boolean
True if this is a pe run, or if the host has had a ‘use-service’ property set.
-
#uses_passenger!(puppetservice = 'apache2') ⇒ Object
Modifies the host settings to indicate that it will be using passenger service scripts, (apache2) by default.
Constructor Details
#initialize(name, options) ⇒ Host
Returns a new instance of Host.
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/beaker/host.rb', line 41 def initialize name, @logger = [:logger] @name, @options = name.to_s, .dup # This is annoying and its because of drift/lack of enforcement/lack of having # a explict relationship between our defaults, our setup steps and how they're # related through 'type' and the differences between the assumption of our two # configurations we have for many of our products type = is_pe? ? :pe : :foss @defaults = merge_defaults_for_type @options, type pkg_initialize end |
Instance Attribute Details
#defaults ⇒ Object (readonly)
Returns the value of attribute defaults.
40 41 42 |
# File 'lib/beaker/host.rb', line 40 def defaults @defaults end |
#logger ⇒ Object
Returns the value of attribute logger.
39 40 41 |
# File 'lib/beaker/host.rb', line 39 def logger @logger end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
40 41 42 |
# File 'lib/beaker/host.rb', line 40 def name @name end |
Class Method Details
Instance Method Details
#+(other) ⇒ Object
132 133 134 |
# File 'lib/beaker/host.rb', line 132 def + other @name + other end |
#[](k) ⇒ Object
108 109 110 |
# File 'lib/beaker/host.rb', line 108 def [] k @defaults[k] end |
#[]=(k, v) ⇒ Object
104 105 106 |
# File 'lib/beaker/host.rb', line 104 def []= k, v @defaults[k] = v end |
#close ⇒ Object
213 214 215 216 |
# File 'lib/beaker/host.rb', line 213 def close @connection.close if @connection @connection = nil end |
#connection ⇒ Object
207 208 209 210 211 |
# File 'lib/beaker/host.rb', line 207 def connection @connection ||= SshConnection.connect( reachable_name, self['user'], self['ssh'], { :logger => @logger } ) end |
#determine_if_x86_64 ⇒ Boolean
Examine the host system to determine the architecture
197 198 199 200 |
# File 'lib/beaker/host.rb', line 197 def determine_if_x86_64 result = exec(Beaker::Command.new("arch | grep x86_64"), :acceptable_exit_codes => (0...127)) result.exit_code == 0 end |
#do_scp_from(source, target, options) ⇒ Object
336 337 338 339 340 341 342 |
# File 'lib/beaker/host.rb', line 336 def do_scp_from source, target, @logger.debug "localhost $ scp #{@name}:#{source} #{target}" result = connection.scp_from(source, target, , $dry_run) @logger.debug result.stdout return result end |
#do_scp_to(source, target, options) ⇒ Object
scp files from the localhost to this test host, if a directory is provided it is recursively copied
271 272 273 274 275 276 277 278 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 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/beaker/host.rb', line 271 def do_scp_to source, target, @logger.notify "localhost $ scp #{source} #{@name}:#{target} {:ignore => #{[:ignore]}}" result = Result.new(@name, [source, target]) has_ignore = [:ignore] and not [:ignore].empty? # construct the regex for matching ignored files/dirs ignore_re = nil if has_ignore ignore_arr = Array([:ignore]).map do |entry| "((\/|\\A)#{entry}(\/|\\z))".sub(/\./, "\.") end ignore_re = Regexp.new(ignore_arr.join('|')) end # either a single file, or a directory with no ignores if File.file?(source) or (File.directory?(source) and not has_ignore) source_file = source if has_ignore and (source =~ ignore_re) @logger.trace "After rejecting ignored files/dirs, there is no file to copy" source_file = nil result.stdout = "No files to copy" result.exit_code = 1 end if source_file result = connection.scp_to(source_file, target, , $dry_run) @logger.trace result.stdout end else # a directory with ignores dir_source = Dir.glob("#{source}/**/*").reject do |f| f =~ ignore_re end @logger.trace "After rejecting ignored files/dirs, going to scp [#{dir_source.join(", ")}]" # create necessary directory structure on host # run this quietly (no STDOUT) @logger.quiet(true) required_dirs = (dir_source.map{ | dir | File.dirname(dir) }).uniq require 'pathname' source_path = Pathname.new(source) required_dirs.each do |dir| dir_path = Pathname.new(dir) if dir_path.absolute? mkdir_p(File.join(target,dir_path.relative_path_from(source_path))) else mkdir_p( File.join(target, dir) ) end end @logger.quiet(false) # copy each file to the host dir_source.each do |s| s_path = Pathname.new(s) if s_path.absolute? file_path = File.join(target,s_path.relative_path_from(source_path)) else file_path = File.join(target, s) end result = connection.scp_to(s, file_path, , $dry_run) @logger.trace result.stdout end end return result end |
#exec(command, options = {}) ⇒ Object
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/beaker/host.rb', line 218 def exec command, ={} # I've always found this confusing cmdline = command.cmd_line(self) if [:silent] output_callback = nil else @logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{cmdline}" output_callback = logger.method(:host_output) end unless $dry_run # is this returning a result object? # the options should come at the end of the method signature (rubyism) # and they shouldn't be ssh specific result = nil seconds = Benchmark.realtime { result = connection.execute(cmdline, , output_callback) } if not [:silent] @logger.debug "\n#{log_prefix} executed in %0.2f seconds" % seconds end unless [:silent] # What? result.log(@logger) # No, TestCase has the knowledge about whether its failed, checking acceptable # exit codes at the host level and then raising... # is it necessary to break execution?? unless result.exit_code_in?(Array([:acceptable_exit_codes] || 0)) raise CommandFailure, "Host '#{self}' exited with #{result.exit_code} running:\n #{cmdline}\nLast #{@options[:trace_limit]} lines of output were:\n#{result.formatted_output(@options[:trace_limit])}" end end # Danger, so we have to return this result? result end end |
#get_ip ⇒ Object
Determine the ip address of this host
186 187 188 |
# File 'lib/beaker/host.rb', line 186 def get_ip @logger.warn("Uh oh, this should be handled by sub-classes but hasn't been") end |
#graceful_restarts? ⇒ Boolean
Mirrors the true/false value of the host’s ‘graceful-restarts’ property, or falls back to the value of is_using_passenger?
if ‘graceful-restarts’ is nil, but only if this is not a PE run (foss only).
148 149 150 151 152 153 154 155 156 |
# File 'lib/beaker/host.rb', line 148 def graceful_restarts? graceful = if !self['graceful-restarts'].nil? self['graceful-restarts'] else !is_pe? && is_using_passenger? end graceful end |
#has_key?(k) ⇒ Boolean
112 113 114 |
# File 'lib/beaker/host.rb', line 112 def has_key? k @defaults.has_key?(k) end |
#hostname ⇒ Object
Return the public name of the particular host, which may be different then the name of the host provided in the configuration file as some provisioners create random, unique hostnames.
128 129 130 |
# File 'lib/beaker/host.rb', line 128 def hostname @defaults['vmhostname'] || @name end |
#ip ⇒ Object
Return the ip address of this host
191 192 193 |
# File 'lib/beaker/host.rb', line 191 def ip self[:ip] ||= get_ip end |
#is_pe? ⇒ Boolean
136 137 138 |
# File 'lib/beaker/host.rb', line 136 def is_pe? @options.is_pe? end |
#is_using_passenger? ⇒ Boolean
True if this is a PE run, or if the host’s ‘passenger’ property has been set.
173 174 175 |
# File 'lib/beaker/host.rb', line 173 def is_using_passenger? is_pe? || self['passenger'] end |
#is_x86_64? ⇒ Boolean
Returns true if x86_64, false otherwise.
203 204 205 |
# File 'lib/beaker/host.rb', line 203 def is_x86_64? @x86_64 ||= determine_if_x86_64 end |
#log_prefix ⇒ Object
177 178 179 180 181 182 183 |
# File 'lib/beaker/host.rb', line 177 def log_prefix if @defaults['vmhostname'] "#{self} (#{@name})" else self.to_s end end |
#merge_defaults_for_type(options, type) ⇒ Object
59 60 61 62 |
# File 'lib/beaker/host.rb', line 59 def merge_defaults_for_type , type defaults = self.class.send "#{type}_defaults".to_sym defaults.merge(.merge((['HOSTS'][name]))) end |
#mkdir_p(dir) ⇒ Boolean
Create the provided directory structure on the host
261 262 263 264 |
# File 'lib/beaker/host.rb', line 261 def mkdir_p dir result = exec(Beaker::Command.new("mkdir -p #{dir}"), :acceptable_exit_codes => [0, 1]) result.exit_code == 0 end |
#node_name ⇒ Object
64 65 66 67 68 69 |
# File 'lib/beaker/host.rb', line 64 def node_name # TODO: might want to consider caching here; not doing it for now because # I haven't thought through all of the possible scenarios that could # cause the value to change after it had been cached. result = puppet['node_name_value'].strip end |
#pkg_initialize ⇒ Object
54 55 56 57 |
# File 'lib/beaker/host.rb', line 54 def pkg_initialize # This method should be overridden by platform-specific code to # handle whatever packaging-related initialization is necessary. end |
#port_open?(port) ⇒ Boolean
71 72 73 74 75 76 77 78 79 80 |
# File 'lib/beaker/host.rb', line 71 def port_open? port begin Timeout.timeout SELECT_TIMEOUT do TCPSocket.new(reachable_name, port).close return true end rescue Errno::ECONNREFUSED, Timeout::Error return false end end |
#puppet(command = 'agent') ⇒ Object
Returning our PuppetConfigReader here allows users of the Host class to do things like ‘host.puppet` to query the ’main’ section or, if they want the configuration for a particular run type, ‘host.puppet(’agent’)‘
100 101 102 |
# File 'lib/beaker/host.rb', line 100 def puppet(command='agent') PuppetConfigReader.new(self, command) end |
#reachable_name ⇒ Object
Return the preferred method to reach the host, will use IP is available and then default to #hostname.
92 93 94 |
# File 'lib/beaker/host.rb', line 92 def reachable_name self['ip'] || hostname end |
#to_s ⇒ Object
The #hostname of this host.
122 123 124 |
# File 'lib/beaker/host.rb', line 122 def to_s hostname end |
#to_str ⇒ Object
The #hostname of this host.
117 118 119 |
# File 'lib/beaker/host.rb', line 117 def to_str hostname end |
#up? ⇒ Boolean
82 83 84 85 86 87 88 89 |
# File 'lib/beaker/host.rb', line 82 def up? begin Socket.getaddrinfo( reachable_name, nil ) return true rescue SocketError return false end end |
#use_service_scripts? ⇒ Boolean
True if this is a pe run, or if the host has had a ‘use-service’ property set.
141 142 143 |
# File 'lib/beaker/host.rb', line 141 def use_service_scripts? is_pe? || self['use-service'] end |
#uses_passenger!(puppetservice = 'apache2') ⇒ Object
Modifies the host settings to indicate that it will be using passenger service scripts, (apache2) by default. Does nothing if this is a PE host, since it is already using passenger.
163 164 165 166 167 168 169 170 |
# File 'lib/beaker/host.rb', line 163 def uses_passenger!(puppetservice = 'apache2') if !is_pe? self['passenger'] = true self['puppetservice'] = puppetservice self['use-service'] = true end return true end |