simp-beaker-helpers 1.3.0 → 1.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDAxZjY1OTM4ZjRlYjZlM2RjMDNhM2MwNjFkMDgxYTdlYmFlYmZmMw==
-  data.tar.gz: !binary |-
-    YTdmN2U2ZTMxMGQ2MTYzZGUzODJjNDAyYTFkZWUwOTBjOWIxNGE4Zg==
+SHA1:
+  metadata.gz: 9a867ae9f1b572aab3ab4c9cc5b31a9e36b006d5
+  data.tar.gz: 7f057b0c8985000cee0f7a64ca55b44cb6fe6bdb
 SHA512:
-  metadata.gz: !binary |-
-    ZDU4NTI0YTMyMGNhYTVjYTg2ODIyMjEyNzBiMzcwOTAxZDcwMTc3YTM0MWM5
-    M2U1NWFmYWMzMTUyNjIyOTMwZmZhNzM4MmM4MDM1M2QxNzU3MmNlN2U1YmVi
-    Mjg4NTliZTY1ZDBmNWYzYTdlMTJmMWI0YmJmNzcxMWM2YzcyYWM=
-  data.tar.gz: !binary |-
-    MDdmNmE2YmVmNzk2NjA4ZTg1MjE5NWMzNzViZTZhZGE0MzM1ZmNhYzY4NGNi
-    YzRhNGM0MzIwYjI3MmVkZDU3ZmYxMWY5NmNlOTQ0YjRmODA3NTA0N2YwMjQz
-    NmZmMWE0ZWJhZWFjNWEwMjhhYjNmNGRkODNiMzM4ODI1OTJkZjc=
+  metadata.gz: 1c6ddedd94aebe0539e7ff54afdd6378f4ebc7523527dd3398f9db95709ed6dbc5fc49c931c9cb84fa049fb3baca6e781b8a1c004fe25f1d3026d1a007709ab0
+  data.tar.gz: 7993446042b193c5131100fb9379a394399ecbf3b8ce433d71ad8d7d4f27d91e98e2ca12bd605ceb7e7b3ce212d9c2d1098b591e3010e4bc1a63c86a84b49357

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 *.old
 .vagrant
 /log
+/spec/fixtures

data/Gemfile

@@ -17,6 +17,7 @@ group :system_tests do
   gem 'pry'
   gem 'beaker'
   gem 'beaker-rspec'
+  gem 'vagrant-wrapper'
   # NOTE: Workaround because net-ssh 2.10 is busting beaker
   # lib/ruby/1.9.1/socket.rb:251:in `tcp': wrong number of arguments (5 for 4) (ArgumentError)
   gem 'net-ssh', '~> 2.9.0'

data/README.md

@@ -6,9 +6,11 @@ Methods to assist beaker acceptance tests for SIMP.
 1. [Overview](#overview)
 2. [Setup](#setup)
     * [Beginning with simp-beaker-helpers](#beginning-with-simp-beaker-helpers)
-3. [Nodeset Enhancements](#nodeset-enhancements)
+3. [General Enhancements](#general-enhancements)
+    * [Suites](#suites)
+4. [Nodeset Enhancements](#nodeset-enhancements)
     * [YUM Repo Support](#yum_repo_support)
-4. [Methods](#methods)
+5. [Methods](#methods)
     * [`copy_fixture_modules_to`](#copy_fixture_modules_to)
     * [`fix_errata_on`](#fix_errata_on)
     * PKI
@@ -21,14 +23,14 @@ Methods to assist beaker acceptance tests for SIMP.
     * Hiera
       * [`set_hieradata_on`](#set_hieradata_on)
       * [`clear_temp_hieradata`](#clear_temp_hieradata)
-5. [Environment variables](#environment-variables)
+6. [Environment variables](#environment-variables)
     * [`BEAKER_fips`](#beaker_fips)
     * [`BEAKER_spec_prep`](#beaker_spec_prep)
     * [`BEAKER_stringify_facts`](#beaker_stringify_facts)
     * [`BEAKER_use_fixtures_dir_for_modules`](#beaker_use_fixtures_dir_for_modules)
-6. [Examples](#examples)
+7. [Examples](#examples)
     * [Prep OS, Generate and copy PKI certs to each SUT](#prep-os-generate-and-copy-pki-certs-to-each-sut)
-7. [License](#license)
+8. [License](#license)
 
 ## Overview
 
@@ -47,6 +49,66 @@ Add this to your project's `spec/spec_helper_acceptance.rb`:
 require 'simp/beaker_helpers'
 include Simp::BeakerHelpers
 ```
+## General Enhancements
+
+### Suites
+
+The 'beaker:suites' rake task provides the ability to run isolated test sets
+with a full reset of the Beaker environment.
+
+These are entirely isolated runs of Beaker and have been designed to be used
+for situations where you need to eliminate all of the cruft from your previous
+runs to perform a new type of test.
+
+#### Suite Execution
+
+By default the only suite that will be executed is `default`.  Since each suite
+is executed in a new environment, spin up can take a lot of time. Therefore,
+the default is to only run the default suite.
+
+If there is a suite where the metadata contains `default_run` set to the
+Boolean `true`, then that suite will be part of the default suite execution.
+
+You can run all suites by setting the passed suite name to `ALL` (case
+sensitive).
+
+#### Environment Variables
+
+* BEAKER_suite_runall
+  * Run all Suites
+
+* BEAKER_suite_basedir
+  * The base directory where suites will be defined
+  * Default: spec/acceptance
+
+#### Global Suite Configuration
+
+A file `config.yml` can be placed in the `suites` directory to control certain
+aspects of the suite run.
+
+##### Supported Config:
+
+```yaml
+---
+# Fail the entire suite at the first failure
+'fail_fast' : <true|false> => Default: true
+```
+
+#### Individual Suite Configuration
+
+Each suite may contain a YAML file, metadata.yml, which will be used to provide
+information to the suite of tests.
+
+##### Supported Config:
+
+```yaml
+---
+'name' : '<User friendly name for the suite>'
+
+# Run this suite by default
+'default_run' : <true|false> => Default: false
+```
+
 ## Nodeset Enhancements
 
 ### YUM Repo Support
@@ -67,10 +129,34 @@ yum_repos:
 
 #### `copy_fixture_modules_to`
 
-Copies the local fixture modules (under `spec/fixtures/modules`) onto a list of SUTs
-`copy_fixture_modules_to( suts = hosts )`
+Copies the local fixture modules (under `spec/fixtures/modules`) onto a list of
+SUTs.
 
+```ruby
+copy_fixture_modules_to( suts = hosts, opts = {} )
+```
+  - **`suts`**   = _(Array,String)_ list of SUTs to copy modules to
+  - **`opts`**   = _(Hash)_ Options passed on to `copy_module_to()` for each SUT
 
+By default, this will copy modules to the first path listed in each SUT's
+`modulepath` and simulate a pluginsync so the Beaker DSL's `facter_on` will
+still work.
+
+If you need to use a non-default module path:
+```ruby
+# WARNING: this will use the same :target_module_dir for each SUT
+copy_fixture_modules_to( hosts, {
+   :target_module_dir => '/path/to/my/modules',
+})
+```
+
+If you want to disable pluginsync:
+```ruby
+# WARNING: `fact_on` will not see custom facts
+copy_fixture_modules_to( hosts, {
+   :pluginsync => false
+})
+```
 
 #### `fix_errata_on`
 
@@ -88,13 +174,13 @@ SUT will have the appropriate openssl in its environment.
 
 `run_fake_pki_ca_on( ca_sut = master, suts = hosts, local_dir = '' )`
 
- -  **ca_sut**    = the SUT to generate the CA & certs on
- -  **suts**      = list of SUTs to generate certs for
- -  **local_dir** = local path where the CA+cert directory tree should copied back to
+ - **`ca_sut`**    = the SUT to generate the CA & certs on
+ - **`suts`**      = list of SUTs to generate certs for
+ - **`local_dir`** = local path where the CA+cert directory tree should copied back to
 
 #### `copy_pki_to`
 
-Copy a single SUT's PKI certs (with cacerts) onto an SUT.  This simulates the result of `pki::copy` without requiring a full master and `simp-pki` module.
+Copy a single SUT's PKI certs (with cacerts) onto the SUT.  This simulates the result of `pki::copy` without requiring a full master and `simp-pki` module.
 
 The directory structure copied to the SUT is:
 ```
@@ -111,7 +197,7 @@ The directory structure copied to the SUT is:
 
 #### `copy_keydist_to`
 
-Copy a CA keydist/ directory of CA+host certs into an SUT
+Copy a CA keydist/ directory of CA+host certs into an SUT.
 
 This simulates the output of FakeCA's `gencerts_nopass.sh` into `keydist/` and is useful for constructing a Puppet master SUT that will distribute PKI keys via agent runs.
 
@@ -120,14 +206,14 @@ This simulates the output of FakeCA's `gencerts_nopass.sh` into `keydist/` and i
 
 #### `pfact_on`
 
-Look up a face on a given SUT's using the `puppet fact` face.  This honors whatever facter-related settings the SUT's Puppet has been configured to use (i.e., `factpath`, `stringify_facts`, etc).
+Look up a fact on a given SUT using the `puppet fact` face.  This honors whatever facter-related settings the SUT's Puppet installation has been configured to use (i.e., `factpath`, `stringify_facts`, etc).
 
 `pfact_on( sut, fact_name )`
 
 
 #### `pluginsync_on`
 
-Simulates a custom fact pluginsync on given SUTs
+Simulates a `pluginsync` (useful for deploying custom facts) on given SUTs.
 
 `pluginsync_on( suts = hosts )`
 
@@ -140,9 +226,9 @@ Set the hiera data file on the provided host to the passed data structure
 
 `set_hieradata_on(host, hieradata, data_file='default')`
 
- -  **host**      = _(Array,String,Symbol)_ One or more hosts to act upon
- -  **hieradata** = _(Hash)_ The full hiera data structure to write to the system
- -  **data_file** = _(String)_ The filename (not path) of the hiera data
+ - **`host`**      = _(Array,String,Symbol)_ One or more hosts to act upon
+ - **`hieradata`** = _(Hash)_ The full hiera data structure to write to the system
+ - **`data_file`** = _(String)_ The filename (not path) of the hiera data
 
 ####  `clear_temp_hieradata`
 
@@ -154,11 +240,19 @@ Clean up all temporary hiera data files; meant to be called from `after(:all)`
 ## Environment variables
 #### `BEAKER_fips`
 
-SIMP acceptance tests enable [FIPS mode](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/sect-Security_Guide-Federal_Standards_And_Regulations-Federal_Information_Processing_Standard.html) on all SUTs by default.  Acceptance tests can be run without FIPS mode when `BEAKER_fips` is set to `no`
+_(Default: `no`)_ When set to `yes`, Beaker will enable [FIPS mode](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/sect-Security_Guide-Federal_Standards_And_Regulations-Federal_Information_Processing_Standard.html) on all SUTs before running tests.
 
-**NOTE:** FIPS mode is only enabled on RedHat family hosts
+**NOTE:** FIPS mode is only enabled on RedHat family hosts.
 
 #### `BEAKER_spec_prep`
+
+_(Default: `yes`)_  Ensures that each fixture module is present under
+`spec/fixtures/modules`.  If any fixture modules are missing, it will run `rake
+spec_prep` to populate the missing modules using `.fixtures.yml`.  Note that
+this will _not_ update modules that are already present under
+`spec/fixtures/modules`.
+
+
 #### `BEAKER_stringify_facts`
 #### `BEAKER_use_fixtures_dir_for_modules`
 

data/lib/simp/beaker_helpers.rb

@@ -1,7 +1,7 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 
   # use the `puppet fact` face to look up facts on an SUT
   def pfact_on(sut, fact_name)
@@ -71,19 +71,42 @@ module Simp::BeakerHelpers
 
 
   # Copy the local fixture modules (under `spec/fixtures/modules`) onto each SUT
-  def copy_fixture_modules_to( suts = hosts, pluginsync = true )
-    STDERR.puts '  ** copy_fixture_modules_to' if ENV['BEAKER_helpers_verbose']
+  def copy_fixture_modules_to( suts = hosts, opts = {})
     ensure_fixture_modules
 
+    opts[:pluginsync] = opts.fetch(:pluginsync, true)
+
     unless ENV['BEAKER_copy_fixtures'] == 'no'
-      suts.each do |sut|
+      Array(suts).each do |sut|
         STDERR.puts "  ** copy_fixture_modules_to: '#{sut}'" if ENV['BEAKER_helpers_verbose']
-        # allow spec_prep to provide modules (to support isolated networks)
+
+        # Use spec_prep to provide modules (this supports isolated networks)
         unless ENV['BEAKER_use_fixtures_dir_for_modules'] == 'no'
+
+          # NOTE: As a result of BKR-723, which does not look easy to fix, we
+          # cannot rely on `copy_module_to()` to choose a sane default for
+          # `target_module_path`.  This workaround queries each SUT's
+          # `modulepath` and targets the first one.
+          target_module_path = on(
+            sut, 'puppet config print modulepath --environment production'
+          ).output.chomp.split(':').first
+
+
           pupmods_in_fixtures_yml.each do |pupmod|
             STDERR.puts "  ** copy_fixture_modules_to: '#{sut}': '#{pupmod}'" if ENV['BEAKER_helpers_verbose']
             mod_root = File.expand_path( "spec/fixtures/modules/#{pupmod}", File.dirname( fixtures_yml_path ))
-            copy_module_to( sut, {:source => mod_root, :module_name => pupmod} )
+            # These options can be overridden by `opt`
+            _opts = {
+                      :target_module_path => target_module_path,
+                    }.merge(opts)
+
+            # These options always override `opt`
+            _opts = _opts.merge({
+                                :source      => mod_root,
+                                :module_name => pupmod,
+                               })
+
+            copy_module_to( sut, _opts )
           end
         end
       end
@@ -91,7 +114,7 @@ module Simp::BeakerHelpers
     STDERR.puts '  ** copy_fixture_modules_to: finished' if ENV['BEAKER_helpers_verbose']
 
     # sync custom facts from the new modules to each SUT's factpath
-    pluginsync_on(suts) if pluginsync
+    pluginsync_on(suts) if opts[:pluginsync]
   end
 
 
@@ -213,7 +236,7 @@ DEFAULT_KERNEL_TITLE=`/sbin/grubby --info=\\\${DEFAULT_KERNEL_INFO} | grep -m1 t
     end
 
     # Configure and reboot SUTs into FIPS mode
-    unless ENV['BEAKER_fips'] == 'no'
+    if ENV['BEAKER_fips'] == 'yes'
       enable_fips_mode_on(suts)
     end
   end
@@ -393,7 +416,9 @@ done
 
   # pluginsync custom facts for all modules
   def pluginsync_on( suts = hosts )
+    puts "== pluginsync_on'" if ENV['BEAKER_helpers_verbose']
     suts.each do |sut|
+      puts "  ** pluginsync_on: '#{sut}'" if ENV['BEAKER_helpers_verbose']
       fact_path = on(sut, %q(puppet config print factpath)).output.strip.split(':').first
       on(sut, %q(puppet config print modulepath)).output.strip.split(':').each do |mod_path|
         on(sut, %Q(mkdir -p #{fact_path}))

data/simp-beaker-helpers.gemspec

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'simp/beaker_helpers.rb'
+require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'simp-beaker-helpers'

data/spec/acceptance/fixture_modules_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper_acceptance'
+
+context 'after copy_fixture_modules_to( hosts )' do
+  before(:all) do
+    # This should automatically run pluginsync_on hosts
+    copy_fixture_modules_to( hosts )
+  end
+
+  describe "fact_on(master,'root_home')" do
+    it 'should not return value of `root_home`' do
+      puts fact = fact_on(master, 'root_home')
+      expect( fact ).to eq ''
+    end
+  end
+
+  describe "fact_on(master,'root_home', {:puppet => nil})" do
+    it 'should return value of `root_home`' do
+      puts fact = fact_on(master, 'root_home', {:puppet => nil} )
+      expect( fact ).to eq '/root'
+    end
+  end
+
+  describe "pfact_on(master,'root_home')" do
+    it 'should return value of `root_home`' do
+      puts fact = pfact_on(master, 'root_home')
+      expect( fact ).to eq '/root'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
@@ -25,9 +25,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
-description: ! '    Beaker helper methods to help scaffold SIMP acceptance tests
-
-'
+description: |2
+      Beaker helper methods to help scaffold SIMP acceptance tests
 email: simp@simp-project.org
 executables: []
 extensions: []
@@ -48,11 +47,11 @@ files:
 - lib/simp/beaker_helpers.rb
 - lib/simp/rake/beaker.rb
 - simp-beaker-helpers.gemspec
+- spec/acceptance/fixture_modules_spec.rb
 - spec/acceptance/nodesets/centos-66-x64.yml
 - spec/acceptance/nodesets/centos-7-x64.yml
 - spec/acceptance/nodesets/centos-combined-x64.yaml
 - spec/acceptance/nodesets/default.yml
-- spec/acceptance/pfacter_spec.rb
 - spec/acceptance/pki_tests_spec.rb
 - spec/spec_helper_acceptance.rb
 homepage: https://github.com/simp/rubygem-simp-beaker-helpers
@@ -66,12 +65,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -81,10 +80,11 @@ signing_key:
 specification_version: 4
 summary: beaker helper methods for SIMP
 test_files:
+- spec/acceptance/fixture_modules_spec.rb
 - spec/acceptance/nodesets/centos-66-x64.yml
 - spec/acceptance/nodesets/centos-7-x64.yml
 - spec/acceptance/nodesets/centos-combined-x64.yaml
 - spec/acceptance/nodesets/default.yml
-- spec/acceptance/pfacter_spec.rb
 - spec/acceptance/pki_tests_spec.rb
 - spec/spec_helper_acceptance.rb
+has_rdoc: 

data/spec/acceptance/pfacter_spec.rb

@@ -1,14 +0,0 @@
-require 'spec_helper_acceptance'
-
-context 'pfact_on operations' do
-  before(:all) do
-    copy_fixture_modules_to( hosts )
-    pluginsync_on( [master] )
-  end
-
-  describe "pfact_on(master,'root_home')" do
-    it 'should return value of root_home' do
-      expect( pfact_on(master, 'root_home')).to_not be_nil
-    end
-  end
-end