beaker 3.18.0 → 3.19.0

data/acceptance/config/puppetgem/acceptance-options.rb

@@ -1,9 +0,0 @@
-{
-    :type                 => 'foss',
-    :add_el_extras        => 'true',
-    :is_puppetserver      => false,
-    :puppetservice        => 'puppet.service',
-    :pre_suite            => 'acceptance/pre_suite/puppet_gem/install.rb',
-    :tests                => 'acceptance/tests/puppet',
-    :'master-start-curl-retries' => 30,
-}.merge(eval File.read('acceptance/config/acceptance-options.rb'))

data/acceptance/config/puppetgit/acceptance-options.rb

@@ -1,9 +0,0 @@
-{
-    :type                 => 'foss',
-    :add_el_extras        => 'true',
-    :is_puppetserver      => false,
-    :puppetservice        => 'puppet.service',
-    :pre_suite            => 'acceptance/pre_suite/puppet_git/install.rb',
-    :tests                => 'acceptance/tests/puppet',
-    :'master-start-curl-retries' => 30,
-}.merge(eval File.read('acceptance/config/acceptance-options.rb'))

data/acceptance/config/puppetpkg/acceptance-options.rb

@@ -1,8 +0,0 @@
-{
-    :type                 => 'foss',
-    :is_puppetserver      => false,
-    :puppetservice        => 'puppet.service',
-    :pre_suite            => 'acceptance/pre_suite/puppet_pkg/install.rb',
-    :tests                => 'acceptance/tests/puppet',
-    :'master-start-curl-retries' => 30,
-}.merge(eval File.read('acceptance/config/acceptance-options.rb'))

data/acceptance/pre_suite/puppet_gem/install.rb

@@ -1,8 +0,0 @@
-hosts.each do |host|
-  install_puppet_from_gem(host, {:version => '3.8.7'})
-  unless host['platform'] =~ /windows/
-    on(host, "touch #{File.join(host.puppet['confdir'],'puppet.conf')}")
-    on(host, puppet('resource user puppet ensure=present'))
-    on(host, puppet('resource group puppet ensure=present'))
-  end
-end

data/acceptance/pre_suite/puppet_git/install.rb

@@ -1,98 +0,0 @@
-begin
-  $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
-  require 'beaker/acceptance/install_utils'
-  extend Beaker::Acceptance::InstallUtils
-end
-test_name 'Puppet git pre-suite'
-
-install = [
-  'facter#2.1.0',
-  'hiera#1.3.4',
-  'puppet#3.8.7'
-]
-
-SourcePath  = Beaker::DSL::InstallUtils::SourcePath
-
-PACKAGES = {
-  :redhat => [
-    'git',
-    'ruby',
-    'rubygem-json', # :add_el_extras is required to find this package
-  ],
-  :debian => [
-    ['git', 'git-core'],
-    'ruby',
-  ],
-  :debian_ruby18 => [
-    'libjson-ruby',
-  ],
-  :solaris_11 => [
-    ['git', 'developer/versioning/git'],
-    ['ruby', 'runtime/ruby-18'],
-  ],
-  :solaris_10 => [
-    'coreutils',
-    'curl', # update curl to fix "CURLOPT_SSL_VERIFYHOST no longer supports 1 as value!" issue
-    'git',
-    'ruby19',
-    'ruby19_dev',
-    'gcc4core',
-  ],
-  :windows => [
-    'git',
-  # there isn't a need for json on windows because it is bundled in ruby 1.9
-  ],
-  :sles => [
-    'git-core',
-  ]
-}
-
-install_packages_on(hosts, PACKAGES, :check_if_exists => true)
-
-hosts.each do |host|
-  case host['platform']
-  when /windows/
-    arch = host[:ruby_arch] || 'x86'
-    step "#{host} Selected architecture #{arch}"
-
-    revision = if arch == 'x64'
-                 '2.1.x-x64'
-               else
-                 '2.1.x-x86'
-               end
-
-    step "#{host} Install ruby from git using revision #{revision}"
-    # TODO remove this step once we are installing puppet from msi packages
-    install_from_git(host, "/opt/puppet-git-repos",
-                     :name => 'puppet-win32-ruby',
-                     :path => build_giturl('puppet-win32-ruby'),
-                     :rev  => revision)
-    on host, 'cd /opt/puppet-git-repos/puppet-win32-ruby; cp -r ruby/* /'
-    on host, 'cd /lib; icacls ruby /grant "Everyone:(OI)(CI)(RX)"'
-    on host, 'cd /lib; icacls ruby /reset /T'
-    on host, 'cd /; icacls bin /grant "Everyone:(OI)(CI)(RX)"'
-    on host, 'cd /; icacls bin /reset /T'
-    on host, 'ruby --version'
-    on host, 'cmd /c gem list'
-  when /solaris/
-    on host, 'gem install json'
-  end
-end
-
-tmp_repos = []
-install.each do |reponame|
-  tmp_repos << extract_repo_info_from("https://github.com/puppetlabs/#{reponame}")
-end
-
-repos = order_packages(tmp_repos)
-
-hosts.each do |host|
-  repos.each do |repo|
-    install_from_git(host, SourcePath, repo)
-  end
-  unless host['platform'] =~ /windows/
-    on(host, "touch #{File.join(host.puppet['confdir'],'puppet.conf')}")
-    on(host, puppet('resource user puppet ensure=present'))
-    on(host, puppet('resource group puppet ensure=present'))
-  end
-end

data/acceptance/pre_suite/puppet_pkg/install.rb

@@ -1,9 +0,0 @@
-# the version is required on windows
-# all versions are required for osx
-install_puppet({
-  :version        => ENV['BEAKER_PUPPET_VERSION'] || '4.8.0',
-  :puppet_agent_version => ENV['BEAKER_PUPPET_AGENT_VERSION'] || '1.8.0'
-})
-
-on(master, puppet('resource user puppet ensure=present'))
-on(master, puppet('resource group puppet ensure=present'))

data/acceptance/tests/puppet/README.md

@@ -1,3 +0,0 @@
-# Beaker Acceptance Tests: puppet
-
-Tests that depend upon Puppet being installed on the SUTs.

data/acceptance/tests/puppet/install_smoke_test.rb

@@ -1,21 +0,0 @@
-test_name "puppet install smoketest"
-
-step 'puppet install smoketest: verify \'facter --help\' can be successfully called on all hosts'
-hosts.each do |host|
-  on host, facter('--help')
-end
-
-step 'puppet install smoketest: verify \'hiera --help\' can be successfully called on all hosts'
-hosts.each do |host|
-  on host, hiera('--help')
-end
-
-step 'puppet install smoketest: verify \'puppet help\' can be successfully called on all hosts'
-hosts.each do |host|
-  on host, puppet('help')
-end
-
-step "puppet install smoketest: can get a configprint of the puppet server setting on all hosts"
-hosts.each do |host|
-  assert(!host.puppet['server'].empty?, "can get a configprint of the puppet server setting")
-end

data/acceptance/tests/puppet/stub_host.rb

@@ -1,47 +0,0 @@
-test_name "validate host stubbing behavior"
-
-def get_hosts_file(host)
-  if host['platform'] =~ /win/
-    hosts_file = "C:\\\\Windows\\\\System32\\\\Drivers\\\\etc\\\\hosts"
-  else
-    hosts_file = '/etc/hosts'
-  end
-  return hosts_file
-end
-
-step 'verify stub_host_on' do
-  step 'should add entry to hosts file' do
-    hosts.each do |host|
-      stub_hosts_on(host, { 'foo' => '1.1.1.1' }, { 'foo' => [ 'bar', 'baz' ] })
-      hosts_file = get_hosts_file(host)
-      result = on host, "cat #{hosts_file}"
-      assert_match %r{foo}, result.stdout
-    end
-  end
-
-  step 'stubbed value should be available for other steps in the test' do
-    hosts.each do |host|
-      hosts_file = get_hosts_file(host)
-      result = on host, "cat #{hosts_file}"
-      assert_match %r{foo}, result.stdout
-    end
-  end
-end
-
-step 'verify with_stub_host_on' do
-  step 'should add entry to hosts file' do
-    hosts.each do |host|
-      hosts_file = get_hosts_file(host)
-      result = with_host_stubbed_on(host, { 'sleepy' => '1.1.1.2' }, { 'sleepy' => [ 'grumpy', 'dopey' ] }) { on host, "cat #{hosts_file}" }
-      assert_match %r{sleepy}, result.stdout
-    end
-  end
-
-  step 'stubbed value should be reverted after the execution of the block' do
-    hosts.each do |host|
-      hosts_file = get_hosts_file(host)
-      result = on host, "cat #{hosts_file}"
-      assert_no_match %r{sleepy}, result.stdout
-    end
-  end
-end

data/acceptance/tests/puppet/web_helpers_test.rb

@@ -1,55 +0,0 @@
-require 'helpers/test_helper'
-require 'webrick'
-require 'webrick/https'
-
-test_name 'dsl::helpers::web_helpers #link_exists?' do
-  cert_name = [
-      %w[CN localhost],
-  ]
-  http_cmd = "ruby -rwebrick -e'WEBrick::HTTPServer.new(:Port => 80, :DocumentRoot => \"/tmp\").start' > /tmp/mylogfile 2>&1 &"
-  https_cmd = "ruby -rwebrick/https -e'WEBrick::HTTPServer.new(:SSLEnable => true, :SSLCertName => #{cert_name}, :Port => 555,:DocumentRoot => \"/tmp\").start' > /tmp/mylogfile 2>&1 &"
-  on(default, http_cmd)
-  on(default, https_cmd)
-  #allow web servers to start up
-  sleep(3)
-  dir = default.tmpdir('test_dir')
-  file = default.tmpfile('test_file')
-  dir.slice! "/tmp"
-  file.slice! "/tmp"
-  dst_dir = 'web_helpers'
-
-  step '#port_open_within? can tell if a port is open' do
-    assert port_open_within?(default,80)
-  end
-
-  step '#link_exists? can tell if a basic link exists' do
-    assert link_exists?("http://#{default}")
-  end
-
-  step '#link_exists? can tell if a basic link does not exist' do
-    assert !link_exists?("http://#{default}/test")
-  end
-
-  step '#link_exists? can use an ssl link' do
-    assert link_exists?("https://#{default}:555")
-  end
-
-  step '#fetch_http_dir can fetch a dir' do
-    assert_equal "#{dst_dir}#{dir}", fetch_http_dir("http://#{default}/#{dir}", dst_dir)
-  end
-
-  step '#fetch_http_dir will raise an error if unable fetch a dir' do
-    exception = assert_raises(RuntimeError) { fetch_http_dir("http://#{default}/tmps", dst_dir) }
-    assert_match /Failed to fetch_remote_dir.*/, exception.message, "#fetch_http_dir raised an unexpected RuntimeError"
-  end
-
-  step '#fetch_http_file can fetch a file' do
-    assert_equal "#{dst_dir}#{file}", fetch_http_file("http://#{default}", file, dst_dir)
-  end
-
-  step '#fetch_http_file will raise an error if unable to fetch a file' do
-    exception = assert_raises(RuntimeError) { fetch_http_file("http://#{default}", "test2.txt", dst_dir) }
-    assert_match /Failed to fetch_remote_file.*/, exception.message, "#fetch_http_dir raised an unexpected RuntimeError"
-  end
-
-end

data/acceptance/tests/puppet/with_puppet_running_on.rb

@@ -1,26 +0,0 @@
-test_name 'skip_test in with_puppet_running_on' do
-  assert_raises SkipTest do
-    with_puppet_running_on(master, {}) do
-      skip_test 'skip rest'
-      assert(false)
-    end
-  end
-end
-
-test_name 'pending_test in with_puppet_running_on' do
-  assert_raises PendingTest do
-    with_puppet_running_on(master, {}) do
-      pending_test 'pending appendix prepended'
-      assert(false)
-    end
-  end
-end
-
-test_name 'fail_test in with_puppet_running_on' do
-  assert_raises FailTest do
-    with_puppet_running_on(master, {}) do
-      fail_test 'fail_test message'
-      assert(false)
-    end
-  end
-end

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

@@ -1,865 +0,0 @@
-require 'timeout'
-require 'inifile'
-require 'resolv'
-
-module Beaker
-  module DSL
-    module Helpers
-      # Methods that help you interact with your puppet installation, puppet must be installed
-      # for these methods to execute correctly
-      module PuppetHelpers
-
-        # Return the regular expression pattern for an IPv4 address
-        def ipv4_regex
-          return /(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/
-        end
-
-        # Return the IP address that given hostname returns when resolved on
-        # the given host.
-        #
-        # @ param [Host] host One object that acts like a Beaker::Host
-        # @ param [String] hostname The hostname to perform a DNS resolution on
-        #
-        # @return [String, nil] An IP address, or nil.
-        def resolve_hostname_on(host, hostname)
-          match = curl_on(host, "--verbose #{hostname}", :accept_all_exit_codes => true).stderr.match(ipv4_regex)
-          return match ? match[0] : nil
-        end
-
-        # @!macro [new] common_opts
-        #   @param [Hash{Symbol=>String}] opts Options to alter execution.
-        #   @option opts [Boolean] :silent (false) Do not produce log output
-        #   @option opts [Array<Fixnum>] :acceptable_exit_codes ([0]) An array
-        #     (or range) of integer exit codes that should be considered
-        #     acceptable.  An error will be thrown if the exit code does not
-        #     match one of the values in this list.
-        #   @option opts [Boolean] :accept_all_exit_codes (false) Consider all
-        #     exit codes as passing.
-        #   @option opts [Boolean] :dry_run (false) Do not actually execute any
-        #     commands on the SUT
-        #   @option opts [String] :stdin (nil) Input to be provided during command
-        #     execution on the SUT.
-        #   @option opts [Boolean] :pty (false) Execute this command in a pseudoterminal.
-        #   @option opts [Boolean] :expect_connection_failure (false) Expect this command
-        #     to result in a connection failure, reconnect and continue execution.
-        #   @option opts [Hash{String=>String}] :environment ({}) These will be
-        #     treated as extra environment variables that should be set before
-        #     running the command.
-        #
-
-        # Return the name of the puppet user.
-        #
-        # @param [Host] host One object that acts like a Beaker::Host
-        #
-        # @note This method assumes puppet is installed on the host.
-        #
-        def puppet_user(host)
-          return host.puppet('master')['user']
-        end
-
-        # Return the name of the puppet group.
-        #
-        # @param [Host] host One object that acts like a Beaker::Host
-        #
-        # @note This method assumes puppet is installed on the host.
-        #
-        def puppet_group(host)
-          return host.puppet('master')['group']
-        end
-
-        # Test Puppet running in a certain run mode with specific options.
-        # This ensures the following steps are performed:
-        # 1. The pre-test Puppet configuration is backed up
-        # 2. A new Puppet configuraton file is layed down
-        # 3. Puppet is started or restarted in the specified run mode
-        # 4. Ensure Puppet has started correctly
-        # 5. Further tests are yielded to
-        # 6. Revert Puppet to the pre-test state
-        # 7. Testing artifacts are saved in a folder named for the test
-        #
-        # @note Whether Puppet is started or restarted depends on what kind of
-        #   server you're running.  Passenger and puppetserver are restarted before.
-        #   Webrick is started before and stopped after yielding, unless you're using
-        #   service scripts, then it'll behave like passenger & puppetserver.
-        #   Passenger and puppetserver (or webrick using service scripts)
-        #   restart after yielding by default.  You can stop this from happening
-        #   by setting the :restart_when_done flag of the conf_opts argument.
-        #
-        # @param [Host] host        One object that act like Host
-        #
-        # @param [Hash{Symbol=>String}] conf_opts  Represents puppet settings.
-        #                            Sections of the puppet.conf may be
-        #                            specified, if no section is specified the
-        #                            a puppet.conf file will be written with the
-        #                            options put in a section named after [mode]
-        # @option conf_opts [String] :__commandline_args__  A special setting for
-        #                            command_line arguments such as --debug or
-        #                            --logdest, which cannot be set in
-        #                            puppet.conf. For example:
-        #
-        #                            :__commandline_args__ => '--logdest /tmp/a.log'
-        #
-        #                            These will only be applied when starting a FOSS
-        #                            master, as a pe master is just bounced.
-        # @option conf_opts [Hash]   :__service_args__  A special setting of options
-        #                            for controlling how the puppet master service is
-        #                            handled. The only setting currently is
-        #                            :bypass_service_script, which if set true will
-        #                            force stopping and starting a webrick master
-        #                            using the start_puppet_from_source_* methods,
-        #                            even if it seems the host has passenger.
-        #                            This is needed in FOSS tests to initialize
-        #                            SSL.
-        # @option conf_opts [Boolean] :restart_when_done  determines whether a restart
-        #                            should be run after the test has been yielded to.
-        #                            Will stop puppet if false. Default behavior
-        #                            is to restart, but you can override this on the
-        #                            host or with this option.
-        #                            (Note: only works for passenger & puppetserver
-        #                            masters (or webrick using the service scripts))
-        # @param [File] testdir      The temporary directory which will hold backup
-        #                            configuration, and other test artifacts.
-        #
-        # @param [Block]             block The point of this method, yields so
-        #                            tests may be ran. After the block is finished
-        #                            puppet will revert to a previous state.
-        #
-        # @example A simple use case to ensure a master is running
-        #     with_puppet_running_on( master ) do
-        #         ...tests that require a master...
-        #     end
-        #
-        # @example Fully utilizing the possiblities of config options
-        #     with_puppet_running_on( master,
-        #                             :main => {:logdest => '/var/blah'},
-        #                             :master => {:masterlog => '/elswhere'},
-        #                             :agent => {:server => 'localhost'} ) do
-        #
-        #       ...tests to be ran...
-        #     end
-        #
-        def with_puppet_running_on host, conf_opts, testdir = host.tmpdir(File.basename(@path)), &block
-          raise(ArgumentError, "with_puppet_running_on's conf_opts must be a Hash. You provided a #{conf_opts.class}: '#{conf_opts}'") if !conf_opts.kind_of?(Hash)
-          cmdline_args = conf_opts[:__commandline_args__]
-          service_args = conf_opts[:__service_args__] || {}
-          restart_when_done = true
-          restart_when_done = host[:restart_when_done] if host.has_key?(:restart_when_done)
-          restart_when_done = conf_opts.fetch(:restart_when_done, restart_when_done)
-          conf_opts = conf_opts.reject { |k,v| [:__commandline_args__, :__service_args__, :restart_when_done].include?(k) }
-
-          curl_retries = host['master-start-curl-retries'] || options['master-start-curl-retries']
-          logger.debug "Setting curl retries to #{curl_retries}"
-
-          if options[:is_puppetserver] || host[:is_puppetserver]
-            confdir = host.puppet('master')['confdir']
-            vardir = host.puppet('master')['vardir']
-
-            if cmdline_args
-              split_args = cmdline_args.split()
-
-              split_args.each do |arg|
-                case arg
-                when /--confdir=(.*)/
-                  confdir = $1
-                when /--vardir=(.*)/
-                  vardir = $1
-                end
-              end
-            end
-
-            puppetserver_opts = { "jruby-puppet" => {
-              "master-conf-dir" => confdir,
-              "master-var-dir" => vardir,
-            }}
-
-            puppetserver_conf = File.join("#{host['puppetserver-confdir']}", "puppetserver.conf")
-            modify_tk_config(host, puppetserver_conf, puppetserver_opts)
-          end
-          begin
-            backup_file = backup_the_file(host, host.puppet('master')['confdir'], testdir, 'puppet.conf')
-            lay_down_new_puppet_conf host, conf_opts, testdir
-
-            if host.use_service_scripts? && !service_args[:bypass_service_script]
-              bounce_service( host, host['puppetservice'], curl_retries )
-            else
-              puppet_master_started = start_puppet_from_source_on!( host, cmdline_args )
-            end
-
-            yield self if block_given?
-
-          # FIXME: these test-flow-control exceptions should be using throw
-            # they can be caught in test_case.  current layout dows not allow it
-          rescue Beaker::DSL::Outcomes::PassTest => early_assertion
-            pass_test(early_assertion)
-          rescue Beaker::DSL::Outcomes::FailTest => early_assertion
-            fail_test(early_assertion)
-          rescue Beaker::DSL::Outcomes::PendingTest => early_assertion
-            pending_test(early_assertion)
-          rescue Beaker::DSL::Outcomes::SkipTest => early_assertion
-            skip_test(early_assertion)
-          rescue Beaker::DSL::Assertions, Minitest::Assertion => early_assertion
-            fail_test(early_assertion)
-          rescue Exception => early_exception
-            original_exception = RuntimeError.new("PuppetAcceptance::DSL::Helpers.with_puppet_running_on failed (check backtrace for location) because: #{early_exception}\n#{early_exception.backtrace.join("\n")}\n")
-            raise(original_exception)
-
-          ensure
-            begin
-
-              if host.use_service_scripts? && !service_args[:bypass_service_script]
-                restore_puppet_conf_from_backup( host, backup_file )
-                if restart_when_done
-                  bounce_service( host, host['puppetservice'], curl_retries )
-                else
-                  host.exec puppet_resource('service', host['puppetservice'], 'ensure=stopped')
-                end
-              else
-                if puppet_master_started
-                  stop_puppet_from_source_on( host )
-                else
-                  dump_puppet_log(host)
-                end
-                restore_puppet_conf_from_backup( host, backup_file )
-              end
-
-            rescue Exception => teardown_exception
-              begin
-                if !host.is_pe?
-                  dump_puppet_log(host)
-                end
-              rescue Exception => dumping_exception
-                logger.error("Raised during attempt to dump puppet logs: #{dumping_exception}")
-              end
-
-              if original_exception
-                logger.error("Raised during attempt to teardown with_puppet_running_on: #{teardown_exception}\n---\n")
-                raise original_exception
-              else
-                raise teardown_exception
-              end
-            end
-          end
-        end
-
-        # Test Puppet running in a certain run mode with specific options,
-        # on the default host
-        # @see #with_puppet_running_on
-        def with_puppet_running conf_opts, testdir = host.tmpdir(File.basename(@path)), &block
-          with_puppet_running_on(default, conf_opts, testdir, &block)
-        end
-
-        # @!visibility private
-        def restore_puppet_conf_from_backup( host, backup_file )
-          puppet_conf = host.puppet('master')['config']
-
-          if backup_file
-            host.exec( Command.new( "if [ -f '#{backup_file}' ]; then " +
-                                        "cat '#{backup_file}' > " +
-                                        "'#{puppet_conf}'; " +
-                                        "rm -f '#{backup_file}'; " +
-                                    "fi" ) )
-          else
-            host.exec( Command.new( "rm -f '#{puppet_conf}'" ))
-          end
-
-        end
-
-        # @!visibility private
-        def start_puppet_from_source_on! host, args = ''
-          host.exec( puppet( 'master', args ) )
-
-          logger.debug 'Waiting for the puppet master to start'
-          unless port_open_within?( host, 8140, 10 )
-            raise Beaker::DSL::FailTest, 'Puppet master did not start in a timely fashion'
-          end
-          logger.debug 'The puppet master has started'
-          return true
-        end
-
-        # @!visibility private
-        def stop_puppet_from_source_on( host )
-          pid = host.exec( Command.new('cat `puppet master --configprint pidfile`') ).stdout.chomp
-          host.exec( Command.new( "kill #{pid}" ) )
-          Timeout.timeout(10) do
-            while host.exec( Command.new( "kill -0 #{pid}"), :acceptable_exit_codes => [0,1] ).exit_code == 0 do
-              # until kill -0 finds no process and we know that puppet has finished cleaning up
-              sleep 1
-            end
-          end
-        end
-
-        # @!visibility private
-        def dump_puppet_log(host)
-          syslogfile = case host['platform']
-            when /fedora|centos|el|redhat|scientific/ then '/var/log/messages'
-            when /ubuntu|debian|cumulus/ then '/var/log/syslog'
-            else return
-          end
-
-          logger.notify "\n*************************"
-          logger.notify "* Dumping master log    *"
-          logger.notify "*************************"
-          host.exec( Command.new( "tail -n 100 #{syslogfile}" ), :acceptable_exit_codes => [0,1])
-          logger.notify "*************************\n"
-        end
-
-        # @!visibility private
-        def lay_down_new_puppet_conf( host, configuration_options, testdir )
-          puppetconf_main = host.puppet('master')['config']
-          puppetconf_filename = File.basename(puppetconf_main)
-          puppetconf_test = File.join(testdir, puppetconf_filename)
-
-          new_conf = puppet_conf_for( host, configuration_options )
-          create_remote_file host, puppetconf_test, new_conf.to_s
-
-          host.exec(
-            Command.new( "cat #{puppetconf_test} > #{puppetconf_main}" ),
-            :silent => true
-          )
-          host.exec( Command.new( "cat #{puppetconf_main}" ) )
-        end
-
-        # @!visibility private
-        def puppet_conf_for host, conf_opts
-          puppetconf = host.exec( Command.new( "cat #{host.puppet('master')['config']}" ) ).stdout
-          new_conf   = IniFile.new(content: puppetconf).merge( conf_opts )
-
-          new_conf
-        end
-
-        # Restarts the named puppet service
-        #
-        # @param [Host] host Host the service runs on
-        # @param [String] service Name of the service to restart
-        # @param [Fixnum] curl_retries Number of seconds to wait for the restart to complete before failing
-        # @param [Fixnum] port Port to check status at
-        #
-        # @return [Result] Result of last status check
-        # @!visibility private
-        def bounce_service host, service, curl_retries = nil, port = nil
-          curl_retries = 120 if curl_retries.nil?
-          port = options[:puppetserver_port] if port.nil?
-          if host.graceful_restarts?
-            service = host.check_for_command('apache2ctl') ? 'apache2ctl' : 'apachectl'
-            apachectl_path = host.is_pe? ? "#{host['puppetsbindir']}/#{service}" : service
-            host.exec(Command.new("#{apachectl_path} graceful"))
-          else
-            result = host.exec(Command.new("service #{service} reload"),
-                               :acceptable_exit_codes => [0,1,3])
-            if result.exit_code == 0
-              return result
-            else
-              host.exec puppet_resource('service', service, 'ensure=stopped')
-              host.exec puppet_resource('service', service, 'ensure=running')
-            end
-          end
-          curl_with_retries(" #{service} ", host, "https://localhost:#{port}", [35, 60], curl_retries)
-        end
-
-        # Runs 'puppet apply' on a remote host, piping manifest through stdin
-        #
-        # @param [Host] host The host that this command should be run on
-        #
-        # @param [String] manifest The puppet manifest to apply
-        #
-        # @!macro common_opts
-        # @option opts [Boolean]  :parseonly (false) If this key is true, the
-        #                          "--parseonly" command line parameter will
-        #                          be passed to the 'puppet apply' command.
-        #
-        # @option opts [Boolean]  :trace (false) If this key exists in the Hash,
-        #                         the "--trace" command line parameter will be
-        #                         passed to the 'puppet apply' command.
-        #
-        # @option opts [Array<Integer>] :acceptable_exit_codes ([0]) The list of exit
-        #                          codes that will NOT raise an error when found upon
-        #                          command completion.  If provided, these values will
-        #                          be combined with those used in :catch_failures and
-        #                          :expect_failures to create the full list of
-        #                          passing exit codes.
-        #
-        # @option opts [Hash]     :environment Additional environment variables to be
-        #                         passed to the 'puppet apply' command
-        #
-        # @option opts [Boolean]  :catch_failures (false) By default `puppet
-        #                         --apply` will exit with 0, which does not count
-        #                         as a test failure, even if there were errors or
-        #                         changes when applying the manifest. This option
-        #                         enables detailed exit codes and causes a test
-        #                         failure if `puppet --apply` indicates there was
-        #                         a failure during its execution.
-        #
-        # @option opts [Boolean]  :catch_changes (false) This option enables
-        #                         detailed exit codes and causes a test failure
-        #                         if `puppet --apply` indicates that there were
-        #                         changes or failures during its execution.
-        #
-        # @option opts [Boolean]  :expect_changes (false) This option enables
-        #                         detailed exit codes and causes a test failure
-        #                         if `puppet --apply` indicates that there were
-        #                         no resource changes during its execution.
-        #
-        # @option opts [Boolean]  :expect_failures (false) This option enables
-        #                         detailed exit codes and causes a test failure
-        #                         if `puppet --apply` indicates there were no
-        #                         failure during its execution.
-        #
-        # @option opts [Boolean]  :future_parser (false) This option enables
-        #                         the future parser option that is available
-        #                         from Puppet verion 3.2
-        #                         By default it will use the 'current' parser.
-        #
-        # @option opts [Boolean]  :noop (false) If this option exists, the
-        #                         the "--noop" command line parameter will be
-        #                         passed to the 'puppet apply' command.
-        #
-        # @option opts [String]   :modulepath The search path for modules, as
-        #                         a list of directories separated by the system
-        #                         path separator character. (The POSIX path separator
-        #                         is ‘:’, and the Windows path separator is ‘;’.)
-        #
-        # @option opts [String]   :debug (false) If this option exists,
-        #                         the "--debug" command line parameter
-        #                         will be passed to the 'puppet apply' command.
-        # @option opts [Boolean] :run_in_parallel Whether to run on each host in parallel.
-        #
-        # @param [Block] block This method will yield to a block of code passed
-        #                      by the caller; this can be used for additional
-        #                      validation, etc.
-        #
-        # @return [Array<Result>, Result, nil] An array of results, a result object,
-        #   or nil. Check {#run_block_on} for more details on this.
-        def apply_manifest_on(host, manifest, opts = {}, &block)
-          block_on host, opts do | host |
-            on_options = {}
-            on_options[:acceptable_exit_codes] = Array(opts[:acceptable_exit_codes])
-
-            puppet_apply_opts = {}
-            if opts[:debug]
-              puppet_apply_opts[:debug] = nil
-            else
-              puppet_apply_opts[:verbose] = nil
-            end
-            puppet_apply_opts[:parseonly] = nil if opts[:parseonly]
-            puppet_apply_opts[:trace] = nil if opts[:trace]
-            puppet_apply_opts[:parser] = 'future' if opts[:future_parser]
-            puppet_apply_opts[:modulepath] = opts[:modulepath] if opts[:modulepath]
-            puppet_apply_opts[:noop] = nil if opts[:noop]
-
-            # From puppet help:
-            # "... an exit code of '2' means there were changes, an exit code of
-            # '4' means there were failures during the transaction, and an exit
-            # code of '6' means there were both changes and failures."
-            if [opts[:catch_changes],opts[:catch_failures],opts[:expect_failures],opts[:expect_changes]].compact.length > 1
-              raise(ArgumentError,
-                    'Cannot specify more than one of `catch_failures`, ' +
-                    '`catch_changes`, `expect_failures`, or `expect_changes` ' +
-                    'for a single manifest')
-            end
-
-            if opts[:catch_changes]
-              puppet_apply_opts['detailed-exitcodes'] = nil
-
-              # We're after idempotency so allow exit code 0 only.
-              on_options[:acceptable_exit_codes] |= [0]
-            elsif opts[:catch_failures]
-              puppet_apply_opts['detailed-exitcodes'] = nil
-
-              # We're after only complete success so allow exit codes 0 and 2 only.
-              on_options[:acceptable_exit_codes] |= [0, 2]
-            elsif opts[:expect_failures]
-              puppet_apply_opts['detailed-exitcodes'] = nil
-
-              # We're after failures specifically so allow exit codes 1, 4, and 6 only.
-              on_options[:acceptable_exit_codes] |= [1, 4, 6]
-            elsif opts[:expect_changes]
-              puppet_apply_opts['detailed-exitcodes'] = nil
-
-              # We're after changes specifically so allow exit code 2 only.
-              on_options[:acceptable_exit_codes] |= [2]
-            else
-              # Either use the provided acceptable_exit_codes or default to [0]
-              on_options[:acceptable_exit_codes] |= [0]
-            end
-
-            # Not really thrilled with this implementation, might want to improve it
-            # later. Basically, there is a magic trick in the constructor of
-            # PuppetCommand which allows you to pass in a Hash for the last value in
-            # the *args Array; if you do so, it will be treated specially. So, here
-            # we check to see if our caller passed us a hash of environment variables
-            # that they want to set for the puppet command. If so, we set the final
-            # value of *args to a new hash with just one entry (the value of which
-            # is our environment variables hash)
-            if opts.has_key?(:environment)
-              puppet_apply_opts['ENV'] = opts[:environment]
-            end
-
-            file_path = host.tmpfile('apply_manifest.pp')
-            create_remote_file(host, file_path, manifest + "\n")
-
-            if host[:default_apply_opts].respond_to? :merge
-              puppet_apply_opts = host[:default_apply_opts].merge( puppet_apply_opts )
-            end
-
-            on host, puppet('apply', file_path, puppet_apply_opts), on_options, &block
-          end
-        end
-
-        # Runs 'puppet apply' on default host, piping manifest through stdin
-        # @see #apply_manifest_on
-        def apply_manifest(manifest, opts = {}, &block)
-          apply_manifest_on(default, manifest, opts, &block)
-        end
-
-        # @deprecated
-        def run_agent_on(host, arg='--no-daemonize --verbose --onetime --test',
-                         options={}, &block)
-          block_on host do | host |
-            on host, puppet_agent(arg), options, &block
-          end
-        end
-
-        # This method using the puppet resource 'host' will setup host aliases
-        # and register the remove of host aliases via Beaker::TestCase#teardown
-        #
-        # A teardown step is also added to make sure unstubbing of the host is
-        # removed always.
-        #
-        # @param [Host, Array<Host>, String, Symbol] machine    One or more hosts to act upon,
-        #                            or a role (String or Symbol) that identifies one or more hosts.
-        # @param ip_spec [Hash{String=>String}] a hash containing the host to ip
-        #   mappings
-        # @param alias_spec [Hash{String=>Array[String]] an hash containing the host to alias(es) mappings to apply
-        # @example Stub puppetlabs.com on the master to 127.0.0.1 with an alias example.com
-        #   stub_hosts_on(master, {'puppetlabs.com' => '127.0.0.1'}, {'puppetlabs.com' => ['example.com']})
-        def stub_hosts_on(machine, ip_spec, alias_spec={})
-          block_on machine do | host |
-            ip_spec.each do |address, ip|
-              aliases = alias_spec[address] || []
-              manifest =<<-EOS.gsub /^\s+/, ""
-                host { '#{address}':
-                  \tensure       => present,
-                  \tip           => '#{ip}',
-                  \thost_aliases => #{aliases},
-                }
-              EOS
-              logger.notify("Stubbing address #{address} to IP #{ip} on machine #{host}")
-              apply_manifest_on( host, manifest )
-            end
-
-            teardown do
-              ip_spec.each do |address, ip|
-                logger.notify("Unstubbing address #{address} to IP #{ip} on machine #{host}")
-                on( host, puppet('resource', 'host', address, 'ensure=absent') )
-              end
-            end
-          end
-        end
-
-        # This method accepts a block and using the puppet resource 'host' will
-        # setup host aliases before and after that block.
-        #
-        # @param [Host, Array<Host>, String, Symbol] host    One or more hosts to act upon,
-        #                            or a role (String or Symbol) that identifies one or more hosts.
-        # @param ip_spec [Hash{String=>String}] a hash containing the host to ip
-        #   mappings
-        # @param alias_spec [Hash{String=>Array[String]] an hash containing the host to alias(es) mappings to apply
-        # @example Stub forgeapi.puppetlabs.com on the master to 127.0.0.1 with an alias forgeapi.example.com
-        #   with_host_stubbed_on(master, {'forgeapi.puppetlabs.com' => '127.0.0.1'}, {'forgeapi.puppetlabs.com' => ['forgeapi.example.com']}) do
-        #     puppet( "module install puppetlabs-stdlib" )
-        #   end
-        def with_host_stubbed_on(host, ip_spec, alias_spec={}, &block)
-          begin
-            block_on host do |host|
-              # this code is duplicated from the `stub_hosts_on` method. The
-              # `stub_hosts_on` method itself is not used here because this
-              # method is used by modules tests using `beaker-rspec`. Since
-              # the `stub_hosts_on` method contains a `teardown` step, it is
-              # incompatible with `beaker_rspec`.
-              ip_spec.each do |address, ip|
-                aliases = alias_spec[address] || []
-                manifest =<<-EOS.gsub /^\s+/, ""
-                  host { '#{address}':
-                    \tensure       => present,
-                    \tip           => '#{ip}',
-                    \thost_aliases => #{aliases},
-                  }
-                EOS
-                logger.notify("Stubbing address #{address} to IP #{ip} on machine #{host}")
-                apply_manifest_on( host, manifest )
-              end
-            end
-
-            block.call
-
-          ensure
-            ip_spec.each do |address, ip|
-              logger.notify("Unstubbing address #{address} to IP #{ip} on machine #{host}")
-              on( host, puppet('resource', 'host', address, 'ensure=absent') )
-            end
-          end
-        end
-
-        # This method accepts a block and using the puppet resource 'host' will
-        # setup host aliases before and after that block on the default host
-        #
-        # @example Stub puppetlabs.com on the default host to 127.0.0.1
-        #   stub_hosts('puppetlabs.com' => '127.0.0.1')
-        # @see #stub_hosts_on
-        def stub_hosts(ip_spec)
-          stub_hosts_on(default, ip_spec)
-        end
-
-        # This wraps the method `stub_hosts_on` and makes the stub specific to
-        # the forge alias.
-        #
-        # forge api v1 canonical source is forge.puppetlabs.com
-        # forge api v3 canonical source is forgeapi.puppetlabs.com
-        #
-        # @param machine [String] the host to perform the stub on
-        # @param forge_host [String] The URL to use as the forge alias, will default to using :forge_host in the
-        #                             global options hash
-        def stub_forge_on(machine, forge_host = nil)
-          #use global options hash
-          primary_forge_name = 'forge.puppetlabs.com'
-          forge_host ||= options[:forge_host]
-          forge_ip = resolve_hostname_on(machine, forge_host)
-          raise "Failed to resolve forge host '#{forge_host}'" unless forge_ip
-          @forge_ip ||= forge_ip
-          block_on machine do | host |
-            stub_hosts_on(host, {primary_forge_name => @forge_ip}, {primary_forge_name => ['forge.puppet.com','forgeapi.puppetlabs.com','forgeapi.puppet.com']})
-          end
-        end
-
-        # This wraps the method `with_host_stubbed_on` and makes the stub specific to
-        # the forge alias.
-        #
-        # forge api v1 canonical source is forge.puppetlabs.com
-        # forge api v3 canonical source is forgeapi.puppetlabs.com
-        #
-        # @param host [String] the host to perform the stub on
-        # @param forge_host [String] The URL to use as the forge alias, will default to using :forge_host in the
-        #                             global options hash
-        def with_forge_stubbed_on( host, forge_host = nil, &block )
-          #use global options hash
-          primary_forge_name = 'forge.puppetlabs.com'
-          forge_host ||= options[:forge_host]
-          forge_ip = resolve_hostname_on(host, forge_host)
-          raise "Failed to resolve forge host '#{forge_host}'" unless forge_ip
-          @forge_ip ||= forge_ip
-          with_host_stubbed_on( host, {primary_forge_name => @forge_ip}, {primary_forge_name => ['forge.puppet.com','forgeapi.puppetlabs.com','forgeapi.puppet.com']}, &block )
-        end
-
-        # This wraps `with_forge_stubbed_on` and provides it the default host
-        # @see with_forge_stubbed_on
-        def with_forge_stubbed( forge_host = nil, &block )
-          with_forge_stubbed_on( default, forge_host, &block )
-        end
-
-        # This wraps the method `stub_hosts` and makes the stub specific to
-        # the forge alias.
-        #
-        # @see #stub_forge_on
-        def stub_forge(forge_host = nil)
-          #use global options hash
-          forge_host ||= options[:forge_host]
-          stub_forge_on(default, forge_host)
-        end
-
-        # Waits until a successful curl check has happened against puppetdb
-        #
-        # @param [Host] host Host puppetdb is on
-        # @param [Fixnum] nonssl_port Port to make the HTTP status check over
-        # @param [Fixnum] ssl_port Port to make the HTTPS status check over
-        #
-        # @return [Result] Result of the last HTTPS status check
-        def sleep_until_puppetdb_started(host, nonssl_port = nil, ssl_port = nil)
-          nonssl_port = options[:puppetdb_port_nonssl] if nonssl_port.nil?
-          ssl_port = options[:puppetdb_port_ssl] if ssl_port.nil?
-          pe_ver = host['pe_ver'] || '0'
-          if version_is_less(pe_ver, '2016.1.0') then
-            # the status endpoint was introduced in puppetdb 4.0. The earliest
-            # PE release with the 4.x pdb version was 2016.1.0
-            endpoint = 'pdb/meta/v1/version'
-            expected_regex = '\"version\" \{0,\}: \{0,\}\"[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}\"'
-          else
-            endpoint = 'status/v1/services/puppetdb-status'
-            expected_regex = '\"state\" \{0,\}: \{0,\}\"running\"'
-          end
-          retry_on(host,
-                   "curl -m 1 http://localhost:#{nonssl_port}/#{endpoint} | grep '#{expected_regex}'",
-                   {:max_retries => 120})
-          curl_with_retries("start puppetdb (ssl)",
-                            host, "https://#{host.node_name}:#{ssl_port}", [35, 60])
-        end
-
-        # Waits until a successful curl check has happened against puppetserver
-        #
-        # @param [Host] host Host puppetserver is on
-        # @param [Fixnum] port Port to make the HTTPS status check over
-        #
-        # @return [Result] Result of the last HTTPS status check
-        def sleep_until_puppetserver_started(host, port = nil)
-          port = options[:puppetserver_port] if port.nil?
-          curl_with_retries("start puppetserver (ssl)",
-                            host, "https://#{host.node_name}:#{port}", [35, 60])
-        end
-
-        # Waits until a successful curl check has happaned against node classifier
-        #
-        # @param [Host] host Host node classifier is on
-        # @param [Fixnum] port Port to make the HTTPS status check over
-        #
-        # @return [Result] Result of the last HTTPS status check
-        def sleep_until_nc_started(host, port = nil)
-          port = options[:nodeclassifier_port] if port.nil?
-          curl_with_retries("start nodeclassifier (ssl)",
-                            host, "https://#{host.node_name}:#{port}", [35, 60])
-        end
-
-        #stops the puppet agent running on the host
-        # @param [Host, Array<Host>, String, Symbol] agent    One or more hosts to act upon,
-        #                            or a role (String or Symbol) that identifies one or more hosts.
-        # @param [Hash{Symbol=>String}] opts Options to alter execution.
-        # @option opts [Boolean] :run_in_parallel Whether to run on each host in parallel.
-        def stop_agent_on(agent, opts = {})
-          block_on agent, opts do | host |
-            vardir = host.puppet_configprint['vardir']
-            agent_running = true
-            while agent_running
-              agent_running = host.file_exist?("#{vardir}/state/agent_catalog_run.lock")
-              if agent_running
-                sleep 2
-              end
-            end
-
-            # In 4.0 this was changed to just be `puppet`
-            agent_service = 'puppet'
-            if !aio_version?(host)
-              # The agent service is `pe-puppet` everywhere EXCEPT certain linux distros on PE 2.8
-              # In all the case that it is different, this init script will exist. So we can assume
-              # that if the script doesn't exist, we should just use `pe-puppet`
-              agent_service = 'pe-puppet-agent'
-              agent_service = 'pe-puppet' unless host.file_exist?('/etc/init.d/pe-puppet-agent')
-            end
-
-            # Under a number of stupid circumstances, we can't stop the
-            # agent using puppet.  This is usually because of issues with
-            # the init script or system on that particular configuration.
-            avoid_puppet_at_all_costs = false
-            avoid_puppet_at_all_costs ||= host['platform'] =~ /el-4/
-            avoid_puppet_at_all_costs ||= host['pe_ver'] && version_is_less(host['pe_ver'], '3.2') && host['platform'] =~ /sles/
-
-            if avoid_puppet_at_all_costs
-              # When upgrading, puppet is already stopped. On EL4, this causes an exit code of '1'
-              on host, "/etc/init.d/#{agent_service} stop", :acceptable_exit_codes => [0, 1]
-            else
-              on host, puppet_resource('service', agent_service, 'ensure=stopped')
-            end
-          end
-        end
-
-        #stops the puppet agent running on the default host
-        # @see #stop_agent_on
-        def stop_agent
-          stop_agent_on(default)
-        end
-
-        #wait for a given host to appear in the dashboard
-        # @deprecated this method should be removed in the next release since we don't believe the check is necessary.
-        def wait_for_host_in_dashboard(host)
-
-          hostname = host.node_name
-          hostcert = dashboard.puppet['hostcert']
-          key = dashboard.puppet['hostprivkey']
-          cacert = dashboard.puppet['localcacert']
-          retry_on(dashboard, "curl --cert #{hostcert} --key #{key} --cacert #{cacert}\
-                              https://#{dashboard}:4433/classifier-api/v1/nodes | grep '\"name\":\"#{hostname}\"'")
-        end
-
-        # Ensure the host has requested a cert, then sign it
-        #
-        # @param [Host, Array<Host>, String, Symbol] host   One or more hosts, or a role (String or Symbol)
-        #                            that identifies one or more hosts to validate certificate signing.
-        #                            No argument, or an empty array means no validation of success
-        #                            for specific hosts will be performed. This will always execute
-        #                            'cert --sign --all --allow-dns-alt-names' even for a single host.
-        #
-        # @return nil
-        # @raise [FailTest] if process times out
-        def sign_certificate_for(host = [])
-          hostnames = []
-          hosts = host.is_a?(Array) ? host : [host]
-          hosts.each{ |current_host|
-            if [master, dashboard, database].include? current_host
-
-              on current_host, puppet( 'agent -t' ), :acceptable_exit_codes => [0,1,2]
-              on master, puppet( "cert --allow-dns-alt-names sign #{current_host}" ), :acceptable_exit_codes => [0,24]
-
-            else
-              hostnames << Regexp.escape( current_host.node_name )
-            end
-          }
-          if hostnames.size < 1
-            on master, puppet("cert --sign --all --allow-dns-alt-names"),
-               :acceptable_exit_codes => [0,24]
-            return
-          end
-          while hostnames.size > 0
-            last_sleep = 0
-            next_sleep = 1
-            (0..10).each do |i|
-              if i == 10
-                fail_test("Failed to sign cert for #{hostnames}")
-                hostnames.clear
-              end
-              on master, puppet("cert --sign --all --allow-dns-alt-names"), :acceptable_exit_codes => [0,24]
-              out = on(master, puppet("cert --list --all")).stdout
-              if hostnames.all? { |hostname| out =~ /\+ "?#{hostname}"?/ }
-                hostnames.clear
-                break
-              end
-
-              sleep next_sleep
-              (last_sleep, next_sleep) = next_sleep, last_sleep+next_sleep
-            end
-          end
-          host
-        end
-
-        #prompt the master to sign certs then check to confirm the cert for the default host is signed
-        #@see #sign_certificate_for
-        def sign_certificate
-          sign_certificate_for(default)
-        end
-
-        # Create a temp directory on remote host with a user.  Default user
-        # is puppet master user.
-        #
-        # @param [Host] host A single remote host on which to create and adjust
-        # the ownership of a temp directory.
-        # @param [String] name A remote path prefix for the new temp
-        # directory. Default value is '/tmp/beaker'
-        # @param [String] user The name of user that should own the temp
-        # directory. If no username is specified, use `puppet master
-        # --configprint user` to obtain username from master. Raise RuntimeError
-        # if this puppet command returns a non-zero exit code.
-        #
-        # @return [String] Returns the name of the newly-created dir.
-        def create_tmpdir_for_user(host, name='/tmp/beaker', user=nil)
-          if not user
-            result = on host, puppet("master --configprint user")
-            if not result.exit_code == 0
-              raise "`puppet master --configprint` failed, check that puppet is installed on #{host} or explicitly pass in a user name."
-            end
-            user = result.stdout.strip
-          end
-
-          create_tmpdir_on(host, name, user)
-
-        end
-
-      end
-    end
-  end
-end