rspec-system 2.5.1 → 2.6.0

data/lib/rspec-system/node_set/{vagrant.rb → vagrant_base.rb}

@@ -5,13 +5,22 @@ require 'net/scp'
 require 'rspec-system/node_set/base'
 
 module RSpecSystem
-  # A NodeSet implementation for Vagrant.
-  class NodeSet::Vagrant < RSpecSystem::NodeSet::Base
+  # An abstract NodeSet implementation for Vagrant.
+  class NodeSet::VagrantBase < RSpecSystem::NodeSet::Base
     include RSpecSystem::Log
     include RSpecSystem::Util
 
-    ENV_TYPE = 'vagrant'
-    VALID_VM_OPTIONS = ['ip']
+    # @!group Abstract Methods
+
+    # The vagrant specific provider name
+    #
+    # @return [String] name of the provider as used by `vagrant --provider`
+    # @abstract override to return the name of the vagrant provider
+    def vagrant_provider_name
+      raise RuntimeError, "Unimplemented method #vagrant_provider_name"
+    end
+
+    # @!group Common Methods
 
     # Creates a new instance of RSpecSystem::NodeSet::Vagrant
     #
@@ -21,30 +30,49 @@ module RSpecSystem
     # @param options [Hash] options Hash
     def initialize(setname, config, custom_prefabs_path, options)
       super
-      @vagrant_path = File.expand_path(File.join(RSpec.configuration.system_tmp, 'vagrant_projects', setname))
+      @vagrant_path = File.expand_path(File.join(RSpec.configuration.rs_tmp, 'vagrant_projects', setname))
 
-      RSpec.configuration.rspec_storage[:nodes] ||= {}
+      RSpec.configuration.rs_storage[:nodes] ||= {}
     end
 
-    # Setup the NodeSet by starting all nodes.
+    # Launch the nodes
     #
     # @return [void]
-    def setup
+    def launch
       create_vagrantfile()
 
       teardown()
 
-      output << bold(color("localhost$", :green)) << " vagrant up\n"
-      vagrant("up")
+      nodes.each do |k,v|
+        RSpec.configuration.rs_storage[:nodes][k] ||= {}
+        output << bold(color("localhost$", :green)) << " vagrant up #{k}\n"
+        vagrant("up #{k} --provider=#{vagrant_provider_name}")
+      end
+
+      nil
+    end
 
-      # Establish ssh connectivity
+    # Connect to the nodes
+    #
+    # @return [void]
+    def connect
       nodes.each do |k,v|
-        output << bold(color("localhost$", :green)) << " ssh #{k}\n"
-        chan = Net::SSH.start(k, 'vagrant', :config => ssh_config)
+        RSpec.configuration.rs_storage[:nodes][k] ||= {}
+
+        chan = ssh_connect(:host => k, :user => 'vagrant', :net_ssh_options => {
+          :config => ssh_config
+        })
 
-        RSpec.configuration.rspec_storage[:nodes][k] = {
-          :ssh => chan,
-        }
+        # Copy the authorized keys from vagrant user to root then reconnect
+        cmd = 'mkdir /root/.ssh ; cp /home/vagrant/.ssh/authorized_keys /root/.ssh'
+
+        output << bold(color("#{k}$ ", :green)) << cmd << "\n"
+        ssh_exec!(chan, "cd /tmp && sudo sh -c #{shellescape(cmd)}")
+
+        chan = ssh_connect(:host => k, :user => 'root', :net_ssh_options => {
+          :config => ssh_config
+        })
+        RSpec.configuration.rs_storage[:nodes][k][:ssh] = chan
       end
 
       nil
@@ -55,7 +83,7 @@ module RSpecSystem
     # @return [void]
     def teardown
       nodes.each do |k,v|
-        storage = RSpec.configuration.rspec_storage[:nodes][k]
+        storage = RSpec.configuration.rs_storage[:nodes][k]
 
         next if storage.nil?
 
@@ -67,49 +95,8 @@ module RSpecSystem
         output << bold(color("localhost$", :green)) << " vagrant destroy --force\n"
         vagrant("destroy --force")
       end
-      nil
-    end
 
-    # Run a command on a host in the NodeSet.
-    #
-    # @param opts [Hash] options
-    # @return [Hash] a hash containing :exit_code, :stdout and :stderr
-    def run(opts)
-      dest = opts[:n].name
-      cmd = opts[:c]
-
-      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
-      ssh_exec!(ssh, "cd /tmp && sudo sh -c #{shellescape(cmd)}")
-    end
-
-    # Transfer files to a host in the NodeSet.
-    #
-    # @param opts [Hash] options
-    # @return [Boolean] returns true if command succeeded, false otherwise
-    # @todo This is damn ugly, because we ssh in as vagrant, we copy to a temp
-    #   path then move it later. Its slow and brittle and we need a better
-    #   solution. Its also very Linux-centrix in its use of temp dirs.
-    def rcp(opts)
-      dest = opts[:d].name
-      source = opts[:sp]
-      dest_path = opts[:dp]
-
-      # Grab a remote path for temp transfer
-      tmpdest = tmppath
-
-      # Do the copy and print out results for debugging
-      cmd = "scp -r '#{source}' #{dest}:#{tmpdest}"
-      output << bold(color("localhost$", :green)) << " #{cmd}\n"
-      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
-      ssh.scp.upload! source.to_s, tmpdest.to_s, :recursive => true
-
-      # Now we move the file into their final destination
-      result = shell(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}")
-      if result[:exit_code] == 0
-        return true
-      else
-        return false
-      end
+      nil
     end
 
     # Create the Vagrantfile for the NodeSet.
@@ -121,7 +108,7 @@ module RSpecSystem
       File.open(File.expand_path(File.join(@vagrant_path, "Vagrantfile")), 'w') do |f|
         f.write('Vagrant.configure("2") do |c|' + "\n")
         nodes.each do |k,v|
-          ps = v.provider_specifics['vagrant']
+          ps = v.provider_specifics[provider_type]
           default_options = { 'mac' => randmac }
           options = default_options.merge(v.options || {})
 
@@ -130,8 +117,8 @@ module RSpecSystem
           node_config << "    v.vm.box = '#{ps['box']}'\n"
           node_config << "    v.vm.box_url = '#{ps['box_url']}'\n" unless ps['box_url'].nil?
           node_config << customize_vm(k,options)
-          node_config << "    v.vm.provider 'virtualbox' do |vbox|\n"
-          node_config << customize_virtualbox(k,options)
+          node_config << "    v.vm.provider '#{vagrant_provider_name}' do |prov, override|\n"
+          node_config << customize_provider(k,options)
           node_config << "    end\n"
           node_config << "  end\n"
 
@@ -142,26 +129,15 @@ module RSpecSystem
       nil
     end
 
-    # Adds virtualbox customization to the Vagrantfile
-    # 
+    # Add provider specific customization to the Vagrantfile
+    #
     # @api private
     # @param name [String] name of the node
     # @param options [Hash] customization options
-    # @return [String] a series of vbox.customize lines
-    def customize_virtualbox(name,options)
-      custom_config = ""
-      options.each_pair do |key,value|
-        next if VALID_VM_OPTIONS.include?(key)
-        case key
-        when 'cpus','memory'
-          custom_config << "    vbox.customize ['modifyvm', :id, '--#{key}','#{value}']\n"
-        when 'mac'
-          custom_config << "    vbox.customize ['modifyvm', :id, '--macaddress1','#{value}']\n"
-        else
-          log.warn("Skipped invalid custom option for node #{name}: #{key}=#{value}")
-        end
-      end
-      custom_config
+    # @return [String] a series of prov.customize lines
+    # @abstract Overridet ot provide your own customizations
+    def customize_provider(name,options)
+      ''
     end
 
     # Adds VM customization to the Vagrantfile
@@ -207,9 +183,6 @@ module RSpecSystem
     #
     # @api private
     # @param args [String] args to vagrant
-    # @todo This seems a little too specific these days, might want to
-    #   generalize. It doesn't use systemu, because we want to see the output
-    #   immediately, but still - maybe we can make systemu do that.
     def vagrant(args)
       Dir.chdir(@vagrant_path) do
         system("vagrant #{args}")
@@ -217,5 +190,13 @@ module RSpecSystem
       nil
     end
 
+    # Returns a list of options that apply to all types of vagrant providers
+    #
+    # @return [Array<String>] Array of options
+    # @api private
+    def global_vagrant_options
+      ['ip']
+    end
+
   end
 end

data/lib/rspec-system/node_set/vagrant_virtualbox.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+require 'systemu'
+require 'net/ssh'
+require 'net/scp'
+require 'rspec-system/node_set/vagrant_base'
+
+module RSpecSystem
+  # A NodeSet implementation for Vagrant.
+  class NodeSet::VagrantVirtualbox < NodeSet::VagrantBase
+    PROVIDER_TYPE = 'vagrant_virtualbox'
+
+    # Name of provider
+    #
+    # @return [String] name of the provider as used by `vagrant --provider`
+    def vagrant_provider_name
+      'virtualbox'
+    end
+
+    # Adds virtualbox customization to the Vagrantfile
+    #
+    # @api private
+    # @param name [String] name of the node
+    # @param options [Hash] customization options
+    # @return [String] a series of vbox.customize lines
+    def customize_provider(name,options)
+      custom_config = ""
+      options.each_pair do |key,value|
+        next if global_vagrant_options.include?(key)
+        case key
+        when 'cpus','memory'
+          custom_config << "    prov.customize ['modifyvm', :id, '--#{key}','#{value}']\n"
+        when 'mac'
+          custom_config << "    prov.customize ['modifyvm', :id, '--macaddress1','#{value}']\n"
+        else
+          log.warn("Skipped invalid custom option for node #{name}: #{key}=#{value}")
+        end
+      end
+      custom_config
+    end
+  end
+end

data/lib/rspec-system/node_set/vagrant_vmware_fusion.rb

@@ -0,0 +1,43 @@
+require 'fileutils'
+require 'systemu'
+require 'net/ssh'
+require 'net/scp'
+require 'rspec-system/node_set/vagrant_base'
+
+module RSpecSystem
+  # A NodeSet implementation for Vagrant using the vmware_fusion provider
+  class NodeSet::VagrantVmwareFusion < NodeSet::VagrantBase
+    PROVIDER_TYPE = 'vagrant_vmware_fusion'
+
+    # Name of provider
+    #
+    # @return [String] name of the provider as used by `vagrant --provider`
+    def vagrant_provider_name
+      'vmware_fusion'
+    end
+
+    # Adds virtualbox customization to the Vagrantfile
+    #
+    # @api private
+    # @param name [String] name of the node
+    # @param options [Hash] customization options
+    # @return [String] a series of vbox.customize lines
+    def customize_provider(name,options)
+      custom_config = ""
+      options.each_pair do |key,value|
+        next if global_vagrant_options.include?(key)
+        case key
+        when 'cpus'
+          custom_config << "    prov.vmx['numvcpus'] = '#{value}'\n"
+        when 'memory'
+          custom_config << "    prov.vmx['memsize'] = '#{value}'\n"
+        when 'mac'
+          custom_config << "    prov.vmx['ethernet0.generatedAddress'] = '#{value}'\n"
+        else
+          log.warn("Skipped invalid custom option for node #{name}: #{key}=#{value}")
+        end
+      end
+      custom_config
+    end
+  end
+end

data/lib/rspec-system/node_set/vsphere.rb

@@ -10,7 +10,7 @@ module RSpecSystem
   class NodeSet::Vsphere < RSpecSystem::NodeSet::Base
     include RSpecSystem::Log
 
-    ENV_TYPE = 'vsphere'
+    PROVIDER_TYPE = 'vsphere'
 
     attr_reader :vmconf
 
@@ -26,8 +26,7 @@ module RSpecSystem
       # Valid supported ENV variables
       options = [:host, :user, :pass, :dest_dir, :template_dir, :rpool,
         :cluster, :ssh_keys, :datacenter, :node_timeout, :node_tries,
-        :node_sleep, :ssh_timeout, :ssh_tries, :ssh_sleep, :connect_timeout,
-        :connect_tries]
+        :node_sleep, :connect_timeout, :connect_tries]
 
       # Devise defaults, use fog configuration from file system if it exists
       defaults = load_fog_config()
@@ -35,9 +34,6 @@ module RSpecSystem
         :node_timeout => 1200,
         :node_tries => 10,
         :node_sleep => 30 + rand(60),
-        :ssh_timeout => 60,
-        :ssh_tries => 10,
-        :ssh_sleep => 4,
         :connect_timeout => 60,
         :connect_tries => 10,
       })
@@ -45,8 +41,8 @@ module RSpecSystem
       # Traverse the ENV variables and load them into our config automatically
       @vmconf = defaults
       ENV.each do |k,v|
-        next unless k =~/^RSPEC_VSPHERE_/
-        var = k.sub(/^RSPEC_VSPHERE_/, '').downcase.to_sym
+        next unless k =~/^RS(PEC)?_VSPHERE_/
+        var = k.sub(/^RS(PEC)?_VSPHERE_/, '').downcase.to_sym
         unless options.include?(var)
           log.info("Ignoring unknown environment variable #{k}")
           next
@@ -55,7 +51,7 @@ module RSpecSystem
       end
 
       # Initialize node storage if not already
-      RSpec.configuration.rspec_storage[:nodes] ||= {}
+      RSpec.configuration.rs_storage[:nodes] ||= {}
     end
 
     # Retrieves fog configuration if it exists
@@ -82,7 +78,7 @@ module RSpecSystem
     # The connection handling automatically retries upon failure.
     #
     # @api private
-    def with_connection(&block)
+    def with_vsphere_connection(&block)
       vim = nil
       dc = nil
 
@@ -122,11 +118,11 @@ module RSpecSystem
 
     # @!group NodeSet Methods
 
-    # Setup the NodeSet by starting all nodes.
+    # Launch the nodes
     #
     # @return [void]
-    def setup
-      with_connection do |dc|
+    def launch
+      with_vsphere_connection do |dc|
         # Traverse folders to find target folder for new vm's and template
         # folders. Automatically create the destination folder if it doesn't
         # exist.
@@ -148,10 +144,7 @@ module RSpecSystem
 
         log.info "Launching VSphere instances one by one"
         nodes.each do |k,v|
-          #####################
-          # Node launching step
-          #####################
-          RSpec.configuration.rspec_storage[:nodes][k] ||= {}
+          RSpec.configuration.rs_storage[:nodes][k] ||= {}
 
           # Obtain the template name to use
           ps = v.provider_specifics['vsphere']
@@ -165,7 +158,7 @@ module RSpecSystem
 
           # Create a random name for the new VM
           vm_name = "rspec-system-#{k}-#{random_string(10)}"
-          RSpec.configuration.rspec_storage[:nodes][k][:vm] = vm_name
+          RSpec.configuration.rs_storage[:nodes][k][:vm] = vm_name
 
           log.info "Launching VSphere instance #{k} with template #{vmconf[:template_dir]}/#{template} as #{vmconf[:dest_dir]}/#{vm_name}"
 
@@ -201,7 +194,7 @@ module RSpecSystem
               time3 = Time.now
               log.info "#{k}> Time in seconds waiting for IP: #{time3 - time2}"
             end
-            RSpec.configuration.rspec_storage[:nodes][k][:ipaddress] = ipaddress
+            RSpec.configuration.rs_storage[:nodes][k][:ipaddress] = ipaddress
           rescue Timeout::Error, SystemCallError => e
             tries += 1
             log.error("VM launch attempt #{tries} failed with: " + e.message)
@@ -227,47 +220,31 @@ module RSpecSystem
               raise e
             end
           end
+
           time2 = Time.now
           log.info "#{k}> Took #{time2 - start_time} seconds to boot instance"
+        end
+      end
 
-          #####################
-          # SSH Step
-          #####################
-          tries = 0
-          begin
-            timeout(vmconf[:ssh_timeout]) do
-              output << bold(color("localhost$", :green)) << " ssh #{k}\n"
-              chan = Net::SSH.start(ipaddress, 'root', {
-                :keys => vmconf[:ssh_keys].split(":"),
-              })
+      nil
+    end
 
-              RSpec.configuration.rspec_storage[:nodes][k][:ssh] = chan
-            end
-          rescue Timeout::Error, SystemCallError => e
-            tries += 1
-            output << e.message << "\n"
-            if tries < vmconf[:ssh_tries]
-              log.info("Sleeping for #{vmconf[:ssh_sleep]} seconds then trying again ...")
-              sleep vmconf[:ssh_sleep]
-              retry
-            else
-              log.error("Inability to connect to host, already tried #{tries} times, throwing exception")
-              raise e
-            end
-          end
-          time3 = Time.now
-          log.info "#{k}> Took #{time3 - start_time} seconds for instance to be ready"
-
-          ######################
-          # Do initial box setup
-          ######################
-          hosts = <<-EOS
-127.0.0.1 localhost localhost.localdomain
-#{ipaddress}  #{k}
-          EOS
-          shell(:n => k, :c => "echo '#{hosts}' > /etc/hosts")
-          shell(:n => k, :c => "hostname #{k}")
-        end
+    # Connect to the nodes
+    #
+    # @return [void]
+    def connect
+      nodes.each do |k,v|
+        rs_storage = RSpec.configuration.rs_storage[:nodes][k]
+        raise RuntimeError, "No internal storage for node #{k}" if rs_storage.nil?
+
+        ipaddress = rs_storage[:ipaddress]
+        raise RuntimeError, "No ipaddress provided from launch phase for node #{k}" if ipaddress.nil?
+
+        chan = ssh_connect(:host => k, :user => 'root', :net_ssh_options => {
+          :keys => vmconf[:ssh_keys].split(":"),
+          :host_name => ipaddress,
+        })
+        RSpec.configuration.rs_storage[:nodes][k][:ssh] = chan
       end
 
       nil
@@ -277,9 +254,9 @@ module RSpecSystem
     #
     # @return [void]
     def teardown
-      with_connection do |dc|
+      with_vsphere_connection do |dc|
         nodes.each do |k,v|
-          storage = RSpec.configuration.rspec_storage[:nodes][k]
+          storage = RSpec.configuration.rs_storage[:nodes][k]
 
           if storage.nil?
             log.info "No entry for node #{k}, no teardown necessary"
@@ -325,42 +302,5 @@ module RSpecSystem
       nil
     end
 
-    # Run a command on a host in the NodeSet.
-    #
-    # @param opts [Hash] options
-    # @return [Hash] a hash containing :exit_code, :stdout and :stderr
-    def run(opts)
-      dest = opts[:n].name
-      cmd = opts[:c]
-
-      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
-      ssh_exec!(ssh, cmd)
-    end
-
-    # Transfer files to a host in the NodeSet.
-    #
-    # @param opts [Hash] options
-    # @return [Boolean] returns true if command succeeded, false otherwise
-    # @todo This is damn ugly, because we ssh in as vagrant, we copy to a temp
-    #   path then move it later. Its slow and brittle and we need a better
-    #   solution. Its also very Linux-centrix in its use of temp dirs.
-    def rcp(opts)
-      dest = opts[:d].name
-      source = opts[:sp]
-      dest_path = opts[:dp]
-
-      # Do the copy and print out results for debugging
-      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
-
-      begin
-        ssh.scp.upload! source.to_s, dest_path.to_s, :recursive => true
-      rescue => e
-        log.error("Error with scp of file #{source} to #{dest}:#{dest_path}")
-        raise e
-      end
-
-      true
-    end
-
   end
 end