puppetlabs_spec_helper 2.8.0 → 2.9.0

data/lib/puppetlabs_spec_helper/tasks/beaker.rb

@@ -42,9 +42,9 @@ module PuppetlabsSpecHelper::Tasks::BeakerHelpers
       # 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,
+        'RUBYLIB' => nil,
+        'GEM_PATH' => nil,
+        'BUNDLE_BIN_PATH' => nil,
       }
       system env, command
     end
@@ -52,7 +52,7 @@ module PuppetlabsSpecHelper::Tasks::BeakerHelpers
 end
 include PuppetlabsSpecHelper::Tasks::BeakerHelpers
 
-desc "Run beaker acceptance tests"
+desc 'Run beaker acceptance tests'
 RSpec::Core::RakeTask.new(:beaker) do |t|
   SetupBeaker.setup_beaker(t)
 end
@@ -67,18 +67,18 @@ class SetupBeaker
       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)
+        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
+    t
   end
 end
 
-desc "List available beaker nodesets"
+desc 'List available beaker nodesets'
 task 'beaker:sets' do
   beaker_node_sets.each do |set|
     puts set

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -21,38 +21,38 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   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
+    fixtures_yaml = if ENV['FIXTURES_YML']
+                      ENV['FIXTURES_YML']
+                    elsif File.exist?('.fixtures.yml')
+                      '.fixtures.yml'
+                    elsif File.exist?('.fixtures.yaml')
+                      '.fixtures.yaml'
+                    else
+                      false
+                    end
 
     begin
-      if fixtures_yaml
-        fixtures = YAML.load_file(fixtures_yaml) || { 'fixtures' => {} }
-      else
-        fixtures = { 'fixtures' => {} }
-      end
+      fixtures = if fixtures_yaml
+                   YAML.load_file(fixtures_yaml) || { 'fixtures' => {} }
+                 else
+                   { 'fixtures' => {} }
+                 end
     rescue Errno::ENOENT
-      fail("Fixtures file not found: '#{fixtures_yaml}'")
+      raise("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}")
+      raise("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")
+      raise("No 'fixtures' entries found in '#{fixtures_yaml}'; required")
     end
 
-    if fixtures.include? 'defaults'
-      fixture_defaults = fixtures['defaults']
-    else
-      fixture_defaults = {}
-    end
+    fixture_defaults = if fixtures.include? 'defaults'
+                         fixtures['defaults']
+                       else
+                         {}
+                       end
 
     fixtures = fixtures['fixtures']
 
@@ -61,9 +61,9 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     end
 
     result = {}
-    if fixtures.include? category and fixtures[category] != nil
+    if fixtures.include?(category) && !fixtures[category].nil?
 
-      defaults = { "target" => "spec/fixtures/modules" }
+      defaults = { 'target' => 'spec/fixtures/modules' }
 
       # load defaults from the `.fixtures.yml` `defaults` section
       # for the requested category and merge them into my defaults
@@ -75,25 +75,31 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
         # 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 }
+          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
+        next unless 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
-    return result
+    result
   end
 
-  def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
+  def clone_repo(scm, remote, target, _subdir = nil, ref = nil, branch = nil, flags = nil)
     args = []
     case scm
     when 'hg'
@@ -108,11 +114,11 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
       args.push(flags) if flags
       args.push(remote, target)
     else
-      fail "Unfortunately #{scm} is not supported yet"
+      raise "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}"
+    unless File.exist?(target)
+      raise "Failed to clone #{scm} repository #{remote} into #{target}"
     end
     result
   end
@@ -124,7 +130,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
            when 'git'
              ['fetch']
            else
-             fail "Unfortunately #{scm} is not supported yet"
+             raise "Unfortunately #{scm} is not supported yet"
            end
     Dir.chdir(target) do
       system("#{scm} #{args.flatten.join(' ')}")
@@ -139,18 +145,18 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     when 'git'
       args.push('reset', '--hard', ref)
     else
-      fail "Unfortunately #{scm} is not supported yet"
+      raise "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}")
-      }
+      Dir.mktmpdir do |tmpdir|
+        FileUtils.mv(Dir.glob("#{target}/#{subdir}/{.[^\.]*,*}"), tmpdir)
+        FileUtils.rm_rf("#{target}/#{subdir}")
+        FileUtils.mv(Dir.glob("#{tmpdir}/{.[^\.]*,*}"), target.to_s)
+      end
     end
   end
 
@@ -158,11 +164,11 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   def logger
     unless @logger
       require 'logger'
-      if ENV['ENABLE_LOGGER']
-         level = Logger::DEBUG
-       else
-         level = Logger::INFO
-      end
+      level = if ENV['ENABLE_LOGGER']
+                Logger::DEBUG
+              else
+                Logger::INFO
+              end
       @logger = Logger.new(STDERR)
       @logger.level = level
     end
@@ -173,14 +179,14 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     # 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')
+    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|
+    active_threads = items.find_all do |_item, opts|
       if opts[:thread]
         opts[:thread].status
       else
@@ -197,16 +203,16 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     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
+      @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
   end
 
-  def check_directory_for_symlinks(dir='.')
+  def check_directory_for_symlinks(dir = '.')
     dir = Pathname.new(dir) unless dir.is_a?(Pathname)
     results = []
 
@@ -223,7 +229,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
 end
 include PuppetlabsSpecHelper::Tasks::FixtureHelpers
 
-desc "Create the fixtures directory"
+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
@@ -232,21 +238,21 @@ task :spec_prep do
     begin
       require 'win32/dir'
     rescue LoadError
-      $stderr.puts "win32-dir gem not installed, falling back to executing mklink directly"
+      $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")
+  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"]
+    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
@@ -263,42 +269,41 @@ task :spec_prep do
       end
     else
       # the last thread started should be the longest wait
-      item, item_opts = repositories.find_all {|i,o| o.has_key?(:thread)}.last
+      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
+      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 }
+  repositories.each { |_remote, opts| opts[:thread].join }
 
-  fixtures("symlinks").each do |target, link|
+  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
+    next if 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
-        FileUtils::ln_sf(target, link)
+        system("call mklink /J \"#{link.tr('/', '\\')}\" \"#{target.tr('/', '\\')}\"")
       end
+    else
+      FileUtils.ln_sf(target, link)
     end
   end
 
-  fixtures("forge_modules").each do |remote, opts|
-    ref = ""
-    flags = ""
+  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?
+      target = opts['target']
+      ref = " --version #{opts['ref']}" unless opts['ref'].nil?
       flags = " #{opts['flags']}" if opts['flags']
     end
 
@@ -307,46 +312,46 @@ task :spec_prep do
     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}\""
+    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}"
+      raise "Failed to install module #{remote} to #{target_dir}"
     end
   end
 
-  FileUtils::mkdir_p("spec/fixtures/manifests")
-  FileUtils::touch("spec/fixtures/manifests/site.pp")
+  FileUtils.mkdir_p('spec/fixtures/manifests')
+  FileUtils.touch('spec/fixtures/manifests/site.pp')
 end
 
-desc "Clean up the fixtures directory"
+desc 'Clean up the fixtures directory'
 task :spec_clean do
-  fixtures("repositories").each do |remote, opts|
-    target = opts["target"]
-    FileUtils::rm_rf(target)
+  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)
+  fixtures('forge_modules').each do |_remote, opts|
+    target = opts['target']
+    FileUtils.rm_rf(target)
   end
 
-  FileUtils::rm_rf(module_working_directory)
+  FileUtils.rm_rf(module_working_directory)
 
   Rake::Task[:spec_clean_symlinks].invoke
 
-  if File.zero?("spec/fixtures/manifests/site.pp")
-    FileUtils::rm_f("spec/fixtures/manifests/site.pp")
+  if File.zero?('spec/fixtures/manifests/site.pp')
+    FileUtils.rm_f('spec/fixtures/manifests/site.pp')
   end
 end
 
-desc "Clean up any fixture symlinks"
+desc 'Clean up any fixture symlinks'
 task :spec_clean_symlinks do
-  fixtures("symlinks").each do |source, opts|
-    target = opts["target"]
-    FileUtils::rm_f(target)
+  fixtures('symlinks').each do |_source, opts|
+    target = opts['target']
+    FileUtils.rm_f(target)
   end
 end

data/lib/puppetlabs_spec_helper/version.rb

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

data/puppet_spec_helper.rb

@@ -1,4 +1,4 @@
-$:.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'puppetlabs_spec_helper/puppet_spec_helper'
 

data/puppetlabs_spec_helper.gemspec

@@ -1,34 +1,35 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'puppetlabs_spec_helper/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "puppetlabs_spec_helper"
+  spec.name          = 'puppetlabs_spec_helper'
   spec.version       = PuppetlabsSpecHelper::VERSION
-  spec.authors       = ["Puppet, Inc.", "Community Contributors"]
-  spec.email         = ["modules-team@puppet.com"]
+  spec.authors       = ['Puppet, Inc.', 'Community Contributors']
+  spec.email         = ['modules-team@puppet.com']
 
-  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.summary       = 'Standard tasks and configuration for module spec tests.'
+  spec.description   = '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"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  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 "rspec-puppet", "~> 2.0"
+  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 'rspec-puppet', '~> 2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "puppet"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "gettext-setup", "~> 0.29"
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'puppet'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'gettext-setup', '~> 0.29'
 end

data/puppetlabs_spec_helper.rb

@@ -1,4 +1,4 @@
-$:.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'puppetlabs_spec_helper/puppetlabs_spec_helper'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -177,10 +177,12 @@ files:
 - ".noexec.yaml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Standard tasks and configuration for module spec tests.