beaker 2.52.0 → 3.0.0

data/acceptance/tests/base/external_resources_test.rb

@@ -1,34 +1,16 @@
 test_name 'External Resources Test' do
-  step 'Verify EPEL is correct' do
-    def epel_url_test(el_version, arch, pkg_key)
-      url = "#{@options[:epel_url]}/#{el_version}/#{arch}/#{@options[pkg_key]}"
+  step 'Verify EPEL resources are up and available' do
+    def epel_url_test(el_version)
+      url = "#{options[:epel_url]}/epel-release-latest-#{el_version}.noarch.rpm"
       curl_headers_result = default.exec(Command.new("curl -I #{url}"))
       assert_match(/200 OK/, curl_headers_result.stdout, "EPEL #{el_version} should be reachable")
     end
 
-    step 'arch is i386' do
-      @arch = 'i386'
-      # epel-7 does not provide packages for i386
-      step 'EPEL 6' do
-        epel_url_test(6, @arch, :epel_6_pkg)
-      end
-      step 'EPEL 5' do
-        epel_url_test(5, @arch, :epel_5_pkg)
+    step 'Verify el_version numbers 5,6,7 are found on the epel resource' do
+      [5,6,7].each do |el_version|
+        epel_url_test(el_version)
       end
     end
 
-    step 'arch is x86_64' do
-      @arch = 'x86_64'
-      step 'EPEL 7' do
-        # note: interpolation gets around URL change for epel 7
-        epel_url_test(7, "#{@arch}/e", :epel_7_pkg)
-      end
-      step 'EPEL 6' do
-        epel_url_test(6, @arch, :epel_6_pkg)
-      end
-      step 'EPEL 5' do
-        epel_url_test(5, @arch, :epel_5_pkg)
-      end
-    end
   end
-end
+end

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

@@ -27,6 +27,112 @@ hosts.each do |host|
   end
 end
 
+step "#get_env_var : can get a specific environment variable"
+hosts.each do |host|
+  env_prefix = 'BEAKER' + SecureRandom.hex(4).upcase
+  env_param1 = "#{env_prefix}_p1"
+  env_value1 = "#{env_prefix}_v1"
+
+  host.clear_env_var(env_param1)
+  host.add_env_var(env_param1,env_value1)
+
+  val = host.get_env_var(env_param1)
+
+  assert_match(/^#{env_param1}=#{env_value1}$/, val, "get_env_var can get a specific environment variable")
+end
+
+step "#get_env_var : should not match a partial env key name"
+hosts.each do |host|
+  env_id = 'BEAKER' + SecureRandom.hex(4).upcase
+  # Used as a prefix
+  env_param1 = "#{env_id}_pre"
+  env_value1 = "#{env_id}_pre"
+  # Used as a suffix
+  env_param2 = "suf_#{env_id}"
+  env_value2 = "suf_#{env_id}"
+  # Used as a infix
+  env_param3 = "in_#{env_id}_in"
+  env_value3 = "in_#{env_id}_in"
+
+  host.clear_env_var(env_param1)
+  host.clear_env_var(env_param2)
+  host.clear_env_var(env_param3)
+  host.add_env_var(env_param1,env_value1)
+  host.add_env_var(env_param1,env_value2)
+  host.add_env_var(env_param1,env_value3)
+
+  val = host.get_env_var(env_id)
+  assert('' == val,'get_env_var should not match a partial env key name')
+end
+
+step "#get_env_var : should not return a match from a key\'s value"
+hosts.each do |host|
+  env_prefix = 'BEAKER' + SecureRandom.hex(4).upcase
+  env_param1 = "#{env_prefix}_p1"
+  env_value1 = "#{env_prefix}_v1"
+
+  host.clear_env_var(env_param1)
+  host.add_env_var(env_param1,env_value1)
+
+  val = host.get_env_var(env_value1)
+  assert('' == val,'get_env_var should not return a match from a key\'s value')
+end
+
+step "#clear_env_var : should only remove the specified key"
+hosts.each do |host|
+  # Note - Must depend on `SecureRandom.hex(4)` creating a unique key as unable to depend on the function under test `clear_env_var`
+  env_id = 'BEAKER' + SecureRandom.hex(4).upcase
+  # Use env_id as a suffix
+  env_param1 = "p1_#{env_id}"
+  env_value1 = "v1_#{env_id}"
+  # Use env_id as a prefix
+  env_param2 = "#{env_id}_p2"
+  env_value2 = "#{env_id}_v2"
+  # Use env_id a key to delete
+  env_param3 = "#{env_id}"
+  env_value3 = "#{env_id}"
+  
+  host.add_env_var(env_param1,env_value1)
+  host.add_env_var(env_param2,env_value2)
+  host.add_env_var(env_param3,env_value3)
+
+  host.clear_env_var(env_param3)
+
+  val = host.get_env_var(env_param1)
+  assert_match(/^#{env_param1}=#{env_value1}$/, val, "#{env_param1} should exist after calling clear_env_var")
+  val = host.get_env_var(env_param2)
+  assert_match(/^#{env_param2}=#{env_value2}$/, val, "#{env_param2} should exist after calling clear_env_var")
+  val = host.get_env_var(env_param3)
+  assert('' == val,"#{env_param3} should not exist after calling clear_env_var")
+end
+
+step "#add_env_var : can add a unique environment variable"
+hosts.each do |host|
+  env_id = 'BEAKER' + SecureRandom.hex(4).upcase
+  env_param1 = "#{env_id}"
+  env_value1 = "#{env_id}"
+  # Use env_id as a prefix
+  env_param2 = "#{env_id}_pre"
+  env_value2 = "#{env_id}_pre"
+  # Use env_id as a suffix
+  env_param3 = "suf_#{env_id}"
+  env_value3 = "suf_#{env_id}"
+
+  host.clear_env_var(env_param1)
+  host.clear_env_var(env_param2)
+  host.clear_env_var(env_param3)
+  host.add_env_var(env_param1,env_value1)
+  host.add_env_var(env_param2,env_value2)
+  host.add_env_var(env_param3,env_value3)
+
+  val = host.get_env_var(env_param1)
+  assert_match(/^#{env_param1}=#{env_value1}$/, val, "#{env_param1} should exist")
+  val = host.get_env_var(env_param2)
+  assert_match(/^#{env_param2}=#{env_value2}$/, val, "#{env_param2} should exist")
+  val = host.get_env_var(env_param3)
+  assert_match(/^#{env_param3}=#{env_value3}$/, val, "#{env_param3} should exist")
+end
+
 step "#add_env_var : can add an environment variable"
 hosts.each do |host|
   host.clear_env_var("test")

data/beaker.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'fakefs', '~> 0.6'
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rake', '~> 11.2'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
@@ -31,34 +31,35 @@ Gem::Specification.new do |s|
   # Run time dependencies
   s.add_runtime_dependency 'minitest', '~> 5.4'
   s.add_runtime_dependency 'json', '~> 1.8'
+  ## json: will stay <2.0 while aws-sdk-v1 is in use
+  ## aws-sdk-2 doesn't require json, so we can give this up when we move
+
   s.add_runtime_dependency 'hocon', '~> 1.0'
-  s.add_runtime_dependency 'net-ssh', '~> 2.9'
+  s.add_runtime_dependency 'net-ssh', '~> 3.2'
   s.add_runtime_dependency 'net-scp', '~> 1.2'
   s.add_runtime_dependency 'inifile', '~> 2.0'
+  ## inifile: keep <3.0, breaks puppet_helpers.rb:puppet_conf_for when updated
+  ## will need to fix that to upgrade this gem
+  ## indicating test from puppet acceptance:
+  ##   tests/security/cve-2013-1652_improper_query_params.rb
+
   s.add_runtime_dependency 'rsync', '~> 1.0.9'
   s.add_runtime_dependency 'open_uri_redirections', '~> 0.2.1'
   s.add_runtime_dependency 'in-parallel', '~> 0.1'
 
   # Run time dependencies that are Beaker libraries
-  s.add_runtime_dependency 'beaker-answers', '~> 0.0'
   s.add_runtime_dependency 'stringify-hash', '~> 0.0'
   s.add_runtime_dependency 'beaker-hiera', '~> 0.0'
-  s.add_runtime_dependency 'beaker-pe', '~> 0.0'
   s.add_runtime_dependency 'beaker-hostgenerator'
 
   # Optional provisioner specific support
-  s.add_runtime_dependency 'rbvmomi', ['~> 1.8', '< 1.9.0']
+  s.add_runtime_dependency 'rbvmomi', '~> 1.9'
   s.add_runtime_dependency 'fission', '~> 0.4'
-  s.add_runtime_dependency 'google-api-client', ['~> 0.8', '< 0.9.5'] # dropped ruby 1.9 rupport in 0.9.5
+  s.add_runtime_dependency 'google-api-client', '~> 0.9'
   s.add_runtime_dependency 'aws-sdk-v1', '~> 1.57'
   s.add_runtime_dependency 'docker-api'
-  s.add_runtime_dependency 'mime-types', '~> 2.99' if RUBY_VERSION < '2.0' # dropped ruby 1.9 rupport in 3.0
-  s.add_runtime_dependency 'fog-google', '~> 0.0.9' # dropped ruby 1.9 support in 0.1
-  s.add_runtime_dependency 'fog', ['~> 1.25', '< 1.35.0']
+  s.add_runtime_dependency 'fog', '~> 1.38'
 
   # So fog doesn't always complain of unmet AWS dependencies
   s.add_runtime_dependency 'unf', '~> 0.1'
-  # public_suffix is required by addressable, so make sure it pulls a version
-  # that still supports ruby 1.9.3
-  s.add_runtime_dependency 'public_suffix', ' < 1.5.0'
 end

data/docs/concepts/shared_options_for_executing_beaker_commands.md

@@ -42,7 +42,7 @@ Specifies standard input to be provided to the command post execution.  Defaults
 
     on host, "this command takes input", {:stdin => "hiya"}
 
-## [:run_in_parallel](how_to/run_in_parallel.md)
+## [:run_in_parallel](../how_to/run_in_parallel.md)
 
 Execute the command against all hosts in parallel
 

data/docs/how_to/hypervisors/openstack.md

@@ -114,3 +114,12 @@ in the `CONFIG` section of your hosts file:
     security_group: ['my_sg', 'default']
 
 This is an optional config parameter.
+
+### Floating IP Pool
+
+The name of the floating IP pool that a VM can grab IPs from. This is useful
+if your organization doesn't have a public pool of floating IPs, or give each
+user their own pool.  It's used in allocating new IPs.  It's an options
+parameter in the CONFIG section of the host file:
+
+    floating_ip_pool: 'my_pool_name'

data/docs/how_to/test_arbitrary_beaker_versions.md

@@ -0,0 +1,46 @@
+# Test arbitrary beaker versions without modifying test code
+
+In order to adjust the beaker version used without commiting a change to a Gemfile,
+we at Puppet often use a method in our code that changes the dependency based on the 
+existence of ENV variables in the shell that beaker is executing from. The code
+itself looks like this:
+
+```ruby
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git[:@][^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+```
+
+Once this method definition is in place in the Gemfile, we can call it in a gem command, like 
+this:
+
+```ruby
+
+gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 2.0')
+```
+
+## Example BEAKER_VERSIONs
+
+### git locations
+
+```
+git@github.com:puppetlabs/beaker.git#master
+git://github.com/puppetlabs/beaker.git#master
+```
+
+### file locations
+```
+file://../relative/path/to/beaker
+```
+By adjusting the shell environment that beaker is running in, we can modify what version of 
+beaker is installed by bundler on your test coordinator without modifying any of the test
+code. This strategy can be used for any gem dependency, and is often used when testing
+[beaker libraries](../concepts/beaker_libraries.md) at Puppet.

data/docs/how_to/upgrade_from_2_to_3.md

@@ -0,0 +1,76 @@
+# How To Upgrade from 2.y to 3.0
+
+This is a guide detailing all the issues to be aware of, and to help people make
+any changes that you might need to move from beaker 2.y to 3.0. To test out 
+beaker 3.0.0, we recommend implementing the strategy outlined [here](test_arbitrary_beaker_versions.md) 
+to ensure this new major release does not break your existing testing.
+
+## Locally Cached Files
+
+This is a change of the `:cache_files_locally` preset from `true` to `false`.
+
+At this time, the `:cache_files_locally` setting only affects the
+[`fetch_http_file` method](https://github.com/puppetlabs/beaker/blob/master/lib/beaker/dsl/helpers/web_helpers.rb#L44).
+This is an internal method used in both Puppet Enterprise (PE) and Open Source
+Puppet install helpers to download files from the internet to the Beaker
+coordinator.
+
+If a file with the same destination name already exists on the coordinator,
+Beaker would not fetch the file and use the cached copy instead. In general,
+this wasn't a big problem because we typically have our version numbers in our
+install artifacts, so file name matching is enough. In our Windows MSI
+installers, however, we would many times not have versions built into the file
+name. Since that's the case, you could get an old version installed because it
+was already on your coordinator filesystem. The `:cache_files_locally` setting
+allows you to set whether you want to use a local file cache, or get fresh
+installers every time. This setting is now set to false, and will get installers
+from the online source every time.
+
+If you'd like to keep this setting the way it was in 2.y, then just set the
+global option `:cache_files_locally` to `false`. Checkout the
+[Argument Processing and Precedence](../concepts/argument_processing_and_precedence.md)
+doc for info on how to do this.
+
+## EPEL package update
+
+In beaker < 3.0.0, the epel package names had hardcoded defaults listed in the 
+presets default; in beaker >= 3.0.0, beaker utilizes the `release-latest` file
+provided on epel mirrors for el versions 5, 6, and 7. Since only the latest epel
+packages are available on epel mirrors, beaker only supports installation of 
+that latest version.
+
+## Solaris and AIX Hypervisors removed
+
+Special cased hypervisor support for Solaris and AIX have been removed in favor
+of a `hypervisor=none` workflow where the provisioning of SUTs is handled separately
+outside of beaker itself. Solaris and AIX are still of course supported as `platform`
+strings; only these special-cased hypervisors have been removed.
+
+## Environment Variable DSL Methods
+
+In [BKR-914](https://tickets.puppetlabs.com/browse/BKR-914) we fixed our host
+methods that deal with environment variables (
+[#add_env_var](http://www.rubydoc.info/github/puppetlabs/beaker/Unix/Exec#add_env_var-instance_method),
+[#get_env_var](http://www.rubydoc.info/github/puppetlabs/beaker/Unix/Exec#get_env_var-instance_method),
+and
+[#clear_env_var](http://www.rubydoc.info/github/puppetlabs/beaker/Unix/Exec#clear_env_var-instance_method)).
+
+Before, these methods used regular expressions that were too loose. This means
+that in an example of a call like `get_env_var('abc')`, the environment variables
+`abc=123`, `xx_abc_xx=123`, and `123=abc` would all be matched, where the intent
+is to get `abc=123` alone. From Beaker 3.0 forward, this will be the case.
+
+## beaker-pe Import Changes
+
+Starting in beaker 3.0, there is no explicit beaker-pe requirement in beaker. This
+separates the two, meaning that you'll have to explicitly require beaker-pe if you
+do need it in your testing. And if you don't need it, you won't get it, limiting
+your dependencies & exposure to unnecessary code.
+
+Luckily, if you do need it, this shouldn't be hard to update. These are the steps
+needed to use beaker-pe with beaker 3.0:
+
+1. put a dependency on beaker-pe in your Gemfile as a sibling to your beaker
+  requirement (make sure beaker-pe is >= 1.0)
+2. put a `require 'beaker-pe'` statement where you'd like to use beaker-pe-specific
+  functionality

data/docs/tutorials/README.md

@@ -0,0 +1,82 @@
+# Tutorials
+
+This doc is here to help you get acquainted with beaker
+and how we run our acceptance tests at Puppet. We'll go
+over the purpose of each doc, giving you an idea of when
+you might need each one. The list has been organized as
+a learning guide for someone new to using beaker, so be
+aware of that if you're just dipping into a topic.
+
+For more high level & motivation topics, checkout our
+[concepts docs](../concepts). If you're looking for
+more details on a topic than what is provided in the
+tutorials, checkout our [how to docs](../how_to). And
+if you'd like API level details, feel free to skip on
+over to our
+[Rubydocs](http://www.rubydoc.info/github/puppetlabs/beaker/frames).
+And without further pre-amble, we beaker!
+
+## Installation
+
+If you haven't installed beaker yet, your guide to doing
+so can be found [here](installation.md).
+
+## Quick Start
+ 
+As a completely new beaker user, the
+[quick start rake tasks doc](quick_start_rake_tasks.md)
+will take you through getting beaker running for the
+first time.
+
+## OK, We're Running. Now What?
+
+This is where things get interesting. There are a
+number of directions you can go, based on your needs.
+Here's a list of the common directions people take at
+this point.
+
+### Test Writing
+
+Most people reading this doc are in Quality orgs, or
+are developers who need to get some testing done for
+their current work. If getting a particular bit of
+testing done is your next step, this is the direction
+for you.
+
+Checkout our [let's write a test](lets_write_a_test.md)
+to start with test writing!
+
+### Running Beaker Itself
+
+For the quick start guide, we resorted to using rake
+tasks to get beaker running quickly and easily. In
+the real world, people need much more customization
+out of their testing environments. One of the main
+ways people provide these options is through
+command line arguments.
+
+If you want to find out more about running beaker
+itself, checkout [the command line](the_command_line.md).
+
+### Environment Details
+
+If you don't need to get your tests running _anywhere_,
+but need them on a ton of Operating Systems (OSes),
+then your next stop is setting up your test environment.
+
+Our
+[creating a test environment doc](creating_a_test_environment.md)
+is the next spot for you!
+
+### High Level Execution Details
+
+For a higher level look at what happens during beaker
+execution, which we call a _run_, checkout our
+[test run doc](test_run.md). A _run_ is an entire
+beaker execution cycle, from when the command is run
+until beaker exits.
+
+As one phase of a test run, the test suites are executed.
+To get more information about the test suites that
+are available, and how you configure them, you can
+checkout our [test suites doc](test_suites.md).

data/lib/beaker/dsl.rb

@@ -3,7 +3,6 @@
   require "beaker/dsl/#{lib}"
 end
 
-require 'beaker-pe'
 module Beaker
   # This is a catch all module for including Puppetlabs home grown testing
   # DSL. This module is mixed into {Beaker::TestCase} and can be
@@ -80,7 +79,6 @@ module Beaker
     include Beaker::DSL::Helpers
     include Beaker::DSL::InstallUtils
     include Beaker::DSL::Patterns
-    include Beaker::DSL::PE
 
     def self.register(helper_module)
       include helper_module