beaker 2.44.0 → 2.45.0

data/docs/hypervisors/vagrant.md

@@ -15,7 +15,7 @@ see [downloads.vagrantup.com](http://downloads.vagrantup.com/) for downloads.
 Currently, we provide a suite of pre-built, publicly available vagrant boxes for
 use in constructing tests: [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppetlabs/).
 You can use these boxes easily by pulling one of our
-[Example Vagrant Hosts Files](Example-Vagrant-Hosts-Files.md).
+[Example Vagrant Hosts Files](vagrant_hosts_file_examples.md).
 
 ### Setup a Vagrant Hosts File
 
@@ -118,4 +118,42 @@ as synced_folders inside the vagrant box. This is done by using the
       consoleport: 443
 
 In the above beaker will mount the folders `./` to `/vagrant/folder1` and the
-folder `/tmp` to `/vagrant/tmp`.
+folder `/tmp` to `/vagrant/tmp`.
+
+### Forwarding Ports to Guest
+
+When using the Vagrant Hypervisor, beaker can create the Vagrantfile to forward specified ports to a specific box. This is done by using the `forwarded_ports` option in the nodeset file.
+
+**Example hosts file**
+
+    HOSTS:
+      ubuntu-1404-x64-master:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - database
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.20.20
+      ubuntu-1404-x64-agent:
+        roles:
+          - agent
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.21.21
+        forwarded_ports:
+          apache:
+            from: 10080
+            to: 80
+          tomcat:
+            from: 8080
+            to: 8080
+            from_ip: '127.0.0.1'
+            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.

data/docs/runner/test_run.md

@@ -0,0 +1,31 @@
+# Beaker Test Runs


+
+A Beaker run typically has the following phases. All the phases are not mandatory. Each phase provides an option to skip.


+
+* Provisioning
+  * skip with `--no-provision`
+  * Using supported hypervisors provision SUTs for testing on
+  * Do any initial configuration to ensure that the SUTs can communicate with beaker and each other
+
+
+* Validation
+  * skip with `--no-validate`
+  * Check the SUTs for necessary packages (curl, ntpdate)
+
+
+* Configuration
+  * skip with `--no-configure`
+  * Do any post-provisioning configuration to the test nodes
+
+
+* Testing
+  * For test running options, please refer to [Test Suites & Failure Modes](test_suites.md)
+
+
+* Reverting
+  * Skip with `--preserve-hosts`
+  * Destroy and cleanup all SUTs
+
+
+* Cleanup
+  * Report test results

data/lib/beaker/cli.rb

@@ -189,14 +189,14 @@ module Beaker
       @options[:tests] = []
       @options[:pre_cleanup] = []
       preserved_hosts_filename = File.join(@options[:log_dated_dir], 'hosts_preserved.yml')
-      FileUtils.cp(@options[:hosts_file], preserved_hosts_filename)
-      hosts_yaml = YAML.load_file(preserved_hosts_filename)
+
+      hosts_yaml = @options
       newly_keyed_hosts_entries = {}
       hosts_yaml['HOSTS'].each do |host_name, file_host_hash|
         h = Beaker::Options::OptionsHash.new
         file_host_hash = h.merge(file_host_hash)
         @hosts.each do |host|
-          if host_name == host.name
+          if host_name.to_s == host.name.to_s
             newly_keyed_hosts_entries[host.reachable_name] = file_host_hash.merge(host.host_hash)
             break
           end

data/lib/beaker/dsl/helpers/web_helpers.rb

@@ -24,6 +24,7 @@ module Beaker
           url = URI.parse(link)
           http = Net::HTTP.new(url.host, url.port)
           http.use_ssl = (url.scheme == 'https')
+          http.verify_mode = (OpenSSL::SSL::VERIFY_NONE)
           http.start do |http|
             return http.head(url.request_uri).code == "200"
           end
@@ -52,9 +53,17 @@ module Beaker
           else
             logger.notify "Fetching: #{src}"
             logger.notify "  and saving to #{dst}"
-            open(src, :allow_redirections => :all) do |remote|
-              File.open(dst, "w") do |file|
-                FileUtils.copy_stream(remote, file)
+            begin
+              open(src, :allow_redirections => :all) do |remote|
+                File.open(dst, "w") do |file|
+                  FileUtils.copy_stream(remote, file)
+                end
+              end
+            rescue OpenURI::HTTPError => e
+              if e.message =~ /404.*/
+                raise "Failed to fetch_remote_file '#{src}' (#{e.message})"
+              else
+                raise e
               end
             end
           end
@@ -95,7 +104,7 @@ module Beaker
             logger.debug(line)
           end
           if $?.to_i != 0
-            raise "Failed to fetch_remote_dir '#{url}' (exit code #{$?}"
+            raise "Failed to fetch_remote_dir '#{url}' (exit code #{$?})"
           end
           dst
         end

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

@@ -1210,7 +1210,7 @@ module Beaker
             case host[:platform]
             when /cumulus|huaweios/
               pkgs = on(host, "dpkg-query -l  | awk '{print $2}' | grep -E '(^pe-|puppet)'", :acceptable_exit_codes => [0,1]).stdout.chomp.split(/\n+/)
-            when /aix/
+            when /aix|sles|el|redhat|centos|oracle|scientific/
               pkgs = on(host, "rpm -qa  | grep -E '(^pe-|puppet)'", :acceptable_exit_codes => [0,1]).stdout.chomp.split(/\n+/)
             when /solaris-10/
               cmdline_args = '-a noask'

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

@@ -144,10 +144,10 @@ exit /B %errorlevel%
             # emit the misc/versions.txt file which contains component versions for
             # puppet, facter, hiera, pxp-agent, packaging and vendored Ruby
             [
-              "\"%ProgramFiles%\\Puppet Labs\\puppet\\misc\\versions.txt\"",
-              "\"%ProgramFiles(x86)%\\Puppet Labs\\puppet\\misc\\versions.txt\""
+              "\\\"%ProgramFiles%\\Puppet Labs\\puppet\\misc\\versions.txt\\\"",
+              "\\\"%ProgramFiles(x86)%\\Puppet Labs\\puppet\\misc\\versions.txt\\\""
             ].each do |path|
-              on host, Command.new("if exist #{path} type #{path}", [], { :cmdexe => true })
+              on host, Command.new("\"if exist #{path} type #{path}\"", [], { :cmdexe => true })
             end
           end
         end

data/lib/beaker/host.rb

@@ -224,10 +224,30 @@ module Beaker
       @logger.warn("Uh oh, this should be handled by sub-classes but hasn't been")
     end
 
+    # Determine the ip address using logic specific to the hypervisor
+    def get_public_ip
+      case host_hash[:hypervisor]
+      when 'ec2'
+        if host_hash[:instance]
+          host_hash[:instance].ip_address
+        else
+          # In the case of using ec2 instances with the --no-provision flag, the ec2
+          # instance object does not exist and we should just use the curl endpoint
+          # specified here:
+          # http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html
+          if self.instance_of?(Windows::Host)
+          execute("wget http://169.254.169.254/latest/meta-data/public-ipv4").strip
+          else
+          execute("curl http://169.254.169.254/latest/meta-data/public-ipv4").strip
+          end
+        end
+      end
+    end
+
     #Return the ip address of this host
     #Always pull fresh, because this can sometimes change
     def ip
-      self['ip'] = get_ip
+      self['ip'] = get_public_ip || get_ip
     end
 
     #@return [Boolean] true if x86_64, false otherwise

data/lib/beaker/host/unix/pkg.rb

@@ -148,7 +148,7 @@ module Unix::Pkg
         execute("zypper --non-interactive rm #{name}", opts)
       when /el-4/
         @logger.debug("Package uninstallation not supported on rhel4")
-      when /fedora-22/
+      when /edora-(2[2-9])/
         execute("dnf -y #{cmdline_args} remove #{name}", opts)
       when /cisco|fedora|centos|eos|el-/
         execute("yum -y #{cmdline_args} remove #{name}", opts)

data/lib/beaker/hypervisor/openstack.rb

@@ -170,7 +170,7 @@ module Beaker
           :image_ref  => image(host[:image]).id,
           :nics       => [ {'net_id' => network(@options[:openstack_network]).id } ],
           :name       => host[:vmhostname],
-          :user_data  => "#cloud-config\nmanage_etc_hosts: true\n",
+          :user_data  => host[:user_data] || "#cloud-config\nmanage_etc_hosts: true\n",
         }
         options[:key_name] = key_name(host)
         vm = @compute_client.servers.create(options)

data/lib/beaker/hypervisor/vagrant.rb

@@ -41,6 +41,20 @@ module Beaker
           end
         end
 
+        unless host['forwarded_ports'].nil?
+          host['forwarded_ports'].each do |_name, port|
+            fwd = "    v.vm.network :forwarded_port,"
+            fwd << " protocol: '#{port[:protocol]}'," unless port[:protocol].nil?
+            fwd << " guest_ip: '#{port[:to_ip]}'," unless port[:to_ip].nil?
+            fwd << " guest: #{port[:to]},"
+            fwd << " host_ip: '#{port[:from_ip]}'," unless port[:from_ip].nil?
+            fwd << " host: #{port[:from]}"
+            fwd << "\n"
+
+            v_file << fwd
+          end
+        end
+
         if /windows/i.match(host['platform'])
           #due to a regression bug in versions of vagrant 1.6.2, 1.6.3, 1.6.4, >= 1.7.3 ssh fails to forward 
           #automatically (note <=1.6.1, 1.6.5, 1.7.0 - 1.7.2 are uneffected)
@@ -180,7 +194,7 @@ module Beaker
     end
 
     def cleanup
-      @logger.debug "removing temporory ssh-config files per-vagrant box"
+      @logger.debug "removing temporary ssh-config files per-vagrant box"
       @temp_files.each do |f|
         f.close()
       end

data/lib/beaker/options/hosts_file_parser.rb

@@ -11,24 +11,47 @@ module Beaker
       #     hosts_hash == {:HOSTS=>{:"pe-ubuntu-lucid"=>{:roles=>["agent", "dashboard", "database", "master"], ... }
       #
       # @return [OptionsHash] The contents of the hosts file as an OptionsHash
-      # @raise [ArgumentError] Raises if hosts_file_path is not a path to a file, or is not a valid YAML file
+      # @raise [ArgumentError] Raises if hosts_file_path is not a valid YAML file
+      # @raise [Errno::ENOENT] File not found error: hosts_file doesn't exist
       def self.parse_hosts_file(hosts_file_path = nil)
+        host_options = new_host_options
+        return host_options unless hosts_file_path
+        error_message = "#{hosts_file_path} is not a valid YAML file\n\t"
+        host_options = self.merge_hosts_yaml( host_options, error_message ) {
+          hosts_file_path = File.expand_path( hosts_file_path )
+          YAML.load_file( hosts_file_path )
+        }
+        fix_roles_array( host_options )
+      end
+
+      # Read the contents of a host definition as a string into an OptionsHash
+      #
+      # @param [String] hosts_def_yaml YAML hosts definition
+      #
+      # @return [OptionsHash] Contents of the hosts file as an OptionsHash
+      # @raise [ArgumentError] If hosts_def_yaml is not a valid YAML string
+      def self.parse_hosts_string(hosts_def_yaml = nil)
+        host_options = new_host_options
+        return host_options unless hosts_def_yaml
+        error_message = "#{hosts_def_yaml}\nis not a valid YAML string\n\t"
+        host_options = self.merge_hosts_yaml( host_options, error_message ) {
+          YAML.load( hosts_def_yaml )
+        }
+        fix_roles_array( host_options )
+      end
+
+      # Convenience method to create new OptionsHashes with a HOSTS section
+      #
+      # @return [OptionsHash] Hash with HOSTS section
+      def self.new_host_options
         host_options = Beaker::Options::OptionsHash.new
         host_options['HOSTS'] ||= {}
-        unless hosts_file_path
-           return host_options
-        end
-        hosts_file_path = File.expand_path(hosts_file_path)
-        unless File.exists?(hosts_file_path)
-          raise ArgumentError, "Host file '#{hosts_file_path}' does not exist!"
-        end
-        begin
-          host_options = host_options.merge(YAML.load_file(hosts_file_path))
-        rescue Psych::SyntaxError => e
-          raise ArgumentError, "#{hosts_file_path} is not a valid YAML file\n\t#{e}"
-        end
+        host_options
+      end
 
-        # Make sure the roles array is present for all hosts
+      # Make sure the roles array is present for all hosts
+      #
+      def self.fix_roles_array( host_options )
         host_options['HOSTS'].each_key do |host|
           host_options['HOSTS'][host]['roles'] ||= []
         end
@@ -38,6 +61,23 @@ module Beaker
         host_options
       end
 
+      # Merges YAML read in the passed block into given OptionsHash
+      #
+      # @param [OptionsHash] host_options Host information hash
+      # @param [String] error_message Message to print if {::Psych::SyntaxError}
+      #   is raised during block execution
+      # @return [OptionsHash] Updated host_options with host info merged
+      def self.merge_hosts_yaml( host_options, error_message, &block )
+        begin
+          loaded_host_options = yield
+        rescue Psych::SyntaxError => e
+          error_message << e.to_s
+          raise ArgumentError, error_message
+        end
+
+        host_options.merge( loaded_host_options )
+      end
+
     end
   end
 end

data/lib/beaker/options/parser.rb

@@ -90,7 +90,9 @@ module Beaker
       # @return nil
       # @api public
       def resolve_symlinks!
-        @options[:hosts_file] = File.realpath(@options[:hosts_file]) if @options[:hosts_file]
+        if @options[:hosts_file] && !@options[:hosts_file_generated]
+          @options[:hosts_file] = File.realpath(@options[:hosts_file])
+        end
       end
 
       #Converts array of paths into array of fully qualified git repo URLS with expanded keywords
@@ -192,8 +194,7 @@ module Beaker
         @options                        = @options.merge(cmd_line_and_file_options)
 
         if not @options[:help] and not @options[:beaker_version_print]
-          #read the hosts file that contains the node configuration and hypervisor info
-          hosts_options = Beaker::Options::HostsFileParser.parse_hosts_file(@options[:hosts_file])
+          hosts_options = parse_hosts_options
 
           # merge in host file vars
           #   overwrite options (default, file options, command line) with host file options
@@ -215,6 +216,39 @@ module Beaker
         @options
       end
 
+      # Parse hosts options from host files into a host options hash. Falls back
+      # to trying as a beaker-hostgenerator string if reading the hosts file
+      # doesn't work
+      #
+      # @return [Hash] Host options, containing all host-specific details
+      # @raise [ArgumentError] if a hosts file is generated, but it can't
+      #   be read by the HostsFileParser
+      def parse_hosts_options
+        if File.exists?(@options[:hosts_file])
+          #read the hosts file that contains the node configuration and hypervisor info
+          return Beaker::Options::HostsFileParser.parse_hosts_file(@options[:hosts_file])
+        end
+
+        dne_message = "\nHosts file '#{@options[:hosts_file]}' does not exist."
+        dne_message << "\nTrying as beaker-hostgenerator input.\n\n"
+        $stdout.puts dne_message
+        require 'beaker-hostgenerator'
+
+        hosts_file_content = begin
+          bhg_cli = BeakerHostGenerator::CLI.new( [ @options[:hosts_file] ] )
+          bhg_cli.execute
+        rescue BeakerHostGenerator::Exceptions::Error,
+          BeakerHostGenerator::Exceptions::InvalidNodeSpecError => error
+          error_message = "\nbeaker-hostgenerator was not able to use this value as input."
+          error_message << "\nExiting with an Error.\n\n"
+          $stderr.puts error_message
+          raise error
+        end
+
+        @options[:hosts_file_generated] = true
+        Beaker::Options::HostsFileParser.parse_hosts_string( hosts_file_content )
+      end
+
       #Validate all merged options values for correctness
       #
       #Currently checks:

data/lib/beaker/options/presets.rb

@@ -165,9 +165,9 @@ module Beaker
           :repo_proxy             => false,
           :package_proxy          => false,
           :add_el_extras          => false,
-          :epel_url               => "http://mirrors.kernel.org/fedora-epel",
+          :epel_url               => "http://dl.fedoraproject.org/pub/epel",
           :epel_arch              => "i386",
-          :epel_7_pkg             => "epel-release-7-6.noarch.rpm",
+          :epel_7_pkg             => "epel-release-7-7.noarch.rpm",
           :epel_6_pkg             => "epel-release-6-8.noarch.rpm",
           :epel_5_pkg             => "epel-release-5-4.noarch.rpm",
           :consoleport            => 443,

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '2.44.0'
+    STRING = '2.45.0'
   end
 end

data/spec/beaker/cli_spec.rb

@@ -2,7 +2,10 @@ require 'spec_helper'
 
 module Beaker
   describe CLI do
-    let(:cli)      { Beaker::CLI.new }
+    let(:cli)      {
+      allow(File).to receive(:exists?).and_return(true)
+      Beaker::CLI.new
+    }
 
     context 'execute!' do
       before :each do

data/spec/beaker/dsl/install_utils/foss_utils_spec.rb

@@ -1110,68 +1110,45 @@ describe ClassMixedWithDSLInstallUtils do
   end
 
   describe '#remove_puppet_on' do
-    let(:aixhost) { make_host('aix', :platform => 'aix-53-power') }
-    let(:sol10host) { make_host('sol10', :platform => 'solaris-10-x86_64') }
-    let(:sol11host) { make_host('sol11', :platform => 'solaris-11-x86_64') }
-    let(:cumulushost) { make_host('cumulus', :platform => 'cumulus-2.2-amd64') }
-    let(:el6host) { make_host('el6', :platform => 'el-6-x64') }
-
-    pkg_list = 'foo bar'
-
-    it 'uninstalls packages on aix' do
-      result = Beaker::Result.new(aixhost,'')
-      result.stdout = pkg_list
-
-      expected_list = pkg_list
-      cmd_args = ''
-
-      expect( subject ).to receive(:on).exactly(2).times.and_return(result, result)
-      expect( aixhost ).to receive(:uninstall_package).with(expected_list, cmd_args)
-
-      subject.remove_puppet_on( aixhost )
-    end
-
-    it 'uninstalls packages on solaris 10' do
-      result = Beaker::Result.new(sol10host,'')
-      result.stdout = pkg_list
-
-      expected_list = pkg_list
-      cmd_args = '-a noask'
-
-      expect( subject ).to receive(:on).exactly(2).times.and_return(result, result)
-      expect( sol10host ).to receive(:uninstall_package).with(expected_list, cmd_args)
-
-      subject.remove_puppet_on( sol10host  )
-    end
-
-    it 'uninstalls packages on solaris 11' do
-      result = Beaker::Result.new(sol11host,'')
-      result.stdout='foo bar'
-
-      expected_list = pkg_list
-      cmd_args = ''
-
-      expect( subject ).to receive(:on).exactly(4).times.and_return(result, result, result)
-      expect( sol11host ).to receive(:uninstall_package).with(expected_list, cmd_args)
-
-      subject.remove_puppet_on( sol11host  )
-    end
-
-    it 'uninstalls packages on cumulus' do
-      result = Beaker::Result.new(cumulushost,'')
-      result.stdout = pkg_list
-
-      expected_list = pkg_list
-      cmd_args = ''
-
-      expect( subject ).to receive(:on).exactly(2).times.and_return(result, result)
-      expect( cumulushost ).to receive(:uninstall_package).with(expected_list, cmd_args)
-
-      subject.remove_puppet_on( cumulushost  )
+    supported_platforms   = [ 'aix-53-power',
+                              'aix-61-power',
+                              'aix-71-power',
+                              'solaris-10-x86_64',
+                              'solaris-10-x86_64',
+                              'solaris-11-x86_64',
+                              'cumulus-2.2-amd64',
+                              'el-6-x86_64',
+                              'redhat-7-x86_64',
+                              'centos-7-x86_64',
+                              'oracle-7-x86_64',
+                              'scientific-7-x86_64',
+                              'sles-10-x86_64',
+                              'sles-11-x86_64',
+                              'sles-12-s390x'
+                            ]
+
+    supported_platforms.each do |platform|
+      let(:host) { make_host(platform, :platform => platform) }
+
+      pkg_list = 'foo bar'
+
+      it "uninstalls packages on #{platform}" do
+        result = Beaker::Result.new(host,'')
+        result.stdout = pkg_list
+
+        expected_list = pkg_list
+        cmd_args = ''
+
+        expect( subject ).to receive(:on).exactly(2).times.and_return(result, result)
+        expect( host ).to receive(:uninstall_package).with(expected_list, cmd_args)
+
+        subject.remove_puppet_on( host )
+      end
     end
 
-    it 'raises error on other platforms' do
-      expect { subject.remove_puppet_on( el6host ) }.to raise_error(RuntimeError, /unsupported platform/)
+    let(:ubuntu12) { make_host('ubuntu-1204-amd64', :platform => 'ubuntu-1204-amd64') }
+    it 'raises error on unsupported platforms' do
+      expect { subject.remove_puppet_on( ubuntu12 ) }.to raise_error(RuntimeError, /unsupported platform/)
     end
 
   end