Class: OpenStackTaster

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

Overview

Author:

  • Andrew Tolvstad, Samarendra Hedaoo, Cody Holliday

Constant Summary collapse

INSTANCE_NAME_PREFIX = 
'taster'
INSTANCE_VOLUME_MOUNT_POINT = 
'/mnt/taster_volume'
VOLUME_NAME_PREFIX = 
'test_volume'
VOLUME_DESCRIPTION = 
'Test volume for OpenStack Taster.'
VOLUME_SIZE = 
1
VOLUME_FILESYSTEM = 
'ext4'
VOLUME_TEST_FILE_NAME = 
'info'
VOLUME_TEST_FILE_CONTENTS = 
'test-volume'
TIMEOUT_INSTANCE_CREATE = 
20
TIMEOUT_VOLUME_ATTACH = 
10
TIMEOUT_VOLUME_PERSIST = 
20
TIMEOUT_INSTANCE_TO_BE_CREATED = 
20
TIMEOUT_INSTANCE_STARTUP = 
30
TIMEOUT_SSH_RETRY = 
15
MAX_SSH_RETRY = 
3
TIME_SLUG_FORMAT = 
'%Y%m%d_%H%M%S'

Instance Method Summary collapse

Constructor Details

#initialize(compute_service, volume_service, image_service, network_service, network_name, instance_flavor, ssh_keys, log_dir) ⇒ OpenStackTaster

Returns a new instance of OpenStackTaster.



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
 
# File 'lib/openstack_taster.rb', line 32

def initialize(
  compute_service,
  volume_service,
  image_service,
  network_service,
  network_name,
  instance_flavor,
  ssh_keys,
  log_dir
)
  @compute_service = compute_service
  @volume_service  = volume_service
  @image_service   = image_service
  @network_service = network_service

  @network_name = network_name || 'public'
  @volumes = @volume_service.volumes

  @ssh_keypair     = ssh_keys[:keypair]
  @ssh_private_key = ssh_keys[:private_key]
  @ssh_public_key  = ssh_keys[:public_key] # REVIEW

  @session_id      = object_id
  @log_dir         = log_dir + "/#{@session_id}"

  @instance_flavor = @compute_service.flavors
    .select { |flavor| flavor.name == instance_flavor }.first
  @instance_network = @network_service.networks
    .select { |network| network.name == @network_name }.first
end

Instance Method Details

#create_image(instance) ⇒ Fog::Image::OpenStack::Image

Note:

This method blocks until snapshot creation is complete on the server.

Create an image of an instance.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance to query

Returns:

  • (Fog::Image::OpenStack::Image) —

    the generated image



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openstack_taster.rb', line 239

def create_image(instance)
  image_name = [
    instance.name,
    get_image_name(instance)
  ].join('_')

  response = instance.create_image(image_name)
  image_id = response.body['image']['id']

  @image_service.images
    .find_by_id(image_id)
    .wait_for { status == 'active' }
end

#error_log(logger, level, message, dup_stdout = false, context = nil) ⇒ Object

Write an error message to the log and optionally stdout.

Parameters:

  • logger (Logger) —

    the logger used to record the message.

  • level (String) —

    the level to use when logging.

  • message (String) —

    the message to write

  • dup_stdout (Boolean) (defaults to: false) —

    whether or not to print the message to stdout

  • context (String) (defaults to: nil) —

    the context of the message to be logged. i.e. SSH, Inspec, etc.



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/openstack_taster.rb', line 212

def error_log(logger, level, message, dup_stdout = false, context = nil)
  puts message if dup_stdout

  begin
    logger.add(Logger.const_get(level.upcase), message, context)
  rescue NameError
    puts
    puts "\e[31m#{level} is not a severity. Make sure that you use the correct string for logging severity!\e[0m"
    puts
    logger.error('Taster Source Code') { "#{level} is not a logging severity name. Defaulting to INFO." }
    logger.info(context) { message }
  end
end

#get_image_name(instance) ⇒ String

Get the name of the image from which an instance was created.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance to query

Returns:

  • (String) —

    the name of the image



229
230
231
232
233
 
# File 'lib/openstack_taster.rb', line 229

def get_image_name(instance)
  @image_service
    .get_image_by_id(instance.image['id'])
    .body['name']
end

#log_partitions(instance, username) ⇒ Object

Log instance’s partition listing.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance to log

  • username (String) —

    the username to use when logging in to the instance



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/openstack_taster.rb', line 442

def log_partitions(instance, username)
  puts 'Logging partition list and dmesg...'

  record_info_commands = [
    'lsblk -l',
    'lsblk -fl',
    'dmesg | tail -n 20'
  ]

  with_ssh(instance, username) do |ssh|
    record_info_commands.each do |command|
      result = ssh.exec!(command)
      error_log(instance.logger, 'info', "Ran '#{command}' and got '#{result}'")
    end
  end
end

#taste(image_name, settings) ⇒ Boolean

TODO:

Reduce Percieved and Cyclomatic complexity

TODO:

Images over compute service is deprecated

Note:

The testing section could be further streamlined by: creating a naming standard for test functions (i.e. taste_<name>) limiting the parameters of each test to be: instance, distro_username Adding a ‘suites’ subhash to the settings hash Then that subhash can be iterated over, use eval to call each function, appending the suite name to ‘taste_’ for the function name and passing the standardized parameters

Taste a specified image

Parameters:

  • image_name (String) —

    The name on OpenStack of the image to be tested.

  • settings (Hash) —

    A hash of settings to enable and disable tests, snapshot creation upon failure.

Returns:

  • (Boolean) —

    success or failure of tests on image.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/openstack_taster.rb', line 76

def taste(image_name, settings)
  image = @compute_service.images
    .select { |i| i.name == image_name }.first

  abort("#{image_name} is not an available image.") if image.nil?

  distro = image.name.downcase[/^[a-z]*/]
  instance_name = format(
    '%s-%s-%s',
    INSTANCE_NAME_PREFIX,
    Time.new.strftime(TIME_SLUG_FORMAT),
    distro
  )

  FileUtils.mkdir_p(@log_dir) unless Dir.exist?(@log_dir)

  instance_logger = Logger.new("#{@log_dir}/#{instance_name}.log")

  error_log(
    instance_logger,
    'info',
    "Tasting #{image.name} as '#{instance_name}' with username '#{settings[:ssh_user]}' and " \
    "flavor '#{settings[:flavor]}'.\nBuilding...",
    true
  )

  instance = @compute_service.servers.create(
    name: instance_name,
    flavor_ref: @instance_flavor.id,
    image_ref: image.id,
    nics: [{ net_id: @instance_network.id }],
    key_name: @ssh_keypair
  )

  if instance.nil?
    error_log(instance_logger, 'error', 'Failed to create instance.', true)
    return false
  end

  instance.class.send(:attr_accessor, 'logger')

  instance.logger = instance_logger

  instance.wait_for(TIMEOUT_INSTANCE_TO_BE_CREATED) { ready? }

  error_log(instance.logger, 'info', "Sleeping #{TIMEOUT_INSTANCE_STARTUP} seconds for OS startup...", true)
  sleep TIMEOUT_INSTANCE_STARTUP

  error_log(instance.logger, 'info', "Testing for instance '#{instance.id}'.", true)

  # Run tests
  return_values = []
  return_values.push taste_security(instance, settings[:ssh_user]) if settings[:security]
  return_values.push taste_volumes(instance, settings[:ssh_user]) if settings[:volumes]

  if settings[:create_snapshot] && !return_values.all?
    error_log(instance.logger, 'info', "Tests failed for instance '#{instance.id}'. Creating image...", true)
    create_image(instance) # Create image here since it is destroyed before scope returns to taste function
  end
  return return_values.all?
rescue Fog::Errors::TimeoutError
  puts 'Instance creation timed out.'
  error_log(instance.logger, 'error', "Instance fault: #{instance.fault}")
  return false
rescue Interrupt
  puts "\nCaught interrupt"
  puts "Exiting session #{@session_id}"
  raise
ensure
  if instance
    puts "Destroying instance for session #{@session_id}.\n\n"
    instance.destroy
  end
end

#taste_security(instance, username) ⇒ Boolean

TODO:

Don’t crash when connection refused.

Runs the security test suite using inspec

Parameters:

  • instance (Fog::Image::OpenStack::Image) —

    The instance to test.

  • username (String) —

    The username to use when logging into the instance.

Returns:

  • (Boolean) —

    Whether or not the image passed hte security tests.



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/openstack_taster.rb', line 156

def taste_security(instance, username)
  opts = {
    'backend' => 'ssh',
    'host' => instance.addresses[@network_name].first['addr'],
    'port' => 22,
    'user' => username,
    'sudo' => true,
    'keys_only' => true,
    'key_files' => @ssh_private_key,
    'logger' => instance.logger
  }

  tries = 0

  begin
    runner = Inspec::Runner.new(opts)
    runner.add_target(File.dirname(__FILE__) + '/../tests')
    runner.run
  rescue RuntimeError => e
    puts "Encountered error \"#{e.message}\" while testing the instance."
    if tries < MAX_SSH_RETRY
      tries += 1
      puts "Initiating SSH attempt #{tries} in #{TIMEOUT_SSH_RETRY} seconds"
      sleep TIMEOUT_SSH_RETRY
      retry
    end
    error_log(instance.logger, 'error', e.backtrace, false, 'Inspec Runner')
    error_log(instance.logger, 'error', e.message, false, 'Inspec Runner')
    return true
  rescue StandardError => e
    puts "Encountered error \"#{e.message}\". Aborting test."
    return true
  end

  error_log(
    instance.logger,
    'info',
    "Inspec Test Results\n" +
    runner.report[:controls].map do |test|
      "#{test[:status].upcase}: #{test[:code_desc]}\n#{test[:message]}"
    end.join("\n")
  )

  if runner.report[:controls].any? { |test| test[:status] == 'failed' }
    error_log(instance.logger, 'warn', 'Image failed security test suite')
    return false
  end
  true
end

#taste_volumes(instance, username) ⇒ Boolean

Run the set of tests for each available volume on an instance.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance to query

  • username (String) —

    the username to use when logging into the instance

Returns:

  • (Boolean) —

    Whether or not the tests succeeded



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
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
 
# File 'lib/openstack_taster.rb', line 257

def taste_volumes(instance, username)
  volume_name = format(
    '%s-%s-%s',
    VOLUME_NAME_PREFIX,
    Time.new.strftime(TIME_SLUG_FORMAT),
    instance.id
  )
  begin
    volume = @compute_service.volumes.create name: volume_name, size: VOLUME_SIZE, description: VOLUME_DESCRIPTION
  rescue Excon::Error => e
    puts 'Failed to create volume. check log for details.'
    error_log(instance.logger, 'error', e.message)
    return false
  end

  loop do
    volume.reload
    sleep 2
    break if volume.ready?
    error_log(instance.logger, 'info', "volume #{volume.name} not ready, waiting...", true)
  end

  if volume_attach?(instance, volume)
    vdev = @volume_service.volumes.find_by_id(volume.id).attachments.first['device']
    mkfs_command = [
      ["sudo parted --script #{vdev} mklabel gpt mkpart primary 1 100%", ''],
      ["sudo mkfs.#{VOLUME_FILESYSTEM} -Fq #{vdev}1", '']
    ]
    with_ssh(instance, username) do |ssh|
      mkfs_command.each do |command, expected|
        result = ssh.exec!(command)
        next unless result != expected
        error_log(
          instance.logger,
          'error',
          "Failure while running '#{command}':\n\texpected '#{expected}'\n\tgot '#{result}'",
          true
        )
        return false
      end
    end
    mount = volume_mount_unmount?(instance, username, volume)
    detach = volume_detach?(instance, volume)
  else
    error_log(instance.logger, 'error', "Volume '#{volume.id}' failed to attach.", true)
    return false
  end

  if mount && detach
    error_log(instance.logger, 'info', "Deleting volume #{volume.id}.", true)
    volume.destroy if volume.ready?
    error_log(instance.logger, 'info', "\nVolume testing passed!.", true)
    true
  else
    error_log(instance.logger, 'info', "Deleting volume #{volume.id}.", true)
    volume.destroy if volume.ready?
    error_log(
      instance.logger,
      'error',
      "\nVolume mounted: #{mount} detached: #{detach}.",
      true
    )
    error_log(instance.logger, 'error', "\nEncountered failures.", true)
    false
  end
end

#volume_attach?(instance, volume) ⇒ Boolean

Test volume attachment for a given instance and volume.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance to which to attach the volume

  • volume (Fog::Volume::OpenStack::Volume) —

    the volume to attach

Returns:

  • (Boolean) —

    whether or not the attachment was successful



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/openstack_taster.rb', line 360

def volume_attach?(instance, volume)
  volume_attached = lambda do |_|
    volume_attachments.any? do |attachment|
      attachment['volumeId'] == volume.id
    end
  end

  error_log(instance.logger, 'info', "Attaching volume '#{volume.name}' (#{volume.id})...", true)
  @compute_service.attach_volume(volume.id, instance.id, nil)
  instance.wait_for(TIMEOUT_VOLUME_ATTACH, &volume_attached)

  error_log(instance.logger, 'info', "Sleeping #{TIMEOUT_VOLUME_PERSIST} seconds for attachment persistance...", true)
  sleep TIMEOUT_VOLUME_PERSIST

  # In the off chance that the volume host goes down, catch it.
  if instance.instance_eval(&volume_attached)
    return true if volume.reload.attachments.first
    error_log(instance.logger, 'error', "Failed to attach '#{volume.name}': Volume host might be down.", true)
  else
    error_log(instance.logger, 'error', "Failed to attach '#{volume.name}': Volume was unexpectedly detached.", true)
  end

  false
rescue Excon::Error => e
  puts 'Error attaching volume, check log for details.'
  error_log(instance.logger, 'error', e.message)
  false
rescue Fog::Errors::TimeoutError
  error_log(instance.logger, 'error', "Failed to attach '#{volume.name}': Operation timed out.", true)
  false
end

#volume_detach?(instance, volume) ⇒ Boolean

Detach volume from instance.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance from which to detach

  • volume (Fog::Volume::OpenStack::Volume) —

    the volume to detach

Returns:

  • (Boolean) —

    whether or not the detachment succeeded



463
464
465
466
467
468
469
470
 
# File 'lib/openstack_taster.rb', line 463

def volume_detach?(instance, volume)
  error_log(instance.logger, 'info', "Detaching #{volume.name}.", true)
  instance.detach_volume(volume.id)
rescue Excon::Error => e
  puts 'Failed to detach. check log for details.'
  error_log(instance.logger, 'error', e.message)
  false
end

#volume_mount_unmount?(instance, username, volume) ⇒ Boolean

Test volume mounting and unmounting for an instance and a volume.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance on which to mount the volume

  • username (String) —

    the username to use when logging into the instance

  • volume (Fog::Volume::OpenStack::Volume) —

    the volume to mount

Returns:

  • (Boolean) —

    whether or not the mounting/unmounting was successful



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/openstack_taster.rb', line 397

def volume_mount_unmount?(instance, username, volume)
  mount = INSTANCE_VOLUME_MOUNT_POINT
  file_name = VOLUME_TEST_FILE_NAME
  file_contents = VOLUME_TEST_FILE_CONTENTS
  vdev = @volume_service.volumes.find_by_id(volume.id)
    .attachments.first['device']
  vdev << '1'

  log_partitions(instance, username)

  commands = [
    ["echo -e \"127.0.0.1\t$HOSTNAME\" | sudo tee -a /etc/hosts", nil], # to fix problems with sudo and DNS resolution
    ['sudo partprobe -s',                        nil],
    ["[ -d '#{mount}' ] || sudo mkdir #{mount}", ''],
    ["sudo mount #{vdev} #{mount}",              ''],
    ["sudo sh -c 'echo -n #{file_contents} > #{mount}/#{file_name}'", ''],
    ["sudo cat #{mount}/#{file_name}",           file_contents],
    ["sudo umount #{mount}",                     '']
  ]

  error_log(instance.logger, 'info', "Mounting volume '#{volume.name}' (#{volume.id})...", true)

  error_log(instance.logger, 'info', 'Mounting from inside the instance...', true)
  with_ssh(instance, username) do |ssh|
    commands.each do |command, expected|
      result = ssh.exec!(command).chomp
      if expected.nil?
        error_log(instance.logger, 'info', "#{command} yielded '#{result}'")
      elsif result != expected
        error_log(
          instance.logger,
          'error',
          "Failure while running '#{command}':\n\texpected '#{expected}'\n\tgot '#{result}'",
          true
        )
        return false # returns from volume_mount_unmount?
      end
    end
  end
  true
end

#with_ssh(instance, username, &block) ⇒ Object

TODO:

Don’t crash when connection refused.

A helper method to execute a series of commands remotely on an instance. This helper passes its block directly to ‘Net::SSH#start()`.

Parameters:

  • instance (Fog::Compute::OpenStack::Server) —

    the instance on which to run the commands

  • username (String) —

    the username to use when logging into the instance



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/openstack_taster.rb', line 329

def with_ssh(instance, username, &block)
  tries = 0
  instance.logger.progname = 'SSH'
  begin
    Net::SSH.start(
      instance.addresses[@network_name].first['addr'],
      username,
      verbose: :info,
      paranoid: false,
      logger: instance.logger,
      keys: [@ssh_private_key],
      &block
    )
  rescue Errno::ECONNREFUSED => e
    puts "Encountered #{e.message} while connecting to the instance."
    if tries < MAX_SSH_RETRY
      tries += 1
      puts "Initiating SSH attempt #{tries} in #{TIMEOUT_SSH_RETRY} seconds"
      sleep TIMEOUT_SSH_RETRY
      retry
    end
    error_log(instance.logger, 'error', e.backtrace, false, 'SSH')
    error_log(instance.logger, 'error', e.message, false, 'SSH')
    exit 1
  end
end