puppetlabs_spec_helper 2.6.2 → 4.0.1

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.
@@ -79,8 +79,7 @@ And then to run spec tests in parallel:
 Issues
 ======
 
-Please file issues against this project at the [Puppet Labs Issue
-Tracker](https://tickets.puppetlabs.com/browse/MODULES)
+Please file issues against this project at the [Puppet Labs Issue Tracker](https://tickets.puppetlabs.com/browse/MODULES)
 
 The Long Version
 ----------------
@@ -103,10 +102,10 @@ This project is intended to serve two purposes:
 To Use this Project
 ===================
 
-The most common usage scenario is that you will check out the 'master'
+The most common usage scenario is that you will check out the 'main'
 branch of this project from github, and install it as a rubygem.
 There should be few or no cases where you would want to have any other
-branch of this project besides master/HEAD.
+branch of this project besides main/HEAD.
 
 Running on non-current ruby versions
 ------------------------------------
@@ -142,9 +141,6 @@ A number of the Puppet parser features, controlled via configuration during a
 normal puppet run, can be controlled by exporting specific environment
 variables for the spec run. These are:
 
-* ``FUTURE_PARSER`` - set to "yes" to enable the [future parser](http://docs.puppetlabs.com/puppet/latest/reference/experiments_future.html),
-  the equivalent of setting [parser=future](http://docs.puppetlabs.com/references/latest/configuration.html#parser)
-  in puppet.conf.
 * ``STRICT_VARIABLES`` - set to "yes" to enable set to strict variable checking when using Puppet versions between 3.5 and 4.0;
   set to "no" to disable strict variable checking on Puppet versions 4.0, and later.
   See [strict_variables](http://docs.puppetlabs.com/references/latest/configuration.html#strictvariables)
@@ -153,14 +149,18 @@ variables for the spec run. These are:
   to set the order of unrelated resources when applying a catalog. Leave unset for the default
   behavior, currently "random". This is equivalent to setting [ordering](http://docs.puppetlabs.com/references/latest/configuration.html#ordering)
   in puppet.conf.
-* ``STRINGIFY_FACTS`` - 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](http://docs.puppetlabs.com/references/latest/configuration.html#stringifyfacts)
-  in puppet.conf.
-* ``TRUSTED_NODE_DATA`` - set to "yes" to enable [the $facts hash and trusted node data](http://docs.puppetlabs.com/puppet/latest/reference/lang_facts_and_builtin_vars.html),
-  which enabled ``$facts`` and ``$trusted`` hashes. This is equivalent to setting
-  [trusted_node_data=true](http://docs.puppetlabs.com/references/latest/configuration.html#trustednodedata)
-  in puppet.conf.
+* The following options only affect Puppet 3.x:
+  * ``FUTURE_PARSER`` _(Puppet 3.x, starting with 3.2)_ - set to "yes" to enable the [future parser](https://docs.puppet.com/puppet/3/experiments_future.html),
+    the equivalent of setting [parser=future](https://puppet.com/docs/puppet/3.8/configuration.html#parser)
+    in puppet.conf.
+  * ``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.
+  * ``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)
+    in puppet.conf.
 
 As an example, to run spec tests with the future parser, strict variable checking,
 and manifest ordering, you would:
@@ -191,32 +191,40 @@ file named `.fixtures.yml` in the root of the project. You can specify a alterna
 You can use the `MODULE_WORKING_DIR` environment variable to specify a diffent location when installing module fixtures via the forge. By default the
 working directory is `<module directory>/spec/fixtures/work-dir`.
 
-When specifying the repo source of the fixture you have a few options as to which revision of the codebase you wish to use.
+When specifying the repo source of the fixture you have a few options as to which revision of the codebase you wish to use, and optionally, the puppet versions where the fixture is needed.
 
- * repo - the url to the repo
- * scm - options include git or hg. This is an optional step as the helper code will figure out which scm is used.
+ * `repo` - the url to the repo
+ * `scm` - options include git or hg. This is an optional step as the helper code will figure out which scm is used.
 
    ```yaml
    scm: git
    scm: hg
    ```
 
- * 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)
+ * `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) or commit hash to be checked out (Optional). Branch names should use the `branch` option instead.
 
    ```yaml
    ref: 1.0.0
    ref: 880fca52c
    ```
- * branch - used to specify the branch name you want to use ie. `branch: development`
- * flags - additional flags passed to the module installer (both puppet and scm)
+ * `branch` - used to specify the branch name you want to use ie. `branch: development`
+ * `flags` - additional flags passed to the module installer (both puppet and scm)
 
    ```yaml
    flags: --verbose
    ```
+ * `puppet_version` - versions of puppet for which the fixture should be installed. Ruby version constraints are supported. Only works when the `semantic_puppet` gem is available (shipped with puppet 4.0 and up, by default).
+
+   ```yaml
+   puppet_version: '>= 6.0.0'
+   ```
+
+ **Notes:**
 
- **Note:** ref and branch can be used together to get a specific revision on a specific branch
+ * `ref` and `branch` can be used together to get a specific revision on a specific branch
+ * Top level `defaults` option could be used to set global options
 
 Fixtures Examples
 -----------------
@@ -252,7 +260,7 @@ fixtures:
       target: "spec/fixtures/control_repos"
 ```
 
-Specify that the git tag `2.4.2` of `stdlib' should be checked out:
+Specify that the git tag `2.4.2` of `stdlib` should be checked out:
 
 ```yaml
 fixtures:
@@ -263,6 +271,16 @@ fixtures:
       ref: "2.6.0"
 ```
 
+Only install the `yumrepo_core` module when testing against Puppet 6 or greater:
+
+```yaml
+fixtures:
+  repositories:
+    yumrepo_core:
+      repo: "git://github.com/puppetlabs/puppetlabs-yumrepo_core"
+      puppet_version: ">= 6.0.0"
+```
+
 Move manifests and siblings to root directory when they are inside a `code` directory:
 
 ```yaml
@@ -300,6 +318,27 @@ fixtures:
         flags: "--verbose"
 ```
 
+Use `defaults` to define global parameters:
+
+```yaml
+defaults:
+  forge_modules:
+    flags: "--module_repository https://my_repo.com"
+fixtures:
+  forge_modules:
+    stdlib:
+      repo: "puppetlabs/stdlib"
+      ref: "2.6.0"
+    repositories:
+      firewall:
+        repo: "git://github.com/puppetlabs/puppetlabs-firewall"
+        ref: "2.6.0"
+```
+
+Fixture Loading
+---------------
+Any module that has a `spec/lib` directory will be available on the ruby `LOAD_PATH` for tests to consume. This allows modules to provide additional helper code to be supplied. The [augeasprovider_core](https://github.com/hercules-team/augeasproviders_core) module has [some examples](https://github.com/hercules-team/augeasproviders_core/tree/master/spec/lib).
+
 Testing Parser Functions
 ========================
 
@@ -345,14 +384,18 @@ 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 
-the appropriate tiers.
+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``
-  
+
+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
+``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.
 
 
@@ -364,80 +407,20 @@ See the documentation of [RSpec-Puppet](https://github.com/rodjek/rspec-puppet)
 for Puppet manifest coverage reports.
 
 Starting with Ruby 1.9, the *de facto* standard for Ruby code coverage is
-[SimpleCov](https://github.com/colszowka/simplecov).
-You can add it to your module like this:
-
-```Ruby
-# First line of spec/spec_helper.rb
-require 'simplecov'
-
-SimpleCov.start do
-  add_filter '/spec/'
-  # Exclude bundled Gems in `/.vendor/`
-  add_filter '/.vendor/'
-end
-
-require 'puppetlabs_spec_helper/module_spec_helper'
-# Further content
-```
+[SimpleCov](https://github.com/colszowka/simplecov). It is implemented as a Rake task in this gem.
 
-The reports will then be generated every time you invoke RSpec, e.g. via `rake spec`,
-and are written to `/coverage/`, which you should add to `.gitignore`.
+To run code coverage:
 
-Remember to add `gem 'simplecov', require: false` to your `Gemfile`.
+    $ rake spec:simplecov
 
-Using Code Climate
-------------------
+Reports are written to `/coverage/`, which you should add to `.gitignore`.
 
-You can also use [Code Climate](https://codeclimate.com/) together with SimpleCov:
+The reports can be generated every time you invoke RSpec, e.g. via `rake spec`,
+You can enable it, set the following environment variable:s
 
-```Ruby
-# First line of spec/spec_helper.rb
-require 'codeclimate-test-reporter'
+``SIMPLECOV=yes``
 
-SimpleCov.formatters = [
-  SimpleCov::Formatter::HTMLFormatter,
-  CodeClimate::TestReporter::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 'codeclimate-test-reporter', require: false` 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
 ============================
@@ -451,7 +434,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 +446,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). We recommend that you choose rspec-mocks explicitly 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 Puppet Development Kit'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_return('value')
+```
+
+Translate all expectations:
+```
+context.expects(:some_method).with(arguments).returns('value')
+```
+to this:
+```
+expect(context).to receive(:some_method).with(arguments).and_return('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/Rakefile

@@ -1,15 +1,45 @@
-# encoding: utf-8
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+def gem_present(name)
+  !Bundler.rubygems.find_name(name).empty?
+end
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb'].exclude('spec/fixtures/**/*_spec.rb')
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
 require 'yard'
 YARD::Rake::YardocTask.new
+
+default_tasks = [:spec]
+
+if gem_present 'rubocop'
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  default_tasks.unshift(:rubocop)
+end
+
+task default: default_tasks
+
+#### CHANGELOG ####
+begin
+  require 'github_changelog_generator/task'
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    require 'puppetlabs_spec_helper/version'
+    config.since_tag = 'v2.8.0'
+    config.future_release = "v#{PuppetlabsSpecHelper::VERSION}"
+    config.header = "# Changelog\n\n" \
+      "All significant changes to this repo will be summarized in this file.\n"
+    # config.include_labels = %w[enhancement bug]
+    config.user = 'puppetlabs'
+    config.project = 'puppetlabs_spec_helper'
+  end
+rescue LoadError
+  desc 'Install github_changelog_generator to get access to automatic changelog generation'
+  task :changelog do
+    raise 'Install github_changelog_generator to get access to automatic changelog generation'
+  end
+end

data/lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec-puppet'
 require 'puppetlabs_spec_helper/puppet_spec_helper'
 require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
@@ -18,6 +20,46 @@ env_module_path = ENV['MODULEPATH']
 module_path = File.join(fixture_path, 'modules')
 
 module_path = [module_path, env_module_path].join(File::PATH_SEPARATOR) if env_module_path
+if ENV['SIMPLECOV'] == 'yes'
+  begin
+    require 'simplecov'
+    require 'simplecov-console'
+    require 'codecov'
+
+    SimpleCov.formatters = [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console,
+      SimpleCov::Formatter::Codecov,
+    ]
+    SimpleCov.start do
+      track_files 'lib/**/*.rb'
+      add_filter '/spec'
+
+      # do not track vendored files
+      add_filter '/vendor'
+      add_filter '/.vendor'
+
+      # do not track gitignored files
+      # this adds about 4 seconds to the coverage check
+      # this could definitely be optimized
+      add_filter do |f|
+        # system returns true if exit status is 0, which with git-check-ignore means file is ignored
+        system("git check-ignore --quiet #{f.filename}")
+      end
+    end
+  rescue LoadError
+    raise 'Add the simplecov, simplecov-console, codecov gems to Gemfile to enable this task'
+  end
+end
+
+# Add all spec lib dirs to LOAD_PATH
+components = module_path.split(File::PATH_SEPARATOR).collect do |dir|
+  next unless Dir.exist? dir
+  Dir.entries(dir).reject { |f| f =~ %r{^\.} }.collect { |f| File.join(dir, f, 'spec', 'lib') }
+end
+components.flatten.each do |d|
+  $LOAD_PATH << d if FileTest.directory?(d) && !$LOAD_PATH.include?(d)
+end
 
 RSpec.configure do |c|
   c.environmentpath = spec_path if Puppet.version.to_f >= 4.0
@@ -26,7 +68,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

@@ -1,14 +1,25 @@
+# frozen_string_literal: true
+
 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'
@@ -36,7 +47,7 @@ require 'puppetlabs_spec_helper/puppetlabs_spec/files'
 # to compatibility mode for older versions of puppet.
 begin
   require 'puppet/test/test_helper'
-rescue LoadError => err
+rescue LoadError
 end
 
 # This is just a utility class to allow us to isolate the various version-specific
@@ -49,7 +60,7 @@ module Puppet
     # Puppet's Settings singleton object, and other fun implementation details
     # that code external to puppet should really never know about.
     def self.initialize_via_fallback_compatibility(config)
-      $stderr.puts("Warning: you appear to be using an older version of puppet; spec_helper will use fallback compatibility mode.")
+      warn('Warning: you appear to be using an older version of puppet; spec_helper will use fallback compatibility mode.')
       config.before :all do
         # nothing to do for now
       end
@@ -70,11 +81,11 @@ module Puppet
 
         # Set the confdir and vardir to gibberish so that tests
         # have to be correctly mocked.
-        Puppet[:confdir] = "/dev/null"
-        Puppet[:vardir] = "/dev/null"
+        Puppet[:confdir] = '/dev/null'
+        Puppet[:vardir] = '/dev/null'
 
         # Avoid opening ports to the outside world
-        Puppet.settings[:bindaddress] = "127.0.0.1"
+        Puppet.settings[:bindaddress] = '127.0.0.1'
       end
 
       config.after :each do
@@ -82,7 +93,7 @@ module Puppet
 
         Puppet::Node::Environment.clear
         Puppet::Util::Storage.clear
-        Puppet::Util::ExecutionStub.reset if Puppet::Util.constants.include? "ExecutionStub"
+        Puppet::Util::ExecutionStub.reset if Puppet::Util.constants.include? 'ExecutionStub'
 
         PuppetlabsSpec::Files.cleanup
       end
@@ -91,7 +102,7 @@ module Puppet
 end
 
 # JJM Hack to make the stdlib tests run in Puppet 2.6 (See puppet commit cf183534)
-if not Puppet.constants.include? "Test" then
+unless Puppet.constants.include? 'Test'
   module Puppet::Test
     class LogCollector
       def initialize(logs)
@@ -104,7 +115,7 @@ if not Puppet.constants.include? "Test" then
     end
   end
   Puppet::Util::Log.newdesttype :log_collector do
-    match "Puppet::Test::LogCollector"
+    match 'Puppet::Test::LogCollector'
 
     def initialize(messages)
       @messages = messages
@@ -118,11 +129,17 @@ 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))
+  if defined?(Puppet::Test::TestHelper)
     # This case is handled by rspec-puppet since v1.0.0 (via 41257b33cb1f9ade4426b044f70be511b0c89112)
   else
     Puppet::PuppetSpecInitializer.initialize_via_fallback_compatibility(config)
@@ -158,5 +175,4 @@ RSpec.configure do |config|
     Puppet::Util::Log.close_all
     Puppet::Util::Log.level = @log_level
   end
-
 end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'tempfile'
 require 'pathname'
@@ -18,11 +20,11 @@ module PuppetlabsSpec::Files
 
   def self.cleanup
     $global_tempfiles ||= []
-    while path = $global_tempfiles.pop do
-      fail "Not deleting tmpfile #{path} outside regular tmpdir" unless in_tmp(path)
+    while path = $global_tempfiles.pop
+      raise "Not deleting tmpfile #{path} outside regular tmpdir" unless in_tmp(path)
 
       begin
-        FileUtils.rm_r path, :secure => true
+        FileUtils.rm_r path, secure: true
       rescue Errno::ENOENT
         # nothing to do
       end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/fixtures.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 # This module provides some helper methods to assist with fixtures. It's
 # methods are designed to help when you have a conforming fixture layout so we
 # get project consistency.
 module PuppetlabsSpec::Fixtures
-
   # Returns the joined path of the global FIXTURE_DIR plus any path given to it
   def fixtures(*rest)
     File.join(PuppetlabsSpec::FIXTURE_DIR, *rest)
@@ -13,21 +14,23 @@ module PuppetlabsSpec::Fixtures
   # <project>/spec/fixture/unit/facter/foo
   def my_fixture_dir
     callers = caller
-    while line = callers.shift do
+    while line = callers.shift
       next unless found = line.match(%r{/spec/(.*)_spec\.rb:})
+
       return fixtures(found[1])
     end
-    fail "sorry, I couldn't work out your path from the caller stack!"
+    raise "sorry, I couldn't work out your path from the caller stack!"
   end
 
   # Given a name, returns the full path of a file from your relative fixture
   # dir as returned by my_fixture_dir.
   def my_fixture(name)
     file = File.join(my_fixture_dir, name)
-    unless File.readable? file then
-      fail "fixture '#{name}' for #{my_fixture_dir} is not readable"
+    unless File.readable? file
+      raise "fixture '#{name}' for #{my_fixture_dir} is not readable"
     end
-    return file
+
+    file
   end
 
   # Return the contents of the file using read when given a name. Uses
@@ -38,12 +41,13 @@ module PuppetlabsSpec::Fixtures
 
   # Provides a block mechanism for iterating across the files in your fixture
   # area.
-  def my_fixtures(glob = '*', flags = 0)
+  def my_fixtures(glob = '*', flags = 0, &block)
     files = Dir.glob(File.join(my_fixture_dir, glob), flags)
-    unless files.length > 0 then
-      fail "fixture '#{glob}' for #{my_fixture_dir} had no files!"
+    if files.empty?
+      raise "fixture '#{glob}' for #{my_fixture_dir} had no files!"
     end
-    block_given? and files.each do |file| yield file end
+
+    block_given? && files.each(&block)
     files
   end
 end