beaker 1.8.1 → 1.8.2

data/lib/beaker/hypervisor.rb

@@ -1,10 +1,22 @@
+%w( host_prebuilt_steps ).each do |lib|
+  begin
+    require lib
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), lib))
+  end
+end
+
 module Beaker
+  #The Beaker class that interacts to all the supported hypervisors
   class Hypervisor
+    include HostPrebuiltSteps
 
-    def configure(hosts)
-      @logger.debug "No post-provisioning configuration necessary for #{self.class.name} boxes"
-    end
-
+    #Hypervisor creator method.  Creates the appropriate hypervisor class object based upon
+    #the provided hypervisor type selected, then provisions hosts with hypervisor.
+    #@param [String] type The type of hypervisor to create - one of aix, solaris, vsphere, fusion,
+    #                     blimpy, vcloud or vagrant
+    #@param [Array<Host>] hosts_to_provision The hosts to be provisioned with the selected hypervisor
+    #@param [Hash] options options Options to alter execution
     def self.create(type, hosts_to_provision, options)
       @logger = options[:logger]
       @logger.notify("Beaker::Hypervisor, found some #{type} boxes to create") 
@@ -27,17 +39,54 @@ module Beaker
           end
         when /vagrant/
           Beaker::Vagrant
+        when /none/
+          Beaker::Hypervisor
+        else
+          raise "Invalid hypervisor: #{type}" 
         end
+
       hypervisor = hyper_class.new(hosts_to_provision, options)
       hypervisor.provision
 
       hypervisor
     end
 
+    def initialize(hosts, options)
+      @hosts = hosts
+      @options = options
+    end
+
+    #Provisioning steps for be run for a given hypervisor.  Default is nil.
     def provision
       nil
     end
 
+    #Cleanup steps to be run for a given hypervisor.  Default is nil.
+    def cleanup
+      nil
+    end
+
+    #Default configuration steps to be run for a given hypervisor
+    def configure
+      if @options[:timesync]
+        timesync(@hosts, @options)
+      end
+      if @options[:root_keys]
+        sync_root_keys(@hosts, @options)
+      end
+      if @options[:add_el_extras]
+        add_el_extras(@hosts, @options)
+      end
+      if @options[:add_master_entry]
+        add_master_entry(@hosts, @options)
+      end
+   end
+
+   #Default validation steps to be run for a given hypervisor
+   def validate
+     validate_host(@hosts, @options)
+   end
+
   end
 end
 

data/lib/beaker/hypervisor/aixer.rb

@@ -4,7 +4,7 @@ module Beaker
     def initialize(aix_hosts, options)
       @options = options
       @logger = options[:logger]
-      @aix_hosts = aix_hosts
+      @hosts = aix_hosts
       #aix machines are reverted to known state, not a snapshot
       @fog_file = nil
       if File.exists?( @options[:dot_fog] )
@@ -27,7 +27,7 @@ module Beaker
       hypervisor[:user] = @fog_file[:default][:aix_hypervisor_username] || hypervisor[:user]
       hypervisor[:ssh][:keys] = [@fog_file[:default][:aix_hypervisor_keyfile]] || hypervisor[:ssh][:keys]
 
-      @aix_hosts.each do |host|
+      @hosts.each do |host|
         vm_name = host['vmname'] || host.name
 
         @logger.notify "Reverting #{vm_name} to aix clean state"

data/lib/beaker/hypervisor/blimper.rb

@@ -27,7 +27,7 @@ module Beaker
     def initialize(blimpy_hosts, options)
       @options = options
       @logger = options[:logger]
-      @blimpy_hosts = blimpy_hosts
+      @hosts = blimpy_hosts
       @blimpy = Blimpy
     end
 
@@ -35,7 +35,7 @@ module Beaker
       ami_spec= YAML.load_file(@options[:ec2_yaml])["AMI"]
 
       fleet = @blimpy.fleet do |fleet|
-        @blimpy_hosts.each do |host|
+        @hosts.each do |host|
           amitype = host['vmname'] || host['platform']
           amisize = host['amisize'] || 'm1.small'
           #use snapshot provided for this host 
@@ -90,7 +90,7 @@ module Beaker
       fleet.ships.each do |ship|
         ship.wait_for_sshd
         name = ship.name
-        host = @blimpy_hosts.select { |host| host.name == name }[0]
+        host = @hosts.select { |host| host.name == name }[0]
         host['ip'] = ship.dns
         host.exec(Command.new("hostname #{name}"))
         ip = get_ip(host) 
@@ -99,7 +99,7 @@ module Beaker
       end
 
       # Send our hosts information to the nodes
-      @blimpy_hosts.each do |host|
+      @hosts.each do |host|
         set_etc_hosts(host, etc_hosts)
       end
 
@@ -107,7 +107,7 @@ module Beaker
 
     def cleanup
       fleet = @blimpy.fleet do |fleet|
-        @blimpy_hosts.each do |host|
+        @hosts.each do |host|
           fleet.add(:aws) do |ship|
             ship.name = host.name
           end

data/lib/beaker/hypervisor/fusion.rb

@@ -10,9 +10,9 @@ module Beaker
       end
       @logger = options[:logger]
       @options = options
-      @fusion_hosts = fusion_hosts
+      @hosts = fusion_hosts
       #check preconditions for fusion
-      @fusion_hosts.each do |host|
+      @hosts.each do |host|
         raise "You must specify a snapshot for Fusion instances, no snapshot defined for #{host.name}!" unless host["snapshot"]
       end
       @fission = Fission::VM
@@ -22,7 +22,7 @@ module Beaker
       available = @fission.all.data.collect{|vm| vm.name}.sort.join(", ")
       @logger.notify "Available VM names: #{available}"
 
-      @fusion_hosts.each do |host|
+      @hosts.each do |host|
         vm_name = host["vmname"] || host.name
         vm = @fission.new vm_name
         raise "Could not find VM '#{vm_name}' for #{host.name}!" unless vm.exists?

data/lib/beaker/hypervisor/solaris.rb

@@ -4,7 +4,7 @@ module Beaker
     def initialize(solaris_hosts, options)
       @options = options
       @logger = options[:logger]
-      @solaris_hosts = solaris_hosts
+      @hosts = solaris_hosts
       @fog_file = nil
       if File.exists?( @options[:dot_fog] )
         @fog_file = YAML.load_file( @options[:dot_fog] )
@@ -28,7 +28,7 @@ module Beaker
       hypervisor[:user] = @fog_file[:default][:solaris_hypervisor_username] || hypervisor[:user]
       hypervisor[:ssh][:keys] = [@fog_file[:default][:solaris_hypervisor_keyfile]] || hypervisor[:ssh][:keys]
 
-      @solaris_hosts.each do |host|
+      @hosts.each do |host|
         vm_name = host['vmname'] || host.name
         #use the snapshot provided for this host
         snapshot = host['snapshot']

data/lib/beaker/hypervisor/vagrant.rb

@@ -52,16 +52,6 @@ module Beaker
       end
     end
 
-    def copy_ssh_to_root host
-      #make is possible to log in as root by copying the ssh dir to root's account
-      @logger.debug "Give root a copy of vagrant's keys"
-      if host['platform'] =~ /windows/
-        host.exec(Command.new('sudo su -c "cp -r .ssh /home/Administrator/."'))
-      else
-        host.exec(Command.new('sudo su -c "cp -r .ssh /root/."'))
-      end
-    end
-
     def set_ssh_config host, user
         f = Tempfile.new("#{host.name}")
         ssh_config = Dir.chdir(@vagrant_path) do
@@ -104,7 +94,7 @@ module Beaker
       @options = options
       @logger = options[:logger]
       @temp_files = []
-      @vagrant_hosts = vagrant_hosts
+      @hosts = vagrant_hosts
       @vagrant_path = File.expand_path(File.join(File.basename(__FILE__), '..', '.vagrant', 'beaker_vagrant_files', File.basename(options[:hosts_file])))
       FileUtils.mkdir_p(@vagrant_path)
       @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
@@ -117,29 +107,29 @@ module Beaker
         #make sure that any old boxes are dead dead dead
         vagrant_cmd("destroy --force") if File.file?(@vagrant_file)
 
-        make_vfile @vagrant_hosts, @options
+        make_vfile @hosts, @options
 
         vagrant_cmd("up")
       else #set host ip of already up boxes
-        @vagrant_hosts.each do |host|
+        @hosts.each do |host|
           host[:ip] = get_ip_from_vagrant_file(host.name)
         end
       end
 
       @logger.debug "configure vagrant boxes (set ssh-config, switch to root user, hack etc/hosts)"
-      @vagrant_hosts.each do |host|
+      @hosts.each do |host|
         default_user = host['user']
       
         set_ssh_config host, 'vagrant'
 
-        copy_ssh_to_root host
+        copy_ssh_to_root host, @options
         #shut down connection, will reconnect on next exec
         host.close
 
         set_ssh_config host, default_user
       end
 
-      hack_etc_hosts @vagrant_hosts
+      hack_etc_hosts @hosts
 
     end
 

data/lib/beaker/hypervisor/vcloud.rb

@@ -7,7 +7,7 @@ module Beaker
     def initialize(vcloud_hosts, options)
       @options = options
       @logger = options[:logger]
-      @vcloud_hosts = vcloud_hosts
+      @hosts = vcloud_hosts
 
       raise 'You must specify a datastore for vCloud instances!' unless @options['datastore']
       raise 'You must specify a resource pool for vCloud instances!' unless @options['resourcepool']
@@ -101,7 +101,7 @@ module Beaker
   
         start = Time.now
         tasks = []
-        @vcloud_hosts.each_with_index do |h, i|
+        @hosts.each_with_index do |h, i|
           # Generate a randomized hostname
           h['vmhostname'] = generate_host_name
   
@@ -135,7 +135,7 @@ module Beaker
   
         try = (Time.now - start) / 5
         duration = run_and_report_duration do 
-          @vcloud_hosts.each_with_index do |h, i|
+          @hosts.each_with_index do |h, i|
             booting_host(h, try, attempts)
           end
         end
@@ -143,7 +143,7 @@ module Beaker
   
         try = (Time.now - start) / 5
         duration = run_and_report_duration do
-          @vcloud_hosts.each_with_index do |h, i|
+          @hosts.each_with_index do |h, i|
             wait_for_dns_resolution(h, try, attempts)
           end
         end
@@ -158,8 +158,8 @@ module Beaker
       @logger.notify "Destroying vCloud boxes"
       connect_to_vsphere
 
-      vm_names = @vcloud_hosts.map {|h| h['vmhostname'] }.compact
-      if @vcloud_hosts.length != vm_names.length
+      vm_names = @hosts.map {|h| h['vmhostname'] }.compact
+      if @hosts.length != vm_names.length
         @logger.warn "Some hosts did not have vmhostname set correctly! This likely means VM provisioning was not successful"
       end
       vms = @vsphere_helper.find_vms vm_names

data/lib/beaker/hypervisor/vcloud_pooled.rb

@@ -19,7 +19,7 @@ module Beaker
     def initialize(vcloud_hosts, options)
       @options = options
       @logger = options[:logger]
-      @vcloud_hosts = vcloud_hosts
+      @hosts = vcloud_hosts
 
       raise 'You must specify a datastore for vCloud instances!' unless @options['datastore']
       raise 'You must specify a resource pool for vCloud instances!' unless @options['resourcepool']
@@ -54,7 +54,7 @@ module Beaker
     def provision
       start = Time.now
       try = 1
-      @vcloud_hosts.each_with_index do |h, i|
+      @hosts.each_with_index do |h, i|
         if not h['template']
           raise ArgumentError, "You must specify a template name for #{h}"
         end
@@ -97,8 +97,8 @@ module Beaker
     end
 
     def cleanup
-      vm_names = @vcloud_hosts.map {|h| h['vmhostname'] }.compact
-      if @vcloud_hosts.length != vm_names.length
+      vm_names = @hosts.map {|h| h['vmhostname'] }.compact
+      if @hosts.length != vm_names.length
         @logger.warn "Some hosts did not have vmhostname set correctly! This likely means VM provisioning was not successful"
       end
 

data/lib/beaker/hypervisor/vsphere.rb

@@ -6,7 +6,7 @@ module Beaker
     def initialize(vsphere_hosts, options)
       @options = options
       @logger = options[:logger]
-      @vsphere_hosts = vsphere_hosts
+      @hosts = vsphere_hosts
     end
 
     def provision
@@ -18,7 +18,7 @@ module Beaker
       vsphere_helper = VsphereHelper.new( vsphere_credentials )
 
       vsphere_vms = {}
-      @vsphere_hosts.each do |h|
+      @hosts.each do |h|
         name = h["vmname"] || h.name
         vsphere_vms[name] = h["snapshot"]
       end
@@ -60,7 +60,7 @@ module Beaker
 
       vsphere_helper = VsphereHelper.new( vsphere_credentials )
 
-      vm_names = @vsphere_hosts.map {|h| h['vmname'] || h.name }
+      vm_names = @hosts.map {|h| h['vmname'] || h.name }
       vms = vsphere_helper.find_vms vm_names
       vm_names.each do |name|
         unless vm = vms[name]

data/lib/beaker/network_manager.rb

@@ -7,15 +7,17 @@
 end
 
 module Beaker
+  #Object that holds all the provisioned and non-provisioned virtual machines.
+  #Controls provisioning, configuration, validation and cleanup of those virtual machines.
   class NetworkManager
-    HYPERVISOR_TYPES = ['solaris', 'blimpy', 'vsphere', 'fusion', 'aix', 'vcloud', 'vagrant']
 
+    #Determine if a given host should be provisioned.
+    #Provision if:
+    # - only if we are running with ---provision
+    # - only if we have a hypervisor
+    # - only if either the specific hosts has no specification or has 'provision' in its config
+    # - always if it is a vagrant box (vagrant boxes are always provisioned as they always need ssh key hacking)
     def provision? options, host 
-      #provision this box
-      # - only if we are running with --provision
-      # - only if we have a hypervisor
-      # - only if either the specific hosts has no specification or has 'provision' in its config
-      # - always if it is a vagrant box (vagrant boxes are always provisioned as they always need ssh key hacking)
       command_line_says = options[:provision] 
       host_says = host['hypervisor'] && (host.has_key?('provision') ? host['provision'] : true) 
       (command_line_says && host_says) or (host['hypervisor'] =~/vagrant/)
@@ -25,55 +27,67 @@ module Beaker
       @logger = logger
       @options = options
       @hosts = []
-      @virtual_machines = {}
-      @noprovision_machines = []
+      @machines = {}
+      @hypervisors = nil
     end
 
+    #Provision all virtual machines.  Provision machines according to their set hypervisor, if no hypervisor
+    #is selected assume that the described hosts are already up and reachable and do no provisioning.
     def provision
-      #sort hosts into those to be provisioned and those to use non-provisioned
+      if @hypervisors
+        cleanup
+      end
+      @hypervisors = {}
+      #sort hosts by their hypervisor, use hypervisor 'none' if no hypervisor is specified 
       @options['HOSTS'].each_key do |name|
         host = @options['HOSTS'][name]
-        hypervisor = host['hypervisor']
-        if provision?(@options, host)
-          raise "Invalid hypervisor: #{hypervisor} (#{name})" unless HYPERVISOR_TYPES.include? hypervisor
-          @logger.debug "Hypervisor for #{name} is #{hypervisor}"
-          @virtual_machines[hypervisor] = [] unless @virtual_machines[hypervisor]
-          @virtual_machines[hypervisor] << name
-        else #this is a non-provisioned machine, deal with it without hypervisors
-          @logger.debug "No hypervisor for #{name}, connecting to host without provisioning"
-          @noprovision_machines << name
-        end
+        hypervisor = host['hypervisor'] 
+        hypervisor = provision?(@options, host) ? host['hypervisor'] : 'none'
+        @logger.debug "Hypervisor for #{name} is #{hypervisor}"
+        @machines[hypervisor] = [] unless @machines[hypervisor]
+        @machines[hypervisor] << Beaker::Host.create(name, @options)
       end
 
-      @provisioned_set = {}
-      @virtual_machines.each do |type, names|
-        hosts_for_type = []
-        #set up host objects for provisioned provisioned_set
-        names.each do |name|
-          host = Beaker::Host.create(name, @options)
-          hosts_for_type << host
-        end
-        @provisioned_set[type] = Beaker::Hypervisor.create(type, hosts_for_type, @options)
-        @hosts << hosts_for_type
-      end
-      @noprovision_machines.each do |name|
-        @hosts << Beaker::Host.create(name, @options)
+      @machines.each_key do |type|
+        @hypervisors[type] = Beaker::Hypervisor.create(type, @machines[type], @options)
+        @hosts << @machines[type]
       end
       @hosts = @hosts.flatten
       @hosts
     end
 
+    #Validate all provisioned machines, ensure that required packages are installed - if they are missing
+    #attempt to add them.
+    #@raise [Exception] Raise an exception if virtual machines fail to be validated
+    def validate
+      if @hypervisors
+        @hypervisors.each_key do |type|
+          @hypervisors[type].validate
+        end
+      end
+    end
+
+    #Configure all provisioned machines, adding any packages or settings required for SUTs
+    #@raise [Exception] Raise an exception if virtual machines fail to be configured
+    def configure
+      if @hypervisors
+        @hypervisors.each_key do |type|
+          @hypervisors[type].configure
+        end
+      end
+    end
+
+    #Shut down network connections and revert all provisioned virtual machines
     def cleanup
       #shut down connections
       @hosts.each {|host| host.close }
 
-      if @provisioned_set
-        @provisioned_set.each_key do |type|
-          if @provisioned_set[type]
-            @provisioned_set[type].cleanup
-          end
+      if @hypervisors
+        @hypervisors.each_key do |type|
+          @hypervisors[type].cleanup
         end
       end
+      @hypervisors = nil
     end
 
   end