(CONT-237) Rubocop - fixes for spec_helper

Author: chelnak

lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -53,9 +53,9 @@ def verify_contents(subject, title, expected_lines)
 end
 
 # Add all spec lib dirs to LOAD_PATH
-components = module_path.split(File::PATH_SEPARATOR).collect do |dir|
+components = module_path.split(File::PATH_SEPARATOR).map do |dir|
   next unless Dir.exist? dir
-  Dir.entries(dir).reject { |f| f =~ %r{^\.} }.collect { |f| File.join(dir, f, 'spec', 'lib') }
+  Dir.entries(dir).reject { |f| f =~ %r{^\.} }.map { |f| File.join(dir, f, 'spec', 'lib') }
 end
 components.flatten.each do |d|
   $LOAD_PATH << d if FileTest.directory?(d) && !$LOAD_PATH.include?(d)

lib/puppetlabs_spec_helper/puppet_spec_helper.rb

@@ -48,62 +48,63 @@
 begin
   require 'puppet/test/test_helper'
 rescue LoadError
+  # Continue gracefully
 end
 
 # This is just a utility class to allow us to isolate the various version-specific
 # branches of initialization logic into methods without polluting the global namespace.#
-module Puppet
-  class PuppetSpecInitializer
-    # This method is for initializing puppet state for testing for older versions
-    # of puppet that do not support the new TestHelper API.  As you can see,
-    # this involves explicitly modifying global variables, directly manipulating
-    # 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)
-      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
+class Puppet::PuppetSpecInitializer
+  # This method is for initializing puppet state for testing for older versions
+  # of puppet that do not support the new TestHelper API.  As you can see,
+  # this involves explicitly modifying global variables, directly manipulating
+  # 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)
+    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
 
-      config.after :all do
-        # nothing to do for now
-      end
+    config.after :all do
+      # nothing to do for now
+    end
 
-      config.before :each do
-        # these globals are set by Application
-        $puppet_application_mode = nil
-        $puppet_application_name = nil
+    config.before :each do
+      # these globals are set by Application
+      $puppet_application_mode = nil # rubocop:disable Style/GlobalVars
+      $puppet_application_name = nil # rubocop:disable Style/GlobalVars
 
-        # REVISIT: I think this conceals other bad tests, but I don't have time to
-        # fully diagnose those right now.  When you read this, please come tell me
-        # I suck for letting this float. --daniel 2011-04-21
-        Signal.stubs(:trap)
+      # REVISIT: I think this conceals other bad tests, but I don't have time to
+      # fully diagnose those right now.  When you read this, please come tell me
+      # I suck for letting this float. --daniel 2011-04-21
+      Signal.stubs(:trap)
 
-        # Set the confdir and vardir to gibberish so that tests
-        # have to be correctly mocked.
-        Puppet[:confdir] = '/dev/null'
-        Puppet[:vardir] = '/dev/null'
+      # Set the confdir and vardir to gibberish so that tests
+      # have to be correctly mocked.
+      Puppet[:confdir] = '/dev/null'
+      Puppet[:vardir] = '/dev/null'
 
-        # Avoid opening ports to the outside world
-        Puppet.settings[:bindaddress] = '127.0.0.1'
-      end
+      # Avoid opening ports to the outside world
+      Puppet.settings[:bindaddress] = '127.0.0.1'
+    end
 
-      config.after :each do
-        Puppet.settings.clear
+    config.after :each do
+      Puppet.settings.clear
 
-        Puppet::Node::Environment.clear
-        Puppet::Util::Storage.clear
-        Puppet::Util::ExecutionStub.reset if Puppet::Util.constants.include? 'ExecutionStub'
+      Puppet::Node::Environment.clear
+      Puppet::Util::Storage.clear
+      Puppet::Util::ExecutionStub.reset if Puppet::Util.constants.include? 'ExecutionStub'
 
-        PuppetlabsSpec::Files.cleanup
-      end
+      PuppetlabsSpec::Files.cleanup
     end
   end
 end
 
 # JJM Hack to make the stdlib tests run in Puppet 2.6 (See puppet commit cf183534)
 unless Puppet.constants.include? 'Test'
   module Puppet::Test
+    # This is a stub class to allow the stdlib tests to run in Puppet 2.6
+    # This class will be removed in another commit.
     class LogCollector
       def initialize(logs)
         @logs = logs

lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -79,13 +79,11 @@
 
 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)
-    Rake::Task[:spec_clean].invoke
-  ensure
-    Rake::Task[:spec_clean_symlinks].invoke
-  end
+  Rake::Task[:spec_prep].invoke
+  Rake::Task[:spec_standalone].invoke(*args.extras)
+  Rake::Task[:spec_clean].invoke
+ensure
+  Rake::Task[:spec_clean_symlinks].invoke
 end
 
 desc 'Run spec tests with ruby simplecov code coverage'
@@ -98,13 +96,11 @@
 
 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)
-    Rake::Task[:spec_clean].invoke
-  ensure
-    Rake::Task[:spec_clean_symlinks].invoke
-  end
+  Rake::Task[:spec_prep].invoke
+  Rake::Task[:parallel_spec_standalone].invoke(*args.extras)
+  Rake::Task[:spec_clean].invoke
+ensure
+  Rake::Task[:spec_clean_symlinks].invoke
 end
 
 desc 'Parallel spec tests'
@@ -144,21 +140,19 @@
 
   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'))
-      puts "Module built: #{path}"
-    rescue LoadError
-      _ = `pdk --version`
-      unless $CHILD_STATUS.success?
-        warn 'Unable to build module. Please install PDK or add the `pdk` gem to your Gemfile.'
-        abort
-      end
-
-      system('pdk build --force')
+    require 'pdk/util'
+    require 'pdk/module/build'
+
+    path = PDK::Module::Build.invoke(force: true, 'target-dir': File.join(Dir.pwd, 'pkg'))
+    puts "Module built: #{path}"
+  rescue LoadError
+    _ = `pdk --version`
+    unless $CHILD_STATUS.success?
+      warn 'Unable to build module. Please install PDK or add the `pdk` gem to your Gemfile.'
+      abort
     end
+
+    system('pdk build --force')
   end
 end
 
@@ -183,15 +177,16 @@
 PuppetLint.configuration.ignore_paths << 'tests/**/*.pp'
 PuppetLint.configuration.ignore_paths << 'types/**/*.pp'
 PuppetLint.configuration.ignore_paths << 'vendor/**/*.pp'
-puppet_lint_disable_checks = %w[
-  80chars
-  140chars
-  class_inherits_from_params_class
-  class_parameter_defaults
-  disable_autoloader_layout
-  documentation
-  single_quote_string_with_variables
+puppet_lint_disable_checks = [
+  '80chars',
+  '140chars',
+  'class_inherits_from_params_class',
+  'class_parameter_defaults',
+  'disable_autoloader_layout',
+  'documentation',
+  'single_quote_string_with_variables',
 ]
+
 puppet_lint_disable_checks.each do |check|
   PuppetLint.configuration.send("disable_#{check}")
 end
@@ -268,7 +263,7 @@
   # 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 main branch when trying to push to the staging forge.
   # More info can be found at https://tickets.puppetlabs.com/browse/FM-6170
-  new_version = if build = (ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER'])
+  new_version = if (build = (ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER']))
                   if branch.eql? 'release'
                     '%s-%s%04d-%s' % [version, 'r', build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
                   else
@@ -416,7 +411,7 @@ def changelog_future_release
         },
         'Added' => {
           'prefix' => '### Added',
-          'labels' => %w[feature enhancement],
+          'labels' => ['feature', 'enhancement'],
         },
         'Fixed' => {
           'prefix' => '### Fixed',