beaker 3.23.0 → 3.24.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmM3NDg3NTZhMTAzZjM5Mzc5NGMzMDJjMjU1MDQ4NDY5NmRkZGViOA==
+    N2FiNDY2YjhkNzI2MThmMjJiNWE4NTQyZDBiYjkyZTU3ZGMxYzViYQ==
   data.tar.gz: !binary |-
-    ODg4NTRkZjBmZDEyZmE3NDhiNjI3OTNlYWYxOTk5ZmM4ZDIwMmE5Ng==
+    MGRiYzJiNDU4NDg3ZTdmYTkzZDk2YjA4NmU2MDE1MzM4ZGIyZGU2Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZjgwNzAyZTIxZGNjYzA1MDgwYzVkMTEyZjBjZTU0NTU3ZDQ5ODNiNTA4OTk4
-    NGI4OTljMmJiMmM3N2M4YWNkNTliNzQ1YTExMmU3MzJhYmIzZmFmOTNhYjYx
-    MWFhNGEzMjgzOTRlM2YzNzRlN2Q0YzhlOTdjZmExNmNkYThmOWM=
+    NGU5ZDg5NGIxMzUxYTNjYzc1ZWY4OGNhYzEwMTExYTllOGEzY2I1MjE2ZTQ3
+    MzViOTUyNmI5MmVmYzMyMjE5MTljOWI5YTAwZDdlYzZkNzMwMGQ4NDNiYjc3
+    MjFmZjVmN2U4YTNkN2NlYjUyNGUyOTY3ODIwMjU3MjUwMDE0MDI=
   data.tar.gz: !binary |-
-    MTNkMmUzMWQ1MjBhZDY3OWM5ZjhiMzYzYzMxYTRiYTZkMDIxMzc2MjM5ZTI0
-    MzA3MGExYWE2OWQzYmVmZDg1MWJkOWMxZDg1MjMzNjNkNWIwMTkwNTcyMTUw
-    MmI3NDQwY2RiYThiYjA3ZDE3YmE5OWE3ZWFjYmFkMThlMmU1Yjg=
+    NWQ0YzQ3NjViMWIxNDYwMjUxZDZiNTZkOTY0MTE1NTE5NjE3Y2UyYTJhYjY3
+    MTY1ODYwZjZmOGZiYTJmNDFiZmFmNDM5NTBmNDc2NDlkZmNmZTM1OTc1NmRm
+    NDlkOTI4ZTQzZDkyNGY3YWMwMzZkNGU2OGE3Nzc3YjllZjQ5NzQ=

data/docs/how_to/ssh_connection_preference.md

@@ -0,0 +1,47 @@
+# Set SSH connection methods preference
+
+Setting up a SSH connection to hosts can be tricky. Beaker supports three methods to SSH to hosts:
+
+1. `ip`
+2. `vmhostname (dns name)`
+3. `hostname`
+
+Beaker tries to SSH to hosts using these methods in a particular preference (order). Default preference is mentioned above. We allow hypervisor authors and end users to provide an array of these methods that reflects their preference.
+
+### Why set a preference?
+
+Depending upon your hypervisor, your host could have specific method that it uses to SSH better and faster than other methods. For example, hosts generated by vmpooler connects better with `vmhostname` as some change their ip adderess on restart. Therefore vmpooler hypervisor sets its connection preference to use vmhostname first.
+
+### Setting SSH connection preference at hypervisor level
+
+Hypervisor authors can set SSH connection preference. The only thing they have to do is override the `connection_preference` method set in [hypervisor.rb](https://github.com/puppetlabs/beaker/blob/master/lib/beaker/hypervisor.rb) file in their own hypervisor file.
+
+For example, `beaker-vmpooler` overriding this in [vmpooler.rb](https://github.com/puppetlabs/beaker-vmpooler/blob/master/lib/beaker/hypervisor/vmpooler.rb) file.
+
+### Setting SSH connection methods in hosts file
+
+End users can override the connection preference that is default or set by their hypervisor. This can be done from your hosts file. All you need to do is provide a `ssh_preference` for each host. The value of this key should be an array of the methods specified above in an order you prefer. Beaker then will attempt to SSH to the hosts in that particular order.
+
+Example of a host file:
+
+```
+HOSTS:
+  ubuntu1604-64-1:
+    hypervisor: vmpooler
+    platform: ubuntu-16.04-amd64
+    template: ubuntu-1604-x86_64
+    ssh_preference: ['vmhostname', 'hostname', 'ip']
+    roles:
+    - agent
+    - default
+  ubuntu1604-64-2:
+    hypervisor: vmpooler
+    platform: ubuntu-16.04-amd64
+    template: ubuntu-1604-x86_64
+    ssh_preference: ['ip, 'vmhostname']
+    roles:
+    - agent
+CONFIG:
+  nfs_server: none
+  consoleport: 443
+```

data/lib/beaker/host.rb

@@ -276,7 +276,7 @@ module Beaker
       # create new connection object if necessary
       @connection ||= SshConnection.connect( { :ip => self['ip'], :vmhostname => self['vmhostname'], :hostname => @name },
                                              self['user'],
-                                             self['ssh'], { :logger => @logger } )
+                                             self['ssh'], { :logger => @logger, :ssh_connection_preference => self[:ssh_connection_preference]} )
       # update connection information
       if self['ip'] && (@connection.ip != self['ip'])
         @connection.ip = self['ip']

data/lib/beaker/hypervisor.rb

@@ -37,6 +37,7 @@ module Beaker
         end
 
       hypervisor = hyper_class.new(hosts_to_provision, options)
+      self.set_ssh_connection_preference(hosts_to_provision, hypervisor)
       hypervisor.provision if options[:provision]
 
       hypervisor
@@ -57,6 +58,24 @@ module Beaker
       nil
     end
 
+    DEFAULT_CONNECTION_PREFERENCE = [:ip, :vmhostname, :hostname]
+    # SSH connection method preference. Can be overwritten by hypervisor to change the order
+    def connection_preference(host)
+      DEFAULT_CONNECTION_PREFERENCE
+    end
+
+    def self.set_ssh_connection_preference(hosts_to_provision, hypervisor)
+      hosts_to_provision.each do |host|
+        ssh_methods = hypervisor.connection_preference(host) + DEFAULT_CONNECTION_PREFERENCE
+        if host[:ssh_preference]
+          # If user has provided ssh_connection_preference in hosts file then concat the preference provided by hypervisor
+          # Followed by concatenating the default preference and keeping the unique once
+          ssh_methods = host[:ssh_preference] + ssh_methods
+        end
+        host[:ssh_connection_preference] = ssh_methods.uniq
+      end
+    end
+
     #Proxy package managers on tests hosts created by this hypervisor, runs before validation and configuration.
     def proxy_package_manager
       if @options[:package_proxy]

data/lib/beaker/ssh_connection.rb

@@ -6,7 +6,9 @@ module Beaker
   class SshConnection
 
     attr_accessor :logger
-    attr_accessor :ip, :vmhostname, :hostname
+    attr_accessor :ip, :vmhostname, :hostname, :ssh_connection_preference
+
+    SUPPORTED_CONNECTION_METHODS = [:ip, :vmhostname, :hostname]
 
     RETRYABLE_EXCEPTIONS = [
       SocketError,
@@ -33,6 +35,7 @@ module Beaker
       @ssh_opts = ssh_opts
       @logger = options[:logger]
       @options = options
+      @ssh_connection_preference = @options[:ssh_connection_preference]
     end
 
     def self.connect name_hash, user = 'root', ssh_opts = {}, options = {}
@@ -65,22 +68,24 @@ module Beaker
 
     # connect to the host
     def connect
-      #try three ways to connect to host (vmhostname, ip, hostname)
-      methods = []
-      if @vmhostname
-        @ssh ||= connect_block(@vmhostname, @user, @ssh_opts)
-        methods << "vmhostname (#{@vmhostname})"
-      end
-      if @ip && !@ssh
-        @ssh ||= connect_block(@ip, @user, @ssh_opts)
-        methods << "ip (#{@ip})"
-      end
-      if @hostname && !@ssh
-        @ssh ||= connect_block(@hostname, @user, @ssh_opts)
-        methods << "hostname (#{@hostname})"
+      # Try three ways to connect to host (vmhostname, ip, hostname)
+      # Try each method in turn until we succeed
+      methods = @ssh_connection_preference.dup
+      while (not @ssh) && (not methods.empty?) do
+        unless instance_variable_get("@#{methods[0]}").nil?
+          if SUPPORTED_CONNECTION_METHODS.include?(methods[0])
+            @ssh = connect_block(instance_variable_get("@#{methods[0].to_s}"), @user, @ssh_opts)
+          else
+            @logger.warn "Beaker does not support #{methods[0]} to SSH to host, trying next available method."
+            @ssh_connection_preference.delete(methods[0])
+          end
+        else
+          @logger.warn "Skipping #{methods[0]} method to ssh to host as its value is not set. Refer to https://github.com/puppetlabs/beaker/tree/master/docs/how_to/ssh_connection_preference.md to remove this warning"
+        end
+        methods.shift
       end
-      if not @ssh
-        @logger.error "Failed to connect to #{@hostname}, attempted #{methods.join(', ')}"
+      unless @ssh
+        @logger.error "Failed to connect to #{@hostname}, attempted #{@ssh_connection_preference.join(', ')}"
         raise RuntimeError, "Cannot connect to #{@hostname}"
       end
       @ssh

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '3.23.0'
+    STRING = '3.24.0'
   end
 end

data/spec/beaker/hypervisor/hypervisor_spec.rb

@@ -2,15 +2,45 @@ require 'spec_helper'
 
 module Beaker
   describe Hypervisor do
-    let( :hypervisor ) { Beaker::Hypervisor }
+    let( :hosts ) { make_hosts( { :platform => 'el-5' } ) }
+
+    context "#create" do
+      let( :hypervisor ) { Beaker::Hypervisor }
+
+      it "includes custom hypervisor and call set_ssh_connection_preference" do
+        allow(hypervisor).to receive(:set_ssh_connection_preference).with([], hypervisor)
+        expect{ hypervisor.create('custom_hypervisor', [], make_opts() )}.to raise_error(RuntimeError, "Invalid hypervisor: custom_hypervisor")
+      end
+
+      it "sets ssh connection preference if connection_preference method is not overwritten" do
+        hypervisor.create('none', hosts, make_opts())
+        expect(hosts[0][:ssh_connection_preference]).to eq([:ip,:vmhostname,:hostname])
+      end
+
+      it "concats overriding connection_preference array with the default connection_preference" do
+        allow(hypervisor).to receive(:connection_preference).and_return([:my,:invalid,:method_name])
+        hypervisor.set_ssh_connection_preference(hosts, hypervisor)
+        expect(hosts[0][:ssh_connection_preference]).to eq([:my,:invalid,:method_name,:ip,:vmhostname,:hostname])
+      end
+
+      it "removes unique elements from concated array while preserving order of overriding methods" do
+        allow(hypervisor).to receive(:connection_preference).and_return([:my,:ip,:vmhostname,:method_name])
+        hypervisor.set_ssh_connection_preference(hosts, hypervisor)
+        expect(hosts[0][:ssh_connection_preference]).to eq([:my,:ip,:vmhostname,:method_name,:hostname])
+      end
+
+      it "gives highest precedence to preference specified in host file followed by hypervisor" do
+        hosts[0].options[:ssh_preference] = ['set', 'in', 'hostfile']
+        hypervisor.create('none', hosts, make_opts())
+        allow(hypervisor).to receive(:connection_preference).and_return([:hypervisor, :pref])
+        hypervisor.set_ssh_connection_preference(hosts, hypervisor)
+        expect(hosts[0][:ssh_connection_preference]).to eq(['set', 'in', 'hostfile', :hypervisor, :pref, :ip, :vmhostname, :hostname])
+      end
 
-    it "includes custom hypervisor" do
-      expect{ hypervisor.create('custom_hypervisor', [], make_opts() )}.to raise_error(RuntimeError, "Invalid hypervisor: custom_hypervisor")
     end
 
     context "#configure" do
       let( :options ) { make_opts.merge({ 'logger' => double().as_null_object }) }
-      let( :hosts ) { make_hosts( { :platform => 'el-5' } ) }
       let( :hypervisor ) { Beaker::Hypervisor.new( hosts, options ) }
 
       context 'if :timesync option set true on host' do

data/spec/beaker/ssh_connection_spec.rb

@@ -5,7 +5,7 @@ module Beaker
   describe SshConnection do
     let( :user )      { 'root'    }
     let( :ssh_opts )  { { keepalive: true, keepalive_interval: 2 } }
-    let( :options )   { { :logger => double('logger').as_null_object }  }
+    let( :options )   { { :logger => double('logger').as_null_object, :ssh_connection_preference => [:ip, :vmhostname, :hostname]} }
     let( :ip )        { "default.ip.address" }
     let( :vmhostname ){ "vmhostname" }
     let( :hostname)   { "my_host" }
@@ -17,26 +17,24 @@ module Beaker
     end
 
     it 'self.connect creates connects and returns a proxy for that connection' do
-      # grrr
-      expect( Net::SSH ).to receive(:start).with( vmhostname, user, ssh_opts ).and_return(true)
+      expect( Net::SSH ).to receive(:start).with( "default.ip.address", user, ssh_opts ).and_return(true)
       connection_constructor = SshConnection.connect name_hash, user, ssh_opts, options
       expect( connection_constructor ).to be_a_kind_of SshConnection
     end
 
     it 'connect creates a new connection' do
-      expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts).and_return(true)
+      expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts).and_return(true)
       connection.connect
     end
 
     it 'connect caches its connection' do
-      expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts ).once.and_return true
-      connection.connect
+      expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts ).once.and_return true
       connection.connect
     end
 
-    it 'attempts to connect by ip address if vmhostname connection fails' do
-      expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts).and_return(false)
-      expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts).and_return(true).once
+    it 'attempts to connect by vmhostname address if ip connection fails' do
+      expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts).and_return(false)
+      expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts).and_return(true).once
       expect( Net::SSH ).to receive( :start ).with( hostname, user, ssh_opts).never
       connection.connect
     end
@@ -53,7 +51,7 @@ module Beaker
 
       it 'runs ssh close' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         allow( mock_ssh).to receive( :closed? ).once.and_return(false)
@@ -63,7 +61,7 @@ module Beaker
 
       it 'sets the @ssh variable to nil' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         allow( mock_ssh).to receive( :closed? ).once.and_return(false)
@@ -76,7 +74,7 @@ module Beaker
       it 'calls ssh shutdown & re-raises if ssh close fails with an unexpected Error' do
         mock_ssh = Object.new
         allow( mock_ssh ).to receive( :close ) { raise StandardError }
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         allow( mock_ssh).to receive( :closed? ).once.and_return(false)
@@ -90,7 +88,7 @@ module Beaker
     describe '#execute' do
       it 'retries if failed with a retryable exception' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         allow( subject ).to receive( :close )
@@ -102,7 +100,7 @@ module Beaker
 
       it 'raises an error if it fails both times' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         allow( subject ).to receive( :close )
@@ -115,7 +113,7 @@ module Beaker
     describe '#request_terminal_for' do
       it 'fails correctly by raising Net::SSH::Exception' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         mock_channel = Object.new
@@ -128,7 +126,7 @@ module Beaker
     describe '#register_stdout_for' do
       before :each do
         @mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { @mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { @mock_ssh }
         connection.connect
 
         @data = '7 of clubs'
@@ -164,7 +162,7 @@ module Beaker
 
       before :each do
         @mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { @mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { @mock_ssh }
         connection.connect
 
         @data = '3 of spades'
@@ -203,7 +201,7 @@ module Beaker
 
       it 'assigns the output\'s exit code correctly from the data' do
         mock_ssh = Object.new
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { mock_ssh }
         connection.connect
 
         data = '10 of jeromes'
@@ -236,7 +234,7 @@ module Beaker
         @mock_scp = Object.new
         allow( @mock_scp ).to receive( :upload! )
         allow( @mock_ssh ).to receive( :scp ).and_return( @mock_scp )
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { @mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { @mock_ssh }
         connection.connect
       end
 
@@ -263,7 +261,7 @@ module Beaker
         @mock_scp = Object.new
         allow( @mock_scp ).to receive( :download! )
         allow( @mock_ssh ).to receive( :scp ).and_return( @mock_scp )
-        expect( Net::SSH ).to receive( :start ).with( vmhostname, user, ssh_opts) { @mock_ssh }
+        expect( Net::SSH ).to receive( :start ).with( ip, user, ssh_opts) { @mock_ssh }
         connection.connect
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 3.23.0
+  version: 3.24.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -591,6 +591,7 @@ files:
 - docs/how_to/recipes.md
 - docs/how_to/run_in_parallel.md
 - docs/how_to/ssh_agent_forwarding.md
+- docs/how_to/ssh_connection_preference.md
 - docs/how_to/test_arbitrary_beaker_versions.md
 - docs/how_to/the_beaker_dsl.md
 - docs/how_to/upgrade_from_2_to_3.md