beaker 4.24.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a564a311561c124625926ad527bf42a3fe0681e3a0a1c8f7780217a6b00f82dc
-  data.tar.gz: 27c0f8cbae1a3f30226cb1dbc08db0cb4464e9e6340114b2b49d13b66e79d587
+  metadata.gz: 9a980145fbc318a89a888401bd94260c191604431b1eaa73b3fde746a4c405f5
+  data.tar.gz: 58a17db7a9772ff339511bb8e96bb71d121291df8fe328fc1e4f3e25d795c765
 SHA512:
-  metadata.gz: 2f5c86fd2c82c44dd258d952d404741281a502dc2a2f987014795e940aa7e1f5f56937b628fe62a3fba8105a9f12866bd6a1a1367859f6ab9acbf6b7224d8d42
-  data.tar.gz: 095358374f8ff2dfe5c0d95c41d5ff6ac621f69ef95a58580c7151d8f7d13bdbd89e0afa5b70be25ce0f3e14121b56c668765c78705bfe9868233cee37feb687
+  metadata.gz: a1e4d5183c9816d8259daa604c5ec0874c66e1373f7826dcb18745cf1436b9210be67cc79becd5e5a1cdf338f968a7b5daefc5aa3eb56118b8720910c7ec23dd
+  data.tar.gz: 94ba6fe73b1ca744dcaff5b4e010e992d995fc908ce8bb7951116a2853d268deb125a7e91923225d5c81d1685669e50a0ca3bbe82253b8a919868ea97a088309

data/CHANGELOG.md

@@ -20,7 +20,17 @@ The headers used in [Keep a Changelog](http://keepachangelog.com) are:
 - Fixed - for any bug fixes.
 - Security - in case of vulnerabilities.
 
-# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.23.2...master)
+# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.25.0...master)
+
+# [4.25.0](https://github.com/puppetlabs/beaker/compare/4.24.0...4.25.0)
+
+### Added
+
+- Execution of Beaker directly through ruby on localhost #1637 ([#1637](https://github.com/puppetlabs/beaker/pull/1637))
+
+### Fixed
+
+- Reliability improvements to the `Host#reboot` method ([#1656](https://github.com/puppetlabs/beaker/pull/1656)) ([#1659](https://github.com/puppetlabs/beaker/pull/1659))
 
 # [4.24.0](https://github.com/puppetlabs/beaker/compare/4.23.0...4.24.0) - 2020-06-05
 

data/lib/beaker/host.rb

@@ -6,7 +6,7 @@ require 'rsync'
 require 'beaker/dsl/helpers'
 require 'beaker/dsl/patterns'
 
-[ 'command', 'ssh_connection'].each do |lib|
+[ 'command', 'ssh_connection', 'local_connection' ].each do |lib|
   require "beaker/#{lib}"
 end
 
@@ -294,6 +294,11 @@ module Beaker
 
     def connection
       # create new connection object if necessary
+      if self['hypervisor'] == 'none' && @name == 'localhost'
+        @connection ||= LocalConnection.connect( { :ssh_env_file => self['ssh_env_file'], :logger => @logger })
+        return @connection
+      end
+
       @connection ||= SshConnection.connect( { :ip => self['ip'], :vmhostname => self['vmhostname'], :hostname => @name },
                                              self['user'],
                                              self['ssh'], { :logger => @logger, :ssh_connection_preference => self[:ssh_connection_preference]} )

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

@@ -14,15 +14,27 @@ module Unix::Exec
   def reboot(wait_time=10, max_connection_tries=9, uptime_retries=18)
     require 'time'
 
+    attempts = 0
+
+    original_boot_time_str = nil
+    original_boot_time_line = nil
     begin
       original_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
       original_boot_time_line = original_boot_time_str.lines.grep(/boot/).first
 
-      raise Beaker::Host::RebootFailure, "Could not find system boot time using 'who -b': #{original_boot_time_str}" unless original_boot_time_line
+      raise Beaker::Host::RebootFailure, "Could not find system boot time using 'who -b': '#{original_boot_time_str}'" unless original_boot_time_line
 
       original_boot_time = Time.parse(original_boot_time_line)
 
       exec(Beaker::Command.new('/bin/systemctl reboot -i || reboot || /sbin/shutdown -r now'), :expect_connection_failure => true)
+    rescue Beaker::Host::RebootFailure => e
+      attempts += 1
+      if attempts < uptime_retries
+        @logger.debug("Could not get initial boot time. Will retry #{uptime_retries - attempts} more times.")
+        retry
+      else
+        raise
+      end
     rescue Beaker::Host::CommandFailure => e
       raise Beaker::Host::RebootFailure, "Command failed when attempting to reboot: #{e.message}"
     rescue RuntimeError => e
@@ -38,7 +50,11 @@ module Unix::Exec
       sleep wait_time
 
       current_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
-      current_boot_time = Time.parse(current_boot_time_str.lines.grep(/boot/).first)
+      current_boot_time_line = current_boot_time_str.lines.grep(/boot/).first
+
+      raise Beaker::Host::RebootFailure, "Could not find system boot time using 'who -b': '#{current_boot_time_str}'" unless current_boot_time_line
+
+      current_boot_time = Time.parse(current_boot_time_line)
 
       @logger.debug("Original Boot Time: #{original_boot_time}")
       @logger.debug("Current Boot Time: #{current_boot_time}")

data/lib/beaker/local_connection.rb

@@ -0,0 +1,86 @@
+require 'open3'
+
+module Beaker
+  class LocalConnection
+
+    attr_accessor :logger, :hostname, :ip
+
+    def initialize options = {}
+      @logger = options[:logger]
+      @ssh_env_file = File.expand_path(options[:ssh_env_file])
+      @hostname = 'localhost'
+      @ip = '127.0.0.1'
+      @options = options
+    end
+
+    def self.connect options = {}
+      connection = new options
+      connection.connect
+      connection
+    end
+
+    def connect options = {}
+      @logger.debug "Local connection, no connection to start"
+    end
+
+    def close
+      @logger.debug "Local connection, no connection to close"
+    end
+
+    def with_env(env)
+      backup = ENV.to_hash
+      ENV.replace(env)
+      yield
+    ensure
+      ENV.replace(backup)
+    end
+
+    def execute command, options = {}, stdout_callback = nil, stderr_callback = stdout_callback
+      result = Result.new(@hostname, command)
+      envs = {}
+      if File.readable?(@ssh_env_file)
+        File.foreach(@ssh_env_file) do |line|
+          key, value = line.split('=')
+          envs[key] = value
+        end
+      end
+
+      begin
+        clean_env = ENV.reject{ |k| k =~ /^BUNDLE|^RUBY|^GEM/ }
+
+        with_env(clean_env) do
+          std_out, std_err, status = Open3.capture3(envs, command)
+          result.stdout << std_out
+          result.stderr << std_err
+          result.exit_code = status.exitstatus
+        end
+      rescue => e
+        result.stderr << e.inspect
+        result.exit_code = 1
+      end
+
+      result.finalize!
+      @logger.last_result = result
+      result
+    end
+
+    def scp_to(source, target, _options = {})
+
+      result = Result.new(@hostname, [source, target])
+      begin
+        FileUtils.cp_r source, target
+      rescue Errno::ENOENT => e
+        @logger.warn "#{e.class} error in cp'ing. Forcing the connection to close, which should " \
+                        "raise an error."
+      end
+
+      result.stdout << "  CP'ed file #{source} to #{target}"
+      result.exit_code = 0
+      result
+    end
+
+    def scp_from(source, target, options = {})
+      scp_to(target, source, options)
+    end
+  end
+end

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.24.0'
+    STRING = '4.25.0'
   end
 end

data/spec/beaker/localhost_connection_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'net/ssh'
+
+module Beaker
+  describe LocalConnection do
+    let( :options )   { { :logger => double('logger').as_null_object, :ssh_env_file => '/path/to/ssh/file'} }
+    subject(:connection) { LocalConnection.new(options) }
+
+    before :each do
+      allow( subject ).to receive(:sleep)
+    end
+
+    describe '#self.connect' do
+      it 'loggs message' do
+        expect(options[:logger]).to receive(:debug).with('Local connection, no connection to start')
+        connection_constructor = LocalConnection.connect(options)
+        expect( connection_constructor ).to be_a_kind_of LocalConnection
+      end
+    end
+
+    describe '#close' do
+      it 'logs message' do
+        expect(options[:logger]).to receive(:debug).with('Local connection, no connection to close')
+        connection.close
+      end
+    end
+
+    describe '#with_env' do
+      it 'sets envs temporarily' do
+        connection.connect
+        connection.with_env({'my_env' => 'my_env_value'}) do
+          expect(ENV.to_hash).to include({'my_env' => 'my_env_value'})
+        end
+        expect(ENV.to_hash).not_to include({'my_env' => 'my_env_value'})
+      end
+    end
+
+    describe '#execute' do
+      it 'calls open3' do
+        expect( Open3 ).to receive( :capture3 ).with({}, 'my_command')
+        connection.connect
+        expect(connection.execute('my_command')).to be_a_kind_of Result
+      end
+
+      it 'sets stdout, stderr and exitcode' do
+        allow(Open3).to receive(:capture3).and_return(['stdout', 'stderr', double({exitstatus: 0})])
+        connection.connect
+        result = connection.execute('my_command')
+        expect(result.exit_code).to eq(0)
+        expect(result.stdout).to eq('stdout')
+        expect(result.stderr).to eq('stderr')
+      end
+
+      it 'sets logger last_result' do
+        allow(Open3).to receive(:capture3).and_return(['stdout', 'stderr', double({exitstatus: 0})])
+        expect(options[:logger]).to receive(:last_result=).with(an_instance_of(Result))
+        connection.connect
+        connection.execute('my_command')
+      end
+
+      it 'sets exitcode to 1, when Open3 raises exeception' do
+        allow(Open3).to receive(:capture3).and_raise Errno::ENOENT
+        connection.connect
+        result = connection.execute('my_failing_command')
+        expect(result.exit_code).to eq(1)
+      end
+    end
+
+    describe '#scp_to' do
+      let(:source) { '/source/path' }
+      let(:dest) { '/dest/path' }
+
+      it 'calls FileUtils.cp_r' do
+        connection.connect
+        expect(FileUtils).to receive(:cp_r).with(source, dest)
+        connection.scp_to(source, dest)
+      end
+
+      it 'returns and Result object' do
+        expect(FileUtils).to receive(:cp_r).and_return(true)
+        connection.connect
+        result = connection.scp_to(source, dest)
+        expect(result.exit_code).to eq(0)
+        expect(result.stdout).to eq("  CP'ed file #{source} to #{dest}")
+      end
+
+      it 'catches exception and logs warning message' do
+        allow(FileUtils).to receive(:cp_r).and_raise Errno::ENOENT
+        expect(options[:logger]).to receive(:warn).with("Errno::ENOENT error in cp'ing. Forcing the connection to close, which should raise an error.")
+        connection.connect
+        connection.scp_to(source, dest)
+      end
+    end
+
+    describe '#scp_from' do
+      let(:source) { '/source/path' }
+      let(:dest) { '/dest/path' }
+
+      it 'callse scp_to with reversed params' do
+        expect(connection).to receive(:scp_to).with(dest, source, {})
+        connection.connect
+        connection.scp_from(source, dest)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.24.0
+  version: 4.25.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -576,6 +576,7 @@ files:
 - lib/beaker/hypervisor.rb
 - lib/beaker/hypervisor/noop.rb
 - lib/beaker/junit.xsl
+- lib/beaker/local_connection.rb
 - lib/beaker/logger.rb
 - lib/beaker/logger_junit.rb
 - lib/beaker/network_manager.rb
@@ -646,6 +647,7 @@ files:
 - spec/beaker/host_prebuilt_steps_spec.rb
 - spec/beaker/host_spec.rb
 - spec/beaker/hypervisor/hypervisor_spec.rb
+- spec/beaker/localhost_connection_spec.rb
 - spec/beaker/logger_junit_spec.rb
 - spec/beaker/logger_spec.rb
 - spec/beaker/network_manager_spec.rb
@@ -699,7 +701,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Let's test Puppet!