openstack_taster 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 847cb5a20b108d188a612e254b26c30d553efd90
-  data.tar.gz: 36527d054338e59a9a6410541a3e532b1b096caa
+  metadata.gz: 2f23a80c511e0cdf522d55d4e398b7f8ba95d9d5
+  data.tar.gz: 4337f06484caba1510f9e0fa6b46ce1708c7e107
 SHA512:
-  metadata.gz: 94623399b8a7d779b9db8e96410dcaffb4c144c2c41d0b2ba6ecbbdd6d5da1e100ac55b67be4efe9fb959a4b1f6ca7926928715e8bd56c1f60fbedb83b68f975
-  data.tar.gz: ab0ae7a389592b96ae43e5a712c2ed5af1a438cd277dae8ee6126d3bd6492aaa5ade5713d1b7db3ace62aab69cb590e5ff7b22961a3366ce6f0d9c7caa361d67
+  metadata.gz: 970215a90be5debc307211a6733e02a016949ea7fd2165bcef7ae4c9b3d5a6a6ce9879abd9ff4100d15a2042682ac8995b08924306e73b5fb01040cd3474437d
+  data.tar.gz: da521ffbf76233edca3d11d94ff634ea99b1a4306aa9942b3a2288d11bd15e168e4df432ad15de6636ec8e151d7d9332175ff521ed5890ce4898d0ea0fee3a1a

data/bin/openstack_taster

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'optparse'
+require 'English'
 
 suites = {
   'security' => 'Runs the security test suite',
@@ -12,11 +13,21 @@ settings = {}
 ARGV << '-h' if ARGV.empty?
 
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: openstack_taster <image_name> {suite_name} [--create-snapshot]\n" \
-                "   or: openstack_taster <image_name> [--create-snapshot]\n" \
-                '   or: openstack_taster <option>'
+  opts.banner = "Usage: openstack_taster -i <image_name> -u <ssh_user> [-s suite_name] [--create-snapshot]\n"
   opts.separator('')
   opts.separator('Available Arguments:')
+  opts.on('-i', '--image=<image_name>', 'Image name to use for the instance.') do |i|
+    settings[:image_name] = i
+  end
+  opts.on('-u', '--user=<ssh_user>', 'SSH username for logging into the instance.') do |u|
+    settings[:ssh_user] = u
+  end
+  opts.on('-s', '--suite=<suite_name>', 'Test suite(s) to use.') do |s|
+    settings[:suite] = s
+  end
+  opts.on('-f', '--flavor=<flavor>', 'Set flavor for the instance.') do |f|
+    settings[:flavor] = f
+  end
   opts.on('-c', '--create-snapshot', 'Create snapshot upon test failure.') do
     settings[:create_snapshot] = true
   end
@@ -32,7 +43,16 @@ parser = OptionParser.new do |opts|
 end
 
 begin
-  params = parser.parse!
+  parser.parse!
+  mandatory = [:image_name, :ssh_user]
+  missing = mandatory.select { |p| settings[p].nil? }
+  raise OptionParser::MissingArgument, missing.join(', ') unless missing.empty? || settings[:exit] == true
+rescue OptionParser::MissingArgument
+  puts
+  puts 'Error: ' + $ERROR_INFO.to_s
+  puts
+  puts parser unless settings[:exit] == true
+  exit 1
 rescue OptionParser::InvalidOption => io
   puts io.message
   puts
@@ -48,16 +68,11 @@ end
 exit if settings[:exit] # exit inside OptionParser causes problems.
 
 begin
-  case params.length
-  when 1
-    image_name = params[0]
+  if settings[:suite].nil?
     suites.each_key { |suite| settings[suite.to_sym] = true }
-  when 2
-    raise "#{params[1]} is not a test suite!" unless suites.include? params[1]
-    image_name = params[0]
-    settings[params[1].to_sym] = true
   else
-    raise 'Incorrect format!'
+    raise "#{settings[:suite]} is not a test suite!" unless suites.include? settings[:suite]
+    settings[settings[:suite].to_sym] = true
   end
 rescue StandardError => e
   puts e.message
@@ -66,6 +81,8 @@ rescue StandardError => e
   exit(1)
 end
 
+settings[:flavor] = 'm1.tiny' if settings[:flavor].nil?
+
 require 'fog/openstack'
 require 'openstack_taster'
 
@@ -95,6 +112,6 @@ image   = Fog::Image::OpenStack.new(OPENSTACK_CREDS)
 network = Fog::Network::OpenStack.new(OPENSTACK_CREDS)
 
 exit OpenStackTaster.new(
-  compute, volume, image, network,
+  compute, volume, image, network, ENV['OS_NETWORK_REF'], settings[:flavor],
   SSH_KEYS, LOG_DIR
-).taste(image_name, settings)
+).taste(settings[:image_name], settings)

data/lib/openstack_taster.rb

@@ -9,13 +9,15 @@ require 'inspec'
 
 # @author Andrew Tolvstad, Samarendra Hedaoo, Cody Holliday
 class OpenStackTaster
-  INSTANCE_FLAVOR_NAME = 'm1.tiny'
-  INSTANCE_NETWORK_NAME = 'public'
   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 = nil # Contents would be something like 'test-vol-1 on openpower8.osuosl.bak'
+  VOLUME_TEST_FILE_CONTENTS = 'test-volume'
   TIMEOUT_INSTANCE_CREATE = 20
   TIMEOUT_VOLUME_ATTACH = 10
   TIMEOUT_VOLUME_PERSIST = 20
@@ -32,6 +34,8 @@ class OpenStackTaster
     volume_service,
     image_service,
     network_service,
+    network_name,
+    instance_flavor,
     ssh_keys,
     log_dir
   )
@@ -40,6 +44,7 @@ class OpenStackTaster
     @image_service   = image_service
     @network_service = network_service
 
+    @network_name = network_name || 'public'
     @volumes = @volume_service.volumes
 
     @ssh_keypair     = ssh_keys[:keypair]
@@ -50,9 +55,9 @@ class OpenStackTaster
     @log_dir         = log_dir + "/#{@session_id}"
 
     @instance_flavor = @compute_service.flavors
-      .select { |flavor|  flavor.name  == INSTANCE_FLAVOR_NAME  }.first
+      .select { |flavor| flavor.name == instance_flavor }.first
     @instance_network = @network_service.networks
-      .select { |network| network.name == INSTANCE_NETWORK_NAME }.first
+      .select { |network| network.name == @network_name }.first
   end
 
   # Taste a specified image
@@ -74,14 +79,12 @@ class OpenStackTaster
 
     abort("#{image_name} is not an available image.") if image.nil?
 
-    distro_user_name = image.name.downcase.gsub(/[^a-z].*$/, '') # truncate downcased name at first non-alpha char
-    distro_arch = image.name.downcase.slice(-2, 2)
+    distro = image.name.downcase[/^[a-z]*/]
     instance_name = format(
-      '%s-%s-%s-%s',
+      '%s-%s-%s',
       INSTANCE_NAME_PREFIX,
       Time.new.strftime(TIME_SLUG_FORMAT),
-      distro_user_name,
-      distro_arch
+      distro
     )
 
     FileUtils.mkdir_p(@log_dir) unless Dir.exist?(@log_dir)
@@ -91,7 +94,8 @@ class OpenStackTaster
     error_log(
       instance_logger,
       'info',
-      "Tasting #{image.name} as '#{instance_name}' with username '#{distro_user_name}'.\nBuilding...",
+      "Tasting #{image.name} as '#{instance_name}' with username '#{settings[:ssh_user]}' and " \
+      "flavor '#{settings[:flavor]}'.\nBuilding...",
       true
     )
 
@@ -121,8 +125,8 @@ class OpenStackTaster
 
     # Run tests
     return_values = []
-    return_values.push taste_security(instance, distro_user_name) if settings[:security]
-    return_values.push taste_volumes(instance, distro_user_name) if settings[:volumes]
+    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)
@@ -152,7 +156,7 @@ class OpenStackTaster
   def taste_security(instance, username)
     opts = {
       'backend' => 'ssh',
-      'host' => instance.addresses['public'].first['addr'],
+      'host' => instance.addresses[@network_name].first['addr'],
       'port' => 22,
       'user' => username,
       'sudo' => true,
@@ -251,37 +255,68 @@ class OpenStackTaster
   # @param username [String] the username to use when logging into the instance
   # @return [Boolean] Whether or not the tests succeeded
   def taste_volumes(instance, username)
-    mount_failures = @volumes.reject do |volume|
-      if volume.attachments.any?
-        error_log(instance.logger, 'info', "Volume '#{volume.name}' is already in an attached state; skipping.", true)
-        next
-      end
-
-      unless volume_attach?(instance, volume)
-        error_log(instance.logger, 'error', "Volume '#{volume.name}' failed to attach.", true)
-        next
-      end
+    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)
+      false
+    end
 
-      volume_mount_unmount?(instance, username, volume)
+    loop do
+      volume.reload
+      sleep 2
+      break if volume.ready?
+      error_log(instance.logger, 'info', "volume #{volume.name} not ready, waiting...", true)
     end
 
-    detach_failures = @volumes.reject do |volume|
-      volume_detach?(instance, volume)
+    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_failures.empty? && detach_failures.empty?
-      error_log(instance.logger, 'info', "\nEncountered 0 failures.", true)
+    if mount && detach
+      error_log(instance.logger, 'info', "\nVolume testing passed!.", true)
       true
     else
       error_log(
         instance.logger,
         'error',
-        "\nEncountered #{mount_failures.count} mount failures and #{detach_failures.count} detach failures.",
+        "\nVolume mounted: #{mount} detached: #{detach}.",
         true
       )
       error_log(instance.logger, 'error', "\nEncountered failures.", true)
       false
     end
+    error_log(instance.logger, 'info', "Deleting volume #{volume.id}.", true)
+    volume.destroy if volume.ready?
   end
 
   # A helper method to execute a series of commands remotely on an instance. This helper
@@ -294,7 +329,7 @@ class OpenStackTaster
     instance.logger.progname = 'SSH'
     begin
       Net::SSH.start(
-        instance.addresses['public'].first['addr'],
+        instance.addresses[@network_name].first['addr'],
         username,
         verbose: :info,
         paranoid: false,
@@ -372,6 +407,7 @@ class OpenStackTaster
       ['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}",                     '']
     ]
@@ -405,7 +441,8 @@ class OpenStackTaster
     puts 'Logging partition list and dmesg...'
 
     record_info_commands = [
-      'cat /proc/partitions',
+      'lsblk -l',
+      'lsblk -fl',
       'dmesg | tail -n 20'
     ]
 

data/tests/controls/security_test.rb

@@ -60,6 +60,15 @@ control 'security-1.0' do
       its('stdout') { should cmp(/\(ALL\) ((NO)*PASSWD)*: ALL/) }
     end
   end
+end
+
+control 'ports-1.0' do
+  impact 1.0
+  title 'Openstack Image Ports Test'
+  desc 'Tests the open ports of images used for Openstack.'
+
+  # Skip these tests if we detect openstack is installed
+  only_if { !file('/etc/keystone').exist? }
 
   # ssh should be the only thing listening
   describe port.where { protocol =~ /tcp/ && port != 22 } do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstack_taster
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - OSU Open Source Lab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inspec