puppetlabs_spec_helper 5.0.0 → 6.0.0

data/lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb

@@ -1,61 +1,61 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/GlobalVars # TODO: investigate the use of instance variables
-
 require 'fileutils'
 require 'tempfile'
 require 'pathname'
 
-# A support module for testing files.
-module PuppetlabsSpec::Files
-  # This code exists only to support tests that run as root, pretty much.
-  # Once they have finally been eliminated this can all go... --daniel 2011-04-08
-  def self.in_tmp(path)
-    tempdir = Dir.tmpdir
+module PuppetlabsSpec
+  # A support module for testing files.
+  module Files
+    # This code exists only to support tests that run as root, pretty much.
+    # Once they have finally been eliminated this can all go... --daniel 2011-04-08
+    def self.in_tmp(path)
+      tempdir = Dir.tmpdir
 
-    Pathname.new(path).ascend do |dir|
-      return true if File.identical?(tempdir, dir)
-    end
+      Pathname.new(path).ascend do |dir|
+        return true if File.identical?(tempdir, dir)
+      end
 
-    false
-  end
+      false
+    end
 
-  def self.cleanup
-    $global_tempfiles ||= []
-    while (path = $global_tempfiles.pop)
-      raise "Not deleting tmpfile #{path} outside regular tmpdir" unless in_tmp(path)
+    def self.cleanup
+      $global_tempfiles ||= []
+      while (path = $global_tempfiles.pop)
+        raise "Not deleting tmpfile #{path} outside regular tmpdir" unless in_tmp(path)
 
-      begin
-        FileUtils.rm_r path, secure: true
-      rescue Errno::ENOENT
-        # nothing to do
+        begin
+          FileUtils.rm_r path, secure: true
+        rescue Errno::ENOENT
+          # nothing to do
+        end
       end
     end
-  end
 
-  def make_absolute(path)
-    path = File.expand_path(path)
-    path[0] = 'c' if Puppet.features.microsoft_windows?
-    path
-  end
+    def make_absolute(path)
+      path = File.expand_path(path)
+      path[0] = 'c' if Puppet.features.microsoft_windows?
+      path
+    end
 
-  def tmpfilename(name)
-    # Generate a temporary file, just for the name...
-    source = Tempfile.new(name)
-    path = source.path
-    source.close!
+    def tmpfilename(name)
+      # Generate a temporary file, just for the name...
+      source = Tempfile.new(name)
+      path = source.path
+      source.close!
 
-    # ...record it for cleanup,
-    $global_tempfiles ||= []
-    $global_tempfiles << File.expand_path(path)
+      # ...record it for cleanup,
+      $global_tempfiles ||= []
+      $global_tempfiles << File.expand_path(path)
 
-    # ...and bam.
-    path
-  end
+      # ...and bam.
+      path
+    end
 
-  def tmpdir(name)
-    path = tmpfilename(name)
-    FileUtils.mkdir_p(path)
-    path
+    def tmpdir(name)
+      path = tmpfilename(name)
+      FileUtils.mkdir_p(path)
+      path
+    end
   end
 end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/fixtures.rb

@@ -1,53 +1,51 @@
 # 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)
-  end
-
-  # Returns the path to your relative fixture dir. So if your spec test is
-  # <project>/spec/unit/facter/foo_spec.rb then your relative dir will be
-  # <project>/spec/fixture/unit/facter/foo
-  def my_fixture_dir
-    callers = caller
-    while (line = callers.shift)
-      next unless (found = line.match(%r{/spec/(.*)_spec\.rb:}))
-
-      return fixtures(found[1])
+module PuppetlabsSpec
+  # 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 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)
     end
-    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
-      raise "fixture '#{name}' for #{my_fixture_dir} is not readable"
+    # Returns the path to your relative fixture dir. So if your spec test is
+    # <project>/spec/unit/facter/foo_spec.rb then your relative dir will be
+    # <project>/spec/fixture/unit/facter/foo
+    def my_fixture_dir
+      callers = caller
+      while (line = callers.shift)
+        next unless (found = line.match(%r{/spec/(.*)_spec\.rb:}))
+
+        return fixtures(found[1])
+      end
+      raise "sorry, I couldn't work out your path from the caller stack!"
     end
 
-    file
-  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)
+      raise "fixture '#{name}' for #{my_fixture_dir} is not readable" unless File.readable? file
 
-  # Return the contents of the file using read when given a name. Uses
-  # my_fixture to work out the relative path.
-  def my_fixture_read(name)
-    File.read(my_fixture(name))
-  end
+      file
+    end
 
-  # Provides a block mechanism for iterating across the files in your fixture
-  # area.
-  def my_fixtures(glob = '*', flags = 0, &block)
-    files = Dir.glob(File.join(my_fixture_dir, glob), flags)
-    if files.empty?
-      raise "fixture '#{glob}' for #{my_fixture_dir} had no files!"
+    # Return the contents of the file using read when given a name. Uses
+    # my_fixture to work out the relative path.
+    def my_fixture_read(name)
+      File.read(my_fixture(name))
     end
 
-    block && files.each(&block)
-    files
+    # Provides a block mechanism for iterating across the files in your fixture
+    # area.
+    def my_fixtures(glob = '*', flags = 0, &block)
+      files = Dir.glob(File.join(my_fixture_dir, glob), flags)
+      raise "fixture '#{glob}' for #{my_fixture_dir} had no files!" if files.empty?
+
+      block && files.each(&block)
+      files
+    end
   end
 end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -4,41 +4,43 @@
 # 'puppetlabs_spec_helper/puppet_spec_helper' library
 require 'puppetlabs_spec_helper/puppet_spec_helper'
 
-# PuppetInternals provides a set of methods that interface
-# with internal puppet implementations.
-module PuppetlabsSpec::PuppetInternals
-  def resource(parts = {})
-    resource_type = parts[:type] || :hostclass
-    resource_name = parts[:name] || 'testing'
-    Puppet::Resource::Type.new(resource_type, resource_name)
-  end
-  module_function :resource
+module PuppetlabsSpec
+  # PuppetInternals provides a set of methods that interface
+  # with internal puppet implementations.
+  module PuppetInternals
+    def resource(parts = {})
+      resource_type = parts[:type] || :hostclass
+      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
-    Puppet::Parser::Compiler.new(compiler_node)
-  end
-  module_function :compiler
+    def compiler(parts = {})
+      compiler_node = parts[:node] || node
+      Puppet::Parser::Compiler.new(compiler_node)
+    end
+    module_function :compiler
 
-  def node(parts = {})
-    node_name = parts[:name] || 'testinghost'
-    options = parts[:options] || {}
-    node_environment = Puppet::Node::Environment.create(parts[:environment] || 'test', [])
-    options[:environment] = node_environment
-    Puppet::Node.new(node_name, options)
-  end
-  module_function :node
+    def node(parts = {})
+      node_name = parts[:name] || 'testinghost'
+      options = parts[:options] || {}
+      node_environment = Puppet::Node::Environment.create(parts[:environment] || 'test', [])
+      options[:environment] = node_environment
+      Puppet::Node.new(node_name, options)
+    end
+    module_function :node
 
-  # Return a method instance for a given function.  This is primarily useful
-  # for rspec-puppet
-  def function_method(name, parts = {})
-    scope = parts[:scope] || scope()
-    # Ensure the method instance is defined by side-effect of checking if it
-    # exists.  This is a hack, but at least it's a hidden hack and not an
-    # exposed hack.
-    return nil unless Puppet::Parser::Functions.function(name)
+    # Return a method instance for a given function.  This is primarily useful
+    # for rspec-puppet
+    def function_method(name, parts = {})
+      scope = parts[:scope] || scope()
+      # Ensure the method instance is defined by side-effect of checking if it
+      # exists.  This is a hack, but at least it's a hidden hack and not an
+      # exposed hack.
+      return nil unless Puppet::Parser::Functions.function(name)
 
-    scope.method("function_#{name}".to_sym)
+      scope.method("function_#{name}".to_sym)
+    end
+    module_function :function_method
   end
-  module_function :function_method
 end

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -112,7 +112,7 @@ task :parallel_spec_standalone do |_t, args|
   else
 
     args = ['-t', 'rspec']
-    args.push('--').concat(ENV['CI_SPEC_OPTIONS'].strip.split(' ')).push('--') unless ENV['CI_SPEC_OPTIONS'].nil? || ENV['CI_SPEC_OPTIONS'].strip.empty?
+    args.push('--').concat(ENV['CI_SPEC_OPTIONS'].strip.split).push('--') unless ENV['CI_SPEC_OPTIONS'].nil? || ENV['CI_SPEC_OPTIONS'].strip.empty?
     args.concat(Rake::FileList[pattern].to_a)
 
     ParallelTests::CLI.new.run(args)
@@ -165,14 +165,14 @@ PuppetLint.configuration.ignore_paths << 'spec/**/*.pp'
 PuppetLint.configuration.ignore_paths << 'tests/**/*.pp'
 PuppetLint.configuration.ignore_paths << 'types/**/*.pp'
 PuppetLint.configuration.ignore_paths << 'vendor/**/*.pp'
-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 = %w[
+  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|
@@ -227,7 +227,7 @@ task :compute_dev_version do
     version = modinfo['version']
   elsif File.exist?('Modulefile')
     modfile = File.read('Modulefile')
-    version = modfile.match(%r{\nversion +['"](.*)['"]})[1]
+    version = modfile.match(/\nversion +['"](.*)['"]/)[1]
   else
     raise 'Could not find a metadata.json or Modulefile! Cannot compute dev version without one or the other!'
   end
@@ -239,11 +239,11 @@ 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 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'])
+  new_version = if (build = ENV.fetch('BUILD_NUMBER', nil))
                   if branch.eql? 'release'
-                    '%s-%s%04d-%s' % [version, 'r', build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
+                    format('%s-%s%04d-%s', version, 'r', build, sha) # legacy support code
                   else
-                    '%s-%04d-%s' % [version, build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
+                    format('%s-%04d-%s', version, build, sha) # legacy support code
                   end
                 else
                   "#{version}-#{sha}"
@@ -321,9 +321,7 @@ begin
     # Use Rubocop's Github Actions formatter if possible
     if ENV['GITHUB_ACTIONS'] == 'true'
       rubocop_spec = Gem::Specification.find_by_name('rubocop')
-      if Gem::Version.new(rubocop_spec.version) >= Gem::Version.new('1.2')
-        task.formatters << 'github'
-      end
+      task.formatters << 'github' if Gem::Version.new(rubocop_spec.version) >= Gem::Version.new('1.2')
     end
   end
 rescue LoadError
@@ -365,9 +363,7 @@ def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_sin
     # 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
+      raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if ENV['CHANGELOG_GITHUB_TOKEN'].nil?
 
       config.user = changelog_user || changelog_user_from_metadata
       config.project = changelog_project || changelog_project_from_metadata
@@ -383,16 +379,16 @@ def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_sin
       config.configure_sections = {
         'Changed' => {
           'prefix' => '### Changed',
-          'labels' => ['backwards-incompatible'],
+          'labels' => ['backwards-incompatible']
         },
         'Added' => {
           'prefix' => '### Added',
-          'labels' => ['feature', 'enhancement'],
+          'labels' => %w[feature enhancement]
         },
         'Fixed' => {
           'prefix' => '### Fixed',
-          'labels' => ['bugfix'],
-        },
+          'labels' => ['bugfix']
+        }
       }
     end
   else

data/lib/puppetlabs_spec_helper/tasks/check_symlinks.rb

@@ -2,48 +2,52 @@
 
 require 'pathspec'
 
-# Helpers for validating symlinks.
-class PuppetlabsSpecHelper::Tasks::CheckSymlinks
-  DEFAULT_IGNORED = [
-    '/.git/',
-    '/.bundle/',
-    '/vendor/',
-  ].freeze
-
-  IGNORE_LIST_FILES = [
-    '.pdkignore',
-    '.gitignore',
-  ].freeze
-
-  def check(dir = Dir.pwd)
-    dir = Pathname.new(dir) unless dir.is_a?(Pathname)
-    results = []
-
-    dir.each_child(true) do |child|
-      next if ignored?(child.to_s)
-
-      if child.symlink?
-        results << child
-      elsif child.directory? && child.basename.to_s !~ %r{^(\.git|\.?bundle)$}
-        results.concat(check(child))
+module PuppetlabsSpecHelper
+  module Tasks
+    # Helpers for validating symlinks.
+    class CheckSymlinks
+      DEFAULT_IGNORED = [
+        '/.git/',
+        '/.bundle/',
+        '/vendor/'
+      ].freeze
+
+      IGNORE_LIST_FILES = [
+        '.pdkignore',
+        '.gitignore'
+      ].freeze
+
+      def check(dir = Dir.pwd)
+        dir = Pathname.new(dir) unless dir.is_a?(Pathname)
+        results = []
+
+        dir.each_child(true) do |child|
+          next if ignored?(child.to_s)
+
+          if child.symlink?
+            results << child
+          elsif child.directory? && child.basename.to_s !~ /^(\.git|\.?bundle)$/
+            results.concat(check(child))
+          end
+        end
+
+        results
       end
-    end
-
-    results
-  end
 
-  def ignored?(path)
-    path = "#{path}/" if File.directory?(path)
+      def ignored?(path)
+        path = "#{path}/" if File.directory?(path)
 
-    !ignore_pathspec.match_paths([path], Dir.pwd).empty?
-  end
+        !ignore_pathspec.match_paths([path], Dir.pwd).empty?
+      end
 
-  def ignore_pathspec
-    @ignore_pathspec ||= PathSpec.new(DEFAULT_IGNORED).tap do |pathspec|
-      IGNORE_LIST_FILES.each do |f|
-        next unless File.file?(f) && File.readable?(f)
+      def ignore_pathspec
+        @ignore_pathspec ||= PathSpec.new(DEFAULT_IGNORED).tap do |pathspec|
+          IGNORE_LIST_FILES.each do |f|
+            next unless File.file?(f) && File.readable?(f)
 
-        File.open(f, 'r') { |fd| pathspec.add(fd) }
+            File.open(f, 'r') { |fd| pathspec.add(fd) }
+          end
+        end
       end
     end
   end