puppetlabs_spec_helper 2.5.1 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0130f0a082660bbb7b06949f05de5b12fba0495a
-  data.tar.gz: 221164acdd88485d5c1925a6c1ff5f4c819a27b7
+  metadata.gz: b3adeff1476e7d1c79bd8f1c565c1545bc03674f
+  data.tar.gz: 2d9d4b9869daa78653e68e05db09881cf1aa565a
 SHA512:
-  metadata.gz: 32cef604ccbab6524d8c19c77809d792084c87afb15dfdfcf2b178a7768a2eaccad081820fd58221d52febbea46822dd61815836118c20a14fe9cfa7c6c534bc
-  data.tar.gz: 5aacb1ac9e6c48033d1c4779f857dc9869a18b00e38c374e26fac01cae4587e7e27b9afd04ddc2dea94817429579df84f1cd3da20de9501e4c824eb6e1042bc7
+  metadata.gz: 95fc8c316731dd994d018c58b092ef7ae2408fe68f2eb0c7eb5b6dc5c0c552206267e49ca88e2718732b12c34385b65867abeffc36ee462ee4c4d68e8db86873
+  data.tar.gz: e3d978f0af9c5fccc97aff5638c2a9cf2d6dd39a9ba8d530e25ecb25385b71f4ac5cc20645506fdf0a2eee3d6780537b3593351b9399daaafff4f1632dc0fb83

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.6.1]
+### Summary
+Includes changes for 2.6.0 plus tests and bugfix of said feature.
+
+## 2.6.0 - Yanked
+### Summary
+Adds a `defaults` section to `.fixtures.yml` to specify properties such as `flags` that apply to all fixtures in a category. One example use case is to specify an alternate forge URI for the `forge_modules` fixtures.
+
+### Added
+- Add `defaults` section to fixtures.
+
 ## [2.5.1]
 ### Summary
 Adds a fix to the parallel_spec rake task.
@@ -415,7 +426,8 @@ compatible yet.
 ### Added
  * Initial release
 
-[unreleased]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.5.1...master
+[unreleased]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.6.1...master
+[2.6.1]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.5.1...v2.6.1
 [2.5.1]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.5.0...v2.5.1
 [2.5.0]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.3.2...v2.4.0

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -4,6 +4,7 @@ require 'rspec/core/rake_task'
 require 'tmpdir'
 require 'yaml'
 require 'pathname'
+require 'puppetlabs_spec_helper/version'
 
 # optional gems
 begin
@@ -75,208 +76,246 @@ RSpec::Core::RakeTask.new(:beaker) do |t|
   end
 end
 
-# This is a helper for the self-symlink entry of fixtures.yml
-def source_dir
-  Dir.pwd
-end
+module PuppetlabsSpecHelper::RakeTasks
+  # This is a helper for the self-symlink entry of fixtures.yml
+  def source_dir
+    Dir.pwd
+  end
 
-# cache the repositories and retruns and hash object
-def repositories
-  unless @repositories
-    @repositories = fixtures('repositories')
-    @repositories.each do |remote, opts|
-      if opts.instance_of?(String)
-        @repositories[remote] = {"target" => opts} # inject a hash
-      end
+  # cache the repositories and return a hash object
+  def repositories
+    unless @repositories
+      @repositories = fixtures('repositories')
     end
+    @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)
+  # 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
-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
+  # 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
-
-def auto_symlink
-  { File.basename(Dir.pwd).split('-').last => '#{source_dir}' }
-end
 
-def fixtures(category)
-  if File.exists?('.fixtures.yml')
-    fixtures_yaml = '.fixtures.yml'
-  elsif File.exists?('.fixtures.yaml')
-    fixtures_yaml = '.fixtures.yaml'
-  else
-    fixtures_yaml = ''
+  def auto_symlink
+    { File.basename(Dir.pwd).split('-').last => '#{source_dir}' }
   end
 
-  begin
-    fixtures = (YAML.load_file(ENV['FIXTURES_YML'] || fixtures_yaml) || { fixtures: {} })["fixtures"]
-  rescue Errno::ENOENT
-    fixtures = {}
-  rescue Psych::SyntaxError => e
-    abort("Found malformed YAML in #{fixtures_yaml} on line #{e.line} column #{e.column}: #{e.problem}")
-  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
 
-  if fixtures['symlinks'].nil?
-    fixtures['symlinks'] = auto_symlink
-  end
+    begin
+      if fixtures_yaml
+        fixtures = YAML.load_file(fixtures_yaml) || { 'fixtures' => {} }
+      else
+        fixtures = { 'fixtures' => {} }
+      end
+    rescue Errno::ENOENT
+      fail("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}")
+    end
 
-  result = {}
-  if fixtures.include? category and fixtures[category] != nil
-    fixtures[category].each do |fixture, opts|
-      if opts.instance_of?(String)
-        source = opts
-        target = "spec/fixtures/modules/#{fixture}"
-        real_source = eval('"'+source+'"')
-        result[real_source] = target
-      elsif opts.instance_of?(Hash)
+    unless fixtures.include?('fixtures')
+      # File is non-empty, but does not specify fixtures
+      fail("No 'fixtures' entries found in '#{fixtures_yaml}'; required")
+    end
 
-        if opts["target"]
-          real_target = eval('"'+opts["target"]+'"')
-        end
+    if fixtures.include? 'defaults'
+      fixture_defaults = fixtures['defaults']
+    else
+      fixture_defaults = {}
+    end
+
+    fixtures = fixtures['fixtures']
+
+    if fixtures['symlinks'].nil?
+      fixtures['symlinks'] = auto_symlink
+    end
+
+    result = {}
+    if fixtures.include? category and fixtures[category] != nil
+
+      defaults = { "target" => "spec/fixtures/modules" }
 
-        unless real_target
-          real_target = "spec/fixtures/modules"
+      # load defaults from the `.fixtures.yml` `defaults` section
+      # for the requested category and merge them into my defaults
+      if fixture_defaults.include? category
+        defaults = defaults.merge(fixture_defaults[category])
+      end
+
+      fixtures[category].each do |fixture, opts|
+        # 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 }
         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_source = eval('"'+opts["repo"]+'"')
+          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"]}
+          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
     end
+    return result
+  end
+
+  def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
+    args = []
+    case scm
+    when 'hg'
+      args.push('clone')
+      args.push('-b', branch) if branch
+      args.push(flags) if flags
+      args.push(remote, target)
+    when 'git'
+      args.push('clone')
+      args.push('--depth 1') unless ref
+      args.push('-b', branch) if branch
+      args.push(flags) if flags
+      args.push(remote, target)
+    else
+      fail "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}"
+    end
+    result
   end
-  return result
-end
 
-def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
-  args = []
-  case scm
-  when 'hg'
-    args.push('clone')
-    args.push('-b', branch) if branch
-    args.push(flags) if flags
-    args.push(remote, target)
-  when 'git'
-    args.push('clone')
-    args.push('--depth 1') unless ref
-    args.push('-b', branch) if branch
-    args.push(flags) if flags
-    args.push(remote, target)
-  else
-    fail "Unfortunately #{scm} is not supported yet"
+  def revision(scm, target, ref)
+    args = []
+    case scm
+    when 'hg'
+      args.push('update', '--clean', '-r', ref)
+    when 'git'
+      args.push('reset', '--hard', ref)
+    else
+      fail "Unfortunately #{scm} is not supported yet"
+    end
+    system("cd #{target} && #{scm} #{args.flatten.join ' '}")
   end
-  result = system("#{scm} #{args.flatten.join ' '}")
-  unless File::exists?(target)
-    fail "Failed to clone #{scm} repository #{remote} into #{target}"
+
+  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}")
+      }
+    end
   end
-  result
-end
 
-def revision(scm, target, ref)
-  args = []
-  case scm
-  when 'hg'
-    args.push('update', '--clean', '-r', ref)
-  when 'git'
-    args.push('reset', '--hard', ref)
-  else
-    fail "Unfortunately #{scm} is not supported yet"
+  # creates a logger so we can log events with certain levels
+  def logger
+    unless @logger
+      require 'logger'
+      if ENV['ENABLE_LOGGER']
+         level = Logger::DEBUG
+       else
+         level = Logger::INFO
+      end
+      @logger = Logger.new(STDERR)
+      @logger.level = level
+    end
+    @logger
   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}")
-    }
+  def module_working_directory
+    # 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')
   end
-end
 
-# creates a logger so we can log events with certain levels
-def logger
-  unless @logger
-    require 'logger'
-    if ENV['ENABLE_LOGGER']
-       level = Logger::DEBUG
-     else
-       level = Logger::INFO
+  # 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|
+      if opts[:thread]
+        opts[:thread].status
+      else
+        false
+      end
     end
-    @logger = Logger.new(STDERR)
-    @logger.level = level
+    logger.debug "Current thread count #{active_threads.count}"
+    active_threads.count
+  end
+
+  # returns the max_thread_count
+  # because we may want to limit ssh or https connections
+  def max_thread_limit
+    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
+    end
+    @max_thread_limit
   end
-  @logger
-end
 
-def module_working_directory
-  # 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')
-end
+  def check_directory_for_symlinks(dir='.')
+    dir = Pathname.new(dir) unless dir.is_a?(Pathname)
+    results = []
 
-# 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|
-    if opts[:thread]
-      opts[:thread].status
-    else
-      false
+    dir.each_child(true) do |child|
+      if child.symlink?
+        results << child
+      elsif child.directory? && child.basename.to_s != '.git'
+        results.concat(check_directory_for_symlinks(child))
+      end
     end
-  end
-  logger.debug "Current thread count #{active_threads.count}"
-  active_threads.count
-end
 
-# returns the max_thread_count
-# because we may want to limit ssh or https connections
-def max_thread_limit
-  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
+    results
   end
-  @max_thread_limit
 end
+include PuppetlabsSpecHelper::RakeTasks
 
 desc "Create the fixtures directory"
 task :spec_prep do
@@ -326,6 +365,7 @@ task :spec_prep do
   repositories.each {|remote, opts| opts[:thread].join }
 
   fixtures("symlinks").each do |target, link|
+    link = link['target']
     unless File.symlink?(link)
       logger.info("Creating symlink from #{link} to #{target}")
       if is_windows
@@ -374,26 +414,19 @@ end
 desc "Clean up the fixtures directory"
 task :spec_clean do
   fixtures("repositories").each do |remote, opts|
-    if opts.instance_of?(String)
-      target = opts
-    elsif opts.instance_of?(Hash)
-      target = opts["target"]
-    end
+    target = opts["target"]
     FileUtils::rm_rf(target)
   end
 
   fixtures("forge_modules").each do |remote, opts|
-    if opts.instance_of?(String)
-      target = opts
-    elsif opts.instance_of?(Hash)
-      target = opts["target"]
-    end
+    target = opts["target"]
     FileUtils::rm_rf(target)
   end
 
   FileUtils::rm_rf(module_working_directory)
 
-  fixtures("symlinks").each do |source, target|
+  fixtures("symlinks").each do |source, opts|
+    target = opts["target"]
     FileUtils::rm_f(target)
   end
 
@@ -591,21 +624,6 @@ task :release_checks do
   Rake::Task["check:git_ignore"].invoke
 end
 
-def check_directory_for_symlinks(dir='.')
-  dir = Pathname.new(dir) unless dir.is_a?(Pathname)
-  results = []
-
-  dir.each_child(true) do |child|
-    if child.symlink?
-      results << child
-    elsif child.directory? && child.basename.to_s != '.git'
-      results.concat(check_directory_for_symlinks(child))
-    end
-  end
-
-  results
-end
-
 namespace :check do
   desc "Fails if symlinks are present in directory"
   task :symlinks do

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,5 @@
 module PuppetlabsSpecHelper
-  VERSION = "2.5.1"
+  VERSION = "2.6.1"
 
   # compat for pre-1.2.0 users; deprecated
   module Version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.1
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha