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
-
#has_key?(k) ⇒ Boolean
-
#initialize(name, options) ⇒ Host
constructor
-
#is_pe? ⇒ Boolean
-
#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
-
#to_s ⇒ Object
-
#to_str ⇒ Object
-
#up? ⇒ Boolean
Constructor Details
#initialize(name, options) ⇒ Host
Returns a new instance of Host.
44
45
46
47
48
49
50
51
52
53
54
55
|
# File 'lib/beaker/host.rb', line 44
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.
43
44
45
|
# File 'lib/beaker/host.rb', line 43
def defaults
@defaults
end
|
#logger ⇒ Object
Returns the value of attribute logger.
42
43
44
|
# File 'lib/beaker/host.rb', line 42
def logger
@logger
end
|
#name ⇒ Object
Returns the value of attribute name.
43
44
45
|
# File 'lib/beaker/host.rb', line 43
def name
@name
end
|
Class Method Details
.create(name, options) ⇒ Object
31
32
33
34
35
36
37
38
39
40
|
# File 'lib/beaker/host.rb', line 31
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
126
127
128
|
# File 'lib/beaker/host.rb', line 126
def + other
@name + other
end
|
#[](k) ⇒ Object
110
111
112
|
# File 'lib/beaker/host.rb', line 110
def [] k
@defaults[k]
end
|
#[]=(k, v) ⇒ Object
106
107
108
|
# File 'lib/beaker/host.rb', line 106
def []= k, v
@defaults[k] = v
end
|
#close ⇒ Object
140
141
142
143
|
# File 'lib/beaker/host.rb', line 140
def close
@connection.close if @connection
@connection = nil
end
|
#connection ⇒ Object
134
135
136
137
138
|
# File 'lib/beaker/host.rb', line 134
def connection
@connection ||= SshConnection.connect( reachable_name,
self['user'],
self['ssh'] )
end
|
#do_scp_from(source, target, options) ⇒ Object
189
190
191
192
193
194
|
# File 'lib/beaker/host.rb', line 189
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
182
183
184
185
186
187
|
# File 'lib/beaker/host.rb', line 182
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
# File 'lib/beaker/host.rb', line 145
def exec command, options={}
cmdline = command.cmd_line(self)
if options[:silent]
output_callback = nil
else
if @defaults['vmhostname']
@logger.debug "\n#{self} (#{@name}) $ #{cmdline}"
else
@logger.debug "\n#{self} $ #{cmdline}"
end
output_callback = logger.method(:host_output)
end
unless $dry_run
result = connection.execute(cmdline, options, output_callback)
unless options[:silent]
result.log(@logger)
unless result.exit_code_in?(Array(options[:acceptable_exit_codes] || 0))
limit = 10
raise CommandFailure, "Host '#{self}' exited with #{result.exit_code} running:\n #{cmdline}\nLast #{limit} lines of output were:\n#{result.formatted_output(limit)}"
end
end
result
end
end
|
#has_key?(k) ⇒ Boolean
114
115
116
|
# File 'lib/beaker/host.rb', line 114
def has_key? k
@defaults.has_key?(k)
end
|
#is_pe? ⇒ Boolean
130
131
132
|
# File 'lib/beaker/host.rb', line 130
def is_pe?
@options.is_pe?
end
|
#merge_defaults_for_type(options, type) ⇒ Object
62
63
64
65
|
# File 'lib/beaker/host.rb', line 62
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
67
68
69
70
71
72
|
# File 'lib/beaker/host.rb', line 67
def node_name
result = puppet['node_name_value'].strip
end
|
#pkg_initialize ⇒ Object
57
58
59
60
|
# File 'lib/beaker/host.rb', line 57
def pkg_initialize
end
|
#port_open?(port) ⇒ Boolean
74
75
76
77
78
79
80
81
82
83
|
# File 'lib/beaker/host.rb', line 74
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’)‘
102
103
104
|
# File 'lib/beaker/host.rb', line 102
def puppet(command='agent')
PuppetConfigReader.new(self, command)
end
|
#reachable_name ⇒ Object
94
95
96
|
# File 'lib/beaker/host.rb', line 94
def reachable_name
self['ip'] || self['vmhostname'] || name
end
|
#to_s ⇒ Object
122
123
124
|
# File 'lib/beaker/host.rb', line 122
def to_s
@defaults['vmhostname'] || @name
end
|
#to_str ⇒ Object
118
119
120
|
# File 'lib/beaker/host.rb', line 118
def to_str
@defaults['vmhostname'] || @name
end
|
#up? ⇒ Boolean
85
86
87
88
89
90
91
92
|
# File 'lib/beaker/host.rb', line 85
def up?
begin
Socket.getaddrinfo( reachable_name, nil )
return true
rescue SocketError
return false
end
end
|