puppetlabs_spec_helper 2.14.1 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb89bc7cd1c8a7ea79dd83f18fc2d15ad24f035c
-  data.tar.gz: 67d56faf027cbbec8e0ffa0a32b4f2c0dd9134e1
+SHA256:
+  metadata.gz: ef8655a96bfce5e47b0a0c1691cc79033fb8c0257ae329f1f133bcfcf950cb51
+  data.tar.gz: 6422a905001992ce256ce6102e59feffb1853c37f6997b5a2deb439e77721e98
 SHA512:
-  metadata.gz: b7604f2bc60bd6e96722e89229e69b74e1cef4c45a67c377730b5e5eb2a23b525f5486772f7fa5dbcdc5904971caab232d845d506323deb435510fbf1411c7dd
-  data.tar.gz: 00a4bcf65955310bbe0e9b5f3e71da39ee0a63f104ad764c3df7519edf42c13fc8dc5c6a8dfd176c602abf911c8a73b650118ffe0239f04e9567cf18fc0ba032
+  metadata.gz: 6b1ede292272b8999f9d0c2775dc9796cea623062dc482b1ed5f3c8e9d7b204b2c171b4a9c582eb0a72a0ef73c1c604c33255e7a234bfedc45435dc9a87f1a0e
+  data.tar.gz: d90acb664b74a454610637f5363ab6d975290272aff8f9b6dc0195104493a7d66c6e9c0d646d4d1f877d06244646dae95fa9e70a036f3f4f8a995c296444e1a4

data/.rubocop.yml

@@ -136,3 +136,7 @@ Style/SymbolArray:
   Description: Using percent style obscures symbolic intent of array's contents.
   Enabled: true
   EnforcedStyle: brackets
+
+# Enforce LF line endings, even when on Windows
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/.travis.yml

@@ -1,12 +1,16 @@
-sudo: false
+os: linux
+dist: xenial
 language: ruby
 cache: bundler
-before_install:
-   bundle -v
+before_install: bundle -v
 script: env COVERAGE=yes bundle exec rake
-matrix:
+jobs:
   fast_finish: true
   include:
+  - rvm: '2.7'
+    env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#master' # TODO: change to 7 once it becomes available
+  - rvm: '2.6'
+    env: PUPPET_GEM_VERSION='~> 6.0'
   - rvm: '2.5'
     env: PUPPET_GEM_VERSION='~> 6.0'
   - rvm: '2.4'
@@ -25,11 +29,5 @@ matrix:
     env: PUPPET_GEM_VERSION='~> 4.0'
   - rvm: '2.1'
     env: PUPPET_GEM_VERSION='~> 4.0'
-  - rvm: '2.1'
-    env: PUPPET_GEM_VERSION='~> 3.0'
-  - rvm: '2.0'
-    env: PUPPET_GEM_VERSION='~> 3.0'
-  - rvm: '1.9'
-    env: PUPPET_GEM_VERSION='~> 3.0'
 notifications:
   email: false

data/CHANGELOG.md

@@ -3,6 +3,31 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v2.15.0](https://github.com/puppetlabs/puppetlabs_spec_helper/tree/v2.15.0) (2020-06-11)
+[Full Changelog](https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.14.1...v2.15.0)
+
+**Implemented enhancements:**
+
+- Add Ruby 2.6/Puppet6 to CI matrix [\#311](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/311) ([bastelfreak](https://github.com/bastelfreak))
+- \(GH-297\) Don't allow git refs with forward slashes [\#299](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/299) ([glennsarti](https://github.com/glennsarti))
+- Accept `:tag` for consistency with r10k [\#296](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/296) ([binford2k](https://github.com/binford2k))
+- \(maint\) migrate the changelog task from pdk-templates [\#278](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/278) ([DavidS](https://github.com/DavidS))
+
+**Fixed bugs:**
+
+- \(MAINT\) Fix initialize of Gettext call [\#292](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/292) ([ThoughtCrhyme](https://github.com/ThoughtCrhyme))
+
+**Merged pull requests:**
+
+- \(IAC-859\) Update all the gems and ruby to 2.7 [\#316](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/316) ([DavidS](https://github.com/DavidS))
+- Support git fixture branches containing slashes [\#297](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/297) ([trevor-vaughan](https://github.com/trevor-vaughan))
+- \(maint\) Require pdk/util in build:pdk rake task [\#295](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/295) ([rodjek](https://github.com/rodjek))
+- Ignore plans folder and any subfolder [\#294](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/294) ([cyberious](https://github.com/cyberious))
+- \(maint\) add codeowners file [\#293](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/293) ([tphoney](https://github.com/tphoney))
+- \(MAINT\) Removes old rubies and puppet versions [\#290](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/290) ([logicminds](https://github.com/logicminds))
+- Remove coveralls docs [\#289](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/289) ([DavidS](https://github.com/DavidS))
+- Download forge modules in parallel [\#284](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/284) ([logicminds](https://github.com/logicminds))
+
 ## [v2.14.1](https://github.com/puppetlabs/puppetlabs_spec_helper/tree/v2.14.1) (2019-03-26)
 [Full Changelog](https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.14.0...v2.14.1)
 
@@ -10,6 +35,10 @@ All significant changes to this repo will be summarized in this file.
 
 - Revert "\(feat\) dont load the beaker if litmus is there" [\#286](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/286) ([pmcmaw](https://github.com/pmcmaw))
 
+**Merged pull requests:**
+
+- \(MODULES-8778\) - Release Prep 2.14.1 [\#287](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/287) ([pmcmaw](https://github.com/pmcmaw))
+
 ## [v2.14.0](https://github.com/puppetlabs/puppetlabs_spec_helper/tree/v2.14.0) (2019-03-25)
 [Full Changelog](https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.13.1...v2.14.0)
 

data/CODEOWNERS

@@ -0,0 +1,2 @@
+# Default owners.
+* @puppetlabs/pdk @puppetlabs/modules

data/Gemfile

@@ -1,24 +1,46 @@
-source 'https://rubygems.org'
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+def location_for(place_or_version, fake_version = nil)
+  git_url_regex = %r{\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?}
+  file_url_regex = %r{\Afile:\/\/(?<path>.*)}
+
+  if place_or_version && (git_url = place_or_version.match(git_url_regex))
+    [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact
+  elsif place_or_version && (file_url = place_or_version.match(file_url_regex))
+    ['>= 0', { path: File.expand_path(file_url[:path]), require: false }]
+  else
+    [place_or_version, { require: false }]
+  end
+end
 
 # Specify the global dependencies in puppetlabs_spec_helper.gemspec
 # Note that only ruby 1.9 compatible dependencies may go there, everything else needs to be documented and pulled in manually, and optionally by everyone who wants to use the extended features.
 gemspec
 
+def infer_puppet_version
+  # Infer the Puppet Gem version based on the Ruby Version
+  ruby_ver = Gem::Version.new(RUBY_VERSION.dup)
+  return '~> 6.0' if ruby_ver >= Gem::Version.new('2.5.0')
+  return '~> 5.0' if ruby_ver >= Gem::Version.new('2.4.0')
+  '~> 4.0'
+end
+
 group :development do
   gem 'codecov'
   gem 'github_changelog_generator' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.0')
-  gem 'puppet', ENV['PUPPET_GEM_VERSION'] || ENV['PUPPET_VERSION'] || '~> 4.0'
+  gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'] || ENV['PUPPET_VERSION'] || infer_puppet_version)
   gem 'simplecov', '~> 0'
   gem 'simplecov-console'
   if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
-    gem 'rubocop', '< 0.50'
+    gem 'rubocop', '= 0.49'
     gem 'rubocop-rspec', '~> 1'
   end
 end
 
-# json_pure 2.0.2 added a requirement on ruby >= 2. We pin to json_pure 2.0.1
-# if using ruby 1.x
-gem 'json_pure', '<=2.0.1' if RUBY_VERSION =~ %r{^1\.}
-gem 'rack', '~> 1'
+# pin some gems for older ruby versions
+gem 'fakefs', '<= 0.13.3' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.4.0')
+gem 'json_pure', '<=2.0.1' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
+gem 'puppet-syntax', '<= 3' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.4.0')
+gem 'rack', '~> 1' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.2.0')
 
 # vim:filetype=ruby

data/README.md

@@ -59,7 +59,7 @@ Host github.com
 
 ```
 
-Note: parallel downloads is only available for repositories and not forge modules.
+Note: parallel downloads are available for repositories and forge modules.
 
 ### Parallel tests
 It is also possible to use the `parallel_tests` Gem via the `:parallel_spec` Rake task to run rspec commands in parallel on groups of spec files.
@@ -156,7 +156,7 @@ variables for the spec run. These are:
   * ``TRUSTED_NODE_DATA``  _(Puppet 3.x, starting with 3.4)_ - set to "yes" to enable [the $facts hash and trusted node data](https://puppet.com/docs/puppet/3.8/lang_facts_and_builtin_vars.html#trusted-facts),
     which enabled ``$facts`` and ``$trusted`` hashes. This is equivalent to setting
     [trusted_node_data=true](https://puppet.com/docs/puppet/3.8/configuration.html#trustednodedata)
-    in puppet.conf.    
+    in puppet.conf.
   * ``STRINGIFY_FACTS``  _(Puppet 3.x, starting with 3.5)_  - set to "no" to enable [structured facts](http://docs.puppetlabs.com/facter/2.0/fact_overview.html#writing-structured-facts),
     otherwise leave unset to retain the current default behavior. This is equivalent to setting
     [stringify_facts=false](https://puppet.com/docs/puppet/3.8/configuration.html#stringifyfacts)
@@ -203,7 +203,7 @@ When specifying the repo source of the fixture you have a few options as to whic
 
  * `target` - the directory name to clone the repo into ie. `target: mymodule`  defaults to the repo name  (Optional)
  * `subdir` - directory to be removed from the cloned repo. Its contents will be moved to the root directory (Optional)
- * `ref` - used to specify the tag name like version hash of commit (Optional)
+ * `ref` - used to specify the tag name (like version) or commit hash to be checked out (Optional). Branch names should use the `branch` option instead.
 
    ```yaml
    ref: 1.0.0
@@ -389,7 +389,7 @@ environment variable``TEST_TIERS=high,medium``
 
 By default ``TEST_TIERS`` only accepts low, medium and high as valid tiers.  If you would like to use your own keywords to set the environment variable ``TEST_TIERS_ALLOWED``.
 
-For example: to use the keywords dev, rnd, staging and production you can set 
+For example: to use the keywords dev, rnd, staging and production you can set
 ``TEST_TIERS_ALLOWED=dev,rnd,staging,production``. Then you would be able to run tests marked ``tier_dev => true``, ``tier_production => true`` with ``TEST_TIERS=dev,production``
 
 Note, if the ``TEST_TIERS`` environment variable is set to empty string or nil, all tiers will be executed.
@@ -416,34 +416,7 @@ You can enable it, set the following environment variable:s
 
 ``SIMPLECOV=yes``
 
-Remember to add the simplecov-console and codecov gems to your `Gemfile`.
-
-Using Coveralls
----------------
-
-You can also use [Coveralls](https://coveralls.io/) together with SimpleCov:
-
-```Ruby
-# First line of spec/spec_helper.rb
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatters = [
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-
-SimpleCov.start do
-  add_filter '/spec/'
-  # Exclude bundled Gems in `/.vendor/`
-  add_filter '/.vendor/'
-end
-
-require 'puppetlabs_spec_helper/module_spec_helper'
-# Further content
-```
-
-Remember to add `gem 'coveralls', require: false` to your `Gemfile`.
+Remember to add the simplecov-console and codecov gems to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports gets automatically uploaded to https://codecov.io/ .
 
 Some Notes for Windows Users
 ============================

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -142,6 +142,7 @@ namespace :build do
   desc 'Build Puppet module with PDK'
   task :pdk do
     begin
+      require 'pdk/util'
       require 'pdk/module/build'
 
       path = PDK::Module::Build.invoke(:force => true, :'target-dir' => File.join(Dir.pwd, 'pkg'))
@@ -220,7 +221,8 @@ PuppetSyntax.exclude_paths ||= []
 PuppetSyntax.exclude_paths << 'spec/fixtures/**/*'
 PuppetSyntax.exclude_paths << 'pkg/**/*'
 PuppetSyntax.exclude_paths << 'vendor/**/*'
-PuppetSyntax.exclude_paths << 'plans/*'
+PuppetSyntax.exclude_paths << '.vendor/**/*'
+PuppetSyntax.exclude_paths << 'plans/**/*'
 if Puppet.version.to_f < 4.0
   PuppetSyntax.exclude_paths << 'types/**/*'
 end
@@ -367,7 +369,7 @@ if File.exist? locales_dir
     spec = Gem::Specification.find_by_name 'gettext-setup'
     load "#{spec.gem_dir}/lib/tasks/gettext.rake"
     # Initialization requires a valid locales directory
-    GettextSetup.initialize_config(locales_dir)
+    GettextSetup.initialize(locales_dir)
     namespace :module do
       desc 'Runs all tasks to build a modules POT file for internationalization'
       task :pot_gen do
@@ -379,3 +381,79 @@ if File.exist? locales_dir
     puts 'No gettext-setup gem found, skipping GettextSetup config initialization' if Rake.verbose == true
   end
 end
+
+def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_since_tag = nil, changelog_tag_pattern = 'v%s')
+  if Bundler.rubygems.find_name('github_changelog_generator').any?
+    # needed a place to hide these methods
+    # rubocop:disable Lint/NestedMethodDefinition
+    def changelog_user_from_metadata
+      result = JSON.parse(File.read('metadata.json'))['author']
+      raise 'unable to find the changelog_user in .sync.yml, or the author in metadata.json' if result.nil?
+      puts "GitHubChangelogGenerator user:#{result}"
+      result
+    end
+
+    def changelog_project_from_metadata
+      result = JSON.parse(File.read('metadata.json'))['name']
+      raise 'unable to find the changelog_project in .sync.yml or the name in metadata.json' if result.nil?
+      puts "GitHubChangelogGenerator project:#{result}"
+      result
+    end
+
+    def changelog_future_release
+      return unless Rake.application.top_level_tasks.include? 'changelog'
+      result = JSON.parse(File.read('metadata.json'))['version']
+      raise 'unable to find the future_release (version) in metadata.json' if result.nil?
+      puts "GitHubChangelogGenerator future_release:#{result}"
+      result
+    end
+    # rubocop:enable Lint/NestedMethodDefinition
+
+    GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+      if ENV['CHANGELOG_GITHUB_TOKEN'].nil?
+        raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'"
+      end
+      config.user = changelog_user || changelog_user_from_metadata
+      config.project = changelog_project || changelog_project_from_metadata
+      config.since_tag = changelog_since_tag if changelog_since_tag
+      config.future_release = changelog_tag_pattern % changelog_future_release.to_s
+      config.exclude_labels = ['maintenance']
+      config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. " \
+                      'The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres ' \
+                      'to [Semantic Versioning](https://semver.org).'
+      config.add_pr_wo_labels = true
+      config.issues = false
+      config.merge_prefix = '### UNCATEGORIZED PRS; GO LABEL THEM'
+      config.configure_sections = {
+        'Changed' => {
+          'prefix' => '### Changed',
+          'labels' => ['backwards-incompatible'],
+        },
+        'Added' => {
+          'prefix' => '### Added',
+          'labels' => %w[feature enhancement],
+        },
+        'Fixed' => {
+          'prefix' => '### Fixed',
+          'labels' => ['bugfix'],
+        },
+      }
+    end
+  else
+    desc 'Generate a Changelog from GitHub'
+    task :changelog do
+      raise <<EOM
+The changelog tasks depends on unreleased features of the github_changelog_generator gem.
+Please manually add it to your .sync.yml for now, and run `pdk update`:
+---
+Gemfile:
+  optional:
+    ':development':
+      - gem: 'github_changelog_generator'
+        git: 'https://github.com/skywinder/github-changelog-generator'
+        ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
+        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
+EOM
+    end
+  end
+end

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -4,12 +4,14 @@ require 'json'
 
 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
 
+  # @return [String] - the name of current module
   def module_name
     raise ArgumentError unless File.file?('metadata.json') && File.readable?('metadata.json')
 
@@ -23,18 +25,39 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     File.basename(Dir.pwd).split('-').last
   end
 
-  # cache the repositories and return a hash object
+  # @return [Hash] - returns a hash of all the fixture repositories
+  # @example
+  # {"puppetlabs-stdlib"=>{"target"=>"https://gitlab.com/puppetlabs/puppet-stdlib.git",
+  # "ref"=>nil, "branch"=>"master", "scm"=>nil,
+  # }}
   def repositories
-    unless @repositories
-      @repositories = fixtures('repositories')
-    end
-    @repositories
+    @repositories ||= fixtures('repositories') || {}
+  end
+
+  # @return [Hash] - returns a hash of all the fixture forge modules
+  # @example
+  # {"puppetlabs-stdlib"=>{"target"=>"spec/fixtures/modules/stdlib",
+  # "ref"=>nil, "branch"=>nil, "scm"=>nil,
+  # "flags"=>"--module_repository=https://myforge.example.com/", "subdir"=>nil}}
+  def forge_modules
+    @forge_modules ||= fixtures('forge_modules') || {}
+  end
+
+  # @return [Hash] - a hash of symlinks specified in the fixtures file
+  def symlinks
+    @symlinks ||= fixtures('symlinks') || {}
   end
 
+  # @return [Hash] - returns a hash with the module name and the source directory
   def auto_symlink
     { module_name => '#{source_dir}' }
   end
 
+  # @return [Boolean] - true if the os is a windows system
+  def windows?
+    !!File::ALT_SEPARATOR
+  end
+
   def fixtures(category)
     fixtures_yaml = if ENV['FIXTURES_YML']
                       ENV['FIXTURES_YML']
@@ -77,7 +100,6 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
 
     result = {}
     if fixtures.include?(category) && !fixtures[category].nil?
-
       defaults = { 'target' => 'spec/fixtures/modules' }
 
       # load defaults from the `.fixtures.yml` `defaults` section
@@ -103,19 +125,29 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
         real_target = eval('"' + opts['target'] + '"')
         real_source = eval('"' + opts['repo'] + '"')
 
-        result[real_source] = {
+        result[real_source] = validate_fixture_hash!(
           'target' => File.join(real_target, fixture),
-          'ref' => opts['ref'],
+          'ref'    => opts['ref'] || opts['tag'],
           'branch' => opts['branch'],
-          'scm' => opts['scm'],
-          'flags' => opts['flags'],
+          'scm'    => opts['scm'],
+          'flags'  => opts['flags'],
           'subdir' => opts['subdir'],
-        }
+        )
       end
     end
     result
   end
 
+  def validate_fixture_hash!(hash)
+    # Can only validate git based scm
+    return hash unless hash['scm'] == 'git'
+
+    # Forward slashes in the ref aren't allowed. And is probably a branch name.
+    raise ArgumentError, "The ref for #{hash['target']} is invalid (Contains a forward slash). If this is a branch name, please use the 'branch' setting instead." if hash['ref'] =~ %r{\/}
+
+    hash
+  end
+
   def include_repo?(version_range)
     if version_range && defined?(SemanticPuppet)
       puppet_spec = Gem::Specification.find_by_name('puppet')
@@ -235,6 +267,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   # 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
+  # @return [Integer] - current thread count
   def current_thread_count(items)
     active_threads = items.find_all do |_item, opts|
       if opts[:thread]
@@ -247,79 +280,46 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     active_threads.count
   end
 
-  # returns the max_thread_count
-  # because we may want to limit ssh or https connections
+  # @summary Set a limit on the amount threads used, defaults to 10
+  #   MAX_FIXTURE_THREAD_COUNT can be used to set this limit
+  # @return [Integer] - returns the max_thread_count
   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
-      @max_thread_limit = if ENV['MAX_FIXTURE_THREAD_COUNT'].to_i > 0
-                            ENV['MAX_FIXTURE_THREAD_COUNT'].to_i
-                          else
-                            10 # the default
-                          end
-    end
-    @max_thread_limit
+    @max_thread_limit ||= (ENV['MAX_FIXTURE_THREAD_COUNT'] || 10).to_i
   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
-        if valid_repo?(scm, target, remote)
-          update_repo(scm, target)
-        else
-          clone_repo(scm, remote, target, subdir, ref, branch, flags)
+  # @param items [Hash] - a hash of either repositories or forge modules
+  # @param [Block] - the method you wish to use to download the item
+  def download_items(items)
+    items.each do |remote, opts|
+      # get the current active threads that are alive
+      count = current_thread_count(items)
+      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
+          yield(remote, opts)
         end
-        revision(scm, target, ref) if ref
-        remove_subdirectory(target, subdir) if subdir
+      else
+        # the last thread started should be the longest wait
+        item, item_opts = items.find_all { |_i, o| o.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
-    else
-      # the last thread started should be the longest wait
-      item, item_opts = repositories.find_all { |_i, o| o.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
+    # wait for all the threads to finish
+    items.each { |_remote, opts| opts[:thread].join }
   end
 
-  # wait for all the threads to finish
-  repositories.each { |_remote, opts| opts[:thread].join }
-
-  fixtures('symlinks').each do |target, link|
+  # @param target [String] - the target directory
+  # @param link [String] - the name of the link you wish to create
+  # works on windows and linux
+  def setup_symlink(target, link)
     link = link['target']
-    next if File.symlink?(link)
+    return if File.symlink?(link)
     logger.info("Creating symlink from #{link} to #{target}")
-    if is_windows
+    if windows?
       target = File.join(File.dirname(link), target) unless Pathname.new(target).absolute?
       if Dir.respond_to?(:create_junction)
         Dir.create_junction(link, target)
@@ -331,7 +331,35 @@ task :spec_prep do
     end
   end
 
-  fixtures('forge_modules').each do |remote, opts|
+  # @return [Boolean] - returns true if the module was downloaded successfully, false otherwise
+  # @param [String] - the remote url or namespace/name of the module to download
+  # @param [Hash] - list of options such as version, branch, ref
+  def download_repository(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']
+    if valid_repo?(scm, target, remote)
+      update_repo(scm, target)
+    else
+      clone_repo(scm, remote, target, subdir, ref, branch, flags)
+    end
+    revision(scm, target, ref) if ref
+    remove_subdirectory(target, subdir) if subdir
+  end
+
+  # @return [String] - the spec/fixtures/modules directory in the module root folder
+  def module_target_dir
+    @module_target_dir ||= File.expand_path('spec/fixtures/modules')
+  end
+
+  # @return [Boolean] - returns true if the module was downloaded successfully, false otherwise
+  # @param [String] - the remote url or namespace/name of the module to download
+  # @param [Hash] - list of options such as version
+  def download_module(remote, opts)
     ref = ''
     flags = ''
     if opts.instance_of?(String)
@@ -342,34 +370,60 @@ task :spec_prep do
       flags = " #{opts['flags']}" if opts['flags']
     end
 
-    next if File.directory?(target)
+    return false if File.directory?(target)
 
-    working_dir = module_working_directory
-    target_dir = File.expand_path('spec/fixtures/modules')
+    # The PMT cannot handle multi threaded runs due to cache directory collisons
+    # so we randomize the directory instead.
+    # Does working_dir even need to be passed?
+    Dir.mktmpdir do |working_dir|
+      command = 'puppet module install' + ref + flags + ' --ignore-dependencies' \
+      ' --force' \
+      " --module_working_dir \"#{working_dir}\"" \
+      " --target-dir \"#{module_target_dir}\" \"#{remote}\""
+
+      unless system(command)
+        raise "Failed to install module #{remote} to #{module_target_dir}"
+      end
+    end
+    $CHILD_STATUS.success?
+  end
+end
 
-    command = 'puppet module install' + ref + flags + \
-              ' --ignore-dependencies' \
-              ' --force' \
-              " --module_working_dir \"#{working_dir}\"" \
-              " --target-dir \"#{target_dir}\" \"#{remote}\""
+include PuppetlabsSpecHelper::Tasks::FixtureHelpers
 
-    unless system(command)
-      raise "Failed to install module #{remote} to #{target_dir}"
+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
+  if 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')
+
+  symlinks.each { |target, link| setup_symlink(target, link) }
+
+  download_items(repositories) { |remote, opts| download_repository(remote, opts) }
+
+  download_items(forge_modules) { |remote, opts| download_module(remote, opts) }
+
   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|
+  repositories.each do |_remote, opts|
     target = opts['target']
     FileUtils.rm_rf(target)
   end
 
-  fixtures('forge_modules').each do |_remote, opts|
+  forge_modules.each do |_remote, opts|
     target = opts['target']
     FileUtils.rm_rf(target)
   end

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,5 @@
 module PuppetlabsSpecHelper
-  VERSION = '2.14.1'.freeze
+  VERSION = '2.15.0'.freeze
 
   # compat for pre-1.2.0 users; deprecated
   module Version

data/puppetlabs_spec_helper.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'mocha', '~> 1.0'
   spec.add_runtime_dependency 'puppet-lint', '~> 2.0'
-  spec.add_runtime_dependency 'puppet-syntax', '~> 2.0'
+  spec.add_runtime_dependency 'puppet-syntax', ['>= 2.0', '< 4']
   spec.add_runtime_dependency 'rspec-puppet', '~> 2.0'
   spec.add_runtime_dependency 'pathspec', '~> 0.2.1'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'puppet'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', ['>= 10.0', '< 14']
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'gettext-setup', '~> 0.29'
-  spec.add_development_dependency 'fakefs', '~> 0.13.3'
+  spec.add_development_dependency 'fakefs', ['>= 0.13.3', '< 2']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.14.1
+  version: 2.15.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -43,16 +43,22 @@ dependencies:
   name: puppet-syntax
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec-puppet
   requirement: !ruby/object:Gem::Requirement
@@ -127,16 +133,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -183,16 +195,22 @@ dependencies:
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: Contains rake tasks and a standard spec_helper for running spec tests
   on puppet modules.
 email:
@@ -208,6 +226,7 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
@@ -249,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Standard tasks and configuration for module spec tests.