beaker 2.47.1 → 2.48.0

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

@@ -0,0 +1,35 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #archive_file_from" do
+
+  step "archiveroot parameter defaults to `archive/sut-files`" do
+    # Create a remote file to archive
+    filepath = default.tmpfile('archive-file-test')
+    create_remote_file(default, filepath, 'contents ignored')
+
+    # Prepare cleanup so we don't pollute the local filesystem
+    teardown do
+      FileUtils.rm_rf('archive') if Dir.exists?('archive')
+    end
+
+    # Test that the archiveroot default directory is created
+    assert_equal(false, Dir.exists?('archive'))
+    assert_equal(false, Dir.exists?('archive/sut-files'))
+    archive_file_from(default, filepath)
+    assert_equal(true, Dir.exists?('archive/sut-files'))
+  end
+
+  step "file is copied to local <archiveroot>/<host name> directory" do
+    # Create a remote file to archive
+    filepath = default.tmpfile('archive-file-test')
+    create_remote_file(default, filepath, 'number of the beast')
+
+    # Test that the file is copied locally to <archiveroot>/<hostname>/<filepath>
+    Dir.mktmpdir do |tmpdir|
+      archive_file_from(default, filepath, {}, tmpdir)
+      expected_path = File.join(tmpdir, default, filepath)
+      assert(File.exists?(expected_path))
+      assert_equal('number of the beast', File.read(expected_path).strip)
+    end
+  end
+end

data/acceptance/tests/base/host_test.rb

@@ -33,33 +33,33 @@ hosts.each do |host|
   logger.debug("add TEST=1")
   host.add_env_var("TEST", "1")
   logger.debug("add TEST=1 again (shouldn't create duplicate entry)")
-  host.add_env_var("test", "1")
-  logger.debug("add test=2")
-  host.add_env_var("test", "2")
+  host.add_env_var("TEST", "1")
+  logger.debug("add TEST=2")
+  host.add_env_var("TEST", "2")
   logger.debug("ensure that TEST env var has correct setting")
-  logger.debug("add test=3")
-  host.add_env_var("test", "3")
+  logger.debug("add TEST=3")
+  host.add_env_var("TEST", "3")
   logger.debug("ensure that TEST env var has correct setting")
-  val = host.get_env_var("test")
+  val = host.get_env_var("TEST")
   assert_match(/TEST=3(;|:)2(;|:)1$/, val, "add_env_var can correctly add env vars")
 end
 
 step "#add_env_var : can preserve an environment between ssh connections"
 hosts.each do |host|
-  host.clear_env_var("test")
+  host.clear_env_var("TEST")
   logger.debug("add TEST=1")
   host.add_env_var("TEST", "1")
   logger.debug("add TEST=1 again (shouldn't create duplicate entry)")
-  host.add_env_var("test", "1")
-  logger.debug("add test=2")
-  host.add_env_var("test", "2")
+  host.add_env_var("TEST", "1")
+  logger.debug("add TEST=2")
+  host.add_env_var("TEST", "2")
   logger.debug("ensure that TEST env var has correct setting")
-  logger.debug("add test=3")
-  host.add_env_var("test", "3")
+  logger.debug("add TEST=3")
+  host.add_env_var("TEST", "3")
   logger.debug("close the connection")
   host.close
   logger.debug("ensure that TEST env var has correct setting")
-  val = host.get_env_var("test")
+  val = host.get_env_var("TEST")
   assert_match(/TEST=3(;|:)2(;|:)1$/, val, "can preserve an environment between ssh connections")
 end
 
@@ -67,15 +67,15 @@ step "#delete_env_var : can delete an environment"
 hosts.each do |host|
   logger.debug("remove TEST=3")
   host.delete_env_var("TEST", "3")
-  val = host.get_env_var("test")
+  val = host.get_env_var("TEST")
   assert_match(/TEST=2(;|:)1$/, val, "delete_env_var can correctly delete part of a chained env var")
   logger.debug("remove TEST=1")
   host.delete_env_var("TEST", "1")
-  val = host.get_env_var("test")
+  val = host.get_env_var("TEST")
   assert_match(/TEST=2$/, val, "delete_env_var can correctly delete part of a chained env var")
   logger.debug("remove TEST=2")
   host.delete_env_var("TEST", "2")
-  val = host.get_env_var("test")
+  val = host.get_env_var("TEST")
   assert_equal("", val, "delete_env_var fully removes empty env var")
 end
 

data/acceptance/tests/install/from_file.rb

@@ -0,0 +1,20 @@
+test_name 'test generic installers'
+
+confine :except, :platform => /^windows|osx/
+
+step 'install arbitrary msi via url' do
+  hosts.each do |host|
+    if host['platform'] =~ /win/
+      # this should be implemented at the host/win/pkg.rb level someday
+      generic_install_msi_on(host, 'https://releases.hashicorp.com/vagrant/1.8.4/vagrant_1.8.4.msi', {}, {:debug => true})
+    end
+  end
+end
+
+step 'install arbitrary dmg via url' do
+  hosts.each do |host|
+    if host['platform'] =~ /osx/
+      host.generic_install_dmg('https://releases.hashicorp.com/vagrant/1.8.4/vagrant_1.8.4.dmg', 'Vagrant', 'Vagrant.pkg')
+    end
+  end
+end

data/acceptance/tests/puppet/stub_host.rb

@@ -0,0 +1,47 @@
+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/beaker.gemspec

@@ -27,12 +27,7 @@ Gem::Specification.new do |s|
 
   # Documentation dependencies
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
 
-  # Temporary pin for gems no longer compatible with ruby 1.9.3
-  s.add_development_dependency 'activesupport', '~> 4.2'
-  s.add_development_dependency 'rack', '~> 1.6'
   # Run time dependencies
   s.add_runtime_dependency 'minitest', '~> 5.4'
   s.add_runtime_dependency 'json', '~> 1.8'
@@ -55,7 +50,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rbvmomi', '~> 1.8'
   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 'aws-sdk', '~> 1.57'
+  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

data/docs/README.md

@@ -1,36 +1,26 @@
 ![Beaker Muppet Image](http://images4.wikia.nocookie.net/__cb20101015151248/muppet/images/0/05/Beaker.jpg)
 
-## Beaker Info
+Documentation for Beaker can be found in this repository in [the docs/ folder](README.md).
 
-* [MAINTAINERS](/MAINTAINERS.md)
-* [Installing Beaker](Beaker-Installation.md)
-* [Running Beaker Tests ](runner/test_run.md)
-* [How to Beaker](How-To-Beaker.md)
-  * [Creating A Test Environment](Creating-A-Test-Environment.md)
-    * [Roles, What Are They?](Roles-What-Are-They.md)
-    * [Supported Virtualization Techniques - Hypervisor Docs](hypervisors)
-  * [The Command Line](The-Command-Line.md)
-  * [Argument Processing and Precedence](Argument-Processing-and-Precedence.md)
-    * [How To Use User/Password Authentication with Beaker](How-To-Use-User-Password-Authentication-with-Beaker.md)
-  * [Running Masterless Beaker](Beaker-with-Masterless-Puppet.md)
-  * [Types, Puppet 4, & The All-In-One Agent](Types,-Puppet-4,-and-the-All-In-One-Agent.md)
-  * [The Beaker DSL](The-Beaker-DSL.md)
-    * [Beaker DSL on rdoc.info](http://rdoc.info/github/puppetlabs/beaker/master/Beaker/DSL)
-    * [How the confine method works](dsl/confine.md)
-    * [Platform Specific Tag Confines](dsl/platform_specific_tag_confines.md)
-    * [Shared Options for Executing Beaker Commands](Shared-Options-for-Executing-Beaker-Commands.md)
-  * [Let's Write a Test!](Lets-Write-a-Test.md)
-  * [Access The Live Test Console with Pry](Access-the-Live-Test-Console-with-Pry.md)
-  * [Test Tagging](Beaker-Test-Tagging.md)
-  * [Recipes](Beaker-Recipes.md)
-* [Beaker vs. Beaker-rspec](beaker-vs.-beaker-rspec.md)
-* [How to Write a Beaker Test for a Module Using beaker-rspec](How-to-Write-a-Beaker-Test-for-a-Module.md)
-* [Beaker Libraries](Beaker-Libraries.md)
+## Table of Contents
+
+- [Tutorials](tutorials) take you by the hand through the steps to setup a
+beaker run. Start here if you’re new to Beaker or test development.
+- [Concepts](concepts) discuss key topics and concepts at a fairly high
+level and provide useful background information and explanation.
+- [Rubydocs](http://rubydoc.info/github/puppetlabs/beaker/frames) contains the
+technical reference for APIs and other aspects of Beaker. They describe how it
+works and how to use it but assume that you have a basic understanding of key concepts.
+- [How-to guides](how_to) are recipes. They guide you through the steps
+involved in addressing key problems and use-cases. They are more advanced than
+tutorials and assume some knowledge of how Beaker works.
 
 ## Other Resources
 
+In addition to the overview above, which matches Beaker's main README docs section,
+this doc's README has some links to other outside resources:
+
 * [Latest Gem Release Notes](https://github.com/puppetlabs/beaker/blob/master/HISTORY.md#LATEST)
-* [File a Beaker Bug](File-a-Beaker-Bug.md)
 * [Video: Beaker 101 talk at PDXPUG, May 2014](https://www.youtube.com/watch?v=cSyJXTYFXFg)
 * [Podcast: Beaker, May 2014](http://puppetlabs.com/podcasts/podcast-beaker-cloud-enabled-acceptance-testing-tool)
 * [Podcast: Automated Testing with Beaker for Windows, December 2014](http://puppetlabs.com/podcasts/podcast-automated-testing-beaker-windows)

data/docs/{Argument-Processing-and-Precedence.md → concepts/argument_processing_and_precedence.md}

@@ -1,14 +1,14 @@
 Beaker uses arguments and settings from a variety of sources to determine how your test run is executed.
 
-*  [Environment Variables](Argument-Processing-and-Precedence.md#environment-variables)
-* [Host/Config File Options](Argument-Processing-and-Precedence.md#host-file-options)
-* [ARGV](Argument-Processing-and-Precedence.md#argv-or-provided-arguments-array)
-  * [Supported Command Line Arguments](Argument-Processing-and-Precedence.md#supported-command-line-arguments)
-* [Options File Values](Argument-Processing-and-Precedence.md#options-file-values)
-  * [Example Options File](Argument-Processing-and-Precedence.md#example-options-file)
-* [Default Values](Argument-Processing-and-Precedence.md#default-values)
-  * [Beaker Default Values](Argument-Processing-and-Precedence.md#beaker-default-values)
-* [Priority of Settings](Argument-Processing-and-Precedence.md#priority-of-settings)
+*  [Environment Variables](#environment-variables)
+* [Host/Config File Options](#host-file-options)
+* [ARGV](#argv-or-provided-arguments-array)
+  * [Supported Command Line Arguments](#supported-command-line-arguments)
+* [Options File Values](#options-file-values)
+  * [Example Options File](#example-options-file)
+* [Default Values](#default-values)
+  * [Beaker Default Values](#beaker-default-values)
+* [Priority of Settings](#priority-of-settings)
 
 
 ## Environment Variables

data/docs/{Shared-Options-for-Executing-Beaker-Commands.md → 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](runner/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/preserve_hosts.md

@@ -0,0 +1,80 @@
+# How to Preserve Hosts
+
+## Motivation
+
+Often when developing acceptance tests to be run with beaker, you'll want to be
+able to quickly iterate on those tests in an already setup System Under Test
+(SUT) configuration. Beaker provides the ability to do that using its preserved
+hosts functionality.
+
+## How Do I Use It?
+
+Note that where you decide to use this option will affect its precedence. You
+can learn more about this in our
+[argument processing & precedence doc](../topics/argument_processing_and_precedence.md).
+
+### Command-Line Option
+
+The primary way that this option is provided is through the command line, where
+it's represented by the `--preserved-hosts` option. It defaults to `never`, and
+if you run `beaker --help`, you'll see the range of values that can be taken:
+
+    $ beaker --help
+        ...
+        --preserve-hosts [MODE]      How should SUTs be treated post test
+                                     Possible values:
+                                     always (keep SUTs alive)
+                                     onfail (keep SUTs alive if failures occur during testing)
+                                     onpass (keep SUTs alive if no failures occur during testing)
+                                     never (cleanup SUTs - shutdown and destroy any changes made during testing)
+                                     (default: never)
+        ...
+
+### Local Options or Global Config
+
+You can also provide a value for this option wherever you can provide a value
+that gets merged into beaker's global options hash. The two ways to do this are
+to provide it in a local options file, or in the global `CONFIG` section of your
+hosts file. To learn more about how to set these options, check out the
+[Options File Values](../topics/argument_processing_and_precedence.md#options-file-values)
+and the
+[`CONFIG` Section of a Hosts File](../topics/argument_processing_and_precedence.md#config-section-of-hosts-file)
+sections of the
+[argument processing & precedence doc](../topics/argument_processing_and_precedence.md).
+
+Either way, the underlying property name that you will have to set if you use
+these options is `:preserve_hosts`.
+
+## What Does It Do (In Detail)?
+
+Using the preserved hosts functionality outputs a `hosts_preserved.yml` file into
+the directory that holds all of the log files for a particular beaker run. The
+short way to access that directory is to look into the `log/latest` path, which
+is a symlink to the actual log directory for the run.
+
+The `hosts_preserved.yml` file generated by a run differs from the original 
+hosts file passed into Beaker in a number of ways:
+
+- all suites are emptied
+- the host names are updated to point to the IPs (or hostnames) of the VMs since
+they exist and no longer need provisioning
+- the `provision` option is set to `false` (check 
+[Beaker Test Run's](../tutorials/test_run.md) provisioning section for details).
+
+Beaker will also output the lines included below at the end of the run:
+
+    You can re-run commands against the already provisioned SUT(s) with:
+    /.../beaker --hosts log/centos7-64mdac-ubuntu1504-64a/2016-07-18_13_42_44/hosts_preserved.yml --tests smoke_simple.rb --preserve-hosts onpass
+
+The important piece here is the hosts argument, in that it's informing you of
+where the preserved hosts file is located. Of course, until you kick off another
+beaker run, you can also reach this file with the `log/latest/hosts_preserved.yml`
+symlink, as mentioned at the beginning of this section.
+
+## What Do I Do With It?
+
+For subsequent runs, if you want to set something, you'll have to pay attention
+to the precedence of your arguments, to be sure that you are overriding what is
+set in the preserved hosts file. Checkout the
+[argument processing & precedence doc](../topics/argument_processing_and_precedence.md)
+for more details on the precedence order of options parsing.

data/docs/how_to/rake_tasks.md

@@ -0,0 +1,49 @@
+# Rake test tasks for running beaker
+
+## How does it work?
+
+There are some rake tasks that you can use to run Beaker tests from your local project dir.
+
+To use them from within your own project, you will need to require the following file in your project's rakefile:
+
+    require 'beaker/tasks/test'
+
+You will also need to have Beaker installed as part of your bundle.
+
+When you run:
+
+    rake --tasks
+    
+from your project dir, you should see (as well as any rake tasks you have defined locally)
+
+    rake beaker:test[hosts,type]  # Run Beaker Acceptance
+    rake beaker:test:git[hosts]   # Run Beaker Git tests
+    rake beaker:test:pe[hosts]    # Run Beaker PE tests
+
+The last two tasks assume that you have an options file in /acceptance named beaker-git.cfg and beaker-pe.cfg
+respectively.
+
+Your options file would look something like:
+
+    {
+      :type            => 'git',
+      :pre_suite       => ['./acceptance/setup/install.rb'],
+      :hosts_file      => './acceptance/config/windows-2012r2-x86_64.cfg',
+      :log_level       => 'debug',
+      :tests           => ['./acceptance/tests/access_rights_directory', './acceptance/tests/identity',
+                            './acceptance/tests/owner', './acceptance/tests/propagation',
+                            './acceptance/tests/use_cases', './acceptance/tests/access_rights_file', './acceptance/tests/group',
+                            './acceptance/tests/inheritance', './acceptance/tests/parameter_target', './acceptance/tests/purge'],
+      :keyfile         => '~/.ssh/id_rsa-acceptance',
+      :timeout         => 6000
+    }
+
+To use the more generic test task, you will need to pass in the type as the 2nd argument to the rake task:
+
+    rake beaker:test[,smoke]
+    
+This will assume that you have created the file:
+
+    acceptance/beaker-smoke.cfg
+    
+