puppetlabs_spec_helper 2.13.1 → 3.0.0

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'

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'
@@ -50,6 +52,14 @@ if ENV['SIMPLECOV'] == 'yes'
   end
 end
 
+# Add all spec lib dirs to LOAD_PATH
+components = module_path.split(File::PATH_SEPARATOR).collect do |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
   c.module_path = module_path

data/lib/puppetlabs_spec_helper/puppet_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppetlabs_spec_helper/puppetlabs_spec_helper'
 
 # Don't want puppet getting the command line arguments for rake or autotest
@@ -45,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
@@ -58,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

data/lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'tempfile'
 require 'pathname'

data/lib/puppetlabs_spec_helper/puppetlabs_spec/fixtures.rb

@@ -1,3 +1,5 @@
+# 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.
@@ -14,6 +16,7 @@ module PuppetlabsSpec::Fixtures
     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!"
@@ -26,6 +29,7 @@ module PuppetlabsSpec::Fixtures
     unless File.readable? file
       raise "fixture '#{name}' for #{my_fixture_dir} is not readable"
     end
+
     file
   end
 
@@ -37,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)
     if files.empty?
       raise "fixture '#{glob}' for #{my_fixture_dir} had no files!"
     end
-    block_given? && files.each { |file| yield file }
+
+    block_given? && files.each(&block)
     files
   end
 end

data/lib/puppetlabs_spec_helper/puppetlabs_spec/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'stringio'
 require 'rspec/expectations'
 
@@ -6,8 +8,8 @@ require 'rspec/expectations'
 module RSpec
   module Matchers
     module BlockAliases
-      if method_defined? :should
-        alias to should unless method_defined? :to
+      if method_defined?(:should) && !method_defined?(:to)
+        alias to should
       end
       if method_defined? :should_not
         alias to_not should_not unless method_defined? :to_not

data/lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Initialize puppet for testing by loading the
 # 'puppetlabs_spec_helper/puppet_spec_helper' library
 require 'puppetlabs_spec_helper/puppet_spec_helper'
@@ -10,7 +12,7 @@ module PuppetlabsSpec
     def scope(parts = {})
       RSpec.deprecate('scope', replacement: 'rspec-puppet 2.2.0 provides a scope property')
 
-      if Puppet.version =~ %r{^2\.[67]}
+      if %r{^2\.[67]}.match?(Puppet.version)
         # 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
@@ -21,7 +23,7 @@ module PuppetlabsSpec
       scope_parent = parts[:parent] || scope_compiler.topscope
       scope_resource = parts[:resource] || resource(type: :node, title: scope_compiler.node.name)
 
-      scope = if Puppet.version =~ %r{^2\.[67]}
+      scope = if %r{^2\.[67]}.match?(Puppet.version)
                 Puppet::Parser::Scope.new(compiler: scope_compiler)
               else
                 Puppet::Parser::Scope.new(scope_compiler)
@@ -67,6 +69,7 @@ module PuppetlabsSpec
       # 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}".intern)
     end
     module_function :function_method

data/lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Define the main module namespace for use by the helper modules
 module PuppetlabsSpec
   # FIXTURE_DIR represents the standard locations of all fixture data. Normally

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'rake'
 require 'rspec/core/rake_task'
@@ -16,6 +18,24 @@ rescue LoadError
   # ignore
 end
 
+begin
+  require 'puppet_blacksmith/rake_tasks'
+rescue LoadError
+  # ignore
+end
+
+begin
+  require 'github_changelog_generator/task'
+rescue LoadError
+  # ignore
+end
+
+begin
+  require 'puppet-strings/tasks'
+rescue LoadError
+  # ignore
+end
+
 parallel_tests_loaded = false
 begin
   require 'parallel_tests'
@@ -29,12 +49,13 @@ task default: [:help]
 pattern = 'spec/{aliases,classes,defines,functions,hosts,integration,plans,tasks,type_aliases,types,unit}/**/*_spec.rb'
 
 RSpec::Core::RakeTask.new(:spec_standalone) do |t, args|
-  t.rspec_opts = ['--color']
+  t.rspec_opts = []
   t.rspec_opts << ENV['CI_SPEC_OPTIONS'] unless ENV['CI_SPEC_OPTIONS'].nil?
   if ENV['CI_NODE_TOTAL'] && ENV['CI_NODE_INDEX']
     ci_total = ENV['CI_NODE_TOTAL'].to_i
     ci_index = ENV['CI_NODE_INDEX'].to_i
     raise "CI_NODE_INDEX must be between 1-#{ci_total}" unless ci_index >= 1 && ci_index <= ci_total
+
     files = Rake::FileList[pattern].to_a
     per_node = (files.size / ci_total.to_f).ceil
     t.pattern = if args.extras.nil? || args.extras.empty?
@@ -90,16 +111,17 @@ end
 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'
   else
-    begin
-      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.concat(Rake::FileList[pattern].to_a)
 
-      ParallelTests::CLI.new.run(args)
-    end
+    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.concat(Rake::FileList[pattern].to_a)
+
+    ParallelTests::CLI.new.run(args)
+
   end
 end
 
@@ -124,14 +146,15 @@ namespace :build do
   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'))
+      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?
-        $stderr.puts 'Unable to build module. Please install PDK or add the `pdk` gem to your Gemfile.'
+        warn 'Unable to build module. Please install PDK or add the `pdk` gem to your Gemfile.'
         abort
       end
 
@@ -149,52 +172,34 @@ require 'puppet-lint/tasks/puppet-lint'
 # Must clear as it will not override the existing puppet-lint rake task since we require to import for
 # the PuppetLint::RakeTask
 Rake::Task[:lint].clear
-# Relative is not able to be set within the context of PuppetLint::RakeTask
+# Utilize PuppetLint global configuration so that these settings can be tweaked by
+# spec_helper.rb in an individual module
 PuppetLint.configuration.relative = true
-PuppetLint::RakeTask.new(:lint) do |config|
-  config.fail_on_warnings = true
-  config.disable_checks = %w[
-    80chars
-    140chars
-    class_inherits_from_params_class
-    class_parameter_defaults
-    disable_autoloader_layout
-    documentation
-    single_quote_string_with_variables
-  ]
-  config.ignore_paths = [
-    '.vendor/**/*.pp',
-    'bundle/**/*.pp',
-    'pkg/**/*.pp',
-    'spec/**/*.pp',
-    'tests/**/*.pp',
-    'types/**/*.pp',
-    'vendor/**/*.pp',
-  ]
+PuppetLint.configuration.ignore_paths ||= []
+PuppetLint.configuration.ignore_paths << '.vendor/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'bundle/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'pkg/**/*.pp'
+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 = %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|
+  PuppetLint.configuration.send("disable_#{check}")
 end
+PuppetLint::RakeTask.new(:lint)
 
 desc 'Run puppet-lint and fix issues automatically'
 PuppetLint::RakeTask.new(:lint_fix) do |config|
-  config.fail_on_warnings = true
   config.fix = true
-  config.disable_checks = %w[
-    80chars
-    140chars
-    class_inherits_from_params_class
-    class_parameter_defaults
-    disable_autoloader_layout
-    documentation
-    single_quote_string_with_variables
-  ]
-  config.ignore_paths = [
-    '.vendor/**/*.pp',
-    'bundle/**/*.pp',
-    'pkg/**/*.pp',
-    'spec/**/*.pp',
-    'tests/**/*.pp',
-    'types/**/*.pp',
-    'vendor/**/*.pp',
-  ]
 end
 
 require 'puppet-syntax/tasks/puppet-syntax'
@@ -202,7 +207,8 @@ PuppetSyntax.exclude_paths ||= []
 PuppetSyntax.exclude_paths << 'spec/fixtures/**/*'
 PuppetSyntax.exclude_paths << 'pkg/**/*'
 PuppetSyntax.exclude_paths << 'vendor/**/*'
-PuppetSyntax.exclude_paths << 'plans/*'
+PuppetSyntax.exclude_paths << '.vendor/**/*'
+PuppetSyntax.exclude_paths << 'plans/**/*'
 if Puppet.version.to_f < 4.0
   PuppetSyntax.exclude_paths << 'types/**/*'
 end
@@ -243,7 +249,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(%r{\nversion +['"](.*)['"]})[1]
   else
     raise 'Could not find a metadata.json or Modulefile! Cannot compute dev version without one or the other!'
   end
@@ -255,12 +261,12 @@ 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
-  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]
+                    '%s-%s%04d-%s' % [version, 'r', build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
                   else
-                    '%s-%04d-%s' % [version, build, sha]
-                                end
+                    '%s-%04d-%s' % [version, build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
+                  end
                 else
                   "#{version}-#{sha}"
                 end
@@ -277,10 +283,7 @@ 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].invoke
 end
 
 namespace :check do
@@ -321,6 +324,9 @@ namespace :check do
   end
 end
 
+desc 'Run static pre release checks'
+task check: ['check:symlinks', 'check:test_file', 'check:dot_underscore', 'check:git_ignore']
+
 desc 'Display the list of available rake tasks'
 task :help do
   system('rake -T')
@@ -339,25 +345,83 @@ rescue LoadError
   end
 end
 
-module_dir = Dir.pwd
-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
-if File.exist? locales_dir
-  begin
-    spec = Gem::Specification.find_by_name 'gettext-setup'
-    load "#{spec.gem_dir}/lib/tasks/gettext.rake"
-    # 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'
-      task :pot_gen do
-        Rake::Task['gettext:pot'].invoke
-        Rake::Task['gettext:metadata_pot'].invoke("#{module_dir}/metadata.json")
+def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_since_tag = nil, changelog_tag_pattern = 'v%s')
+  if Bundler.rubygems.find_name('github_changelog_generator').any?
+    # needed a place to hide these methods
+    # rubocop:disable Lint/NestedMethodDefinition
+    def changelog_user_from_metadata
+      result = JSON.parse(File.read('metadata.json'))['author']
+      raise 'unable to find the changelog_user in .sync.yml, or the author in metadata.json' if result.nil?
+
+      puts "GitHubChangelogGenerator user:#{result}"
+      result
+    end
+
+    def changelog_project_from_metadata
+      result = JSON.parse(File.read('metadata.json'))['name']
+      raise 'unable to find the changelog_project in .sync.yml or the name in metadata.json' if result.nil?
+
+      puts "GitHubChangelogGenerator project:#{result}"
+      result
+    end
+
+    def changelog_future_release
+      return unless Rake.application.top_level_tasks.include? 'changelog'
+
+      result = JSON.parse(File.read('metadata.json'))['version']
+      raise 'unable to find the future_release (version) in metadata.json' if result.nil?
+
+      puts "GitHubChangelogGenerator future_release:#{result}"
+      result
+    end
+    # 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
+
+      config.user = changelog_user || changelog_user_from_metadata
+      config.project = changelog_project || changelog_project_from_metadata
+      config.since_tag = changelog_since_tag if changelog_since_tag
+      config.future_release = changelog_tag_pattern % changelog_future_release.to_s
+      config.exclude_labels = ['maintenance']
+      config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. " \
+                      'The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres ' \
+                      'to [Semantic Versioning](https://semver.org).'
+      config.add_pr_wo_labels = true
+      config.issues = false
+      config.merge_prefix = '### UNCATEGORIZED PRS; GO LABEL THEM'
+      config.configure_sections = {
+        'Changed' => {
+          'prefix' => '### Changed',
+          'labels' => ['backwards-incompatible'],
+        },
+        'Added' => {
+          'prefix' => '### Added',
+          'labels' => %w[feature enhancement],
+        },
+        'Fixed' => {
+          'prefix' => '### Fixed',
+          'labels' => ['bugfix'],
+        },
+      }
+    end
+  else
+    desc 'Generate a Changelog from GitHub'
+    task :changelog do
+      raise <<~MESSAGE
+        The changelog tasks depends on unreleased features of the github_changelog_generator gem.
+        Please manually add it to your .sync.yml for now, and run `pdk update`:
+        ---
+        Gemfile:
+          optional:
+            ':development':
+              - gem: 'github_changelog_generator'
+                git: 'https://github.com/skywinder/github-changelog-generator'
+                ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
+                condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
+      MESSAGE
     end
-  rescue Gem::LoadError
-    puts 'No gettext-setup gem found, skipping GettextSetup config initialization' if Rake.verbose == true
   end
 end