beaker 3.5.0 → 3.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjA4NTNhN2IzZmUxODliZjcwOGEwNzQ1ZTZiZDBmMDg0ZTY3ZTMxMg==
+    YmVmMDI1YTVjZDNjZmM4ODI2MGUzOTBiNDg2YmVlMDMwZGQyY2M2Mg==
   data.tar.gz: !binary |-
-    NjUyZWJiNmU3MDkyYjNmMjIyMjg4MWU3MjE5ZmQxZDZlMTM0MmYxOA==
+    OWExZDNiOGU2NmRkNGJjYTM3MjlhZGRlODk3M2NiYzBjYTE3NmZkZA==
 SHA512:
   metadata.gz: !binary |-
-    YzEzYTAxMDk1NjcyM2FlMDY0MWVlYTQ2ZjY4Njk0YTU2NWU1NDBlZGE0YmQ2
-    M2RkNjkxMDlhMDI2YjJmNzdhM2Y1MjhmNTlmZjczYjUzOGFkY2E2OGI0N2U1
-    ZmNkNDU5N2MzOTE5NWNiZTU0N2QyZDc3ZGFmZTYyODJkMjA0MmQ=
+    YmRmNjhhMWYzZTEzZTk3ZDRiNTEzMzkwYjE3NzBmZDgzOGQzY2I0NTI4OGUy
+    ZjNmN2ZhNjM5ZDI0ZDY3YTRjOGJhMWRmMjViZWM3YzY0Y2QzNTE4ZjIxYzI4
+    NTQ1ZjU4YzVhMjAwMjUxMjY1Y2VlZmFmZDUzMjU1MGNiZGIwYzY=
   data.tar.gz: !binary |-
-    ZWVjZGY0YjBiYmQ3Y2RlMTljOGVlNjM3NGFkZTBmOGZiNGE4ZWFhMmVhZmFi
-    MTI2ZTUxNzUwNGQ2ODNhNWU2NGEyZGYzNTc1MjdjNWExZTBmNjE4YmRjMzIy
-    NTA1Nzc4MGY5NjIzZDQ5YWRmZThlYzBiODIxOWVlMTZjYTI2YzU=
+    YjA4NjRjYjVjMzEyMzg1ZTk2YWEwMDdhYzU1NTU2NjdlZjY1ZjNlN2EwMzc3
+    MWJlMzE4MGQ5Mzc1N2QxZDQ3YjU0M2U5Nzk3MjE1YWI5YWZhMmE4MzA5MjI2
+    ZjhlYTJjNGRiMTc4YTQzOTlmOTE4N2NhYTQwMjFjNzUxMDQwMGE=

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

@@ -0,0 +1,18 @@
+test_name 'Group Test' do
+  step "#group_get: has an Administrators group on Windows" do
+    hosts.select { |h| h['platform'] =~ /windows/ }.each do |host|
+      host.group_get('Administrators') do |result|
+        refute_match(result.stdout, '1376', 'Output indicates Administrators not found')
+      end
+    end
+  end
+
+  step "#group_get: should not have CroMags group on Windows" do
+    hosts.select { |h| h['platform'] =~ /windows/ }.each do |host|
+      assert_raises Beaker::Host::CommandFailure do
+        host.group_get('CroMags') { |result| }
+      end
+    end
+  end
+
+end

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

@@ -60,7 +60,11 @@ hosts.each do |host|
 
   assert_equal(false, host.check_for_package(package), "'#{package}' not should be installed")
   logger.debug("#{package} should be installed on #{host}")
-  host.install_package(package)
+  cmdline_args = ''
+  # Newer vmpooler hosts created by Packer templates, and running Cygwin 2.4,
+  # must have these switches passed
+  cmdline_args = '--local-install --download' if (host['platform'] =~ /windows/ and host.is_cygwin?)
+  host.install_package(package, cmdline_args)
   assert(host.check_for_package(package), "'#{package}' should be installed")
 
   # windows does not support uninstall_package
@@ -74,4 +78,4 @@ hosts.each do |host|
     end
   end
 
-end
+end

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

@@ -0,0 +1,18 @@
+test_name 'User Test' do
+  step "#user_get: has an Administrator user on Windows" do
+    hosts.select { |h| h['platform'] =~ /windows/ }.each do |host|
+      host.user_get('Administrator') do |result|
+        refute_match(result.stdout, 'NET HELPMSG', 'Output indicates Administrator not found')
+      end
+    end
+  end
+
+  step "#user_get: should not have CaptainCaveman user on Windows" do
+    hosts.select { |h| h['platform'] =~ /windows/ }.each do |host|
+      assert_raises Beaker::Host::CommandFailure do
+        host.user_get('CaptainCaveman') { |result| }
+      end
+    end
+  end
+
+end

data/lib/beaker/cli.rb

@@ -13,11 +13,12 @@ module Beaker
       @timestamp = Time.now
       @options_parser = Beaker::Options::Parser.new
       @options = @options_parser.parse_args
+      @attribution = @options_parser.attribution
       @logger = Beaker::Logger.new(@options)
       InParallel::InParallelExecutor.logger = @logger
-      @options[:logger] = @logger
-      @options[:timestamp] = @timestamp
-      @options[:beaker_version] = Beaker::Version::STRING
+      @options_parser.update_option(:logger, @logger, 'runtime')
+      @options_parser.update_option(:timestamp, @timestamp, 'runtime')
+      @options_parser.update_option(:beaker_version, Beaker::Version::STRING, 'runtime')
       beaker_version_string = VERSION_STRING % @options[:beaker_version]
       @execute = true
 

data/lib/beaker/host.rb

@@ -340,6 +340,13 @@ module Beaker
           @logger.debug "\n#{log_prefix} executed in %0.2f seconds" % seconds
         end
 
+        if options[:reset_connection]
+          # Expect the connection to fail hard and possibly take a long time timeout.
+          # Pre-emptively reset it so we don't wait forever.
+          close
+          return result
+        end
+
         unless options[:silent]
           # What?
           result.log(@logger)

data/lib/beaker/host/pswindows/exec.rb

@@ -42,13 +42,23 @@ module PSWindows::Exec
   end
 
   def get_ip
-    ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IP Address\"') do @echo %f", :accept_all_exit_codes => true).strip
-    if ip == ''
-      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv4 Address\"') do @echo %f", :accept_all_exit_codes => true).strip
-    end
-    if ip == ''
-      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv6 Address\"') do @echo %f").strip
+    # when querying for an IP this way the return value can be formatted like:
+    # IPAddress=
+    # IPAddress={"129.168.0.1"}
+    # IPAddress={"192.168.0.1","2001:db8:aaaa:bbbb:cccc:dddd:eeee:0001"}
+
+    ips = execute("wmic nicconfig where ipenabled=true GET IPAddress /format:list")
+
+    ip = ''
+    ips.each_line do |line|
+      matches = line.split('=')
+      next if matches.length <= 1
+      matches = matches[1].match(/^{"(.*?)"/)
+      next if matches.nil? || matches.captures.nil? || matches.captures.empty?
+      ip = matches.captures[0] if matches && matches.captures
+      break if ip != ''
     end
+
     ip
   end
 

data/lib/beaker/host/pswindows/group.rb

@@ -16,7 +16,7 @@ module PSWindows::Group
 
   def group_get(name, &block)
     execute("net localgroup \"#{name}\"") do |result|
-      fail_test "failed to get group #{name}" unless result.stdout =~ /^Alias name\s+#{name}/
+      fail_test "failed to get group #{name}" if result.exit_code != 0
 
       yield result if block_given?
     end

data/lib/beaker/host/pswindows/user.rb

@@ -16,7 +16,7 @@ module PSWindows::User
 
   def user_get(name, &block)
     execute("net user \"#{name}\"") do |result|
-      fail_test "failed to get user #{name}" unless result.stdout =~ /^User name\s+#{name}/
+      fail_test "failed to get user #{name}" if result.exit_code != 0
 
       yield result if block_given?
     end

data/lib/beaker/host/windows/exec.rb

@@ -2,7 +2,7 @@ module Windows::Exec
   include Beaker::CommandFactory
 
   def reboot
-    exec(Beaker::Command.new('shutdown /f /r /t 0 /d p:4:1 /c "Beaker::Host reboot command issued"'), :expect_connection_failure => true)
+    exec(Beaker::Command.new('shutdown /f /r /t 0 /d p:4:1 /c "Beaker::Host reboot command issued"'), :reset_connection => true)
     # rebooting on windows is sloooooow
     # give it some breathing room before attempting a reconnect
     sleep(40)
@@ -24,13 +24,23 @@ module Windows::Exec
   end
 
   def get_ip
-    ip = execute("ipconfig | grep -i 'IP Address' | cut -d: -f2 | head -1").strip
-    if ip == ''
-      ip = execute("ipconfig | grep -i 'IPv4 Address' | cut -d: -f2 | head -1").strip
-    end
-    if ip == ''
-      ip = execute("ipconfig | grep -i 'IPv6 Address' | cut -d: -f2 | head -1").strip
+    # when querying for an IP this way the return value can be formatted like:
+    # IPAddress=
+    # IPAddress={"129.168.0.1"}
+    # IPAddress={"192.168.0.1","2001:db8:aaaa:bbbb:cccc:dddd:eeee:0001"}
+
+    ips = execute("wmic nicconfig where ipenabled=true GET IPAddress /format:list")
+
+    ip = ''
+    ips.each_line do |line|
+      matches = line.split('=')
+      next if matches.length <= 1
+      matches = matches[1].match(/^{"(.*?)"/)
+      next if matches.nil? || matches.captures.nil? || matches.captures.empty?
+      ip = matches.captures[0] if matches && matches.captures
+      break if ip != ''
     end
+
     ip
   end
 

data/lib/beaker/host/windows/group.rb

@@ -16,7 +16,7 @@ module Windows::Group
 
   def group_get(name, &block)
     execute("net localgroup \"#{name}\"") do |result|
-      fail_test "failed to get group #{name}" unless result.stdout =~ /^Alias name\s+#{name}/
+      fail_test "failed to get group #{name}" if result.exit_code != 0
 
       yield result if block_given?
     end

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

@@ -34,7 +34,7 @@ module Windows::Pkg
         execute(command)
       end
     end
-    execute("#{cygwin} -q -n -N -d -R #{cmdline_args} #{rootdir} -s http://cygwin.osuosl.org -P #{name}")
+    execute("#{cygwin} -q -n -N -d -R #{rootdir} -s http://cygwin.osuosl.org -P #{name} #{cmdline_args}")
   end
 
   def uninstall_package(name, cmdline_args = '')

data/lib/beaker/host/windows/user.rb

@@ -16,7 +16,7 @@ module Windows::User
 
   def user_get(name, &block)
     execute("net user \"#{name}\"") do |result|
-      fail_test "failed to get user #{name}" unless result.stdout =~ /^User name\s+#{name}/
+      fail_test "failed to get user #{name}" if result.exit_code != 0
 
       yield result if block_given?
     end

data/lib/beaker/hypervisor/vagrant.rb

@@ -147,7 +147,8 @@ module Beaker
           ip = m[2]
           @logger.debug("Determined existing vagrant box #{hostname} ip to be: #{ip} ")
         else
-          raise("Unable to determine ip for vagrant box #{hostname}")
+          ip = nil
+          @logger.debug("Unable to determine ip for vagrant box #{hostname}")
         end
       else
         raise("No vagrant file found (should be located at #{@vagrant_file})")

data/lib/beaker/options/parser.rb

@@ -15,6 +15,7 @@ module Beaker
 
       #The OptionsHash of all parsed options
       attr_accessor :options
+      attr_reader :attribution
 
       # Returns the git repository used for git installations
       # @return [String] The git repository
@@ -165,6 +166,34 @@ module Beaker
         @command_line_parser = Beaker::Options::CommandLineParser.new
         @presets             = Beaker::Options::Presets.new
         @validator           = Beaker::Options::Validator.new
+        @attribution         = Beaker::Options::OptionsHash.new
+      end
+
+      # Update the @attribution hash with the source of each key in the options_hash
+      #
+      # @param [Hash] options_hash Options hash 
+      # @param [String] source Where the options were specified
+      # @return [Hash] hash Hash of sources for each key
+      def tag_sources(options_hash, source)
+        hash = Beaker::Options::OptionsHash.new
+        options_hash.each do |key, value|
+          if value.is_a?(Hash)
+            hash[key] = tag_sources(value, source)
+          else
+            hash[key] = source
+          end
+        end
+        hash
+      end
+
+      # Update the @option hash with a value and the @attribution hash with a source
+      #
+      # @param [String] key The key to update in both hashes
+      # @param [Object] value The value to set in the @options hash
+      # @param [String] source The source to set in the @attribution hash
+      def update_option(key, value, source)
+        @options[key] = value
+        @attribution[key] = source
       end
 
       # Parses ARGV or provided arguments array, file options, hosts options and combines with environment variables and
@@ -181,9 +210,12 @@ module Beaker
       # @raise [ArgumentError] Raises error on bad input
       def parse_args(args = ARGV)
         @options                        = @presets.presets
+        @attribution = @attribution.merge(tag_sources(@presets.presets, "preset"))
         cmd_line_options                = @command_line_parser.parse(args)
         cmd_line_options[:command_line] = ([$0] + args).join(' ')
+        @attribution = @attribution.merge(tag_sources(cmd_line_options, "flag"))
         file_options                    = Beaker::Options::OptionsFileParser.parse_options_file(cmd_line_options[:options_file])
+        @attribution = @attribution.merge(tag_sources(file_options, "options_file"))
 
         # merge together command line and file_options
         #   overwrite file options with command line options
@@ -199,16 +231,19 @@ module Beaker
           # merge in host file vars
           #   overwrite options (default, file options, command line) with host file options
           @options      = @options.merge(hosts_options)
+          @attribution = @attribution.merge(tag_sources(hosts_options, "host_file"))
 
           # re-merge the command line options
           #   overwrite options (default, file options, hosts file ) with command line arguments
           @options      = @options.merge(cmd_line_options)
+          @attribution = @attribution.merge(tag_sources(cmd_line_options, "cmd"))
 
           # merge in env vars
           #   overwrite options (default, file options, command line, hosts file) with env
           env_vars      = @presets.env_vars
 
           @options = @options.merge(env_vars)
+          @attribution = @attribution.merge(tag_sources(env_vars, "env"))
 
           normalize_args
         end
@@ -280,15 +315,15 @@ module Beaker
         #will end up being normalized into an array
         LONG_OPTS.each do |opt|
           if @options.has_key?(opt)
-            @options[opt] = split_arg(@options[opt])
+            update_option(opt, split_arg(@options[opt]), 'runtime')
             if RB_FILE_OPTS.include?(opt) && (not @options[opt] == [])
-              @options[opt] = file_list(@options[opt])
+              update_option(opt, file_list(@options[opt]), 'runtime')
             end
             if opt == :install
-              @options[:install] = parse_git_repos(@options[:install])
+              update_option(:install, parse_git_repos(@options[:install]), 'runtime')
             end
           else
-            @options[opt] = []
+            update_option(opt, [], 'runtime')
           end
         end
 

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '3.5.0'
+    STRING = '3.6.0'
   end
 end

data/spec/beaker/cli_spec.rb

@@ -35,6 +35,9 @@ module Beaker
 
           expect( cli ).to receive(:run_suite).exactly( 2 ).times
           expect{ cli.execute! }.to raise_error
+          expect(cli.instance_variable_get(:@attribution)[:logger]).to be == 'runtime'
+          expect(cli.instance_variable_get(:@attribution)[:timestamp]).to be == 'runtime'
+          expect(cli.instance_variable_get(:@attribution)[:beaker_version]).to be == 'runtime'
 
         end
 

data/spec/beaker/host/windows/exec_spec.rb

@@ -51,5 +51,14 @@ module Beaker
         expect(instance.selinux_enabled?).to be === false
       end
     end
+
+    describe '#reboot' do
+      it 'invokes the correct command on the host' do
+        expect( Beaker::Command ).to receive( :new ).with( /^shutdown \/f \/r \/t 0 \/d p:4:1 \/c "Beaker::Host reboot command issued"/ ).and_return( :foo )
+        expect( instance ).to receive( :exec ).with( :foo, :reset_connection => true )
+        expect( instance ).to receive( :sleep )
+        instance.reboot
+      end
+    end
   end
 end

data/spec/beaker/host_spec.rb

@@ -315,6 +315,11 @@ module Beaker
         expect { host.exec(command, opts) }.to_not raise_error
       end
 
+      it 'explicitly closes the connection when :reset_connection is set' do
+        expect( host ).to receive( :close )
+        expect { host.exec(command, :reset_connection => true) }.to_not raise_error
+      end
+
       context "controls the result objects logging" do
         it "and passes a test if the exit_code doesn't match the default :acceptable_exit_codes of 0" do
           result.exit_code = 0

data/spec/beaker/hypervisor/vagrant_spec.rb

@@ -375,9 +375,8 @@ EOF
 
       end
 
-      it "raises an error if it is unable to find an ip" do
-        expect{ vagrant.get_ip_from_vagrant_file("unknown") }.to raise_error
-
+      it "returns nil if it is unable to find an ip" do
+        expect( vagrant.get_ip_from_vagrant_file("unknown") ).to be_nil
       end
 
       it "raises an error if no Vagrantfile is present" do

data/spec/beaker/options/parser_spec.rb

@@ -127,16 +127,35 @@ module Beaker
         before { FakeFS.deactivate! }
 
         it 'pulls the args into key called :command_line' do
-          my_args = ['--log-level', 'debug', '-h', hosts_path]
+          my_args = ['--log-level', 'debug', '-h', hosts_path]  
+
           expect(parser.parse_args(my_args)[:command_line]).to include(my_args.join(' '))
+          expect(parser.attribution[:command_line]).to be == 'cmd'
+          expect(parser.attribution[:hosts_file]).to be == 'cmd'
+          expect(parser.attribution[:log_level]).to be == 'cmd'
+          expect(parser.attribution[:pe_dir]).to be == 'preset'
         end
 
         describe 'does prioritization correctly' do
           let(:env) { @env || {:level => 'highest'} }
           let(:argv) { @argv || {:level => 'second'} }
           let(:host_file) { @host_file || {:level => 'third'} }
-          let(:opt_file) { @opt_file || {:level => 'fourth'} }
-          let(:presets) { {:level => 'lowest'} }
+          let(:opt_file) { @opt_file || {:level => 'fourth', 
+                            :ssh => {
+                              :auth_methods => 'auth123',
+                              :user_known_hosts_file => 'hosts123'
+                            }                                
+          } }
+          let(:presets) { {:level => 'lowest',
+                            :ssh => {
+                              :config => 'config123',
+                              :paranoid => 'paranoid123',
+                              :port => 'port123',
+                              :forward_agent => 'forwardagent123',
+                              :keys => 'keys123',
+                              :keepalive => 'keepalive123'
+                            } 
+          } }
 
           before :each do
             expect(parser).to receive(:normalize_args).and_return(true)
@@ -161,7 +180,9 @@ module Beaker
             mock_out_parsing
 
             opts = parser.parse_args([])
+            attribution = parser.attribution
             expect(opts[:level]).to be == 'lowest'
+            expect(attribution[:level]).to be == 'preset'
           end
 
           it 'options file has fourth priority' do
@@ -169,7 +190,18 @@ module Beaker
             mock_out_parsing
 
             opts = parser.parse_args([])
+            attribution = parser.attribution
+            expect(attribution[:ssh]).to be_a(Hash)
+            expect(attribution[:ssh][:auth_methods]).to be == 'options_file'
+            expect(attribution[:ssh][:user_known_hosts_file]).to be == 'options_file'
+            expect(attribution[:ssh][:config]).to be == 'preset'
+            expect(attribution[:ssh][:paranoid]).to be == 'preset'
+            expect(attribution[:ssh][:port]).to be == 'preset'
+            expect(attribution[:ssh][:forward_agent]).to be == 'preset'
+            expect(attribution[:ssh][:keys]).to be == 'preset'
+            expect(attribution[:ssh][:keepalive]).to be == 'preset'
             expect(opts[:level]).to be == 'fourth'
+            expect(attribution[:level]).to be == 'options_file'
           end
 
           it 'host file CONFIG section has third priority' do
@@ -177,7 +209,9 @@ module Beaker
             mock_out_parsing
 
             opts = parser.parse_args([])
+            attribution = parser.attribution
             expect(opts[:level]).to be == 'third'
+            expect(attribution[:level]).to be == 'host_file'
           end
 
           it 'command line arguments have second priority' do
@@ -185,14 +219,18 @@ module Beaker
             mock_out_parsing
 
             opts = parser.parse_args([])
+            attribution = parser.attribution
             expect(opts[:level]).to be == 'second'
+            expect(attribution[:level]).to be == 'cmd'
           end
 
           it 'env vars have highest priority' do
             mock_out_parsing
 
             opts = parser.parse_args([])
+            attribution = parser.attribution
             expect(opts[:level]).to be == 'highest'
+            expect(attribution[:level]).to be == 'env'
           end
 
         end
@@ -207,9 +245,13 @@ module Beaker
 
           args   = ["-h", hosts_path, "--log-level", log_level, "--type", type, "--install", "PUPPET/1.0,HIERA/hello"]
           output = parser.parse_args(args)
-          expect(output[:hosts_file]).to be == hosts_path
+          attribution = parser.attribution
+          expect(output[:hosts_file]).to be == hosts_path  
+          expect(attribution[:hosts_file]).to be == 'cmd'
           expect(output[:jenkins_build_url]).to be == build_url
+          expect(attribution[:jenkins_build_url]).to be == 'env'
           expect(output[:install]).to include('git://github.com/puppetlabs/hiera.git#hello')
+          expect(attribution[:install]).to be == 'runtime'
 
           ENV["BUILD_URL"] = old_build_url
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -500,10 +500,12 @@ files:
 - acceptance/tests/base/dsl/platform_tag_confiner_test.rb
 - acceptance/tests/base/dsl/structure_test.rb
 - acceptance/tests/base/external_resources_test.rb
+- acceptance/tests/base/host/group_test.rb
 - acceptance/tests/base/host/host_test.rb
 - acceptance/tests/base/host/packages.rb
 - acceptance/tests/base/host/packages_unix.rb
 - acceptance/tests/base/host/reboot_test.rb
+- acceptance/tests/base/host/user_test.rb
 - acceptance/tests/base/host_prebuilt_steps/ssh_environment_test.rb
 - acceptance/tests/base/test_suite/export.rb
 - acceptance/tests/hypervisor/communication_test.rb