puppetlabs_spec_helper 2.15.0 → 4.0.1

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'open3'
 require 'json'
@@ -25,10 +27,21 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     File.basename(Dir.pwd).split('-').last
   end
 
+  def module_version(path)
+    metadata_path = File.join(path, 'metadata.json')
+    raise ArgumentError unless File.file?(metadata_path) && File.readable?(metadata_path)
+
+    metadata = JSON.parse(File.read(metadata_path))
+    metadata.fetch('version', nil) || '0.0.1'
+  rescue JSON::ParserError, ArgumentError
+    logger.warn "Failed to find module version at path #{path}"
+    '0.0.1'
+  end
+
   # @return [Hash] - returns a hash of all the fixture repositories
   # @example
   # {"puppetlabs-stdlib"=>{"target"=>"https://gitlab.com/puppetlabs/puppet-stdlib.git",
-  # "ref"=>nil, "branch"=>"master", "scm"=>nil,
+  # "ref"=>nil, "branch"=>"main", "scm"=>nil,
   # }}
   def repositories
     @repositories ||= fixtures('repositories') || {}
@@ -50,7 +63,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
 
   # @return [Hash] - returns a hash with the module name and the source directory
   def auto_symlink
-    { module_name => '#{source_dir}' }
+    { module_name => "\#{source_dir}" }
   end
 
   # @return [Boolean] - true if the os is a windows system
@@ -116,21 +129,22 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
         end
         # there should be a warning or something if it's not a hash...
         next unless opts.instance_of?(Hash)
+
         # merge our options into the defaults to get the
         # final option list
         opts = defaults.merge(opts)
 
         next unless include_repo?(opts['puppet_version'])
 
-        real_target = eval('"' + opts['target'] + '"')
-        real_source = eval('"' + opts['repo'] + '"')
+        real_target = eval("\"#{opts['target']}\"", binding, __FILE__, __LINE__) # evaluating target reference in this context (see auto_symlink)
+        real_source = eval("\"#{opts['repo']}\"", binding, __FILE__, __LINE__) # evaluating repo reference in this context (see auto_symlink)
 
         result[real_source] = validate_fixture_hash!(
           'target' => File.join(real_target, fixture),
-          'ref'    => opts['ref'] || opts['tag'],
+          'ref' => opts['ref'] || opts['tag'],
           'branch' => opts['branch'],
-          'scm'    => opts['scm'],
-          'flags'  => opts['flags'],
+          'scm' => opts['scm'],
+          'flags' => opts['flags'],
           'subdir' => opts['subdir'],
         )
       end
@@ -143,7 +157,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     return hash unless hash['scm'] == 'git'
 
     # Forward slashes in the ref aren't allowed. And is probably a branch name.
-    raise ArgumentError, "The ref for #{hash['target']} is invalid (Contains a forward slash). If this is a branch name, please use the 'branch' setting instead." if hash['ref'] =~ %r{\/}
+    raise ArgumentError, "The ref for #{hash['target']} is invalid (Contains a forward slash). If this is a branch name, please use the 'branch' setting instead." if hash['ref'] =~ %r{/}
 
     hash
   end
@@ -181,6 +195,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
     unless File.exist?(target)
       raise "Failed to clone #{scm} repository #{remote} into #{target}"
     end
+
     result
   end
 
@@ -228,7 +243,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   end
 
   def git_remote_url(target)
-    output, status = Open3.capture2e('git', '-C', target, 'remote', 'get-url', 'origin')
+    output, status = Open3.capture2e('git', '--git-dir', File.join(target, '.git'), 'ls-remote', '--get-url', 'origin')
     status.success? ? output.strip : nil
   end
 
@@ -251,7 +266,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
               else
                 Logger::INFO
               end
-      @logger = Logger.new(STDERR)
+      @logger = Logger.new($stderr)
       @logger.level = level
     end
     @logger
@@ -261,7 +276,7 @@ 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'] || 'spec/fixtures/work-dir')
   end
 
   # returns the current thread count that is currently active
@@ -318,6 +333,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   def setup_symlink(target, link)
     link = link['target']
     return if File.symlink?(link)
+
     logger.info("Creating symlink from #{link} to #{target}")
     if windows?
       target = File.join(File.dirname(link), target) unless Pathname.new(target).absolute?
@@ -370,13 +386,13 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
       flags = " #{opts['flags']}" if opts['flags']
     end
 
-    return false if File.directory?(target)
+    return false if File.directory?(target) && (ref.empty? || opts['ref'] == module_version(target))
 
     # The PMT cannot handle multi threaded runs due to cache directory collisons
     # so we randomize the directory instead.
     # Does working_dir even need to be passed?
     Dir.mktmpdir do |working_dir|
-      command = 'puppet module install' + ref + flags + ' --ignore-dependencies' \
+      command = "puppet module install#{ref}#{flags} --ignore-dependencies" \
       ' --force' \
       " --module_working_dir \"#{working_dir}\"" \
       " --target-dir \"#{module_target_dir}\" \"#{remote}\""
@@ -389,7 +405,7 @@ module PuppetlabsSpecHelper::Tasks::FixtureHelpers
   end
 end
 
-include PuppetlabsSpecHelper::Tasks::FixtureHelpers
+include PuppetlabsSpecHelper::Tasks::FixtureHelpers # DSL include # rubocop:disable Style/MixinUsage
 
 desc 'Create the fixtures directory'
 task :spec_prep do
@@ -399,7 +415,7 @@ task :spec_prep do
     begin
       require 'win32/dir'
     rescue LoadError
-      $stderr.puts 'win32-dir gem not installed, falling back to executing mklink directly'
+      warn 'win32-dir gem not installed, falling back to executing mklink directly'
     end
   end
 

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module PuppetlabsSpecHelper
-  VERSION = '2.15.0'.freeze
+  VERSION = '4.0.1'
 
   # compat for pre-1.2.0 users; deprecated
   module Version

data/puppet_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $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,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'puppetlabs_spec_helper/version'
 
@@ -20,18 +20,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4')
+
   spec.add_runtime_dependency 'mocha', '~> 1.0'
+  spec.add_runtime_dependency 'pathspec', '>= 0.2.1', '< 1.1.0'
   spec.add_runtime_dependency 'puppet-lint', '~> 2.0'
   spec.add_runtime_dependency 'puppet-syntax', ['>= 2.0', '< 4']
   spec.add_runtime_dependency 'rspec-puppet', '~> 2.0'
-  spec.add_runtime_dependency 'pathspec', '~> 0.2.1'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'fakefs', ['>= 0.13.3', '< 2']
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'puppet'
   spec.add_development_dependency 'rake', ['>= 10.0', '< 14']
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'gettext-setup', '~> 0.29'
-  spec.add_development_dependency 'fakefs', ['>= 0.13.3', '< 2']
 end

data/puppetlabs_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'puppetlabs_spec_helper/puppetlabs_spec_helper'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Puppet, Inc.
 - Community Contributors
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -25,6 +25,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pathspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -74,33 +94,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pathspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -177,40 +203,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gettext-setup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 description: Contains rake tasks and a standard spec_helper for running spec tests
   on puppet modules.
 email:
@@ -219,6 +211,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".noexec.yaml"
 - ".rspec"
@@ -241,7 +234,6 @@ files:
 - lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb
 - lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb
 - lib/puppetlabs_spec_helper/rake_tasks.rb
-- lib/puppetlabs_spec_helper/tasks/beaker.rb
 - lib/puppetlabs_spec_helper/tasks/check_symlinks.rb
 - lib/puppetlabs_spec_helper/tasks/fixtures.rb
 - lib/puppetlabs_spec_helper/version.rb
@@ -252,7 +244,7 @@ homepage: http://github.com/puppetlabs/puppetlabs_spec_helper
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,16 +252,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Standard tasks and configuration for module spec tests.
 test_files: []

data/lib/puppetlabs_spec_helper/tasks/beaker.rb

@@ -1,112 +0,0 @@
-require 'rspec/core/rake_task'
-
-module PuppetlabsSpecHelper; end
-module PuppetlabsSpecHelper::Tasks; end
-module PuppetlabsSpecHelper::Tasks::BeakerHelpers
-  # This is a helper for the self-symlink entry of fixtures.yml
-  def source_dir
-    Dir.pwd
-  end
-
-  # cache the repositories and return a hash object
-  def repositories
-    unless @repositories
-      @repositories = fixtures('repositories')
-    end
-    @repositories
-  end
-
-  # get the array of Beaker set names
-  # @return [Array<String>]
-  def beaker_node_sets
-    return @beaker_nodes if @beaker_nodes
-    @beaker_nodes = Dir['spec/acceptance/nodesets/*.yml'].sort.map do |node_set|
-      node_set.slice!('.yml')
-      File.basename(node_set)
-    end
-  end
-
-  # Use "vagrant ssh" to login to the given node in the node set
-  # @param set [String] The name of the node set (yml file)
-  # @param node [String] The name of the node in the set. For multi-node sets.
-  def vagrant_ssh(set, node = nil)
-    vagrant_yml_dir = File.join '.vagrant', 'beaker_vagrant_files', "#{set}.yml"
-    vagrant_file = File.join vagrant_yml_dir, 'Vagrantfile'
-    unless File.file? vagrant_file
-      puts "There is no Vagrantfile at: '#{vagrant_file}'. Perhaps, the node is not created or is destroyed."
-      exit 1
-    end
-    Dir.chdir(vagrant_yml_dir) do
-      command = 'vagrant ssh'
-      command += " #{node}" if node
-      # 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,
-      }
-      system env, command
-    end
-  end
-end
-include PuppetlabsSpecHelper::Tasks::BeakerHelpers
-
-desc 'Run beaker acceptance tests'
-RSpec::Core::RakeTask.new(:beaker) do |t|
-  SetupBeaker.setup_beaker(t)
-end
-
-class SetupBeaker
-  def self.setup_beaker(t)
-    t.rspec_opts = []
-    t.pattern = 'spec/acceptance'
-    # TEST_TIERS env variable is a comma separated list of tiers to run. e.g. low, medium, high
-    if ENV['TEST_TIERS']
-      test_tiers = ENV['TEST_TIERS'].split(',')
-      test_tiers_allowed = ENV.fetch('TEST_TIERS_ALLOWED', 'low,medium,high').split(',')
-      raise 'TEST_TIERS env variable must have at least 1 tier specified. Either low, medium or high or one of the tiers listed in TEST_TIERS_ALLOWED (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 test_tiers_allowed.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
-    t
-  end
-end
-
-desc 'List available beaker nodesets'
-task 'beaker:sets' do
-  beaker_node_sets.each do |set|
-    puts set
-  end
-end
-
-# alias for compatibility
-task 'beaker_nodes' => 'beaker:sets'
-
-desc 'Try to use vagrant to login to the Beaker node'
-task 'beaker:ssh', [:set, :node] do |_task, args|
-  set = args[:set] || ENV['BEAKER_set'] || ENV['RS_SET'] || 'default'
-  node = args[:node]
-  vagrant_ssh set, node
-end
-
-beaker_node_sets.each do |set|
-  desc "Run the Beaker acceptance tests for the node set '#{set}'"
-  task "beaker:#{set}" do
-    ENV['BEAKER_set'] = set
-    Rake::Task['beaker'].reenable
-    Rake::Task['beaker'].invoke
-  end
-
-  desc "Use vagrant to login to a node from the set '#{set}'"
-  task "beaker:ssh:#{set}", [:node] do |_task, args|
-    node = args[:node]
-    vagrant_ssh set, node
-  end
-end