puppetlabs_spec_helper 2.6.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 847f2b3b3a676bafcb358cc257baf0cbc9a8600d
-  data.tar.gz: fa55fb32bbf5445d851105f54c933e18c2a514ae
+  metadata.gz: d87d6131bfee20ef40887c452db37042acdab37d
+  data.tar.gz: a327772c292504414a79d4fd3784ff82348cad4a
 SHA512:
-  metadata.gz: 8b76ba47b2d7f7fd28d2e0b673effb951778475c6653c89c1c67b96c53caf0e076a69baadb0743f945d0f190a14eb77883d52039ae088d7ae04c304bc8b0643f
-  data.tar.gz: 8b0e09f08ef5febe92178185eb3b24a611f3bf8f8b319df6555a221bb2f0ad828e2f75e4caf94fa31af8bcb6922d1ce95c2575ed8af636cf7e8aae5b28c2e711
+  metadata.gz: 6abed6f18fb005b07a38e19c0646716216058d88f425ea1659fd8453ac46bb17cb3135059f4f9deb2f7542609e8348e19121df1d74dc395bfaa94c9a9ec69fd8
+  data.tar.gz: c656294475da31a64af15631968a513438291e4f1d1b0e8e3e85d60cb65029ffcfdf63a793d1f2a0982c02706b6f887ed7a0c69d1f30da9d0d7d04d4acdcfb8d

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.7.0]
+### Summary
+Feature release to begin moving away from mocha as a testing (specifically, mocking) framework for modules.
+
+### Added
+- spec/plans/**/*_spec.rb to spec discovery pattern
+- [mocha as default](README.md#mock_with) test framework unless explicitly set by a module
+
+### Fixed
+- parsing for test tiers in beaker rake task
+- module_spec_helper compatibility with mocha 1.5.0
+
 ## [2.6.2]
 ### Summary
 A bugfix release to remove dependency on GettextSetup.initialize() in the Rake tasks.
@@ -430,7 +442,8 @@ compatible yet.
 ### Added
  * Initial release
 
-[unreleased]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.6.2...master
+[unreleased]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.7.0...master
+[2.7.0]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.6.2...v2.7.0
 [2.6.2]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.6.1...v2.6.2
 [2.6.1]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.5.1...v2.6.1
 [2.5.1]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.5.0...v2.5.1

data/README.md

@@ -345,14 +345,14 @@ remembering to duplicate any existing environment variables:
     env:
       - FUTURE_PARSER=yes CI_NODE_TOTAL=2 CI_NODE_INDEX=1
       - FUTURE_PARSER=yes CI_NODE_TOTAL=2 CI_NODE_INDEX=2
-      
+
 #### Running tests tagged with test tiers
-To run tests tagged with risk levels set the ``TEST_TIERS`` environment variable to a comma-separated list of 
+To run tests tagged with risk levels set the ``TEST_TIERS`` environment variable to a comma-separated list of
 the appropriate tiers.
 
-For example: to run tests marked ``tier_high => true`` and ``tier_medium => true`` in the same test run set the 
+For example: to run tests marked ``tier_high => true`` and ``tier_medium => true`` in the same test run set the
 environment variable``TEST_TIERS=high,medium``
-  
+
 Note, if the ``TEST_TIERS`` environment variable is set to empty string or nil, all tiers will be executed.
 
 
@@ -451,7 +451,7 @@ This is related to a registry security setting requiring elevated privileges to
 
 Currently, there are two known approaches to get around this problem.
 
-- run your windows shell (cmd) as an Administrator  
+- run your windows shell (cmd) as an Administrator
 or
 - modify the registry entry settings to allow symbolic links to be created.
 
@@ -463,5 +463,52 @@ The following links may give you some insight into why...
 
 [Microsoft TechNet](https://technet.microsoft.com/en-us/library/cc754077.aspx)
 
+mock_with
+=========
+
+There are two major mocking frameworks in modules test suites today: [mocha](https://rubygems.org/gems/mocha) and [rspec-mocks](https://rubygems.org/gems/rspec-mocks). It is recommended to choose rspec-mocks explicitely by specifying `mock_with` either in your `spec_helper.rb` like so:
+
+```
+RSpec.configure do |c|
+  c.mock_with :rspec
+end
+require 'puppetlabs_spec_helper/module_spec_helper'
+```
+
+or by using the PDK's [`mock_with` option in `.sync.yml`](https://github.com/puppetlabs/pdk-templates#specspec_helperrb) and `pdk update`.
+
+You can also continue to use mocha by explicitly specifying `:mocha`, following the [mocha documentation](http://gofreerange.com/mocha/docs/).
+
+Migration
+---------
+
+To migrate from mocha to rspec-mocks, in many simple cases the following two kinds of changes are all you need:
+
+Translate all stubs:
+```
+context.stubs(:some_method).with(arguments).returns('value')
+```
+to this:
+```
+allow(context).to receive(:some_method).with(arguments).and_returns('value')
+```
+
+Translate all expectations:
+```
+context.expects(:some_method).with(arguments).returns('value')
+```
+to this:
+```
+expect(context).to receive(:some_method).with(arguments).and_returns('value')
+```
+
+Rationale
+---------
+
+* As a part of the RSpec project, rspec-mocks integration is better.
+* mocha is extending base ruby objects with its `stubs`, and `expects` methods, polluting the global namespace, with a potential for subtle and gnarly errors.
+* Currently both rspec-mocks and mocha get loaded, leading to test suites that use both.
+* puppetlabs_spec_helper loads and configures mocha unconditionally, causing friction when a different mocking framework is wanted.
+* mocha is an additional dependency to carry.
 
 EOF

data/lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -26,7 +26,12 @@ RSpec.configure do |c|
   c.parser = 'future' if ENV['FUTURE_PARSER'] == 'yes'
 
   c.before :each do
-    Puppet.features.stubs(:root?).returns(true)
+    if c.mock_framework.framework_name == :rspec
+      allow(Puppet.features).to receive(:root?).and_return(true)
+    else
+      Puppet.features.stubs(:root?).returns(true)
+    end
+
     # stringify_facts and trusted_node_data were removed in puppet4
     if Puppet.version.to_f < 4.0
       Puppet.settings[:stringify_facts] = false if ENV['STRINGIFY_FACTS'] == 'no'

data/lib/puppetlabs_spec_helper/puppet_spec_helper.rb

@@ -3,12 +3,21 @@ require 'puppetlabs_spec_helper/puppetlabs_spec_helper'
 # Don't want puppet getting the command line arguments for rake or autotest
 ARGV.clear
 
-# This is needed because we're using mocha with rspec instead of Test::Unit or MiniTest
-ENV['MOCHA_OPTIONS']='skip_integration'
-
 require 'puppet'
 require 'rspec/expectations'
-require 'mocha/api'
+
+# Detect whether the module is overriding the choice of mocking framework
+# @mock_framework is used since more than seven years, and we need to avoid
+# `mock_framework`'s autoloading to distinguish between the default, and
+# the module's choice.
+# See also below in RSpec.configure
+if RSpec.configuration.instance_variable_get(:@mock_framework).nil?
+  # This is needed because we're using mocha with rspec instead of Test::Unit or MiniTest
+  ENV['MOCHA_OPTIONS']='skip_integration'
+
+  # Current versions of RSpec already load this for us, but who knows what's used out there?
+  require 'mocha/api'
+end
 
 require 'pathname'
 require 'tmpdir'
@@ -118,8 +127,14 @@ end
 
 # And here is where we do the main rspec configuration / setup.
 RSpec.configure do |config|
-  # Some modules depend on having mocha set up for them
-  config.mock_with :mocha
+  # Detect whether the module is overriding the choice of mocking framework
+  # @mock_framework is used since more than seven years, and we need to avoid
+  # `mock_framework`'s autoloading to distinguish between the default, and
+  # the module's choice.
+  if config.instance_variable_get(:@mock_framework).nil?
+    RSpec.warn_deprecation('puppetlabs_spec_helper: defaults `mock_with` to `:mocha`. See https://github.com/puppetlabs/puppetlabs_spec_helper#mock_with to choose a sensible value for you')
+    config.mock_with :mocha
+  end
 
   # determine whether we can use the new API or not, and call the appropriate initializer method.
   if (defined?(Puppet::Test::TestHelper))

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -2,9 +2,10 @@ require 'fileutils'
 require 'rake'
 require 'rspec/core/rake_task'
 require 'tmpdir'
-require 'yaml'
 require 'pathname'
 require 'puppetlabs_spec_helper/version'
+require 'puppetlabs_spec_helper/tasks/beaker'
+require 'puppetlabs_spec_helper/tasks/fixtures'
 
 # optional gems
 begin
@@ -21,10 +22,9 @@ rescue LoadError
   # ignore
 end
 
-
 task :default => [:help]
 
-pattern = 'spec/{aliases,classes,defines,unit,functions,hosts,integration,type_aliases,types}/**/*_spec.rb'
+pattern = 'spec/{aliases,classes,defines,unit,functions,hosts,integration,plans,type_aliases,types}/**/*_spec.rb'
 
 RSpec::Core::RakeTask.new(:spec_standalone) do |t, args|
   t.rspec_opts = ['--color']
@@ -55,387 +55,6 @@ RSpec::Core::RakeTask.new(:spec_list_json) do |t|
   t.pattern = pattern
 end
 
-desc "Run beaker acceptance tests"
-RSpec::Core::RakeTask.new(:beaker) do |t|
-  t.rspec_opts = ['--color']
-  t.pattern = 'spec/acceptance'
-  # TEST_TIERS env variable is a comma separated list of tiers to run. e.g. low, medium, high
-  if ENV['TEST_TIERS']
-    tiers = '--tag '
-    test_tiers = ENV['TEST_TIERS'].split(',')
-    raise 'TEST_TIERS env variable must have at least 1 tier specified. low, medium or high (comma separated).' if test_tiers.count == 0
-    test_tiers.each do |tier|
-      tier_to_add = tier.strip
-      raise "#{tier_to_add} not a valid test tier." unless %w(low medium high).include?(tier_to_add)
-      tiers += "tier_#{tier_to_add},"
-    end
-    tiers = tiers.chomp(',')
-    t.rspec_opts.push(tiers)
-  else
-    puts 'TEST_TIERS env variable not defined. Defaulting to run all tests.'
-  end
-end
-
-module PuppetlabsSpecHelper::RakeTasks
-  # This is a helper for the self-symlink entry of fixtures.yml
-  def source_dir
-    Dir.pwd
-  end
-
-  # cache the repositories and return a hash object
-  def repositories
-    unless @repositories
-      @repositories = fixtures('repositories')
-    end
-    @repositories
-  end
-
-  # get the array of Beaker set names
-  # @return [Array<String>]
-  def beaker_node_sets
-    return @beaker_nodes if @beaker_nodes
-    @beaker_nodes = Dir['spec/acceptance/nodesets/*.yml'].sort.map do |node_set|
-      node_set.slice!('.yml')
-      File.basename(node_set)
-    end
-  end
-
-  # Use "vagrant ssh" to login to the given node in the node set
-  # @param set [String] The name of the node set (yml file)
-  # @param node [String] The name of the node in the set. For multi-node sets.
-  def vagrant_ssh(set, node = nil)
-    vagrant_yml_dir = File.join '.vagrant', 'beaker_vagrant_files', "#{set}.yml"
-    vagrant_file = File.join vagrant_yml_dir, 'Vagrantfile'
-    unless File.file? vagrant_file
-      puts "There is no Vagrantfile at: '#{vagrant_file}'. Perhaps, the node is not created or is destroyed."
-      exit 1
-    end
-    Dir.chdir(vagrant_yml_dir) do
-      command = 'vagrant ssh'
-      command += " #{node}" if node
-      # Vagrant is not distributed as a normal gem
-      # and we should protect it from the current Ruby environment
-      env = {
-          'RUBYLIB' => nil,
-          'GEM_PATH' => nil,
-          'BUNDLE_BIN_PATH' => nil,
-      }
-      system env, command
-    end
-  end
-
-  def auto_symlink
-    { File.basename(Dir.pwd).split('-').last => '#{source_dir}' }
-  end
-
-  def fixtures(category)
-    if ENV['FIXTURES_YML']
-      fixtures_yaml = ENV['FIXTURES_YML']
-    elsif File.exists?('.fixtures.yml')
-      fixtures_yaml = '.fixtures.yml'
-    elsif File.exists?('.fixtures.yaml')
-      fixtures_yaml = '.fixtures.yaml'
-    else
-      fixtures_yaml = false
-    end
-
-    begin
-      if fixtures_yaml
-        fixtures = YAML.load_file(fixtures_yaml) || { 'fixtures' => {} }
-      else
-        fixtures = { 'fixtures' => {} }
-      end
-    rescue Errno::ENOENT
-      fail("Fixtures file not found: '#{fixtures_yaml}'")
-    rescue Psych::SyntaxError => e
-      fail("Found malformed YAML in '#{fixtures_yaml}' on line #{e.line} column #{e.column}: #{e.problem}")
-    end
-
-    unless fixtures.include?('fixtures')
-      # File is non-empty, but does not specify fixtures
-      fail("No 'fixtures' entries found in '#{fixtures_yaml}'; required")
-    end
-
-    if fixtures.include? 'defaults'
-      fixture_defaults = fixtures['defaults']
-    else
-      fixture_defaults = {}
-    end
-
-    fixtures = fixtures['fixtures']
-
-    if fixtures['symlinks'].nil?
-      fixtures['symlinks'] = auto_symlink
-    end
-
-    result = {}
-    if fixtures.include? category and fixtures[category] != nil
-
-      defaults = { "target" => "spec/fixtures/modules" }
-
-      # load defaults from the `.fixtures.yml` `defaults` section
-      # for the requested category and merge them into my defaults
-      if fixture_defaults.include? category
-        defaults = defaults.merge(fixture_defaults[category])
-      end
-
-      fixtures[category].each do |fixture, opts|
-        # convert a simple string fixture to a hash, by
-        # using the string fixture as the `repo` option of the hash.
-        if opts.instance_of?(String)
-          opts = { "repo" => opts }
-        end
-        # there should be a warning or something if it's not a hash...
-        if opts.instance_of?(Hash)
-          # merge our options into the defaults to get the
-          # final option list
-          opts = defaults.merge(opts)
-
-          real_target = eval('"'+opts["target"]+'"')
-          real_source = eval('"'+opts["repo"]+'"')
-
-          result[real_source] = { "target" => File.join(real_target,fixture), "ref" => opts["ref"], "branch" => opts["branch"], "scm" => opts["scm"], "flags" => opts["flags"], "subdir" => opts["subdir"]}
-        end
-      end
-    end
-    return result
-  end
-
-  def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
-    args = []
-    case scm
-    when 'hg'
-      args.push('clone')
-      args.push('-b', branch) if branch
-      args.push(flags) if flags
-      args.push(remote, target)
-    when 'git'
-      args.push('clone')
-      args.push('--depth 1') unless ref
-      args.push('-b', branch) if branch
-      args.push(flags) if flags
-      args.push(remote, target)
-    else
-      fail "Unfortunately #{scm} is not supported yet"
-    end
-    result = system("#{scm} #{args.flatten.join ' '}")
-    unless File::exists?(target)
-      fail "Failed to clone #{scm} repository #{remote} into #{target}"
-    end
-    result
-  end
-
-  def revision(scm, target, ref)
-    args = []
-    case scm
-    when 'hg'
-      args.push('update', '--clean', '-r', ref)
-    when 'git'
-      args.push('reset', '--hard', ref)
-    else
-      fail "Unfortunately #{scm} is not supported yet"
-    end
-    system("cd #{target} && #{scm} #{args.flatten.join ' '}")
-  end
-
-  def remove_subdirectory(target, subdir)
-    unless subdir.nil?
-      Dir.mktmpdir {|tmpdir|
-         FileUtils.mv(Dir.glob("#{target}/#{subdir}/{.[^\.]*,*}"), tmpdir)
-         FileUtils.rm_rf("#{target}/#{subdir}")
-         FileUtils.mv(Dir.glob("#{tmpdir}/{.[^\.]*,*}"), "#{target}")
-      }
-    end
-  end
-
-  # creates a logger so we can log events with certain levels
-  def logger
-    unless @logger
-      require 'logger'
-      if ENV['ENABLE_LOGGER']
-         level = Logger::DEBUG
-       else
-         level = Logger::INFO
-      end
-      @logger = Logger.new(STDERR)
-      @logger.level = level
-    end
-    @logger
-  end
-
-  def module_working_directory
-    # The problem with the relative path is that PMT doesn't expand the path properly and so passing in a relative path here
-    # becomes something like C:\somewhere\backslashes/spec/fixtures/work-dir on Windows, and then PMT barfs itself.
-    # This has been reported as https://tickets.puppetlabs.com/browse/PUP-4884
-    File.expand_path(ENV['MODULE_WORKING_DIR'] ? ENV['MODULE_WORKING_DIR'] : 'spec/fixtures/work-dir')
-  end
-
-  # returns the current thread count that is currently active
-  # a status of false or nil means the thread completed
-  # so when anything else we count that as a active thread
-  def current_thread_count(items)
-    active_threads = items.find_all do |item, opts|
-      if opts[:thread]
-        opts[:thread].status
-      else
-        false
-      end
-    end
-    logger.debug "Current thread count #{active_threads.count}"
-    active_threads.count
-  end
-
-  # returns the max_thread_count
-  # because we may want to limit ssh or https connections
-  def max_thread_limit
-    unless @max_thread_limit
-      # the default thread count is 10 but can be
-      # raised by using environment variable MAX_FIXTURE_THREAD_COUNT
-      if ENV['MAX_FIXTURE_THREAD_COUNT'].to_i > 0
-        @max_thread_limit = ENV['MAX_FIXTURE_THREAD_COUNT'].to_i
-      else
-        @max_thread_limit = 10 # the default
-      end
-    end
-    @max_thread_limit
-  end
-
-  def check_directory_for_symlinks(dir='.')
-    dir = Pathname.new(dir) unless dir.is_a?(Pathname)
-    results = []
-
-    dir.each_child(true) do |child|
-      if child.symlink?
-        results << child
-      elsif child.directory? && child.basename.to_s != '.git'
-        results.concat(check_directory_for_symlinks(child))
-      end
-    end
-
-    results
-  end
-end
-include PuppetlabsSpecHelper::RakeTasks
-
-desc "Create the fixtures directory"
-task :spec_prep do
-  # Ruby only sets File::ALT_SEPARATOR on Windows and Rubys standard library
-  # uses this to check for Windows
-  is_windows = !!File::ALT_SEPARATOR
-  if is_windows
-    begin
-      require 'win32/dir'
-    rescue LoadError
-      $stderr.puts "win32-dir gem not installed, falling back to executing mklink directly"
-    end
-  end
-
-  # git has a race condition creating that directory, that would lead to aborted clone operations
-  FileUtils::mkdir_p("spec/fixtures/modules")
-
-  repositories.each do |remote, opts|
-    scm = 'git'
-    target = opts["target"]
-    subdir = opts["subdir"]
-    ref = opts["ref"]
-    scm = opts["scm"] if opts["scm"]
-    branch = opts["branch"] if opts["branch"]
-    flags = opts["flags"]
-    # get the current active threads that are alive
-    count = current_thread_count(repositories)
-    if count < max_thread_limit
-      logger.debug "New Thread started for #{remote}"
-      # start up a new thread and store it in the opts hash
-      opts[:thread] = Thread.new do
-        clone_repo(scm, remote, target, subdir, ref, branch, flags)
-        revision(scm, target, ref) if ref
-        remove_subdirectory(target, subdir) if subdir
-      end
-    else
-      # the last thread started should be the longest wait
-      item, item_opts = repositories.find_all {|i,o| o.has_key?(:thread)}.last
-      logger.debug "Waiting on #{item}"
-      item_opts[:thread].join  # wait for the thread to finish
-      # now that we waited lets try again
-      redo
-    end
-  end
-
-  # wait for all the threads to finish
-  repositories.each {|remote, opts| opts[:thread].join }
-
-  fixtures("symlinks").each do |target, link|
-    link = link['target']
-    unless File.symlink?(link)
-      logger.info("Creating symlink from #{link} to #{target}")
-      if is_windows
-        target = File.join(File.dirname(link), target) unless Pathname.new(target).absolute?
-        if Dir.respond_to?(:create_junction)
-          Dir.create_junction(link, target)
-        else
-          system("call mklink /J \"#{link.gsub('/', '\\')}\" \"#{target.gsub('/', '\\')}\"")
-        end
-      else
-        FileUtils::ln_sf(target, link)
-      end
-    end
-  end
-
-  fixtures("forge_modules").each do |remote, opts|
-    ref = ""
-    flags = ""
-    if opts.instance_of?(String)
-      target = opts
-    elsif opts.instance_of?(Hash)
-      target = opts["target"]
-      ref = " --version #{opts['ref']}" if not opts['ref'].nil?
-      flags = " #{opts['flags']}" if opts['flags']
-    end
-    next if File::exists?(target)
-
-    working_dir = module_working_directory
-    target_dir = File.expand_path('spec/fixtures/modules')
-
-    command = "puppet module install" + ref + flags + \
-      " --ignore-dependencies" \
-      " --force" \
-      " --module_working_dir \"#{working_dir}\"" \
-      " --target-dir \"#{target_dir}\" \"#{remote}\""
-
-    unless system(command)
-      fail "Failed to install module #{remote} to #{target_dir}"
-    end
-  end
-
-  FileUtils::mkdir_p("spec/fixtures/manifests")
-  FileUtils::touch("spec/fixtures/manifests/site.pp")
-end
-
-desc "Clean up the fixtures directory"
-task :spec_clean do
-  fixtures("repositories").each do |remote, opts|
-    target = opts["target"]
-    FileUtils::rm_rf(target)
-  end
-
-  fixtures("forge_modules").each do |remote, opts|
-    target = opts["target"]
-    FileUtils::rm_rf(target)
-  end
-
-  FileUtils::rm_rf(module_working_directory)
-
-  fixtures("symlinks").each do |source, opts|
-    target = opts["target"]
-    FileUtils::rm_f(target)
-  end
-
-  if File.zero?("spec/fixtures/manifests/site.pp")
-    FileUtils::rm_f("spec/fixtures/manifests/site.pp")
-  end
-
-end
-
 desc "Run spec tests and clean the fixtures directory if successful"
 task :spec do |t, args|
   begin
@@ -465,38 +84,6 @@ task :parallel_spec do
   end
 end
 
-desc "List available beaker nodesets"
-task 'beaker:sets' do
-  beaker_node_sets.each do |set|
-    puts set
-  end
-end
-
-# alias for compatibility
-task 'beaker_nodes' => 'beaker:sets'
-
-desc 'Try to use vagrant to login to the Beaker node'
-task 'beaker:ssh', [:set, :node] do |_task, args|
-  set = args[:set] || ENV['BEAKER_set'] || ENV['RS_SET'] || 'default'
-  node = args[:node]
-  vagrant_ssh set, node
-end
-
-beaker_node_sets.each do |set|
-  desc "Run the Beaker acceptance tests for the node set '#{set}'"
-  task "beaker:#{set}" do
-    ENV['BEAKER_set'] = set
-    Rake::Task['beaker'].reenable
-    Rake::Task['beaker'].invoke
-  end
-
-  desc "Use vagrant to login to a node from the set '#{set}'"
-  task "beaker:ssh:#{set}", [:node] do |_task, args|
-    node = args[:node]
-    vagrant_ssh set, node
-  end
-end
-
 desc "Build puppet module package"
 task :build do
   # This will be deprecated once puppet-module is a face.

data/lib/puppetlabs_spec_helper/tasks/beaker.rb

@@ -0,0 +1,111 @@
+require 'rspec/core/rake_task'
+
+module PuppetlabsSpecHelper; end
+module PuppetlabsSpecHelper::Tasks; end
+module PuppetlabsSpecHelper::Tasks::BeakerHelpers
+  # This is a helper for the self-symlink entry of fixtures.yml
+  def source_dir
+    Dir.pwd
+  end
+
+  # cache the repositories and return a hash object
+  def repositories
+    unless @repositories
+      @repositories = fixtures('repositories')
+    end
+    @repositories
+  end
+
+  # get the array of Beaker set names
+  # @return [Array<String>]
+  def beaker_node_sets
+    return @beaker_nodes if @beaker_nodes
+    @beaker_nodes = Dir['spec/acceptance/nodesets/*.yml'].sort.map do |node_set|
+      node_set.slice!('.yml')
+      File.basename(node_set)
+    end
+  end
+
+  # Use "vagrant ssh" to login to the given node in the node set
+  # @param set [String] The name of the node set (yml file)
+  # @param node [String] The name of the node in the set. For multi-node sets.
+  def vagrant_ssh(set, node = nil)
+    vagrant_yml_dir = File.join '.vagrant', 'beaker_vagrant_files', "#{set}.yml"
+    vagrant_file = File.join vagrant_yml_dir, 'Vagrantfile'
+    unless File.file? vagrant_file
+      puts "There is no Vagrantfile at: '#{vagrant_file}'. Perhaps, the node is not created or is destroyed."
+      exit 1
+    end
+    Dir.chdir(vagrant_yml_dir) do
+      command = 'vagrant ssh'
+      command += " #{node}" if node
+      # Vagrant is not distributed as a normal gem
+      # and we should protect it from the current Ruby environment
+      env = {
+          'RUBYLIB' => nil,
+          'GEM_PATH' => nil,
+          'BUNDLE_BIN_PATH' => nil,
+      }
+      system env, command
+    end
+  end
+end
+include PuppetlabsSpecHelper::Tasks::BeakerHelpers
+
+desc "Run beaker acceptance tests"
+RSpec::Core::RakeTask.new(:beaker) do |t|
+  SetupBeaker.setup_beaker(t)
+end
+
+class SetupBeaker
+  def self.setup_beaker(t)
+    t.rspec_opts = ['--color']
+    t.pattern = 'spec/acceptance'
+    # TEST_TIERS env variable is a comma separated list of tiers to run. e.g. low, medium, high
+    if ENV['TEST_TIERS']
+      test_tiers = ENV['TEST_TIERS'].split(',')
+      raise 'TEST_TIERS env variable must have at least 1 tier specified. low, medium or high (comma separated).' if test_tiers.count == 0
+      test_tiers.each do |tier|
+        tier_to_add = tier.strip.downcase
+        raise "#{tier_to_add} not a valid test tier." unless %w(low medium high).include?(tier_to_add)
+        tiers = "--tag tier_#{tier_to_add}"
+        t.rspec_opts.push(tiers)
+      end
+    else
+      puts 'TEST_TIERS env variable not defined. Defaulting to run all tests.'
+    end
+    return t
+  end
+end
+
+desc "List available beaker nodesets"
+task 'beaker:sets' do
+  beaker_node_sets.each do |set|
+    puts set
+  end
+end
+
+# alias for compatibility
+task 'beaker_nodes' => 'beaker:sets'
+
+desc 'Try to use vagrant to login to the Beaker node'
+task 'beaker:ssh', [:set, :node] do |_task, args|
+  set = args[:set] || ENV['BEAKER_set'] || ENV['RS_SET'] || 'default'
+  node = args[:node]
+  vagrant_ssh set, node
+end
+
+beaker_node_sets.each do |set|
+  desc "Run the Beaker acceptance tests for the node set '#{set}'"
+  task "beaker:#{set}" do
+    ENV['BEAKER_set'] = set
+    Rake::Task['beaker'].reenable
+    Rake::Task['beaker'].invoke
+  end
+
+  desc "Use vagrant to login to a node from the set '#{set}'"
+  task "beaker:ssh:#{set}", [:node] do |_task, args|
+    node = args[:node]
+    vagrant_ssh set, node
+  end
+end

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -0,0 +1,328 @@
+require 'yaml'
+
+module PuppetlabsSpecHelper; end
+module PuppetlabsSpecHelper::Tasks; end
+module PuppetlabsSpecHelper::Tasks::FixtureHelpers
+  # This is a helper for the self-symlink entry of fixtures.yml
+  def source_dir
+    Dir.pwd
+  end
+
+  # cache the repositories and return a hash object
+  def repositories
+    unless @repositories
+      @repositories = fixtures('repositories')
+    end
+    @repositories
+  end
+
+  def auto_symlink
+    { File.basename(Dir.pwd).split('-').last => '#{source_dir}' }
+  end
+
+  def fixtures(category)
+    if ENV['FIXTURES_YML']
+      fixtures_yaml = ENV['FIXTURES_YML']
+    elsif File.exists?('.fixtures.yml')
+      fixtures_yaml = '.fixtures.yml'
+    elsif File.exists?('.fixtures.yaml')
+      fixtures_yaml = '.fixtures.yaml'
+    else
+      fixtures_yaml = false
+    end
+
+    begin
+      if fixtures_yaml
+        fixtures = YAML.load_file(fixtures_yaml) || { 'fixtures' => {} }
+      else
+        fixtures = { 'fixtures' => {} }
+      end
+    rescue Errno::ENOENT
+      fail("Fixtures file not found: '#{fixtures_yaml}'")
+    rescue Psych::SyntaxError => e
+      fail("Found malformed YAML in '#{fixtures_yaml}' on line #{e.line} column #{e.column}: #{e.problem}")
+    end
+
+    unless fixtures.include?('fixtures')
+      # File is non-empty, but does not specify fixtures
+      fail("No 'fixtures' entries found in '#{fixtures_yaml}'; required")
+    end
+
+    if fixtures.include? 'defaults'
+      fixture_defaults = fixtures['defaults']
+    else
+      fixture_defaults = {}
+    end
+
+    fixtures = fixtures['fixtures']
+
+    if fixtures['symlinks'].nil?
+      fixtures['symlinks'] = auto_symlink
+    end
+
+    result = {}
+    if fixtures.include? category and fixtures[category] != nil
+
+      defaults = { "target" => "spec/fixtures/modules" }
+
+      # load defaults from the `.fixtures.yml` `defaults` section
+      # for the requested category and merge them into my defaults
+      if fixture_defaults.include? category
+        defaults = defaults.merge(fixture_defaults[category])
+      end
+
+      fixtures[category].each do |fixture, opts|
+        # convert a simple string fixture to a hash, by
+        # using the string fixture as the `repo` option of the hash.
+        if opts.instance_of?(String)
+          opts = { "repo" => opts }
+        end
+        # there should be a warning or something if it's not a hash...
+        if opts.instance_of?(Hash)
+          # merge our options into the defaults to get the
+          # final option list
+          opts = defaults.merge(opts)
+
+          real_target = eval('"'+opts["target"]+'"')
+          real_source = eval('"'+opts["repo"]+'"')
+
+          result[real_source] = { "target" => File.join(real_target,fixture), "ref" => opts["ref"], "branch" => opts["branch"], "scm" => opts["scm"], "flags" => opts["flags"], "subdir" => opts["subdir"]}
+        end
+      end
+    end
+    return result
+  end
+
+  def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
+    args = []
+    case scm
+    when 'hg'
+      args.push('clone')
+      args.push('-b', branch) if branch
+      args.push(flags) if flags
+      args.push(remote, target)
+    when 'git'
+      args.push('clone')
+      args.push('--depth 1') unless ref
+      args.push('-b', branch) if branch
+      args.push(flags) if flags
+      args.push(remote, target)
+    else
+      fail "Unfortunately #{scm} is not supported yet"
+    end
+    result = system("#{scm} #{args.flatten.join ' '}")
+    unless File::exists?(target)
+      fail "Failed to clone #{scm} repository #{remote} into #{target}"
+    end
+    result
+  end
+
+  def revision(scm, target, ref)
+    args = []
+    case scm
+    when 'hg'
+      args.push('update', '--clean', '-r', ref)
+    when 'git'
+      args.push('reset', '--hard', ref)
+    else
+      fail "Unfortunately #{scm} is not supported yet"
+    end
+    system("cd #{target} && #{scm} #{args.flatten.join ' '}")
+  end
+
+  def remove_subdirectory(target, subdir)
+    unless subdir.nil?
+      Dir.mktmpdir {|tmpdir|
+         FileUtils.mv(Dir.glob("#{target}/#{subdir}/{.[^\.]*,*}"), tmpdir)
+         FileUtils.rm_rf("#{target}/#{subdir}")
+         FileUtils.mv(Dir.glob("#{tmpdir}/{.[^\.]*,*}"), "#{target}")
+      }
+    end
+  end
+
+  # creates a logger so we can log events with certain levels
+  def logger
+    unless @logger
+      require 'logger'
+      if ENV['ENABLE_LOGGER']
+         level = Logger::DEBUG
+       else
+         level = Logger::INFO
+      end
+      @logger = Logger.new(STDERR)
+      @logger.level = level
+    end
+    @logger
+  end
+
+  def module_working_directory
+    # The problem with the relative path is that PMT doesn't expand the path properly and so passing in a relative path here
+    # becomes something like C:\somewhere\backslashes/spec/fixtures/work-dir on Windows, and then PMT barfs itself.
+    # This has been reported as https://tickets.puppetlabs.com/browse/PUP-4884
+    File.expand_path(ENV['MODULE_WORKING_DIR'] ? ENV['MODULE_WORKING_DIR'] : 'spec/fixtures/work-dir')
+  end
+
+  # returns the current thread count that is currently active
+  # a status of false or nil means the thread completed
+  # so when anything else we count that as a active thread
+  def current_thread_count(items)
+    active_threads = items.find_all do |item, opts|
+      if opts[:thread]
+        opts[:thread].status
+      else
+        false
+      end
+    end
+    logger.debug "Current thread count #{active_threads.count}"
+    active_threads.count
+  end
+
+  # returns the max_thread_count
+  # because we may want to limit ssh or https connections
+  def max_thread_limit
+    unless @max_thread_limit
+      # the default thread count is 10 but can be
+      # raised by using environment variable MAX_FIXTURE_THREAD_COUNT
+      if ENV['MAX_FIXTURE_THREAD_COUNT'].to_i > 0
+        @max_thread_limit = ENV['MAX_FIXTURE_THREAD_COUNT'].to_i
+      else
+        @max_thread_limit = 10 # the default
+      end
+    end
+    @max_thread_limit
+  end
+
+  def check_directory_for_symlinks(dir='.')
+    dir = Pathname.new(dir) unless dir.is_a?(Pathname)
+    results = []
+
+    dir.each_child(true) do |child|
+      if child.symlink?
+        results << child
+      elsif child.directory? && child.basename.to_s != '.git'
+        results.concat(check_directory_for_symlinks(child))
+      end
+    end
+
+    results
+  end
+end
+include PuppetlabsSpecHelper::Tasks::FixtureHelpers
+
+desc "Create the fixtures directory"
+task :spec_prep do
+  # Ruby only sets File::ALT_SEPARATOR on Windows and Rubys standard library
+  # uses this to check for Windows
+  is_windows = !!File::ALT_SEPARATOR
+  if is_windows
+    begin
+      require 'win32/dir'
+    rescue LoadError
+      $stderr.puts "win32-dir gem not installed, falling back to executing mklink directly"
+    end
+  end
+
+  # git has a race condition creating that directory, that would lead to aborted clone operations
+  FileUtils::mkdir_p("spec/fixtures/modules")
+
+  repositories.each do |remote, opts|
+    scm = 'git'
+    target = opts["target"]
+    subdir = opts["subdir"]
+    ref = opts["ref"]
+    scm = opts["scm"] if opts["scm"]
+    branch = opts["branch"] if opts["branch"]
+    flags = opts["flags"]
+    # get the current active threads that are alive
+    count = current_thread_count(repositories)
+    if count < max_thread_limit
+      logger.debug "New Thread started for #{remote}"
+      # start up a new thread and store it in the opts hash
+      opts[:thread] = Thread.new do
+        clone_repo(scm, remote, target, subdir, ref, branch, flags)
+        revision(scm, target, ref) if ref
+        remove_subdirectory(target, subdir) if subdir
+      end
+    else
+      # the last thread started should be the longest wait
+      item, item_opts = repositories.find_all {|i,o| o.has_key?(:thread)}.last
+      logger.debug "Waiting on #{item}"
+      item_opts[:thread].join  # wait for the thread to finish
+      # now that we waited lets try again
+      redo
+    end
+  end
+
+  # wait for all the threads to finish
+  repositories.each {|remote, opts| opts[:thread].join }
+
+  fixtures("symlinks").each do |target, link|
+    link = link['target']
+    unless File.symlink?(link)
+      logger.info("Creating symlink from #{link} to #{target}")
+      if is_windows
+        target = File.join(File.dirname(link), target) unless Pathname.new(target).absolute?
+        if Dir.respond_to?(:create_junction)
+          Dir.create_junction(link, target)
+        else
+          system("call mklink /J \"#{link.gsub('/', '\\')}\" \"#{target.gsub('/', '\\')}\"")
+        end
+      else
+        FileUtils::ln_sf(target, link)
+      end
+    end
+  end
+
+  fixtures("forge_modules").each do |remote, opts|
+    ref = ""
+    flags = ""
+    if opts.instance_of?(String)
+      target = opts
+    elsif opts.instance_of?(Hash)
+      target = opts["target"]
+      ref = " --version #{opts['ref']}" if not opts['ref'].nil?
+      flags = " #{opts['flags']}" if opts['flags']
+    end
+    next if File::exists?(target)
+
+    working_dir = module_working_directory
+    target_dir = File.expand_path('spec/fixtures/modules')
+
+    command = "puppet module install" + ref + flags + \
+      " --ignore-dependencies" \
+      " --force" \
+      " --module_working_dir \"#{working_dir}\"" \
+      " --target-dir \"#{target_dir}\" \"#{remote}\""
+
+    unless system(command)
+      fail "Failed to install module #{remote} to #{target_dir}"
+    end
+  end
+
+  FileUtils::mkdir_p("spec/fixtures/manifests")
+  FileUtils::touch("spec/fixtures/manifests/site.pp")
+end
+
+desc "Clean up the fixtures directory"
+task :spec_clean do
+  fixtures("repositories").each do |remote, opts|
+    target = opts["target"]
+    FileUtils::rm_rf(target)
+  end
+
+  fixtures("forge_modules").each do |remote, opts|
+    target = opts["target"]
+    FileUtils::rm_rf(target)
+  end
+
+  FileUtils::rm_rf(module_working_directory)
+
+  fixtures("symlinks").each do |source, opts|
+    target = opts["target"]
+    FileUtils::rm_f(target)
+  end
+
+  if File.zero?("spec/fixtures/manifests/site.pp")
+    FileUtils::rm_f("spec/fixtures/manifests/site.pp")
+  end
+end

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,5 @@
 module PuppetlabsSpecHelper
-  VERSION = "2.6.2"
+  VERSION = "2.7.0"
 
   # compat for pre-1.2.0 users; deprecated
   module Version

data/puppetlabs_spec_helper.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Standard tasks and configuration for module spec tests.}
   spec.description   = %q{Contains rake tasks and a standard spec_helper for running spec tests on puppet modules.}
   spec.homepage      = "http://github.com/puppetlabs/puppetlabs_spec_helper"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -192,12 +192,15 @@ files:
 - lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb
 - lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb
 - lib/puppetlabs_spec_helper/rake_tasks.rb
+- lib/puppetlabs_spec_helper/tasks/beaker.rb
+- lib/puppetlabs_spec_helper/tasks/fixtures.rb
 - lib/puppetlabs_spec_helper/version.rb
 - puppet_spec_helper.rb
 - puppetlabs_spec_helper.gemspec
 - puppetlabs_spec_helper.rb
 homepage: http://github.com/puppetlabs/puppetlabs_spec_helper
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -215,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Standard tasks and configuration for module spec tests.