puppetlabs_spec_helper 2.8.0 → 2.9.0

data/lib/puppetlabs_spec_helper/puppet_spec_helper.rb

@@ -13,7 +13,7 @@ require 'rspec/expectations'
 # 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'
+  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'
@@ -58,7 +58,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.")
+      $stderr.puts('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
@@ -79,11 +79,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
@@ -91,7 +91,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
@@ -100,7 +100,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)
@@ -113,7 +113,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
@@ -137,7 +137,7 @@ RSpec.configure do |config|
   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)
@@ -173,5 +173,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

@@ -18,11 +18,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

@@ -2,7 +2,6 @@
 # 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 +12,21 @@ 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
@@ -40,10 +39,10 @@ module PuppetlabsSpec::Fixtures
   # area.
   def my_fixtures(glob = '*', flags = 0)
     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 { |file| yield file }
     files
   end
 end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/matchers.rb

@@ -7,17 +7,16 @@ module RSpec
   module Matchers
     module BlockAliases
       if method_defined? :should
-        alias_method :to, :should unless method_defined? :to
+        alias to should unless method_defined? :to
       end
       if method_defined? :should_not
-        alias_method :to_not, :should_not unless method_defined? :to_not
-        alias_method :not_to, :should_not unless method_defined? :not_to
+        alias to_not should_not unless method_defined? :to_not
+        alias not_to should_not unless method_defined? :not_to
       end
     end
   end
 end
 
-
 ########################################################################
 # Custom matchers...
 RSpec::Matchers.define :have_matching_element do |expected|
@@ -26,7 +25,6 @@ RSpec::Matchers.define :have_matching_element do |expected|
   end
 end
 
-
 RSpec::Matchers.define :exit_with do |expected|
   actual = nil
   match do |block|
@@ -35,13 +33,13 @@ RSpec::Matchers.define :exit_with do |expected|
     rescue SystemExit => e
       actual = e.status
     end
-    actual and actual == expected
+    actual && actual == expected
   end
-  failure_message_for_should do |block|
+  failure_message_for_should do |_block|
     "expected exit with code #{expected} but " +
-      (actual.nil? ? " exit was not called" : "we exited with #{actual} instead")
+      (actual.nil? ? ' exit was not called' : "we exited with #{actual} instead")
   end
-  failure_message_for_should_not do |block|
+  failure_message_for_should_not do |_block|
     "expected that exit would not be called with #{expected}"
   end
   description do
@@ -49,7 +47,6 @@ RSpec::Matchers.define :exit_with do |expected|
   end
 end
 
-
 RSpec::Matchers.define :have_printed do |expected|
   match do |block|
     $stderr = $stdout = StringIO.new
@@ -64,7 +61,7 @@ RSpec::Matchers.define :have_printed do |expected|
       $stderr = STDERR
     end
 
-    if @actual then
+    if @actual
       case expected
       when String
         @actual.include? expected
@@ -77,7 +74,7 @@ RSpec::Matchers.define :have_printed do |expected|
   end
 
   failure_message_for_should do |actual|
-    if actual.nil? then
+    if actual.nil?
       "expected #{expected.inspect}, but nothing was printed"
     else
       "expected #{expected.inspect} to be printed; got:\n#{actual}"

data/lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -8,9 +8,9 @@ module PuppetlabsSpec
     # instance suitable for placing in a test harness with the intent of
     # testing parser functions from modules.
     def scope(parts = {})
-      RSpec.deprecate('scope', :replacement => 'rspec-puppet 2.2.0 provides a scope property')
+      RSpec.deprecate('scope', replacement: 'rspec-puppet 2.2.0 provides a scope property')
 
-      if Puppet.version =~ /^2\.[67]/
+      if Puppet.version =~ %r{^2\.[67]}
         # loadall should only be necessary prior to 3.x
         # Please note, loadall needs to happen first when creating a scope, otherwise
         # you might receive undefined method `function_*' errors
@@ -19,15 +19,15 @@ module PuppetlabsSpec
 
       scope_compiler = parts[:compiler] || compiler
       scope_parent = parts[:parent] || scope_compiler.topscope
-      scope_resource = parts[:resource] || resource(:type => :node, :title => scope_compiler.node.name)
+      scope_resource = parts[:resource] || resource(type: :node, title: scope_compiler.node.name)
 
-      if Puppet.version =~ /^2\.[67]/
-        scope = Puppet::Parser::Scope.new(:compiler => scope_compiler)
-      else
-        scope = Puppet::Parser::Scope.new(scope_compiler)
-      end
+      scope = if Puppet.version =~ %r{^2\.[67]}
+                Puppet::Parser::Scope.new(compiler: scope_compiler)
+              else
+                Puppet::Parser::Scope.new(scope_compiler)
+              end
 
-      scope.source = Puppet::Resource::Type.new(:node, "foo")
+      scope.source = Puppet::Resource::Type.new(:node, 'foo')
       scope.parent = scope_parent
       scope
     end
@@ -35,13 +35,13 @@ module PuppetlabsSpec
 
     def resource(parts = {})
       resource_type = parts[:type] || :hostclass
-      resource_name = parts[:name] || "testing"
+      resource_name = parts[:name] || 'testing'
       Puppet::Resource::Type.new(resource_type, resource_name)
     end
     module_function :resource
 
     def compiler(parts = {})
-      compiler_node = parts[:node] || node()
+      compiler_node = parts[:node] || node
       Puppet::Parser::Compiler.new(compiler_node)
     end
     module_function :compiler
@@ -49,12 +49,12 @@ module PuppetlabsSpec
     def node(parts = {})
       node_name = parts[:name] || 'testinghost'
       options = parts[:options] || {}
-      if Puppet.version.to_f >= 4.0
-        node_environment = Puppet::Node::Environment.create(parts[:environment] || 'test', [])
-      else
-        node_environment = Puppet::Node::Environment.new(parts[:environment] || 'test')
-      end
-      options.merge!({:environment => node_environment})
+      node_environment = if Puppet.version.to_f >= 4.0
+                           Puppet::Node::Environment.create(parts[:environment] || 'test', [])
+                         else
+                           Puppet::Node::Environment.new(parts[:environment] || 'test')
+                         end
+      options[:environment] = node_environment
       Puppet::Node.new(node_name, options)
     end
     module_function :node

data/lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb

@@ -3,7 +3,7 @@ module PuppetlabsSpec
   # FIXTURE_DIR represents the standard locations of all fixture data. Normally
   # this represents <project>/spec/fixtures. This will be used by the fixtures
   # library to find relative fixture data.
-  FIXTURE_DIR = File.join("spec", "fixtures") unless defined?(FIXTURE_DIR)
+  FIXTURE_DIR = File.join('spec', 'fixtures') unless defined?(FIXTURE_DIR)
 end
 
 # Require all necessary helper libraries so they can be used later

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -22,7 +22,7 @@ rescue LoadError
   # ignore
 end
 
-task :default => [:help]
+task default: [:help]
 
 pattern = 'spec/{aliases,classes,defines,unit,functions,hosts,integration,plans,type_aliases,types}/**/*_spec.rb'
 
@@ -38,25 +38,25 @@ RSpec::Core::RakeTask.new(:spec_standalone) do |t, args|
     t.pattern = if args.extras.nil? || args.extras.empty?
                   files.each_slice(per_node).to_a[ci_index - 1] || files.first
                 else
-                  args.extras.join(",")
+                  args.extras.join(',')
                 end
   else
-    if args.extras.nil? || args.extras.empty?
-      t.pattern = pattern
-    else
-      t.pattern = args.extras.join(",")
-    end
+    t.pattern = if args.extras.nil? || args.extras.empty?
+                  pattern
+                else
+                  args.extras.join(',')
+                end
   end
 end
 
-desc "List spec tests in a JSON document"
+desc 'List spec tests in a JSON document'
 RSpec::Core::RakeTask.new(:spec_list_json) do |t|
   t.rspec_opts = ['--dry-run', '--format', 'json']
   t.pattern = pattern
 end
 
-desc "Run spec tests and clean the fixtures directory if successful"
-task :spec do |t, args|
+desc 'Run spec tests and clean the fixtures directory if successful'
+task :spec do |_t, args|
   begin
     Rake::Task[:spec_prep].invoke
     Rake::Task[:spec_standalone].invoke(*args.extras)
@@ -66,8 +66,16 @@ task :spec do |t, args|
   end
 end
 
-desc "Run spec tests in parallel and clean the fixtures directory if successful"
-task :parallel_spec do |t, args|
+desc 'Run spec tests with ruby simplecov code coverage'
+namespace :spec do
+  task :simplecov do
+    ENV['SIMPLECOV'] = 'yes'
+    Rake::Task['spec'].execute
+  end
+end
+
+desc 'Run spec tests in parallel and clean the fixtures directory if successful'
+task :parallel_spec do |_t, args|
   begin
     Rake::Task[:spec_prep].invoke
     Rake::Task[:parallel_spec_standalone].invoke(*args.extras)
@@ -77,11 +85,11 @@ task :parallel_spec do |t, args|
   end
 end
 
-desc "Parallel spec tests"
-task :parallel_spec_standalone do |t, args|
+desc 'Parallel spec tests'
+task :parallel_spec_standalone do |_t, args|
   raise 'Add the parallel_tests gem to Gemfile to enable this task' unless parallel_tests_loaded
   if Rake::FileList[pattern].to_a.empty?
-    warn "No files for parallel_spec to run against"
+    warn 'No files for parallel_spec to run against'
   else
     begin
       args = ['-t', 'rspec']
@@ -93,7 +101,7 @@ task :parallel_spec_standalone do |t, args|
   end
 end
 
-desc "Build puppet module package"
+desc 'Build puppet module package'
 task :build do
   # This will be deprecated once puppet-module is a face.
   begin
@@ -105,9 +113,9 @@ task :build do
   end
 end
 
-desc "Clean a built module package"
+desc 'Clean a built module package'
 task :clean do
-  FileUtils.rm_rf("pkg/")
+  FileUtils.rm_rf('pkg/')
 end
 
 require 'puppet-lint/tasks/puppet-lint'
@@ -118,34 +126,35 @@ Rake::Task[:lint].clear
 PuppetLint.configuration.relative = true
 PuppetLint::RakeTask.new(:lint) do |config|
   config.fail_on_warnings = true
-  config.disable_checks = [
-    '80chars',
-    '140chars',
-    'class_inherits_from_params_class',
-    'class_parameter_defaults',
-    'documentation',
-    'single_quote_string_with_variables']
+  config.disable_checks = %w[
+    80chars
+    140chars
+    class_inherits_from_params_class
+    class_parameter_defaults
+    documentation
+    single_quote_string_with_variables
+  ]
   config.ignore_paths = [
-    "bundle/**/*.pp",
-    "pkg/**/*.pp",
-    "spec/**/*.pp",
-    "tests/**/*.pp",
-    "types/**/*.pp",
-    "vendor/**/*.pp",
+    'bundle/**/*.pp',
+    'pkg/**/*.pp',
+    'spec/**/*.pp',
+    'tests/**/*.pp',
+    'types/**/*.pp',
+    'vendor/**/*.pp',
   ]
 end
 
 require 'puppet-syntax/tasks/puppet-syntax'
 PuppetSyntax.exclude_paths ||= []
-PuppetSyntax.exclude_paths << "spec/fixtures/**/*"
-PuppetSyntax.exclude_paths << "pkg/**/*"
-PuppetSyntax.exclude_paths << "vendor/**/*"
+PuppetSyntax.exclude_paths << 'spec/fixtures/**/*'
+PuppetSyntax.exclude_paths << 'pkg/**/*'
+PuppetSyntax.exclude_paths << 'vendor/**/*'
 if Puppet.version.to_f < 4.0
-  PuppetSyntax.exclude_paths << "types/**/*"
+  PuppetSyntax.exclude_paths << 'types/**/*'
 end
 PuppetSyntax.future_parser = true if ENV['FUTURE_PARSER'] == 'yes'
 
-desc "Check syntax of Ruby files and call :syntax and :metadata_lint"
+desc 'Check syntax of Ruby files and call :syntax and :metadata_lint'
 task :validate do
   Dir['lib/**/*.rb'].each do |lib_file|
     sh "ruby -c #{lib_file}"
@@ -156,7 +165,7 @@ task :validate do
     if Rake::Task.task_defined?(:metadata_lint)
       Rake::Task[:metadata_lint].invoke
     else
-      warn "Skipping metadata validation; the metadata-json-lint gem was not found"
+      warn 'Skipping metadata validation; the metadata-json-lint gem was not found'
     end
   end
 end
@@ -166,23 +175,23 @@ task :metadata do
   if Rake::Task.task_defined?(:metadata_lint)
     Rake::Task[:metadata_lint].invoke
   else
-    warn "Skipping metadata validation; the metadata-json-lint gem was not found"
+    warn 'Skipping metadata validation; the metadata-json-lint gem was not found'
   end
 end
 
-desc "Print development version of module"
+desc 'Print development version of module'
 task :compute_dev_version do
   version = ''
-  if File.exists?( 'metadata.json' )
+  if File.exist?('metadata.json')
     require 'json'
 
-    modinfo = JSON.parse(File.read( 'metadata.json' ))
+    modinfo = JSON.parse(File.read('metadata.json'))
     version = modinfo['version']
-  elsif File.exists?( 'Modulefile' )
+  elsif File.exist?('Modulefile')
     modfile = File.read('Modulefile')
-    version = modfile.match(/\nversion[ ]+['"](.*)['"]/)[1]
+    version = modfile.match(%r{\nversion[ ]+['"](.*)['"]})[1]
   else
-    fail "Could not find a metadata.json or Modulefile! Cannot compute dev version without one or the other!"
+    raise 'Could not find a metadata.json or Modulefile! Cannot compute dev version without one or the other!'
   end
 
   sha = `git rev-parse HEAD`[0..7]
@@ -192,20 +201,20 @@ task :compute_dev_version do
   # If the branch is a release branch we append an 'r' into the new_version,
   # this is due to the release branch buildID conflicting with master branch when trying to push to the staging forge.
   # More info can be found at https://tickets.puppetlabs.com/browse/FM-6170
-  if build = ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER']
-    if branch.eql? "release"
-      new_version = sprintf('%s-%s%04d-%s', version, "r", build, sha)
-    else
-      new_version = sprintf('%s-%04d-%s', version, build, sha)
-    end
-  else
-    new_version = "#{version}-#{sha}"
-  end
+  new_version = if build = ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER']
+                  if branch.eql? 'release'
+                    '%s-%s%04d-%s' % [version, 'r', build, sha]
+                  else
+                    '%s-%04d-%s' % [version, build, sha]
+                                end
+                else
+                  "#{version}-#{sha}"
+                end
 
   print new_version
 end
 
-desc "Runs all necessary checks on a module in preparation for a release"
+desc 'Runs all necessary checks on a module in preparation for a release'
 task :release_checks do
   Rake::Task[:lint].invoke
   Rake::Task[:validate].invoke
@@ -214,56 +223,56 @@ task :release_checks do
   else
     Rake::Task[:spec].invoke
   end
-  Rake::Task["check:symlinks"].invoke
-  Rake::Task["check:test_file"].invoke
-  Rake::Task["check:dot_underscore"].invoke
-  Rake::Task["check:git_ignore"].invoke
+  Rake::Task['check:symlinks'].invoke
+  Rake::Task['check:test_file'].invoke
+  Rake::Task['check:dot_underscore'].invoke
+  Rake::Task['check:git_ignore'].invoke
 end
 
 namespace :check do
-  desc "Fails if symlinks are present in directory"
+  desc 'Fails if symlinks are present in directory'
   task :symlinks do
     symlinks = check_directory_for_symlinks
     unless symlinks.empty?
-      symlinks.each { |r| puts "Symlink found: #{r.to_s} => #{r.readlink}" }
-      fail "Symlink(s) exist within this directory"
+      symlinks.each { |r| puts "Symlink found: #{r} => #{r.readlink}" }
+      raise 'Symlink(s) exist within this directory'
     end
   end
 
-  desc "Fails if .pp files present in tests folder"
+  desc 'Fails if .pp files present in tests folder'
   task :test_file do
-    if Dir.exist?("tests")
-      Dir.chdir("tests")
-      ppfiles = Dir["*.pp"]
+    if Dir.exist?('tests')
+      Dir.chdir('tests')
+      ppfiles = Dir['*.pp']
       unless ppfiles.empty?
         puts ppfiles
-        fail ".pp files present in tests folder; Move them to an examples folder following the new convention"
+        raise '.pp files present in tests folder; Move them to an examples folder following the new convention'
       end
     end
   end
 
-  desc "Fails if any ._ files are present in directory"
+  desc 'Fails if any ._ files are present in directory'
   task :dot_underscore do
-    dirs = Dir["._*"]
+    dirs = Dir['._*']
     unless dirs.empty?
       puts dirs
-      fail "._ files are present in the directory"
+      raise '._ files are present in the directory'
     end
   end
 
-  desc "Fails if directories contain the files specified in .gitignore"
+  desc 'Fails if directories contain the files specified in .gitignore'
   task :git_ignore do
     matched = `git ls-files --ignored --exclude-standard`
-    unless matched == ""
+    unless matched == ''
       puts matched
-      fail "File specified in .gitignore has been committed"
+      raise 'File specified in .gitignore has been committed'
     end
   end
 end
 
-desc "Display the list of available rake tasks"
+desc 'Display the list of available rake tasks'
 task :help do
-  system("rake -T")
+  system('rake -T')
 end
 
 begin
@@ -273,17 +282,17 @@ begin
     task.options = ['-D', '-S', '-E']
   end
 rescue LoadError
-  desc "rubocop is not available in this installation"
+  desc 'rubocop is not available in this installation'
   task :rubocop do
-    fail "rubocop is not available in this installation"
+    raise 'rubocop is not available in this installation'
   end
 end
 
 module_dir = Dir.pwd
-locales_dir = File.absolute_path('locales',  module_dir )
+locales_dir = File.absolute_path('locales', module_dir)
 # if the task is allowed to run when the module does not have a locales directory,
 # the task is run in the puppet gem instead and creates a POT there.
-puts "gettext-setup tasks will only be loaded if the locales/ directory is present" if Rake.verbose == true
+puts 'gettext-setup tasks will only be loaded if the locales/ directory is present' if Rake.verbose == true
 if File.exist? locales_dir
   begin
     spec = Gem::Specification.find_by_name 'gettext-setup'
@@ -291,13 +300,13 @@ if File.exist? locales_dir
     # Initialization requires a valid locales directory
     GettextSetup.initialize_config(locales_dir)
     namespace :module do
-      desc "Runs all tasks to build a modules POT file for internationalization"
+      desc 'Runs all tasks to build a modules POT file for internationalization'
       task :pot_gen do
-        Rake::Task["gettext:pot"].invoke()
-        Rake::Task["gettext:metadata_pot"].invoke("#{module_dir}/metadata.json")
+        Rake::Task['gettext:pot'].invoke
+        Rake::Task['gettext:metadata_pot'].invoke("#{module_dir}/metadata.json")
       end
     end
   rescue Gem::LoadError
-    puts "No gettext-setup gem found, skipping GettextSetup config initialization" if Rake.verbose == true
+    puts 'No gettext-setup gem found, skipping GettextSetup config initialization' if Rake.verbose == true
   end
 end