beaker 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2607aad1f0cfd6109c43fedd0299d4b63e4bdaf4
-  data.tar.gz: 98b8eba8588799c8390c3795ffc8c119435cee7e
+  metadata.gz: 700b4229c8f566623b2a3a3caf5ae26308c4bb82
+  data.tar.gz: 27a0432eaba2fd5cb77080b86faac0c1b337062f
 SHA512:
-  metadata.gz: 023baf9c93434352d5d14a9529a484608f089112cac04356ac5bae33f0df69c7cdeee7168d7c2c5f61624fda1e427a726d3d0d75d343f3aa26eb3cf39b8c0cd4
-  data.tar.gz: 2947ce85bb0fbbfbcbe673b721c7d6809df62dba9dadfb4d70bf618f6bf264492d3f58b45eee47c7d54d45baf963fbca9977ab2b84a8af67d8c0f8e015837126
+  metadata.gz: 906361a2f47a868f2062684db26eac305079df40c11aefbc081316d01722a82ed18f94f808aba9167bbe52a656a4c6d3f07c9a27ec1cc2dd341d1b0bd90a5171
+  data.tar.gz: b763ee73c7882b8280da83dbab6fcbc7817c1d2b19ff5ea7aa43b7fedcf90e0bf5c3c44d8a397b519d437b7f0c36f81051b94377b275e3511481bfadadb2bad8

data/CHANGELOG.md

@@ -11,7 +11,24 @@ Tracking in this Changelog began for this project in version 3.25.0.
 If you're looking for changes from before this, refer to the project's
 git logs & PR history.
 
-# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.1.0...master)
+# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.2.0...master)
+
+# [4.2.0](https://github.com/puppetlabs/beaker/compare/4.1.0...4.2.0) - 2018.11.28
+
+### Added
+
+- `BEAKER_HYPERVISOR` environment variable to choose the beaker-hostgenerator hypervisor
+
+### Changed
+
+- Handling of vsh appended commands for cisco_nexus (BKR-1556)
+- Acceptance tests: Add backoffs to other create_remote_file test
+
+### Fixed
+
+- Don't always start a new container with docker (can be reused between invocations of the provision and exec beaker subcommands) (BKR-1547)
+- Recursively remove unpersisted subcommand options (BKR-1549)
+
 
 # [4.1.0](https://github.com/puppetlabs/beaker/compare/4.0.0...4.1.0) - 2018.10.25
 

data/acceptance/tests/base/dsl/helpers/host_helpers/create_remote_file_test.rb

@@ -2,6 +2,32 @@ require "helpers/test_helper"
 
 test_name "dsl::helpers::host_helpers #create_remote_file" do
 
+  def create_remote_file_with_backups host, remote_filename, contents, opts={}
+    result = nil
+    repeat_fibonacci_style_for(10) do
+      begin
+        result = create_remote_file(
+          host, remote_filename, contents, opts
+        ) # return of block is whether or not we're done repeating
+        if result.is_a?(Rsync::Result) || result.is_a?(Beaker::Result)
+          return result.success?
+        end
+
+        result.each do |individual_result| 
+          next if individual_result.success?
+          return false
+        end
+        true
+      rescue Beaker::Host::CommandFailure => err
+        logger.info("create_remote_file threw command failure, details: ")
+        logger.info("  #{err}")
+        logger.info("continuing back-off execution")
+        false
+      end
+    end
+    result
+  end
+
   if test_scp_error_on_close?
     step "#create_remote_file fails when the remote path does not exist" do
       assert_raises Beaker::Host::CommandFailure do
@@ -21,7 +47,7 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     remote_filename = File.join(remote_tmpdir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
-    create_remote_file default, remote_filename, contents
+    create_remote_file_with_backups default, remote_filename, contents
 
     remote_contents = on(default, "cat #{remote_filename}").stdout
     assert_equal contents, remote_contents
@@ -32,7 +58,7 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     remote_filename = File.join(remote_tmpdir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
-    create_remote_file default, remote_filename, contents, { :protocol => "scp" }
+    create_remote_file_with_backups default, remote_filename, contents, { :protocol => "scp" }
 
     remote_contents = on(default, "cat #{remote_filename}").stdout
     assert_equal contents, remote_contents
@@ -49,7 +75,7 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     remote_filename = File.join(remote_dir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
-    create_remote_file hosts, remote_filename, contents
+    create_remote_file_with_backups hosts, remote_filename, contents
 
     hosts.each do |host|
       remote_contents = on(host, "cat #{remote_filename}").stdout
@@ -68,7 +94,7 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     remote_filename = File.join(remote_dir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
-    create_remote_file hosts, remote_filename, contents, { :protocol => 'scp' }
+    create_remote_file_with_backups hosts, remote_filename, contents, { :protocol => 'scp' }
 
     hosts.each do |host|
       remote_contents = on(host, "cat #{remote_filename}").stdout
@@ -112,19 +138,9 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
       remote_filename = File.join(remote_tmpdir, "testfile.txt")
       contents = fixture_contents("simple_text_file")
 
-      repeat_fibonacci_style_for(10) do
-        begin
-          result = create_remote_file(
-            default, remote_filename, contents, { :protocol => "rsync" }
-          ) # return of block is whether or not we're done repeating
-          result.success?
-        rescue Beaker::Host::CommandFailure => err
-          logger.info("Rsync threw command failure, details: ")
-          logger.info("  #{err}")
-          logger.info("continuing back-off execution")
-          false
-        end
-      end
+      create_remote_file_with_backups(
+        default, remote_filename, contents, { :protocol => "rsync" }
+      )
 
       fails_intermittently("https://tickets.puppetlabs.com/browse/BKR-612",
         "default" => default,
@@ -149,7 +165,9 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
       remote_filename = File.join(remote_tmpdir, "testfile.txt")
       contents = fixture_contents("simple_text_file")
 
-      result = create_remote_file hosts, remote_filename, contents, { :protocol => 'rsync' }
+      result = create_remote_file_with_backups(
+        hosts, remote_filename, contents, { :protocol => 'rsync' }
+      )
 
       hosts.each do |host|
         fails_intermittently("https://tickets.puppetlabs.com/browse/BKR-612",

data/acceptance/tests/base/dsl/helpers/host_helpers/rsync_to_test.rb

@@ -3,6 +3,30 @@ require "rsync"
 
 test_name "dsl::helpers::host_helpers #rsync_to" do
 
+  def rsync_to_with_backups hosts, local_filename, remote_dir
+    result = nil
+    repeat_fibonacci_style_for(10) do
+      begin
+        result = rsync_to(
+          hosts, local_filename, remote_dir
+        ) # return of block is whether or not we're done repeating
+        return result.success? if result.is_a? Rsync::Result
+
+        result.each do |individual_result| 
+          next if individual_result.success?
+          return false
+        end
+        true
+      rescue Beaker::Host::CommandFailure => err
+        logger.info("create_remote_file threw command failure, details: ")
+        logger.info("  #{err}")
+        logger.info("continuing back-off execution")
+        false
+      end
+    end
+    result
+  end
+
   # NOTE: there does not seem to be a reliable way to confine to cygwin hosts.
   confine_block :to, :platform => /windows/ do
 
@@ -99,7 +123,7 @@ test_name "dsl::helpers::host_helpers #rsync_to" do
         remote_tmpdir = default.tmpdir()
         remote_filename = File.join(remote_tmpdir, "testfile.txt")
 
-        result = rsync_to default, local_filename, remote_tmpdir
+        result = rsync_to_with_backups default, local_filename, remote_tmpdir
 
         fails_intermittently("https://tickets.puppetlabs.com/browse/QENG-3053",
           "result"          => result,
@@ -124,23 +148,7 @@ test_name "dsl::helpers::host_helpers #rsync_to" do
         on hosts, "mkdir -p #{remote_tmpdir}"
         remote_filename = File.join(remote_tmpdir, "testfile.txt")
 
-        repeat_fibonacci_style_for(10) do
-          begin
-            result = rsync_to hosts, local_filename, remote_tmpdir
-            return result.success? if result.is_a? Rsync::Result
-
-            result.each do |individual_result| 
-              next if individual_result.success?
-              return false
-            end
-            true
-          rescue Beaker::Host::CommandFailure => err
-            logger.info("Rsync threw command failure, details: ")
-            logger.info("  #{err}")
-            logger.info("continuing back-off execution")
-            false
-          end
-        end
+        result = rsync_to_with_backups(hosts, local_filename, remote_tmpdir)
 
         hosts.each do |host|
           fails_intermittently("https://tickets.puppetlabs.com/browse/QENG-3053",

data/docs/tutorials/lets_write_a_test.md

@@ -89,7 +89,27 @@ end
 You can now run this with
 
 ```console
-    $ beaker --host redhat7-64ma.yaml --pre-suite install.rb --tests mytest.rb
+$ beaker --host redhat7-64ma.yaml --pre-suite install.rb --tests mytest.rb
+```
+
+## Creating the host configuration on at runtime
+
+When you don't want to store a static file, you can also let [beaker-hostgenerator](https://github.com/puppetlabs/beaker-hostgenerator) generate it on the fly. The filename is used as a host specification. A simple example is:
+
+```console
+$ beaker --host centos7-64 --pre-suite install.rb --tests mytest.rb
+```
+
+It's also possible to set the hypervisor and hostname:
+
+```console
+$ beaker --host 'centos7-64{hypervisor=docker,hostname=centos7-64.example.com}' --pre-suite install.rb --tests mytest.rb
+```
+
+An alternative way to set the hypervisor is `BEAKER_HYPERVISOR`:
+
+```console
+$ BEAKER_HYPERVISOR=docker beaker --host centos7-64 --pre-suite install.rb --tests mytest.rb
 ```
 
 Next up you may want to look at the [Beaker test for a module](../how_to/write_a_beaker_test_for_a_module.md) page.

data/lib/beaker/command.rb

@@ -51,6 +51,7 @@ module Beaker
       @environment = {}
       @cmdexe = @options.delete(:cmdexe) || false
       @prepend_cmds = @options.delete(:prepend_cmds) || nil
+      @append_cmds = @options.delete(:append_cmds) || nil
 
       # this is deprecated and will not allow you to use a command line
       # option of `--environment`, please use ENV instead.
@@ -69,21 +70,17 @@ module Beaker
     # @param [String] pc   An optional list of commands to prepend
     #
     # @return [String] This returns the fully formed command line invocation.
-    def cmd_line host, cmd = @command, env = @environment, pc = @prepend_cmds
+    def cmd_line host, cmd = @command, env = @environment, pc = @prepend_cmds, ac = @append_cmds
       env_string = host.environment_string( env )
       prepend_commands = host.prepend_commands( cmd, pc, :cmd_exe => @cmdexe )
-      if host[:platform] =~ /cisco/ && host[:user] != 'root'
-        append_command = '"'
-        cmd = cmd.gsub('"') { '\\"' }
-      end
+      append_commands = host.append_commands( cmd, ac, :cmd_exe => @cmdexe )
 
       # This will cause things like `puppet -t -v agent` which is maybe bad.
       if host[:platform] =~ /cisco_ios_xr/
-        cmd_line_array = [prepend_commands, env_string, cmd, options_string, args_string]
+        cmd_line_array = [prepend_commands, env_string, cmd, options_string, args_string, append_commands]
       else
-        cmd_line_array = [env_string, prepend_commands, cmd, options_string, args_string]
+        cmd_line_array = [env_string, prepend_commands, cmd, options_string, args_string, append_commands]
       end
-      cmd_line_array << append_command unless (cmd =~ /ntpdate/ && host[:platform] =~ /cisco_nexus/)
       cmd_line_array.compact.reject( &:empty? ).join( ' ' )
     end
 

data/lib/beaker/host/cisco.rb

@@ -85,6 +85,19 @@ module Cisco
       prepend_cmds.strip
     end
 
+    # Gets the specific append commands as needed for this host
+    #
+    # @param [String] command Command to be executed
+    # @param [String] user_ac List of user-specified commands to append
+    # @param [Hash] opts optional parameters
+    #
+    # @return [String] Command string as needed for this host
+    def append_commands(command = '', user_ac = '', opts = {})
+      command.gsub('"') {'\\"'}
+      # vsh commands and ntpdate commands do not require an appended `"`
+      return '"' unless command =~ /ntpdate|\/isan\/bin\/vsh/
+    end
+
     # Construct the environment string for this command
     #
     # @param [Hash{String=>String}] env   An optional Hash containing

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

@@ -270,6 +270,17 @@ module Unix::Exec
     user_pc
   end
 
+  # Gets the specific append commands as needed for this host
+  #
+  # @param [String] command Command to be executed
+  # @param [String] user_ac List of user-specified commands to append
+  # @param [Hash] opts optional parameters
+  #
+  # @return [String] Command string as needed for this host
+  def append_commands(command = '', user_ac = '', opts = {})
+    user_ac
+  end
+
   # Fills the user SSH environment file.
   #
   # @param [Hash{String=>String}] env Environment variables to set on the system,

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

@@ -100,6 +100,17 @@ module Windows::Exec
     "#{cygwin_prefix}#{spacing}#{user_pc}"
   end
 
+  # Gets the specific append commands as needed for this host
+  #
+  # @param [String] command Command to be executed
+  # @param [String] user_ac List of user-specified commands to append
+  # @param [Hash] opts optional parameters
+  #
+  # @return [String] Command string as needed for this host
+  def append_commands(command = '', user_ac = '', opts = {})
+    user_ac
+  end
+
   # Checks if selinux is enabled
   # selinux is not available on Windows
   #

data/lib/beaker/network_manager.rb

@@ -12,13 +12,12 @@ module Beaker
     # - only if we are running with ---provision
     # - only if we have a hypervisor
     # - only if either the specific hosts has no specification or has 'provision' in its config
-    # - always if it is a vagrant or docker box (vagrant boxes are always provisioned
-    #     as they always need ssh key hacking. docker boxes need to have docker_container_name
-    #     specified)
+    # - always if it is a vagrant box (vagrant boxes are always provisioned as
+    #   they always need ssh key hacking.)
     def provision? options, host
       command_line_says = options[:provision]
       host_says = host['hypervisor'] && (host.has_key?('provision') ? host['provision'] : true)
-      (command_line_says && host_says) or (host['hypervisor'] =~/(vagrant|docker)/)
+      (command_line_says && host_says) or (host['hypervisor'] =~/(vagrant)/)
     end
 
     attr_accessor :hosts, :hypervisors

data/lib/beaker/options/parser.rb

@@ -291,8 +291,11 @@ module Beaker
         $stdout.puts dne_message
         require 'beaker-hostgenerator'
 
+        host_generator_options = [ @options[:hosts_file] ]
+        host_generator_options += [ '--hypervisor', ENV['BEAKER_HYPERVISOR'] ] if ENV['BEAKER_HYPERVISOR']
+
         hosts_file_content = begin
-          bhg_cli = BeakerHostGenerator::CLI.new( [ @options[:hosts_file] ] )
+          bhg_cli = BeakerHostGenerator::CLI.new(host_generator_options)
           bhg_cli.execute
         rescue BeakerHostGenerator::Exceptions::Error,
           BeakerHostGenerator::Exceptions::InvalidNodeSpecError => error

data/lib/beaker/subcommand.rb

@@ -83,14 +83,7 @@ module Beaker
 
       @cli.parse_options
 
-      # delete unnecessary keys for saving the options
-      options_to_write = @cli.configured_options
-      # Remove keys we don't want to save
-      [:timestamp, :logger, :command_line, :beaker_version, :hosts_file].each do |key|
-        options_to_write.delete(key)
-      end
-
-      options_to_write = SubcommandUtil.sanitize_options_for_save(options_to_write)
+      options_to_write = SubcommandUtil.sanitize_options_for_save(@cli.configured_options)
 
       @cli.logger.notify 'Writing configured options to disk'
       File.open(SubcommandUtil::SUBCOMMAND_OPTIONS, 'w') do |f|

data/lib/beaker/subcommands/subcommand_util.rb

@@ -16,18 +16,33 @@ module Beaker
       SUBCOMMAND_STATE = Pathname("#{CONFIG_DIR}/.subcommand_state.yaml")
       PERSISTED_HOSTS = Pathname("#{CONFIG_DIR}/.hosts.yaml")
       PERSISTED_HYPERVISORS = Pathname("#{CONFIG_DIR}/.hypervisors.yaml")
+      # These options should not be part of persisted subcommand state
+      UNPERSISTED_OPTIONS = [:beaker_version, :command_line, :hosts_file, :logger, :password_prompt, :timestamp]
 
       def self.execute_subcommand?(arg0)
         return false if arg0.nil?
         (Beaker::Subcommand.instance_methods(false) << :help).include? arg0.to_sym
       end
 
+      def self.prune_unpersisted(options)
+        UNPERSISTED_OPTIONS.each do |unpersisted_key|
+          options.each do |key, value|
+            if key == unpersisted_key
+              options.delete(key)
+            elsif value.is_a?(Hash)
+              options[key] = self.prune_unpersisted(value) unless value.empty?
+            end
+          end
+        end
+        options
+      end
+
       def self.sanitize_options_for_save(options)
         # God help us, the YAML library won't stop adding tags to objects, so this
         # hack is a way to force the options into the basic object types so that
         # an eventual YAML.dump or .to_yaml call doesn't add tags.
         # Relevant stackoverflow: http://stackoverflow.com/questions/18178098/how-do-i-have-ruby-yaml-dump-a-hash-subclass-as-a-simple-hash
-        JSON.parse(options.to_json)
+        JSON.parse(prune_unpersisted(options).to_json)
       end
 
       # Print a message to the console and exit with specified exit code, defaults to 1

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.1.0'
+    STRING = '4.2.0'
   end
 end

data/spec/beaker/command_spec.rb

@@ -32,6 +32,7 @@ module Beaker
         @args    = [ 'to', 'the', 'baz' ]
         @options = { :foo => 'bar' }
         allow( host ).to receive( :prepend_commands ).and_return( 'aloha!' )
+        allow( host ).to receive( :append_commands ).and_return( '' )
 
         expect( cmd.cmd_line( host ) ).to be ==  "aloha! /usr/bin/blah --foo=bar to the baz"
       end
@@ -41,6 +42,29 @@ module Beaker
         @args    = [ 'to', 'the', 'baz' ]
         @options = { :foo => 'bar' }
         allow( host ).to receive( :prepend_commands ).and_return( '' )
+        allow( host ).to receive( :append_commands ).and_return( '' )
+
+        expect( cmd.cmd_line( host ) ).to be ==  "/usr/bin/blah --foo=bar to the baz"
+      end
+    end
+
+    describe '#:append_commands' do
+      it 'can append commands' do
+        @command = '/usr/bin/blah'
+        @args    = [ 'to', 'the', 'baz' ]
+        @options = { :foo => 'bar' }
+        allow( host ).to receive( :prepend_commands ).and_return( 'aloha!' )
+        allow( host ).to receive( :append_commands ).and_return( 'moo cow' )
+
+        expect( cmd.cmd_line( host ) ).to be ==  "aloha! /usr/bin/blah --foo=bar to the baz moo cow"
+      end
+
+      it 'can handle no append_cmds' do
+        @command = '/usr/bin/blah'
+        @args    = [ 'to', 'the', 'baz' ]
+        @options = { :foo => 'bar' }
+        allow( host ).to receive( :prepend_commands ).and_return( '' )
+        allow( host ).to receive( :append_commands ).and_return( '' )
 
         expect( cmd.cmd_line( host ) ).to be ==  "/usr/bin/blah --foo=bar to the baz"
       end
@@ -91,6 +115,7 @@ module Beaker
       h = Hash.new
       allow( h ).to receive( :environment_string ).and_return( '' )
       allow( h ).to receive( :prepend_commands ).and_return( '' )
+      allow( h ).to receive( :append_commands ).and_return( '' )
       h
     }
     let(:platform)    { @platform   || 'unix' }

data/spec/beaker/host/cisco_spec.rb

@@ -101,6 +101,71 @@ module Cisco
       end
     end
 
+    describe '#append_commands' do
+
+      context 'for cisco_nexus-7' do
+
+        before :each do
+          @platform = 'cisco_nexus-7-x86_64'
+        end
+
+        it 'appends `"` for commands' do
+          answer_correct = '"'
+          answer_test = host.append_commands( 'fake_command' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns nil when vsh command' do
+          answer_correct = nil
+          answer_test = host.append_commands( '/isan/bin/vsh -c foo' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns `"` when command contains vsh' do
+          answer_correct = '"'
+          answer_test = host.append_commands( 'fake_command -c foo vsh' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns nil when ntpdate command' do
+          answer_correct = nil
+          answer_test = host.append_commands( 'fake/ntpdate/command foo' )
+          expect( answer_test ).to be === answer_correct
+        end
+      end
+
+      context 'for cisco_ios_xr-6' do
+
+        before :each do
+          @platform = 'cisco_ios_xr-6-x86_64'
+        end
+
+        it 'appends `"` for commands' do
+          answer_correct = '"'
+          answer_test = host.append_commands( 'fake_command' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns nil when vsh command' do
+          answer_correct = nil
+          answer_test = host.append_commands( '/isan/bin/vsh -c foo' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns `"` when command contains vsh' do
+          answer_correct = '"'
+          answer_test = host.append_commands( 'fake_command -c foo vsh' )
+          expect( answer_test ).to be === answer_correct
+        end
+
+        it 'returns nil when ntpdate command' do
+          answer_correct = nil
+          answer_test = host.append_commands( 'fake/ntpdate/command foo' )
+          expect( answer_test ).to be === answer_correct
+        end
+      end
+    end
+
     describe '#environment_string' do
 
       context 'for cisco_nexus-7' do

data/spec/beaker/options/parser_spec.rb

@@ -376,6 +376,8 @@ module Beaker
             ).and_return( cli_execute_return )
             expect( BeakerHostGenerator::CLI ).to receive(
               :new
+            ).with(
+              [ 'notafile.yml' ]
             ).and_return( mock_beaker_hostgenerator_cli )
             allow( Beaker::Options::HostsFileParser ).to receive(
               :parse_hosts_string
@@ -383,6 +385,37 @@ module Beaker
             parser.parse_hosts_options
           end
 
+          it 'calls beaker-hostgenerator to get hosts information with a default hypervisor' do
+            old_beaker_hypervisor = ENV['BEAKER_HYPERVISOR']
+            begin
+              ENV['BEAKER_HYPERVISOR'] = 'docker'
+
+              parser.instance_variable_set( :@options, {
+                :hosts_file => 'notafile.yml'
+              } )
+              allow( Beaker::Options::HostsFileParser ).to receive(
+                :parse_hosts_file
+              ).and_raise( Errno::ENOENT )
+
+              mock_beaker_hostgenerator_cli = Object.new
+              cli_execute_return = 'job150865'
+              expect( mock_beaker_hostgenerator_cli ).to receive(
+                :execute
+              ).and_return( cli_execute_return )
+              expect( BeakerHostGenerator::CLI ).to receive(
+                :new
+              ).with(
+                [ 'notafile.yml', '--hypervisor', 'docker' ]
+              ).and_return( mock_beaker_hostgenerator_cli )
+              allow( Beaker::Options::HostsFileParser ).to receive(
+                :parse_hosts_string
+              ).with( cli_execute_return )
+              parser.parse_hosts_options
+            ensure
+              ENV['BEAKER_HYPERVISOR'] = old_beaker_hypervisor
+            end
+          end
+
           it 'sets the :hosts_file_generated flag to signal others when needed' do
             options_test = {
               :hosts_file => 'not_a_file.yml'

data/spec/beaker/subcommand/subcommand_util_spec.rb

@@ -104,6 +104,42 @@ module Beaker
         end
       end
 
+      describe 'prune_unpersisted' do
+        let(:good_options) do
+          { user: 'root', roles: ['agent'] }
+        end
+
+        let(:bad_options) do
+          { logger: Beaker::Logger.new, timestamp: Time.now }
+        end
+
+        let(:initial_options) do
+          Beaker::Options::OptionsHash.new.merge(good_options.merge(bad_options))
+        end
+
+        it 'removes unwanted keys from an options hash' do
+          result = subject.prune_unpersisted(initial_options)
+          good_options.keys.each { |key| expect(result).to have_key(key) }
+          bad_options.keys.each { |key| expect(result).not_to have_key(key) }
+        end
+
+        it 'recurses to remove any nested unwanted keys' do
+          opts = initial_options.merge(child: initial_options.merge(child: initial_options))
+          result = subject.prune_unpersisted(opts)
+
+          good_options.keys.each do |key|
+            expect(result).to have_key(key)
+            expect(result[:child]).to have_key(key)
+            expect(result[:child][:child]).to have_key(key)
+          end
+
+          bad_options.keys.each do |key|
+            expect(result).not_to have_key(key)
+            expect(result[:child]).not_to have_key(key)
+            expect(result[:child][:child]).not_to have_key(key)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec