beaker 3.2.0 → 3.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjE0N2NkNzU1MGYxNjdiNDYwOWI1YjQ0YjA4Mzc2ODg1N2Q4MDliNg==
+    OGEwYTM4MDM4OGExZmVmN2ExZjI4NGRjM2RjNmJlOGIyNDk0MWQ0MA==
   data.tar.gz: !binary |-
-    M2FlZTM0YmJmNGUxMDViYTEzNjVmNDZiZjA5YjkxNTE1ZWUzYjdmMQ==
+    ZWE4NGY3ZDgzZWVmYzY3YTQ2ZTlkNjhmY2Y1ZGY4YjRlOTk1MTI3MA==
 SHA512:
   metadata.gz: !binary |-
-    MTg2MDM3Yzg5ZmZhY2RjMGU3MTlmM2ZlNzU2MTA3MzY5MGVhMjQwMzdkZWRi
-    ZWE0M2JiYmU3ZWM3MWZlZDExYzMxOGZmMDI0MmM5N2UxYzUwMzRkMjNkNjA2
-    NGJkMzg1NWU2MWM4Y2QxZTM1NTgyNjczN2MxNDVlNzg2ODZlNDg=
+    MDIwMjY0OTIwMjgwYzljZWQzMTRmMjgyOGQ2YzE4OWViZjJhYWNiM2JkNDli
+    MTE1YTVmZjBkYWQ1OWJkMTg2M2JkOWUzNjdkOWM1M2ZlMGQzOGQ3NTY4MDE0
+    YWNhYTgzODViYWJjMjEwOWM0NDEyY2VjOWY3ZmJmYTQ3OTk4ZTY=
   data.tar.gz: !binary |-
-    NTMzZGE4MDZjZjJjNjU2NTM3NDVkNTg5NTE3YWNjZWMwMWYwZDU5MTlhZjg3
-    ZjdlOTcyZDQyOTVmODNlYTYwODA2ODk3ZTQzN2ViYjRlYjYzODVmY2IwZDYw
-    NjBiMjYyYjVmM2UzZjM5YjdjNzgxOTQzMzY2YzhjODUwNmZhODQ=
+    ZWIxOGNkYjgyZTc2OTc2ZWRiMDczYjI2OGNhYmY3ZTA2ZjY0MjdhMWU4MGY2
+    NDIyMjhkZDUyM2ZhNWVjYmZiOGQ1NWU2ZDNjMTdkZjYzMGUzZWVjNzk3NzBl
+    N2IyMDYwMzk0OTk5Y2IyMDcyYWE1OTNkYTlmN2FiMmMwODc5Njc=

data/MAINTAINERS

@@ -2,6 +2,7 @@
   "version": 1,
   "file_format": "This MAINTAINERS file format is described at https://github.com/puppetlabs/maintainers",
   "issues": "https://tickets.puppet.com/browse/BKR",
+  "internal_list": "https://groups.google.com/a/puppet.com/forum/?hl=en#!forum/discuss-quality-engineering",
   "people": [
     {
       "github": "kevpl",

data/acceptance/tests/base/host/host_test.rb

@@ -279,4 +279,40 @@ hosts.each do |host|
     end
     assert_equal(0, host_paths.length, "there are extra paths on #{host} (#{host_paths})")
   end
-end
+end
+
+step "Ensure scp errors close the ssh connection" do
+
+  step 'Attempt to generate a remote file that does not exist' do
+
+    # This assert relies on the behavior of the net-scp library to
+    # raise an error when #channel.on_close is called, which is called by
+    # indirectly called by beaker's own SshConnection #close mehod. View
+    # the source for further info:
+    # https://github.com/net-ssh/net-sacp/blob/master/lib/net/scp.rb
+    assert_raises Net::SCP::Error do
+      create_remote_file(default, '/tmp/this/path/cannot/possibly/exist.txt', "contents")
+    end
+  end
+
+  step 'Ensure that a subsequent ssh connection works' do
+    # If the ssh connection was left in a dangling state, then this #on call will hang
+    on default, 'true'
+  end
+
+  step 'Attempt to scp from a resource on the SUT that does not exist' do
+
+    # This assert relies on the behavior of the net-scp library to
+    # use the Dir.mkdir method in the #download_start_state method.
+    # See the source for further info:
+    # https://github.com/net-ssh/net-sacp/blob/master/lib/net/scp/download.rb
+    assert_raises Errno::ENOENT do
+      scp_from default, '/tmp/path/dne/wtf/bbq', '/tmp/path/dne/wtf/bbq'
+    end
+  end
+
+  step 'Ensure that a subsequent ssh connection works' do
+    # If the ssh connection was left in a dangling state, then this #on call will hang
+    on default, 'true'
+  end
+end

data/docs/concepts/beaker_libraries.md

@@ -13,6 +13,7 @@ To learn how to create beaker libraries, see the [Beaker-Template](https://githu
 | beaker-hostgenerator | Generates Beaker host files | [Github Repo](https://github.com/puppetlabs/beaker-hostgenerator/) |
 | beaker-answers | Generates answers for Puppet Enterprise installation | [Github Repo](https://github.com/puppetlabs/beaker-answers/) |
 | beaker-pe | Adds helper methods for Puppet Enterprise specific tasks | [Github Repo](https://github.com/puppetlabs/beaker-pe/) |
+| beaker-http | Adds ability to dispatch http traffic from the coordinator | [Github Repo](https://github.com/puppetlabs/beaker-http/) |
 | Beaker Rubymine Plugin | An IntelliJ IDEA plugin making Beaker test runs a native IDE experience | [Github Repo](https://github.com/samwoods1/BeakerRubyMinePlugin) |
 | beaker-rspec | A bridge between beaker itself and [rspec](https://github.com/rspec/rspec); also integrates [serverspec](http://serverspec.org/) | [Github Repo](https://github.com/puppetlabs/beaker-rspec/) |
 

data/docs/how_to/hypervisors/aws.md

@@ -80,6 +80,9 @@ The `ami-size` variable refers to
 Some examples of these values are "m3.large", "c4.xlarge", and "r3.8xlarge". The
 default value if this key is not provided used by Beaker is "m1.small".
       
+### ec2 VM Hostnames
+
+By default, beaker will set the hostnames of the VMs to the 'Public DNS' hostname supplied by ec2 (and which is normally based on the Public IP address). If your test requires the hosts be named identically to the `<hostname>:` from your beaker hosts file, set `:use_beaker_hostnames: true` in the beaker hosts file.
 
 # AWS Keys
 
@@ -140,4 +143,4 @@ like so:
     aws-sdk: Ensure key pair exists, create if not
     [AWS EC2 200 0.142666 0 retries] describe_key_pairs(:filters=>[{:name=>"key-name",:values=>["Beaker-johnsmith-Johns-Ubuntu-2-local"]}])
 
-The values string in that line is what you're looking for.
+The values string in that line is what you're looking for.

data/docs/how_to/hypervisors/vagrant.md

@@ -157,3 +157,9 @@ When using the Vagrant Hypervisor, beaker can create the Vagrantfile to forward
             to_ip: '0.0.0.0'
 
 In the above, beaker will forward port 10080 and 8080 on the Host to port 80 and 8080 (respectively) on the Agent guest.
+
+# vagrant plugins #
+
+You can check more information for some suported vagrant plugins:
+
+ - [vagrant-libvirt](vagrant_libvirt.md)

data/docs/how_to/hypervisors/vagrant_libvirt.md

@@ -0,0 +1,58 @@
+# Vagrant Libvirt #
+
+This driver enabled a tester to trigger tests using libvirtd daemon.
+It is based
+on [libvirt](https://github.com/vagrant-libvirt/vagrant-libvirt)'s
+plugin for vagrant.
+
+## Basic Options ##
+
+Once you've setup the libvirt daemon on your beaker coordinator, you
+can use the vagrant_libvirt hypervisor by providing beaker with a
+configuration similar to this:
+
+```yaml
+HOSTS
+  centos-puppet-keystone:
+    hostname: puppet-keystone.example.net
+    roles:
+      - master
+    platform: el-7-x86_64
+    box: centos/7
+    box_url:  http://cloud.centos.org/centos/7/vagrant/x86_64/images/CentOS-7.LibVirt.box
+    hypervisor: vagrant_libvirt
+    vagrant_memsize: 4096
+    vagrant_cpus: 2
+```
+
+Those are the usual beaker parameters. Note the `hypervisor`
+parameter. Multiple VMs is supported.
+
+
+## Advanced Options and remote libvirt daemon ##
+
+This driver gives the tester access to all available parameters from
+the vagrant-libvirt plugin. Beware there could be dragons here as
+beaker has some expectations about the created VMs.
+
+To pass them down the operator adds them in the config section, here
+is a example.
+
+```yaml
+CONFIG:
+  libvirt:
+    uri: qemu+ssh://root@libvirt.system.com/system
+```
+
+The `uri` parameter is one of the most useful. The user can have its
+test done on a remote libvirt daemon. The network setup between the
+VMs and the host running beaker will have to be done manually though.
+`management_network_name` and `management_network_address` parameters
+can be useful here.
+
+Another good cadidate is `volume_cache: unsafe`.
+
+A complete list of options is available in
+the
+[vagrant plugin](https://github.com/vagrant-libvirt/vagrant-libvirt)
+repository.

data/lib/beaker/dsl/install_utils/foss_utils.rb

@@ -1147,7 +1147,7 @@ module Beaker
         # @option opts [String] :pe_promoted_builds_url Base URL to pull artifacts from
         #
         # @note on windows, the +:ruby_arch+ host parameter can determine in addition
-        # to other settings whether the 32 or 64bit install is used
+        #   to other settings whether the 32 or 64bit install is used
         #
         # @example
         #   install_puppet_agent_pe_promoted_repo_on(host, { :puppet_agent_version => '1.1.0.227', :pe_ver => '4.0.0-rc1'})

data/lib/beaker/hypervisor/aws_sdk.rb

@@ -634,17 +634,33 @@ module Beaker
     # publicly. Then configure each ec2 machine to that dns_name, so that when facter
     # is installed the facts for hostname and domain match the dns_name.
     #
+    # if :use_beaker_hostnames: is true, set the :vmhostname and hostname of each ec2
+    # machine to the host[:name] from the beaker hosts file.
+    #
     # @return [@hosts]
     # @api private
     def set_hostnames
-      @hosts.each do |host|
-        host[:vmhostname] = host[:dns_name]
-        if host['platform'] =~ /el-7/
-          # on el-7 hosts, the hostname command doesn't "stick" randomly
-          host.exec(Command.new("hostnamectl set-hostname #{host.hostname}"))
-        else
-          next if host['platform'] =~ /netscaler/
-          host.exec(Command.new("hostname #{host.hostname}"))
+      if @options[:use_beaker_hostnames]
+        @hosts.each do |host|
+          host[:vmhostname] = host[:name]
+          if host['platform'] =~ /el-7/
+            # on el-7 hosts, the hostname command doesn't "stick" randomly
+            host.exec(Command.new("hostnamectl set-hostname #{host.name}"))
+          else
+            next if host['platform'] =~ /netscaler/
+            host.exec(Command.new("hostname #{host.name}"))
+          end
+        end
+      else
+        @hosts.each do |host|
+          host[:vmhostname] = host[:dns_name]
+          if host['platform'] =~ /el-7/
+            # on el-7 hosts, the hostname command doesn't "stick" randomly
+            host.exec(Command.new("hostnamectl set-hostname #{host.hostname}"))
+          else
+            next if host['platform'] =~ /netscaler/
+            host.exec(Command.new("hostname #{host.hostname}"))
+          end
         end
       end
     end

data/lib/beaker/hypervisor/openstack.rb

@@ -197,18 +197,19 @@ module Beaker
 
       @hosts.each do |host|
         ip = get_ip
-        hostname = ip.ip.gsub '.','-'
-        host[:vmhostname] = hostname+'.rfc1918.puppetlabs.net'
-        @logger.debug "Provisioning #{host.name} (#{host[:vmhostname]})"
+        host[:vmhostname] = ip.ip.gsub '.','-'
+        host[:vmfqdn] = host[:vmhostname] + '.rfc1918.puppetlabs.net'
+        host[:keyname] = key_name(host)
+        @logger.debug "Provisioning #{host.name} (#{host[:vmfqdn]})"
         options = {
           :flavor_ref => flavor(host[:flavor]).id,
           :image_ref  => image(host[:image]).id,
           :nics       => [ {'net_id' => network(@options[:openstack_network]).id } ],
-          :name       => host[:vmhostname],
-          :hostname   => host[:vmhostname],
+          :name       => host[:vmfqdn],
+          :hostname   => host[:vmfqdn],
           :user_data  => host[:user_data] || "#cloud-config\nmanage_etc_hosts: true\n",
+          :key_name   => host[:keyname],
         }
-        options[:key_name] = key_name(host)
         options[:security_groups] = security_groups(@options[:security_group]) unless @options[:security_group].nil?
         vm = @compute_client.servers.create(options)
 
@@ -223,10 +224,10 @@ module Beaker
             break
           rescue Fog::Errors::TimeoutError => e
             if try >= attempts
-              @logger.debug "Failed to connect to new OpenStack instance #{host.name} (#{host[:vmhostname]})"
+              @logger.debug "Failed to connect to new OpenStack instance #{host.name} (#{host[:vmfqdn]})"
               raise e
             end
-            @logger.debug "Timeout connecting to instance #{host.name} (#{host[:vmhostname]}), trying again..."
+            @logger.debug "Timeout connecting to instance #{host.name} (#{host[:vmfqdn]}), trying again..."
           end
           sleep SLEEPWAIT
           try += 1
@@ -236,7 +237,7 @@ module Beaker
         ip.server = vm
         host[:ip] = ip.ip
 
-        @logger.debug "OpenStack host #{host.name} (#{host[:vmhostname]}) assigned ip: #{host[:ip]}"
+        @logger.debug "OpenStack host #{host.name} (#{host[:vmfqdn]}) assigned ip: #{host[:ip]}"
 
         #set metadata
         vm.metadata.update({:jenkins_build_url => @options[:jenkins_build_url].to_s,
@@ -272,7 +273,7 @@ module Beaker
         vm.destroy
         if @options[:openstack_keyname].nil?
           @logger.debug "Deleting random keypair"
-          @compute_client.delete_key_pair vm.name
+          @compute_client.delete_key_pair vm.key_name
         end
       end
     end
@@ -308,7 +309,7 @@ module Beaker
     #@api private
     def key_name(host)
       if @options[:openstack_keyname]
-        @logger.debug "Adding optional key_name #{@options[:openstack_keyname]} to #{host.name} (#{host[:vmhostname]})"
+        @logger.debug "Adding optional key_name #{@options[:openstack_keyname]} to #{host.name} (#{host[:vmfqdn]})"
         @options[:openstack_keyname]
       else
         @logger.debug "Generate a new rsa key"

data/lib/beaker/hypervisor/vagrant_libvirt.rb

@@ -2,6 +2,7 @@ require 'beaker/hypervisor/vagrant'
 
 class Beaker::VagrantLibvirt < Beaker::Vagrant
   @memory = nil
+  @cpu    = nil
 
   class << self
     attr_reader :memory
@@ -13,10 +14,24 @@ class Beaker::VagrantLibvirt < Beaker::Vagrant
 
   def self.provider_vfile_section(host, options)
     "    v.vm.provider :libvirt do |node|\n" +
+      "      node.cpus = #{cpu(host, options)}\n" +
       "      node.memory = #{memory(host, options)}\n" +
+      build_options_str(options) +
       "    end\n"
   end
 
+  def self.cpu(host, options)
+    return @cpu unless @cpu.nil?
+    @cpu = case
+    when host['vagrant_cpus']
+      host['vagrant_cpus']
+    when options['vagrant_cpus']
+      options['vagrant_cpus']
+    else
+      '1'
+    end
+  end
+
   def self.memory(host, options)
     return @memory unless @memory.nil?
     @memory = case
@@ -28,4 +43,16 @@ class Beaker::VagrantLibvirt < Beaker::Vagrant
       '512'
     end
   end
+
+  def self.build_options_str(options)
+    other_options_str = ''
+    if options['libvirt']
+      other_options = []
+      options['libvirt'].each do |k, v|
+        other_options << "      node.#{k} = '#{v}'"
+      end
+      other_options_str = other_options.join("\n")
+    end
+    "#{other_options_str}\n"
+  end
 end

data/lib/beaker/options/command_line_parser.rb

@@ -16,7 +16,10 @@ module Beaker
 
           opts.on '-h', '--hosts FILE',
                   'Use host configuration FILE',
-                  '(default sample.cfg)'  do |file|
+                  'Possible FILE values:',
+                  'a file path (beaker will parse file directly)',
+                  'a beaker-hostgenerator string (BHG generates hosts file)',
+                  'omitted (coordinator-only run; no SUTs provisioned)' do |file|
             @cmd_options[:hosts_file] = file
           end
 

data/lib/beaker/ssh_connection.rb

@@ -273,9 +273,17 @@ module Beaker
       result = Result.new(@hostname, [source, target])
       result.stdout = "\n"
 
-      @ssh.scp.upload! source, target, local_opts do |ch, name, sent, total|
-        result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
+      begin
+        @ssh.scp.upload! source, target, local_opts do |ch, name, sent, total|
+          result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
+        end
+      rescue => e
+        logger.warn "#{e.class} error in scp'ing. Forcing the connection to close, which should " <<
+          "raise an error."
+        close
       end
+
+
       # Setting these values allows reporting via result.log(test_name)
       result.stdout << "  SCP'ed file #{source} to #{@hostname}:#{target}"
 
@@ -297,9 +305,16 @@ module Beaker
       result = Result.new(@hostname, [source, target])
       result.stdout = "\n"
 
-      @ssh.scp.download! source, target, local_opts do |ch, name, sent, total|
-        result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
+      begin
+        @ssh.scp.download! source, target, local_opts do |ch, name, sent, total|
+          result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
+        end
+      rescue => e
+        logger.warn "#{e.class} error in scp'ing. Forcing the connection to close, which should " <<
+          "raise an error."
+        close
       end
+
       # Setting these values allows reporting via result.log(test_name)
       result.stdout << "  SCP'ed file #{@hostname}:#{source} to #{target}"
 

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '3.2.0'
+    STRING = '3.3.0'
   end
 end

data/spec/beaker/hypervisor/aws_sdk_spec.rb

@@ -623,6 +623,19 @@ module Beaker
           end
         end
 
+        it 'sets the the vmhostname to the beaker config name for each host' do
+          options[:use_beaker_hostnames] = true
+	  @hosts.each do |host|
+            host[:name] = "prettyponyprincess"
+	  end
+          expect(set_hostnames).to eq(@hosts)
+          @hosts.each do |host|
+            puts host[:name]
+            expect(host[:vmhostname]).to eq(host[:name])
+            expect(host[:vmhostname]).to eq(host.hostname)
+          end
+        end
+
       end
     end
 

data/spec/beaker/hypervisor/openstack_spec.rb

@@ -69,5 +69,24 @@ module Beaker
       openstack.provision
     end
 
+    it 'generates valid keynames during server creation' do
+      # Simulate getting a dynamic IP from OpenStack to test key generation code
+      # after provisioning. See _validate_new_key_pair in openstack/nova for reference
+      mock_ip = double().as_null_object
+      allow( openstack ).to receive( :get_ip ).and_return( mock_ip )
+      allow( mock_ip ).to receive( :ip ).and_return( '172.16.0.1' )
+      openstack.instance_eval('@options')['openstack_keyname'] = nil
+
+      @hosts.each do |host|
+        allow(host).to receive(:wait_for_port).and_return(true)
+      end
+
+      openstack.provision
+
+      @hosts.each do |host|
+        expect(host[:keyname]).to match(/[_\-0-9a-zA-Z]+/)
+      end
+    end
+
   end
 end

data/spec/beaker/hypervisor/vagrant_libvirt_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe Beaker::VagrantLibvirt do
-  let( :options ) { make_opts.merge({ :hosts_file => 'sample.cfg', 'logger' => double().as_null_object }) }
+  let( :options ) { make_opts.merge({ :hosts_file => 'sample.cfg',
+                                      'logger' => double().as_null_object,
+                                      'libvirt' => { 'uri' => 'qemu+ssh://root@host/system'},
+                                      'vagrant_cpus' => 2,
+                                    }) }
   let( :vagrant ) { Beaker::VagrantLibvirt.new( @hosts, options ) }
 
   before :each do
@@ -27,7 +31,7 @@ describe Beaker::VagrantLibvirt do
       path = vagrant.instance_variable_get( :@vagrant_path )
       allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
 
-      vagrant.make_vfile( @hosts )
+      vagrant.make_vfile( @hosts, options )
       @vagrantfile = File.read( File.expand_path( File.join( path, "Vagrantfile")))
     end
 
@@ -39,5 +43,15 @@ describe Beaker::VagrantLibvirt do
       expect( @vagrantfile.split("\n").map(&:strip) )
         .to include('node.memory = 512')
     end
+
+    it "can specify the number of cpus" do
+      expect( @vagrantfile.split("\n").map(&:strip) )
+        .to include("node.cpus = 2")
+    end
+
+    it "can specify any libvirt option" do
+      expect( @vagrantfile.split("\n").map(&:strip) )
+        .to include("node.uri = 'qemu+ssh://root@host/system'")
+    end
   end
 end

data/spec/beaker/ssh_connection_spec.rb

@@ -245,6 +245,12 @@ module Beaker
         connection.scp_to '', ''
       end
 
+      it 'ensures the connection closes when scp.upload! errors' do
+        expect( @mock_scp ).to receive( :upload! ).once.and_raise(RuntimeError)
+        expect(connection).to receive(:close).once
+        connection.scp_to '', ''
+      end
+
       it 'returns a result object' do
         expect( connection.scp_to '', '' ).to be_a_kind_of Beaker::Result
       end
@@ -266,6 +272,12 @@ module Beaker
         connection.scp_from '', ''
       end
 
+      it 'ensures the connection closes when scp.download! errors' do
+        expect( @mock_scp ).to receive( :download! ).once.and_raise(RuntimeError)
+        expect(connection).to receive(:close).once
+        connection.scp_from '', ''
+      end
+
       it 'returns a result object' do
         expect( connection.scp_from '', '' ).to be_a_kind_of Beaker::Result
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -529,6 +529,7 @@ files:
 - docs/how_to/hypervisors/solaris.md
 - docs/how_to/hypervisors/vagrant.md
 - docs/how_to/hypervisors/vagrant_hosts_file_examples.md
+- docs/how_to/hypervisors/vagrant_libvirt.md
 - docs/how_to/hypervisors/vmware_fusion.md
 - docs/how_to/hypervisors/vsphere.md
 - docs/how_to/platform_specific_tag_confines.md