beaker 3.12.0 → 3.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGJkNWQ2MjM2NzVmMjFiMzIzNDUwMzBhNGRkMDUzMzFlNjk1ZTk2OA==
+    NDRiMDdjNTBhMTU4NTljNWFmZDM1MDNhZjk0ZDI1MjJiNWI2YzE5ZQ==
   data.tar.gz: !binary |-
-    MTVlOGIwNTBlNmRmOTgyMjc1YzBkZWE3NzU3YzIxZTBmNjc5YWIyMA==
+    NzI4NDM0YTE4ZDMxZWEwODU0YTM1ODQ5YTcwNzIwNjM4YTgzYzU2ZA==
 SHA512:
   metadata.gz: !binary |-
-    MDhiOTc5ZWQyMDA3NWE4MmM4ZjA4MTMwOWJkODg1ZjA3N2Q1Mzk4YmEyNzIw
-    OWVhYzE3OTI2YTFiZDkxNmIzNzA2YzI4YWQ5ZTA0YzMzNTk0ZGJhMDU0NzFm
-    OTJkYmFiZjk3NzVhNTVjZGE0ZjY1Yzc3MGYxNjdjYzdhMzE4NGM=
+    MzQ4NmY3MzljYjJmZTk3ZWU4OTFlODc1Nzk4ZDAxZjAxMjlkZGM0ZTg3ZTQx
+    MjNlMzQzY2JkNGFmNDU4ZmRiYTE2YjYyNTQyMzRiOGY2NjI1YWYzY2ZjYWIx
+    ZmFiN2Q3MjFlMTgwOGNkMmM2YzU5ZTAxYTc5YmM0NjU4MjAyYjc=
   data.tar.gz: !binary |-
-    NWYyYTNiYzgxMGY3OWIxNWMzNGViMTBlYmIyODI4MGQ3MmFiNzYzMTQzZTg3
-    NzQ5ZGJlZDExZDU0Yzc3OTY5M2RkMmEyYzQ5NDU4ZDVhM2M1Y2ExOThmMjQ5
-    NDQyNGIxOTA1YWE0YWVkMWRjMDUyY2RmMDlhZjhlYTU1ZmY1MTQ=
+    MTFmYWUzMTQ3NTc1MzZiNmUyYzdmOTBmNmU2YjIxYjBhMTQ2ODI1NmQzMzc4
+    NzRkODcyYmYwNWZiOTA4NTJiYTZkNTEwMDI3MmU1NzVjNTM3MjY1NzdiNWU5
+    NGQwOGQ2NGJlYTAxYjExYzRhMTQyOTY3ZmVhMDc2OTk1NjllMzg=

data/acceptance/tests/subcommands/init.rb

@@ -1,27 +1,30 @@
 test_name 'use the init subcommand' do
 
   def delete_root_folder_contents
-    on default, 'rm -rf /root/*'
+    on default, 'rm -rf /root/* /root/.beaker'
   end
 
-  step 'ensure that `beaker init` fails correctly when not provided a hypervisor' do
-    expect_failure('it should return a non-zero code when it fails') do
-      result = on(default, 'beaker init', :accept_all_exit_codes => true)
-      refute_equal(0, result.exit_code, '`beaker init` without a hypervisor argument should return a non-zero exit code')
-    end
-  end
+  step 'ensure that `beaker init` exit value should be 1 when not provided with a supported hypervisor' do
+    result = on(default, 'beaker init ec2', :accept_all_exit_codes => true)
+    assert_match(/Invalid hypervisor. Currently supported hypervisors are.+/, result.stdout)
+    refute_equal(0, result.exit_code, '`beaker init` with an unsupported hypervisor argument should return a non-zero exit code')
+	end
 
   step 'ensure that `beaker help init` works' do
     result = on(default, 'beaker help init')
-    assert_equal(0, result.exit_code, '`beaker help init` should return a zero exit code')
+    assert_match(/Usage+/, result.stdout)
   end
 
-  step 'ensure that `beaker init` accepts both vmpooler and vagrant hypervisor arguments' do
+  step 'ensure that `beaker init --help` works' do
+    result = on(default, 'beaker init --help')
+    assert_match(/Usage.+/, result.stdout)
+    assert_equal(0, result.exit_code, '`beaker init --help` should return a zero exit code')
+  end
 
-    ['vmpooler', 'vagrant'].each do |hypervisor|
-      result = on(default, "beaker init --hypervisor=#{hypervisor}")
+  step 'ensure that `beaker init` accepts no argument as well as accepts either vmpooler or vagrant hypervisor arguments' do
+    ['vmpooler', 'vagrant', ''].each do |hypervisor|
+      result = on(default, "beaker init #{hypervisor}")
       assert_match(/Writing host config.+/, result.stdout)
-      assert_equal(0, result.exit_code, "`beaker init --hypervisor=#{hypervisor}` should return a zero exit code")
       step 'ensure that the Rakefile is present' do
         on(default, '[ -e "Rakefile" ]')
       end
@@ -29,14 +32,13 @@ test_name 'use the init subcommand' do
     end
   end
 
-
   step 'ensure that a Rakefile is not overwritten if it does exist prior' do
     delete_root_folder_contents
-    on(default, "beaker init --hypervisor=vmpooler")
+    on(default, "beaker init vmpooler")
     prepended_rakefile = on(default, 'cat Rakefile').stdout
     delete_root_folder_contents
     on(default, 'echo "require \'tempfile\'" >> Rakefile')
-    on(default, 'beaker init --hypervisor=vmpooler', :accept_all_exit_codes => true)
+    on(default, 'beaker init vmpooler', :accept_all_exit_codes => true)
     rakefile = on(default, 'cat Rakefile')
 
     # Assert that the Rakefile contents includes the original and inserted requirements

data/acceptance/tests/subcommands/provision.rb

@@ -0,0 +1,45 @@
+test_name 'use the provision subcommand' do
+
+  def delete_root_folder_contents
+    on default, 'rm -rf /root/* /root/.beaker'
+  end
+
+  step 'ensure that `beaker provision` fails correctly when a configuration has not been initialized' do
+    delete_root_folder_contents
+    result = on(default, 'beaker provision', :accept_all_exit_codes => true)
+    assert_match(/Please initialise a configuration/, result.stdout)
+    refute_equal(0, result.exit_code, '`beaker provision` in an uninitialised configuration should return a non-zero exit code')
+  end
+
+  step 'ensure that `beaker help provision` works' do
+    result = on(default, 'beaker help provision')
+    assert_match(/Usage/, result.stdout)
+    assert_equal(0, result.exit_code, '`beaker help provision` should return a zero exit code')
+  end
+
+  step 'ensure that `beaker provision --help` works' do
+    result = on(default, 'beaker provision --help')
+    assert_match(/Usage/, result.stdout)
+    assert_equal(0, result.exit_code, '`beaker provision --help` should return a zero exit code')
+  end
+
+  step 'ensure that `beaker provision` provisions vmpooler configuration' do
+     result = on(default, "beaker init vmpooler")
+     assert_match(/Writing host config/, result.stdout)
+     assert_equal(0, result.exit_code, "`beaker init vmpooler` should return a zero exit code")
+     step 'ensure that the Rakefile is present' do
+       on(default, '[ -e "Rakefile" ]')
+     end
+     step 'ensure provision provisions, validates, and configures new hosts' do
+       result = on(default, "beaker provision")
+       assert_equal(0, result.exit_code, "`beaker provision` should return a zero exit code")
+     end
+     step 'ensure provision will not provision new hosts if hosts have already been provisioned' do
+       result = on(default, 'beaker provision')
+       assert_match(/Hosts have already been provisioned/, result.stdout)
+       assert_equal(0, result.exit_code, "`beaker provision` should return a zero exit code")
+     end
+    delete_root_folder_contents
+  end
+
+end

data/beaker.gemspec

@@ -5,11 +5,11 @@ require 'beaker/version'
 Gem::Specification.new do |s|
   s.name        = "beaker"
   s.version     = Beaker::Version::STRING
-  s.authors     = ["Puppetlabs"]
-  s.email       = ["delivery@puppetlabs.com"]
+  s.authors     = ["Puppet"]
+  s.email       = ["delivery@puppet.com"]
   s.homepage    = "https://github.com/puppetlabs/beaker"
   s.summary     = %q{Let's test Puppet!}
-  s.description = %q{Puppetlabs accceptance testing harness}
+  s.description = %q{Puppet's accceptance testing harness}
   s.license     = 'Apache2'
 
   s.files         = `git ls-files`.split("\n")
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = Gem::Requirement.new('>= 2.2.5')
+  s.required_ruby_version = Gem::Requirement.new('>= 2.1.8')
 
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
@@ -36,11 +36,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'hocon', '~> 1.0'
   s.add_runtime_dependency 'net-ssh', '~> 4.0'
   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 'inifile', '~> 3.0'
 
   s.add_runtime_dependency 'rake', '~> 10.0'
   s.add_runtime_dependency 'rsync', '~> 1.0.9'

data/bin/beaker

@@ -6,7 +6,7 @@ require 'beaker'
 if Beaker::Subcommands::SubcommandUtil.execute_subcommand?(ARGV[0])
   Beaker::Subcommand.start(ARGV)
 else
-  Beaker::CLI.new.execute!
+  Beaker::CLI.new.parse_options.execute!
   puts "Beaker completed successfully, thanks."
 end
 

data/docs/concepts/test_tagging.md

@@ -1,6 +1,10 @@
 ## What is This?
 
-Beaker test tagging allows you to add tags to tests (using the [`tag` DSL method](http://www.rubydoc.info/github/puppetlabs/beaker/master/Beaker/DSL/Structure#tag-instance_method)), so that you can include or exclude a specific subset of the tests given for use in this run.  Why would you want to use this?  Here are some examples of what you can do with this functionality:
+Beaker test tagging allows you to add tags to tests (using the
+[`tag` DSL method](http://www.rubydoc.info/github/puppetlabs/beaker/master/Beaker/DSL/TestTagging#tag-instance_method)),
+so that you can include or exclude a specific subset of the tests given for use
+in this run.  Why would you want to use this?  Here are some examples of what
+you can do with this functionality:
 
 - Run groups of tests separately from the same testing codebase
 - Declare different actions that should be taken when a test fails
@@ -8,12 +12,14 @@ Beaker test tagging allows you to add tags to tests (using the [`tag` DSL method
 
 ## How Tagging Works
 
-Add tags to a Beaker test at the beginning, like you would if you were using confine.  Things to stay aware of:
+Add tags to a Beaker test at the beginning, like you would if you were using
+confine.  Things to stay aware of:
 
 - A test that is not executed due to a tag will be considered a ‘skipped’ test
 - Tags are free form strings and will not be subjected to any correctness testing
 - Tags are NOT case sensitive
 - Tagging was added after Beaker 2.14.1.  If you're using that version or older, this isn't available
+- `--test-tag-or` was added after Beaker 3.12.0. If you're using an older version, this isnt available
 
 ## Test Examples
 
@@ -39,38 +45,45 @@ Preferred style no-block example:
 
 ## Command Line Interaction
 
-`--tag`: Run the set of tests matching ALL of the provided single or comma separated list of tags.
+`--test-tag-and`: Run the set of tests matching ALL of the provided single or comma-separated list of tags.
 
-`--exclude-tag`: Run the set of tests that do not contain ANY of the provided single or command separated list of tags
+`--test-tag-or`: Run the set of tests matching ANY of the provided single or comma-separated list of tags.
 
-To do set intersection combine `--tag` and `--exclude-tag`.
+`--test-tag-exclude`: Run the set of tests that do not contain ANY of the provided single or comma-separated list of tags.
 
-Beaker will raise an error if `--tag` & `--exclude-tag` contain the same tag, however.
+Beaker will raise an error if `--test-tag-and` & `--test-tag-exclude` contain the same tag, however.
+
+Beaker will also raise an error if you use both `--test-tag-or` & `--test-tag-and`, because
+it won't be able to determine which order they should be used in.
 
 ## CLI Examples
 
 Execute all ‘long_running’ tests.
 
-    $ beaker --tests path/to/tests --tag long_running
+    $ beaker --tests path/to/tests --test-tag-and long_running
 
 Execute all tests, except those that are ‘feature_test’
 
-    $ beaker --tests path/to/tests --exclude-tag feature_test
+    $ beaker --tests path/to/tests --test-tag-exclude feature_test
 
 Execute all tests that are long_running but not feature_test
 
-    $ beaker --tests path/to/tests --tag long_running --exclude-tag feature_test
+    $ beaker --tests path/to/tests --test-tag-and long_running --test-tag-exclude feature_test
 
 Execute all tests marked both 'long_running' and 'feature_test'
 
-    $ beaker --tests /path/to/tests --tags long_running,feature_test
+    $ beaker --tests /path/to/tests --test-tag-and long_running,feature_test
 
 ## Environment Variable Support
 
-Equivalent to `--tag`:
+Equivalent to `--test-tag-and`:
+
+    BEAKER_TEST_TAG_AND=long_running,feature_test
+
+Equivalent to `--test-tag-or`:
 
-    BEAKER_TAG=long_running,feature_test
+    BEAKER_TEST_TAG_OR=long_running,feature_test
 
-Equivalent to `--no-tag`:
+Equivalent to `--test-tag-exclude`:
 
-    BEAKER_EXCLUDE_TAG=long_running,feature_test
+    BEAKER_TEST_TAG_EXCLUDE=long_running,feature_test

data/docs/how_to/archive_sut_files.md

@@ -24,8 +24,26 @@ and details of all method arguments are documented there as well. Check it out,
 and with the right use, you won't need to preserve hosts at all to debug any
 test failures.
 
+# Challenges
+
+## Conditionally Saving Files From SUTs
+
+One thing that people tend to want from this functionality is to only archive
+files from SUTs when a beaker run has failed. At this point, beaker does not
+have access to other suites from a current one. This means that in practice,
+a post-suite (where one would typically put archiving and other post-processes)
+will not be able to archive files ONLY IF the test suite has had any failures
+or errors.
+
+Our suggestion to get the functionality required would be to have beaker always
+archive the appropriate files in the post-suite of your tests, but then only
+have Jenkins (or your job running system, whatever that may be) conditionally
+take them from the beaker coordinator to whatever external archive system you
+rely on for later analysis. This can both get you the files that you need from
+the SUTs and save on space, as only files that need analysis will be kept.
+
 # When Did This Come Out?
 
 `archive_file_from` was originally added to the DSL in beaker
 [2.48.0](https://github.com/puppetlabs/beaker/releases/tag/2.48.0), released on
-[July 27, 2016](https://github.com/puppetlabs/beaker/blob/master/HISTORY.md#2480---27-jul-2016-47d3aa18).
+[July 27, 2016](https://github.com/puppetlabs/beaker/blob/master/HISTORY.md#2480---27-jul-2016-47d3aa18).

data/docs/how_to/hypervisors/README.md

@@ -9,9 +9,26 @@ assumptions.
 
 # Credentials File
 
-Beaker uses credentials from a .fog file for authentication. 
-By default, the file is located under the user's home directory. This helps to keep the credentials confidential. 
-The path of .fog file can be changed by setting the 'dot_fog' option.
+Beaker uses credentials from a `.fog` file for authentication. This file came
+from using the [fog cloud services library](http://fog.io). Beaker now only uses
+fog functionality in the openstack hypervisor, but we still use the `.fog` file
+for a credentials store.
+
+By default, the file is located under the user's home directory. This helps to
+keep the credentials confidential. The path of `.fog` file can be changed by
+setting the `dot_fog` global beaker option.
+
+The `.fog` file is written in YAML. The keys are particular to the service that
+they correspond to, and each hypervisor's documentation should include the keys
+that are needed for it. An example `.fog` file is below:
+
+```yaml
+:default:
+  :vsphere_server: 'vsphere.example.com'
+  :vsphere_username: 'joe'
+  :vsphere_password: 'MyP@$$w0rd'
+  :vmpooler_token: 'randomtokentext'
+```
 
 # External Hypervisors
 

data/docs/how_to/hypervisors/ec2.md

@@ -20,6 +20,7 @@ hypervisor: ec2
         hypervisor: ec2
         amisize: c1.medium
         snapshot: pe
+        user: ec2-user
       centos-5-64-1:
         roles:
           - agent
@@ -28,6 +29,7 @@ hypervisor: ec2
         hypervisor: ec2
         amisize: c1.medium
         snapshot: pe
+        user: ec2-user
     CONFIG:
       nfs_server: none
       consoleport: 443
@@ -75,3 +77,5 @@ AMI:
 Size of the [EBS Volume](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html) that will be attached to the EC2 instance.
 ####`vpc_id`####
 ID of the [VPC](https://aws.amazon.com/vpc/) to create the instances in.  If not provided will either use the default VPC for the provided region (marked as `isDefault`), otherwise falls back to `nil`.  If subnet information is provided (`subnet_id`/`subnet_ids`) this must be defined.
+####`user`####
+By default root login is not allowed with Amazon Linux. Setting it to ec2-user will trigger `sshd_config` and `authorized_keys` changes by beaker.

data/docs/how_to/hypervisors/vmpooler.md

@@ -0,0 +1,24 @@
+[vmpooler](https://github.com/puppetlabs/vmpooler) is a puppet-built abstraction
+layer over vSphere infrastructure that pools VMs to be used by beaker & other
+systems.
+
+beaker's vmpooler hypervisor interacts with vmpooler to get Systems Under Test
+(SUTs) for testing purposes.
+
+# Tokens
+
+Using tokens will allow you to extend your VMs lifetime, as well as interact
+with vmpooler and your VMs in more complex ways. You can have beaker do these
+same things by providing your `vmpooler_token` in the `~/.fog` file. For more
+info about how the `.fog` file works, please refer to the
+[hypervisor README](README.md).
+
+An example of a `.fog` file with just the vmpooler details is below:
+```yaml
+:default:
+  :vmpooler_token: 'randomtokentext'
+```
+
+Users with Puppet credentials can follow our instructions for getting & using
+vmpooler tokens in our
+[internal documentation](https://confluence.puppetlabs.com/pages/viewpage.action?spaceKey=SRE&title=Generating+and+using+vmpooler+tokens).

data/docs/how_to/hypervisors/vsphere.md

@@ -7,9 +7,6 @@ To do this create a `~/.fog` file with your vSphere credentials:
       :vsphere_server: 'vsphere.example.com'
       :vsphere_username: 'joe'
       :vsphere_password: 'MyP@$$w0rd'
-      :vmpooler_token: 'randomtokentext'
-
-The vmpooler_token can be used with https://github.com/puppetlabs/vmpooler. Users with Puppet Labs credentials can follow directions for getting and using tokens at https://confluence.puppetlabs.com/display/QE/Generating+and+using+vmpooler+tokens.
 
 These follow the conventions used by Cloud Provisioner and Fog.
 

data/docs/tutorials/installation.md

@@ -1,10 +1,10 @@
-#Beaker Installation
+# Beaker Installation
 
 In most cases, beaker is running on a system separate from the SUT; we will commonly refer to this system as the beaker coordinator. This page outlines how to install requirements for the beaker coordinator and options for the installation of beaker itself.
 
 ## Beaker Requirements
 
-* Ruby >= 2.2.5
+* Ruby >= 2.1.8 (but we [only test on >= 2.2.5](installation.md#ruby-version))
 * libxml2, libxslt (needed for the [Nokogiri](http://nokogiri.org/tutorials/installing_nokogiri.html) gem)
 * g++ (needed for the [unf_ext](http://rubydoc.info/gems/unf_ext/) gem)
 * curl (needed for some DSL functions to be able to execute successfully)
@@ -17,13 +17,13 @@ On an EL or Fedora system use:
 
     sudo yum install make gcc gcc-c++ libxml2-devel libxslt-devel ruby-devel
 
-##Installing Beaker
-###From Gem (Preferred)
+## Installing Beaker
+### From Gem (Preferred)
 
     $ gem install beaker
     $ beaker --help
 
-###From Latest Git
+### From Latest Git
 
 If you need the latest and greatest (and mostly likely broken/untested/no warranty) beaker code.
 
@@ -35,7 +35,7 @@ If you need the latest and greatest (and mostly likely broken/untested/no warran
     $ bundle install
     $ bundle exec beaker --help
 
-###From Latest Git, As Installed Gem
+### From Latest Git, As Installed Gem
 
 If you need the latest and greatest, but prefer to work from gem instead of through bundler.
 
@@ -45,7 +45,7 @@ If you need the latest and greatest, but prefer to work from gem instead of thro
     $ gem build beaker.gemspec
     $ gem install ./beaker-*.gem
 
-###Special Case Installation
+### Special Case Installation
 
 The beaker gem can be built and installed in the context of the current test suite by adding the github repos as the source in the Gemspec file (see <a href = "http://bundler.io/git.html">bundler git documentation</a>).
 
@@ -57,3 +57,18 @@ The beaker gem can be built and installed in the context of the current test sui
       gem 'chromedriver2-helper'
       gem 'beaker', :github => 'puppetlabs/beaker', :branch => 'master', :ref => 'fffe7'
     end
+
+## Ruby Version
+
+In moving to beaker 3.0, we added in a hard requirement that a
+beaker test writer be using Ruby 2.2.5 or higher. Since Puppet
+has versions that support earlier versions of Ruby, this made
+writing tests more difficult than it needed to be.
+
+In order to make this easier, in beaker 3.13.0 we've relaxed
+this requirement to Ruby 2.1.8. Note that the beaker team does
+not internally test Ruby versions below 2.2.5, and that if bugs
+are submitted that are found to be specific to versions below
+2.2.5, they will not be worked on by the beaker team. This
+doesn't mean we won't merge fixes to bugs that are specific to
+those versions that are submitted by the community, however.