Class: Beaker::Host

Inherits:
Object
  • Object
show all
Defined in:
lib/beaker/host.rb

Direct Known Subclasses

Unix::Host, Windows::Host

Defined Under Namespace

Classes: CommandFailure, PuppetConfigReader

Constant Summary collapse

SELECT_TIMEOUT = 
30

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options) ⇒ Host

Returns a new instance of Host.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/beaker/host.rb', line 44

def initialize name, options
  @logger = options[:logger]
  @name, @options = name.to_s, options.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
end

Instance Attribute Details

#defaults ⇒ Object (readonly)

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 (readonly)

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 



120
121
122
 
# File 'lib/beaker/host.rb', line 120

def + other
  @name + other
end

#[](k) ⇒ Object 



104
105
106
 
# File 'lib/beaker/host.rb', line 104

def [] k
  @defaults[k]
end

#[]=(k, v) ⇒ Object 



100
101
102
 
# File 'lib/beaker/host.rb', line 100

def []= k, v
  @defaults[k] = v
end

#close ⇒ Object 



134
135
136
137
 
# File 'lib/beaker/host.rb', line 134

def close
  @connection.close if @connection
  @connection = nil
end

#connection ⇒ Object 



128
129
130
131
132
 
# File 'lib/beaker/host.rb', line 128

def connection
  @connection ||= SshConnection.connect( reachable_name,
                                         self['user'],
                                         self['ssh'] )
end

#do_scp_from(source, target, options) ⇒ Object 



183
184
185
186
187
188
 
# File 'lib/beaker/host.rb', line 183

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 



176
177
178
179
180
181
 
# File 'lib/beaker/host.rb', line 176

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 



139
140
141
142
143
144
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
 
# File 'lib/beaker/host.rb', line 139

def exec command, options={}
  # I've always found this confusing
  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
    # 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 = connection.execute(cmdline, options, output_callback)

    unless options[: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(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
    # Danger, so we have to return this result?
    result
  end
end

#has_key?(k) ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/beaker/host.rb', line 108

def has_key? k
  @defaults.has_key?(k)
end

#is_pe? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/beaker/host.rb', line 124

def is_pe?
  @options.is_pe?
end

#merge_defaults_for_type(options, type) ⇒ Object 



56
57
58
59
 
# File 'lib/beaker/host.rb', line 56

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 



61
62
63
64
65
66
 
# File 'lib/beaker/host.rb', line 61

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

#port_open?(port) ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/beaker/host.rb', line 68

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’)‘



96
97
98
 
# File 'lib/beaker/host.rb', line 96

def puppet(command='agent')
  PuppetConfigReader.new(self, command)
end

#reachable_name ⇒ Object 



88
89
90
 
# File 'lib/beaker/host.rb', line 88

def reachable_name
  self['ip'] || self['vmhostname'] || name
end

#to_s ⇒ Object 



116
117
118
 
# File 'lib/beaker/host.rb', line 116

def to_s
  @defaults['vmhostname'] || @name
end

#to_str ⇒ Object 



112
113
114
 
# File 'lib/beaker/host.rb', line 112

def to_str
  @defaults['vmhostname'] || @name
end

#up? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
82
83
84
85
86
 
# File 'lib/beaker/host.rb', line 79

def up?
  begin
    Socket.getaddrinfo( reachable_name, nil )
    return true
  rescue SocketError
    return false
  end
end