simp-beaker-helpers 1.10.5 → 1.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ef2969b67b01c0674df80bbea3c16889381922bbfdb08505c491a88c125e523
-  data.tar.gz: a86092fd607ad2b35e87c3242af394dc57f69441f2bca2d5c86adbf204a4bacd
+  metadata.gz: 32a8dc49acbd2983aba94a4ba0807a14c38067db0919405ea998fb2a60fe68c0
+  data.tar.gz: 8c85f102e7dc4dce934303d76885b4cfed21c42cf47cdbbc843497b377477d23
 SHA512:
-  metadata.gz: ebf14936b15e19407abe6471a6b4fa0fee9c8b64db9a1e36c52922132e65fba63d29f99a1f9f1c10993bbfbfc334f77b1ec0531f67ef9780e732bc53f7e2a012
-  data.tar.gz: c30f517d4e108c4d7d5a4dfc5d8bb6a1399094bee4f454dcee4ed5b8b37667e596a020d4e370d1353a76375ae0259cf3fec13e0c01eb0c4fa513797606f49b60
+  metadata.gz: 92206a3fd881f98bcd574189c3090459048bfb0c813b08381f7ceeb65d0def201d963616eb08df4ebfa080309bdffd65e8c5a9d010a9f0764ccc3ea8a50f6f14
+  data.tar.gz: 615c5b9a61816772adc6cf6503be7db15ae71ae629fd7f7e4ca63db3e7b10948b983da44260faa8604d7ee8a980cfa3abc95f4d9d6d799f1dc5e89a1d344e4a1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 1.10.7 / 2018-05-11
+* Updated README
+* Changed acceptance tests to use `beaker:suites`
+* Removed all Puppet 5+ mappings and updated the install method to figure out
+  what to use based on the available gems so that everything is now consistent
+
+### 1.10.6 / 2018-05-07
+* Added Simp::BeakerHelpers.tmpname method to work around the removal of
+  Dir::Tmpname in Ruby 2.5
+
 ### 1.10.5 / 2018-04-27
 * Fix issue with direct copy to/from docker containers
 * Add necessary package for SSG builds

data/README.md

@@ -3,38 +3,48 @@
 Methods to assist beaker acceptance tests for SIMP.
 
 #### Table of Contents
-1. [Overview](#overview)
-2. [Setup](#setup)
-    * [Beginning with simp-beaker-helpers](#beginning-with-simp-beaker-helpers)
-3. [General Enhancements](#general-enhancements)
-    * [Suites](#suites)
-4. [Nodeset Enhancements](#nodeset-enhancements)
-    * [YUM Repo Support](#yum_repo_support)
-5. [Methods](#methods)
-    * [`copy_fixture_modules_to`](#copy_fixture_modules_to)
+
+<!-- vim-markdown-toc GFM -->
+
+* [Overview](#overview)
+* [Setup](#setup)
+  * [Beginning with simp-beaker-helpers](#beginning-with-simp-beaker-helpers)
+* [Rake Tasks](#rake-tasks)
+  * [`rake beaker:suites`](#rake-beakersuites)
+  * [Suite Execution](#suite-execution)
+    * [Environment Variables](#environment-variables)
+    * [Global Suite Configuration](#global-suite-configuration)
+      * [Supported Config:](#supported-config)
+    * [Individual Suite Configuration](#individual-suite-configuration)
+      * [Supported Config:](#supported-config-1)
+* [Nodeset Enhancements](#nodeset-enhancements)
+  * [YUM Repo Support](#yum-repo-support)
+* [Methods](#methods)
     * [`copy_to`](#copy_to)
+    * [`copy_fixture_modules_to`](#copy_fixture_modules_to)
     * [`fix_errata_on`](#fix_errata_on)
-    * PKI
-      * [`run_fake_pki_ca_on`](#run_fake_pki_ca_on)
-      * [`copy_pki_to`](#copy_pki_to)
-      * [`copy_keydist_to`](#copy_keydist_to)
-    * Custom facts
-      * [`pfact_on`](#pfact_on)
-      * [`pluginsync_on`](#pluginsync_on)
-    * Hiera
-      * [`write_hieradata_to`](#write_hieradata_to)
-      * [`set_hieradata_on`](#set_hieradata_on)
-      * [`clear_temp_hieradata`](#clear_temp_hieradata)
-6. [Environment variables](#environment-variables)
+    * [`run_fake_pki_ca_on`](#run_fake_pki_ca_on)
+    * [`copy_pki_to`](#copy_pki_to)
+    * [`copy_keydist_to`](#copy_keydist_to)
+    * [`pfact_on`](#pfact_on)
+    * [`pluginsync_on`](#pluginsync_on)
+    * [`write_hieradata_to`](#write_hieradata_to)
+    * [`set_hieradata_on`](#set_hieradata_on)
+    * [`clear_temp_hieradata`](#clear_temp_hieradata)
+    * [`latest_puppet_agent_version_for(puppet_version)`](#latest_puppet_agent_version_forpuppet_version)
+    * [`install_puppet`](#install_puppet)
+* [Environment variables](#environment-variables-1)
     * [`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)
-    * [`PUPPET_VERSION`](#puppet_version)
-7. [Examples](#examples)
-    * [Prep OS, Generate and copy PKI certs to each SUT](#prep-os-generate-and-copy-pki-certs-to-each-sut)
-    * [Specify the version of Puppet to run in the SUTs](#specify-the-version-of-puppet-to-run-in-the-suts)
-8. [License](#license)
+    * [PUPPET_VERSION](#puppet_version)
+* [Examples](#examples)
+  * [Prep OS, Generate and copy PKI certs to each SUT](#prep-os-generate-and-copy-pki-certs-to-each-sut)
+  * [Specify the version of Puppet to run in the SUTs](#specify-the-version-of-puppet-to-run-in-the-suts)
+* [License](#license)
+
+<!-- vim-markdown-toc -->
 
 ## Overview
 
@@ -53,9 +63,19 @@ Add this to your project's `spec/spec_helper_acceptance.rb`:
 require 'simp/beaker_helpers'
 include Simp::BeakerHelpers
 ```
-## General Enhancements
 
-### Suites
+## Rake Tasks
+
+New `rake` tasks are available to help you use `beaker` more effectively.
+
+These can be included in your `Rakefile` by adding the following:
+
+```
+require 'simp/rake/beaker'
+Simp::Rake::Beaker.new(File.dirname(__FILE__))
+```
+
+### `rake beaker:suites`
 
 The 'beaker:suites' rake task provides the ability to run isolated test sets
 with a full reset of the Beaker environment.
@@ -64,7 +84,7 @@ 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
+### 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,
@@ -278,8 +298,33 @@ Clean up all temporary hiera data files; meant to be called from `after(:all)`
 
 `clear_temp_hieradata`
 
+#### `latest_puppet_agent_version_for(puppet_version)`
+
+Finds the latest `puppet-agent` version based on the passed gem version and can
+accept the usual Gem comparison syntax (e.g., '4.0', '=4.2', '~> 4.3.1', '5')
+
+Returns the `puppet-agent` package version or `nil` if not found.
+
+#### `install_puppet`
+
+Performs an assessment of all set parameters and installs the correct
+`puppet-agent` based on those parameters based on the following logic.
+
+If the environment variable `BEAKER_PUPPET_AGENT_VERSION` or
+`PUPPET_INSTALL_VERSION` or `PUPPET_VERSION` is set, it will use that value
+to determine the `puppet-agent` version to install.
+
+If it is unable to determine the `puppet-agent` version from any `*VERSION`
+environment variables and the environment variable `BEAKER_PUPPET_COLLECTION`
+is set, it will use this to determine which puppet collection to install from.
+(Presently, this only works with Puppet 5.x and is set as `puppet5`.)
+
+If it cannot determinte the `puppet-agent` version from any environment
+variables, it will default the version to the value of
+Simp::BeakerHelpers::DEFAULT_PUPPET_AGENT_VERSION, which is currently '1.10.4'.
 
 ## Environment variables
+
 #### `BEAKER_fips`
 
 _(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.
@@ -304,6 +349,9 @@ The `PUPPET_VERSION` environment variable will install the latest
 `puppet-agent` package that provides that version of Puppet.  This honors
 `Gemfile`-style expressions like `"~> 4.8.0"`
 
+`BEAKER_PUPPET_AGENT_VERSION` and `PUPPET_INSTALL_VERSION` are synonyms of
+`PUPPET_VERSION`.
+
 ## Examples
 
 
@@ -361,7 +409,10 @@ PUPPET_VERSION="~> 4.8.0" bundle exec rake beaker:suites
 # puppet-agent 1.9.2 will be installed in VMs
 PUPPET_INSTALL_VERSION=1.9.2 bundle exec rake beaker:suites
 
-# puppet-agent 1.8.3 will be installed in VMs
+# The latest puppet 5 will be installed in VMs
+PUPPET_VERSION="5" bundle exec rake beaker:suites
+
+# puppet-agent 1.10.4 will be installed in VMs
 bundle exec rake beaker:suites
 ```
 

data/Rakefile

@@ -5,17 +5,17 @@ require 'rake/clean'
 require 'fileutils'
 require 'find'
 require 'rspec/core/rake_task'
-require 'puppetlabs_spec_helper/rake_tasks'
+require 'simp/rake/beaker'
 
+@package='simp-beaker-helpers'
+@rakefile_dir=File.dirname(__FILE__)
+
+Simp::Rake::Beaker.new(@rakefile_dir)
 
 ['spec','syntax','syntax:hiera','syntax:manifests','syntax:templates','lint','metadata'].each do |task|
   Rake::Task[task].clear
 end
 
-@package='simp-beaker-helpers'
-@rakefile_dir=File.dirname(__FILE__)
-
-
 CLEAN.include "#{@package}-*.gem"
 CLEAN.include 'pkg'
 CLEAN.include 'dist'
@@ -46,6 +46,12 @@ SIMP_RPM_BUILD     when set, alters the gem produced by pkg:gem to be RPM-safe.
   }
 end
 
+desc "Run spec tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color']
+  t.pattern = 'spec/lib/**/*_spec.rb'
+end
+
 desc %q{run all RSpec tests (alias of 'spec')}
 task :test => :spec
 

data/files/puppet-agent-versions.yaml

@@ -4,17 +4,10 @@
 #   - https://docs.puppet.com/puppet/latest/about_agent.html
 #
 version_mappings:
-  '5.4.0': '5.4.0'
-  '5.3.5': '5.3.5'
-  '5.3.4': '5.3.4'
-  '5.3.3': '5.3.3'
-  '5.3.2': '5.3.2'
-  '5.3.1': '5.3.1'
-  '5.3.0': '5.3.0'
-  '5.2.0': '5.2.0'
-  '5.1.0': '5.1.0'
-  '5.0.1': '5.0.1'
-  '5.0.0': '5.0.0'
+  '4.10.11': '1.10.12'
+  '4.10.10': '1.10.10'
+  '4.10.9': '1.10.9'
+  '4.10.8': '1.10.8'
   '4.10.7': '1.10.7'
   '4.10.6': '1.10.6'
   '4.10.5': '1.10.5'

data/lib/simp/beaker_helpers.rb

@@ -5,11 +5,17 @@ module Simp::BeakerHelpers
   require 'simp/beaker_helpers/inspec'
   require 'simp/beaker_helpers/ssg'
 
+  # Stealing this from the Ruby 2.5 Dir::Tmpname workaround from Rails
+  def self.tmpname
+    t = Time.new.strftime("%Y%m%d")
+    "simp-beaker-helpers-#{t}-#{$$}-#{rand(0x100000000).to_s(36)}.tmp"
+  end
+
   # This is the *oldest* version that the latest release of SIMP supports
   #
   # This is done so that we know if some new thing that we're using breaks the
   # oldest system that we support.
-  DEFAULT_PUPPET_AGENT_VERSION = '1.7.1'
+  DEFAULT_PUPPET_AGENT_VERSION = '1.10.4'
 
   # We can't cache this because it may change during a run
   def fips_enabled(sut)
@@ -175,7 +181,7 @@ module Simp::BeakerHelpers
 
           Dir.chdir(mod_root) do
             begin
-              tarfile = Dir::Tmpname.make_tmpname(['beaker','.tar'],nil)
+              tarfile = "#{Simp::BeakerHelpers.tmpname}.tar"
 
               excludes = PUPPET_MODULE_INSTALL_IGNORE.map do |x|
                 x = "--exclude '*/#{x}'"
@@ -681,48 +687,119 @@ done
   # Looks up latest `puppet-agent` version by the version of its `puppet` gem
   #
   # @param puppet_version [String] target Puppet gem version.  Works with
-  #   Gemfile comparison syntax (e.g., '4.0', '= 4.2', '~> 4.3.1')
+  #   Gemfile comparison syntax (e.g., '4.0', '= 4.2', '~> 4.3.1', '> 5.1, < 5.5')
   #
   # @return [String,Nil] the `puppet-agent` version or nil
   #
   def latest_puppet_agent_version_for( puppet_version )
     return nil if puppet_version.nil?
+
     require 'rubygems/requirement'
     require 'rubygems/version'
     require 'yaml'
+
+    _puppet_version = puppet_version.strip.split(',')
+
+
     @agent_version_table ||= YAML.load_file(
                                File.expand_path(
                                  '../../files/puppet-agent-versions.yaml',
                                  File.dirname(__FILE__)
                              )).fetch('version_mappings')
     _pair = @agent_version_table.find do |k,v|
-      Gem::Requirement.new(puppet_version).satisfied_by?(Gem::Version.new(k))
+      Gem::Requirement.new(_puppet_version).satisfied_by?(Gem::Version.new(k))
     end
     result = _pair ? _pair.last : nil
 
+    # If we didn't get a match, go look for published rubygems
+    unless result
+      puppet_gems = nil
+
+      Bundler.with_clean_env do
+        puppet_gems = %x(gem search -ra -e puppet).match(/\((.+)\)/)
+      end
+
+      if puppet_gems
+        puppet_gems = puppet_gems[1].split(/,?\s+/).select{|x| x =~ /^\d/}
+
+        # If we don't have a full version string, we need to massage it for the
+        # match.
+        begin
+          if _puppet_version.size == 1
+            Gem::Version.new(_puppet_version[0])
+            if _puppet_version[0].count('.') < 2
+             _puppet_version = "~> #{_puppet_version[0]}"
+            end
+          end
+        rescue ArgumentError
+          # this means _puppet_version is not just a version, but a version
+          # specifier such as "= 5.2.3", "<= 5.1", "> 4", "~> 4.10.7"
+        end
+
+        result = puppet_gems.find do |ver|
+          Gem::Requirement.new(_puppet_version).satisfied_by?(Gem::Version.new(ver))
+        end
+      end
+    end
+
     return result
   end
 
+  # returns hash with :puppet_install_version, :beaker_puppet_collection,
+  # and :puppet_install_type keys determined from environment variables,
+  # host settings, and/or defaults
+  #
+  # NOTE: BEAKER_PUPPET_AGENT_VERSION or PUPPET_INSTALL_VERSION or
+  #       PUPPET_VERSION takes precedence over BEAKER_PUPPET_COLLECTION
+  #       or host.options['puppet_collection'], when both a puppet
+  #       install version and a puppet collection are specified. This is
+  #       because the puppet install version can specify more precise
+  #       version information than is available from a puppet collection.
+  def get_puppet_install_info
+    # The first match is internal Beaker and the second is legacy SIMP
+    puppet_install_version = ENV['BEAKER_PUPPET_AGENT_VERSION'] || ENV['PUPPET_INSTALL_VERSION'] || ENV['PUPPET_VERSION']
+
+    if puppet_install_version and !puppet_install_version.strip.empty?
+      puppet_agent_version = latest_puppet_agent_version_for(puppet_install_version.strip)
+    end
+
+    if puppet_agent_version.nil?
+      if puppet_collection = (ENV['BEAKER_PUPPET_COLLECTION'] || host.options['puppet_collection'])
+        if puppet_collection =~ /puppet(\d+)/
+          puppet_install_version = "~> #{$1}"
+          puppet_agent_version = latest_puppet_agent_version_for(puppet_install_version)
+        else
+          raise("Error: Puppet Collection '#{puppet_collection}' must match /puppet(\\d+)/")
+        end
+      else
+        puppet_agent_version = DEFAULT_PUPPET_AGENT_VERSION
+      end
+    end
+
+    if puppet_collection.nil?
+      base_version = puppet_agent_version.to_i
+      puppet_collection = "puppet#{base_version}" if base_version >= 5
+    end
+
+    { :puppet_install_version   => puppet_agent_version,
+      :beaker_puppet_collection => puppet_collection,
+      :puppet_install_type      => ENV.fetch('PUPPET_INSTALL_TYPE', 'agent')
+    }
+  end
+
 
   # Replacement for `install_puppet` in spec_helper_acceptance.rb
   def install_puppet
-    puppet_install_type = ENV.fetch('PUPPET_INSTALL_TYPE', 'agent')
-
-    puppet_agent_version = ENV.fetch('PUPPET_INSTALL_VERSION', nil)
+    install_info = get_puppet_install_info
 
-    unless puppet_agent_version
-      if host.options['puppet_collection'] && host.options['puppet_collection'] =~ /puppet(\d+)/
-        puppet_agent_version = latest_puppet_agent_version_for("~> #{$1}")
-      else
-        puppet_agent_version = (
-          latest_puppet_agent_version_for(ENV.fetch('PUPPET_VERSION',nil)) ||
-          DEFAULT_PUPPET_AGENT_VERSION
-        )
-      end
+    # In case  Beaker needs this info internally
+    ENV['PUPPET_INSTALL_VERSION'] = install_info[:puppet_install_version]
+    unless install_info[:puppet_collection].nil?
+      ENV['BEAKER_PUPPET_COLLECTION'] = install_info[:puppet_collection]
     end
 
     require 'beaker/puppet_install_helper'
 
-    run_puppet_install_helper(puppet_install_type,  puppet_agent_version)
+    run_puppet_install_helper(install_info[:puppet_install_type], install_info[:puppet_install_version])
   end
 end

data/lib/simp/beaker_helpers/version.rb

@@ -1,5 +1,5 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.10.5'
+  VERSION = '1.10.7'
 end

data/spec/acceptance/suites/default/nodesets

@@ -0,0 +1 @@
+spec/acceptance/suites/default/../../nodesets

data/spec/acceptance/suites/puppet_collections/00_default_spec.rb

@@ -0,0 +1,21 @@
+# This needs to be done so that we actually bring in a collection at the start
+# of the run
+#
+# Choosing an arbitrary number in the middle of 5 so that we're not fooled by
+# edge cases
+#
+ENV['PUPPET_VERSION'] = '5.1'
+
+require 'spec_helper_acceptance'
+
+hosts.each do |host|
+  describe 'make sure puppet version is valid' do
+    context "on #{host}" do
+      client_puppet_version = on(host, 'puppet --version').output.strip
+
+      it "should be running puppet version #{ENV['PUPPET_VERSION']}}" do
+        expect(Gem::Version.new(client_puppet_version)).to be >= Gem::Version.new(ENV['PUPPET_VERSION'])
+      end
+    end
+  end
+end

data/spec/acceptance/suites/puppet_collections/metadata.yml

@@ -0,0 +1,2 @@
+---
+'default_run': true

data/spec/lib/simp/beaker_helpers_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+require 'simp/beaker_helpers'
+
+# redefine methods used in RSpec.configure withing Simp::BeakerHelpers
+def hosts; end
+def activate_interfaces(hosts); end
+def clear_temp_hieradata; end
+
+class MyTestClass
+  class FakeHost
+    attr_accessor :options
+    def initialize(opts = {})
+      @options = opts
+    end
+  end
+
+  include Simp::BeakerHelpers
+
+  attr_accessor :host
+
+  def initialize
+    @host = FakeHost.new
+  end
+end
+
+describe 'Simp::BeakerHelpers' do
+  before :each do
+    @helper = MyTestClass.new
+  end
+
+  let(:gem_search_results) {
+    # subset of results, but still exercises code
+    "puppet (5.5.1 ruby universal-darwin x64-mingw32 x86-mingw32, 5.5.0 ruby universal-darwin x64-mingw32 x86-mingw32, 5.4.0 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.6 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.5 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.4 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.3 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.2 ruby universal-darwin x64-mingw32 x86-mingw32, 5.3.1 ruby universal-darwin x64-mingw32 x86-mingw32, 5.2.0 ruby universal-darwin x64-mingw32 x86-mingw32, 5.1.0 ruby universal-darwin x64-mingw32 x86-mingw32, 5.0.1 ruby universal-darwin x64-mingw32 x86-mingw32, 5.0.0 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.11 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.10 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.9 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.8 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.7 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.6 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.5 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.4 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.1 ruby universal-darwin x64-mingw32 x86-mingw32, 4.10.0 ruby universal-darwin x64-mingw32 x86-mingw32, 4.9.4 ruby universal-darwin x64-mingw32 x86-mingw32, 4.9.3 ruby universal-darwin x64-mingw32 x86-mingw32, 4.9.2 ruby universal-darwin x64-mingw32 x86-mingw32, 4.9.1 ruby universal-darwin x64-mingw32 x86-mingw32, 4.9.0 ruby universal-darwin x64-mingw32 x86-mingw32, 4.8.2 ruby universal-darwin x64-mingw32 x86-mingw32, 4.8.1 ruby universal-darwin x64-mingw32 x86-mingw32, 4.8.0 ruby universal-darwin x64-mingw32 x86-mingw32)\n"
+  }
+
+  context '#latest_puppet_agent_version_for' do
+    context 'using table' do
+      it 'maps exact Puppet version' do
+        expect( @helper.latest_puppet_agent_version_for('4.10.4') ).to eq '1.10.4'
+      end
+
+      # remaining tests are only for a sampling of version specifictions with
+      # operators,  because we are really only testing that the version specification
+      # is proper;ly handed off to Gem::Requirement(), not that Gem::Requirement works.
+      it "maps to appropriate Puppet version when '=' operator specified in version" do
+        expect( @helper.latest_puppet_agent_version_for('= 4.8') ).to eq '1.8.0'
+      end
+
+      it "maps to appropriate Puppet version when '~>' operator specified in version" do
+        expect( @helper.latest_puppet_agent_version_for('~> 4.8.0') ).to eq '1.8.3'
+      end
+
+      it "maps to appropriate Puppet version when '<' operator specified in version" do
+        expect( @helper.latest_puppet_agent_version_for('< 4.9') ).to match /1.8.3/
+      end
+
+      it "maps to appropriate Puppet version when comma-separated operators specified in version" do
+        expect( @helper.latest_puppet_agent_version_for('>= 4.7, < 4.9') ).to match /1.8.3/
+      end
+    end
+
+    context 'using gem lookup' do
+      it 'maps exact Puppet version' do
+        allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+        expect( @helper.latest_puppet_agent_version_for('5.3.1') ).to eq '5.3.1'
+      end
+
+      # remaining tests are only for a sampling of version specifictions with
+      # operators,  because we are really only testing that the version specification
+      # is proper;ly handed off to Gem::Requirement(), not that Gem::Requirement works.
+      it "maps to appropriate Puppet version when '=' operator specified in version" do
+        allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+        expect( @helper.latest_puppet_agent_version_for('= 5.5') ).to eq '5.5.0'
+      end
+
+      it "maps to appropriate Puppet version when '~>' operator specified in version" do
+        allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+        expect( @helper.latest_puppet_agent_version_for('~> 5.3.0') ).to eq '5.3.6'
+      end
+
+      # this logic won't work properly without code changes that just aren't worth it because
+      # Puppet 4 is MD soon....
+      it "maps to appropriate Puppet version when '<' operator specified in version" do
+        pending 'fails because matches 4.x table'
+        allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+        expect( @helper.latest_puppet_agent_version_for('< 5.5') ).to match /5.4.0/
+      end
+
+      it "maps to appropriate Puppet version when comma-separated operators specified in version" do
+        allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+        expect( @helper.latest_puppet_agent_version_for('>= 5, < 5.5') ).to match /5.4.0/
+      end
+    end
+  end
+
+  context '#get_puppet_install_info' do
+    after (:each) do
+      ENV['BEAKER_PUPPET_AGENT_VERSION'] = nil
+      ENV['PUPPET_INSTALL_VERSION'] = nil
+      ENV['PUPPET_VERSION'] = nil
+      ENV['BEAKER_PUPPET_COLLECTION'] = nil
+      ENV['PUPPET_INSTALL_TYPE'] = nil
+    end
+
+    it 'uses defaults when no environment variables are set' do
+      expected = {
+      :puppet_install_version   => Simp::BeakerHelpers::DEFAULT_PUPPET_AGENT_VERSION,
+      :beaker_puppet_collection => nil,
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_INSTALL_VERSION for Puppet 4' do
+      ENV['PUPPET_INSTALL_VERSION']= '4.10.5'
+      expected = {
+      :puppet_install_version   => '1.10.5',
+      :beaker_puppet_collection => nil,
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_INSTALL_VERSION for Puppet 5' do
+      allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+      ENV['PUPPET_INSTALL_VERSION']= '5.5.0'
+      expected = {
+      :puppet_install_version   => '5.5.0',
+      :beaker_puppet_collection => 'puppet5',
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_INSTALL_VERSION even when BEAKER_PUPPET_COLLECTION is set' do
+      allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+      ENV['PUPPET_INSTALL_VERSION']= '5.5.0'
+      ENV['BEAKER_PUPPET_COLLECTION']= 'puppet6'
+      expected = {
+      :puppet_install_version   => '5.5.0',
+      :beaker_puppet_collection => 'puppet5',
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_INSTALL_VERSION even when host puppet_collection option is set' do
+      allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+      ENV['PUPPET_INSTALL_VERSION']= '5.5.0'
+      @helper.host.options = {'puppet_collection' => 'puppet6'}
+      expected = {
+      :puppet_install_version   => '5.5.0',
+      :beaker_puppet_collection => 'puppet5',
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from BEAKER_PUPPET_AGENT_VERSION' do
+      ENV['BEAKER_PUPPET_AGENT_VERSION']= '4.10.5'
+      expected = {
+      :puppet_install_version   => '1.10.5',
+      :beaker_puppet_collection => nil,
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_VERSION' do
+      ENV['PUPPET_VERSION']= '4.10.5'
+      expected = {
+      :puppet_install_version   => '1.10.5',
+      :beaker_puppet_collection => nil,
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from BEAKER_PUPPET_COLLECTION' do
+      allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+      ENV['BEAKER_PUPPET_COLLECTION']= 'puppet5'
+      expected = {
+      :puppet_install_version   => '5.5.1',
+      :beaker_puppet_collection => 'puppet5',
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from BEAKER_PUPPET_COLLECTION' do
+      allow(@helper).to receive(:`).with('gem search -ra -e puppet').and_return(gem_search_results)
+      @helper.host.options = {'puppet_collection' => 'puppet5'}
+      expected = {
+      :puppet_install_version   => '5.5.1',
+      :beaker_puppet_collection => 'puppet5',
+      :puppet_install_type      => 'agent'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'extracts info from PUPPET_INSTALL_TYPE' do
+      ENV['PUPPET_INSTALL_TYPE'] = 'pe'
+      expected = {
+      :puppet_install_version   => Simp::BeakerHelpers::DEFAULT_PUPPET_AGENT_VERSION,
+      :beaker_puppet_collection => nil,
+      :puppet_install_type      => 'pe'
+      }
+      expect( @helper.get_puppet_install_info ).to eq expected
+    end
+
+    it 'fails when BEAKER_PUPPET_COLLECTION is invalid' do
+      ENV['BEAKER_PUPPET_COLLECTION'] = 'PUPPET5'
+      expect{ @helper.get_puppet_install_info }.to raise_error(/Error: Puppet Collection 'PUPPET5' must match/)
+    end
+
+    it 'fails when host options puppet_collection is invalid' do
+      @helper.host.options = {'puppet_collection' => 'PUPPET5'}
+      expect{ @helper.get_puppet_install_info }.to raise_error(/Error: Puppet Collection 'PUPPET5' must match/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.10.5
+  version: 1.10.7
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
@@ -81,14 +81,19 @@ files:
 - lib/simp/beaker_helpers/version.rb
 - lib/simp/rake/beaker.rb
 - simp-beaker-helpers.gemspec
-- spec/acceptance/check_puppet_version_spec.rb
-- spec/acceptance/enable_fips_spec.rb
-- spec/acceptance/fixture_modules_spec.rb
 - spec/acceptance/nodesets/default.yml
-- spec/acceptance/nodesets/puppet5.yml
-- spec/acceptance/pki_tests_spec.rb
-- spec/acceptance/set_hieradata_on_spec.rb
-- spec/acceptance/write_hieradata_to_spec.rb
+- spec/acceptance/suites/default/check_puppet_version_spec.rb
+- spec/acceptance/suites/default/enable_fips_spec.rb
+- spec/acceptance/suites/default/fixture_modules_spec.rb
+- spec/acceptance/suites/default/nodesets
+- spec/acceptance/suites/default/pki_tests_spec.rb
+- spec/acceptance/suites/default/set_hieradata_on_spec.rb
+- spec/acceptance/suites/default/write_hieradata_to_spec.rb
+- spec/acceptance/suites/puppet_collections/00_default_spec.rb
+- spec/acceptance/suites/puppet_collections/metadata.yml
+- spec/acceptance/suites/puppet_collections/nodesets/default.yml
+- spec/lib/simp/beaker_helpers_spec.rb
+- spec/spec_helper.rb
 - spec/spec_helper_acceptance.rb
 homepage: https://github.com/simp/rubygem-simp-beaker-helpers
 licenses: