Class: Beaker::Host
- Inherits:
-
Object
show all
- Defined in:
- lib/beaker/host.rb
Defined Under Namespace
Classes: CommandFailure, PuppetConfigReader
Constant Summary
collapse
- SELECT_TIMEOUT =
30
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
-
#+(other) ⇒ Object
-
#[](k) ⇒ Object
-
#[]=(k, v) ⇒ Object
-
#close ⇒ Object
-
#connection ⇒ Object
-
#do_scp_from(source, target, options) ⇒ Object
-
#do_scp_to(source, target, options) ⇒ Object
-
#exec(command, options = {}) ⇒ Object
-
#get_ip ⇒ Object
Determine the ip address of this host.
-
#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
-
#ip ⇒ Object
Return the ip address of this host.
-
#is_pe? ⇒ Boolean
-
#log_prefix ⇒ Object
-
#merge_defaults_for_type(options, type) ⇒ Object
-
#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
-
#to_str ⇒ Object
-
#up? ⇒ Boolean
Constructor Details
#initialize(name, options) ⇒ Host
Returns a new instance of Host.
45
46
47
48
49
50
51
52
53
54
55
56
|
# File 'lib/beaker/host.rb', line 45
def initialize name, options
@logger = options[:logger]
@name, @options = name.to_s, options.dup
type = is_pe? ? :pe : :foss
@defaults = merge_defaults_for_type @options, type
pkg_initialize
end
|
Instance Attribute Details
#defaults ⇒ Object
Returns the value of attribute defaults.
44
45
46
|
# File 'lib/beaker/host.rb', line 44
def defaults
@defaults
end
|
#logger ⇒ Object
Returns the value of attribute logger.
43
44
45
|
# File 'lib/beaker/host.rb', line 43
def logger
@logger
end
|
#name ⇒ Object
Returns the value of attribute name.
44
45
46
|
# File 'lib/beaker/host.rb', line 44
def name
@name
end
|
Class Method Details
.create(name, options) ⇒ Object
32
33
34
35
36
37
38
39
40
41
|
# File 'lib/beaker/host.rb', line 32
def self.create name, options
case options['HOSTS'][name]['platform']
when /windows/
Windows::Host.new name, options
when /aix/
Aix::Host.new name, options
else
Unix::Host.new name, options
end
end
|
Instance Method Details
#+(other) ⇒ Object
136
137
138
|
# File 'lib/beaker/host.rb', line 136
def + other
@name + other
end
|
#[](k) ⇒ Object
112
113
114
|
# File 'lib/beaker/host.rb', line 112
def [] k
@defaults[k]
end
|
#[]=(k, v) ⇒ Object
108
109
110
|
# File 'lib/beaker/host.rb', line 108
def []= k, v
@defaults[k] = v
end
|
#close ⇒ Object
168
169
170
171
|
# File 'lib/beaker/host.rb', line 168
def close
@connection.close if @connection
@connection = nil
end
|
#connection ⇒ Object
162
163
164
165
166
|
# File 'lib/beaker/host.rb', line 162
def connection
@connection ||= SshConnection.connect( reachable_name,
self['user'],
self['ssh'] )
end
|
#do_scp_from(source, target, options) ⇒ Object
216
217
218
219
220
221
|
# File 'lib/beaker/host.rb', line 216
def do_scp_from source, target, options
@logger.debug "localhost $ scp #{@name}:#{source} #{target} #{options.to_s}"
result = connection.scp_from(source, target, options, $dry_run)
return result
end
|
#do_scp_to(source, target, options) ⇒ Object
210
211
212
213
214
|
# File 'lib/beaker/host.rb', line 210
def do_scp_to source, target, options
@logger.debug "localhost $ scp #{source} #{@name}:#{target} #{options.to_s}"
result = connection.scp_to(source, target, options, $dry_run)
return result
end
|
#exec(command, options = {}) ⇒ Object
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
# File 'lib/beaker/host.rb', line 173
def exec command, options={}
cmdline = command.cmd_line(self)
if options[: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
result = nil
seconds = Benchmark.realtime {
result = connection.execute(cmdline, options, output_callback)
}
@logger.debug "\n#{log_prefix} executed in %0.2f seconds" % seconds
unless options[:silent]
result.log(@logger)
unless result.exit_code_in?(Array(options[: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
result
end
end
|
#get_ip ⇒ Object
Determine the ip address of this host
153
154
155
|
# File 'lib/beaker/host.rb', line 153
def get_ip
@logger.warn("Uh oh, this should be handled by sub-classes but hasn't been")
end
|
#has_key?(k) ⇒ Boolean
116
117
118
|
# File 'lib/beaker/host.rb', line 116
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.
132
133
134
|
# File 'lib/beaker/host.rb', line 132
def hostname
@defaults['vmhostname'] || @name
end
|
#ip ⇒ Object
Return the ip address of this host
158
159
160
|
# File 'lib/beaker/host.rb', line 158
def ip
self[:ip] ||= get_ip
end
|
#is_pe? ⇒ Boolean
140
141
142
|
# File 'lib/beaker/host.rb', line 140
def is_pe?
@options.is_pe?
end
|
#log_prefix ⇒ Object
144
145
146
147
148
149
150
|
# File 'lib/beaker/host.rb', line 144
def log_prefix
if @defaults['vmhostname']
"#{self} (#{@name})"
else
self.to_s
end
end
|
#merge_defaults_for_type(options, type) ⇒ Object
63
64
65
66
|
# File 'lib/beaker/host.rb', line 63
def merge_defaults_for_type options, type
defaults = self.class.send "#{type}_defaults".to_sym
defaults.merge(options.merge((options['HOSTS'][name])))
end
|
#node_name ⇒ Object
68
69
70
71
72
73
|
# File 'lib/beaker/host.rb', line 68
def node_name
result = puppet['node_name_value'].strip
end
|
#pkg_initialize ⇒ Object
58
59
60
61
|
# File 'lib/beaker/host.rb', line 58
def pkg_initialize
end
|
#port_open?(port) ⇒ Boolean
75
76
77
78
79
80
81
82
83
84
|
# File 'lib/beaker/host.rb', line 75
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’)‘
104
105
106
|
# File 'lib/beaker/host.rb', line 104
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.
96
97
98
|
# File 'lib/beaker/host.rb', line 96
def reachable_name
self['ip'] || hostname
end
|
#to_s ⇒ Object
126
127
128
|
# File 'lib/beaker/host.rb', line 126
def to_s
hostname
end
|
#to_str ⇒ Object
121
122
123
|
# File 'lib/beaker/host.rb', line 121
def to_str
hostname
end
|
#up? ⇒ Boolean
86
87
88
89
90
91
92
93
|
# File 'lib/beaker/host.rb', line 86
def up?
begin
Socket.getaddrinfo( reachable_name, nil )
return true
rescue SocketError
return false
end
end
|