puppetlabs_spec_helper 1.1.1 → 2.0.0

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -1,5 +1,7 @@
+require 'fileutils'
 require 'rake'
 require 'rspec/core/rake_task'
+require 'tmpdir'
 require 'yaml'
 
 # optional gems
@@ -11,10 +13,33 @@ end
 
 task :default => [:help]
 
+pattern = 'spec/{aliases,classes,defines,unit,functions,hosts,integration,type_aliases,types}/**/*_spec.rb'
+
+spec = Gem::Specification.find_by_name 'gettext-setup'
+load "#{spec.gem_dir}/lib/tasks/gettext.rake"
+locales_dir = File.absolute_path('locales', File.dirname(__FILE__))
+# Initialization requires a valid locales directory
+if File.exist? locales_dir
+  GettextSetup.initialize(locales_dir)
+else
+  puts "No 'locales' directory found in #{File.dirname(__FILE__)}, skipping gettext initialization"
+end
+
 desc "Run spec tests on an existing fixtures directory"
 RSpec::Core::RakeTask.new(:spec_standalone) do |t|
   t.rspec_opts = ['--color']
-  t.pattern = 'spec/{classes,defines,unit,functions,hosts,integration,types}/**/*_spec.rb'
+
+  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 = files.each_slice(per_node).to_a[ci_index - 1] || files.first
+  else
+    t.pattern = pattern
+  end
 end
 
 desc "Run beaker acceptance tests"
@@ -23,12 +48,6 @@ RSpec::Core::RakeTask.new(:beaker) do |t|
   t.pattern = 'spec/acceptance'
 end
 
-desc "Generate code coverage information"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
 # This is a helper for the self-symlink entry of fixtures.yml
 def source_dir
   Dir.pwd
@@ -47,6 +66,43 @@ def repositories
   @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
+
+def auto_symlink
+  { Dir.pwd.split('/').last.split('-').last => '#{source_dir}' }
+end
 
 def fixtures(category)
   if File.exists?('.fixtures.yml')
@@ -58,13 +114,17 @@ def fixtures(category)
   end
 
   begin
-    fixtures = YAML.load_file(fixtures_yaml)["fixtures"]
+    fixtures = YAML.load_file(ENV['FIXTURES_YML'] || fixtures_yaml)["fixtures"]
   rescue Errno::ENOENT
-    return {}
+    fixtures = {}
   rescue Psych::SyntaxError => e
     abort("Found malformed YAML in #{fixtures_yaml} on line #{e.line} column #{e.column}: #{e.problem}")
   end
 
+  if fixtures['symlinks'].nil?
+    fixtures['symlinks'] = auto_symlink
+  end
+
   result = {}
   if fixtures.include? category and fixtures[category] != nil
     fixtures[category].each do |fixture, opts|
@@ -76,14 +136,14 @@ def fixtures(category)
       elsif opts.instance_of?(Hash)
         target = "spec/fixtures/modules/#{fixture}"
         real_source = eval('"'+opts["repo"]+'"')
-        result[real_source] = { "target" => target, "ref" => opts["ref"], "branch" => opts["branch"], "scm" => opts["scm"], "flags" => opts["flags"]}
+        result[real_source] = { "target" => target, "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, ref=nil, branch=nil, flags = nil)
+def clone_repo(scm, remote, target, subdir=nil, ref=nil, branch=nil, flags = nil)
   args = []
   case scm
   when 'hg'
@@ -120,6 +180,16 @@ def revision(scm, target, ref)
   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}")
+    }
+  end
+end
+
 # creates a logger so we can log events with certain levels
 def logger
   unless @logger
@@ -135,6 +205,13 @@ def logger
   @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
+
 # 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
@@ -177,9 +254,13 @@ task :spec_prep do
   rescue
   end
 
+  # git has a race condition creating that directory, that would lead to aborted clone operations
+  FileUtils::mkdir_p("spec/fixtures/modules")
+
   repositories.each do |remote, opts|
     scm = 'git'
     target = opts["target"]
+    subdir = opts["subdir"]
     ref = opts["ref"]
     scm = opts["scm"] if opts["scm"]
     branch = opts["branch"] if opts["branch"]
@@ -190,8 +271,9 @@ task :spec_prep do
       logger.debug "New Thread started for #{remote}"
       # start up a new thread and store it in the opts hash
       opts[:thread] = Thread.new do
-        clone_repo(scm, remote, target, ref, branch, flags)
+        clone_repo(scm, remote, target, subdir, ref, branch, flags)
         revision(scm, target, ref) if ref
+        remove_subdirectory(target, subdir) if subdir
       end
     else
       # the last thread started should be the longest wait
@@ -206,7 +288,6 @@ task :spec_prep do
   # wait for all the threads to finish
   repositories.each {|remote, opts| opts[:thread].join }
 
-  FileUtils::mkdir_p("spec/fixtures/modules")
   fixtures("symlinks").each do |source, target|
     if is_windows
       fail "Cannot symlink on Windows unless using at least Puppet 3.5" if !puppet_symlink_available
@@ -228,10 +309,14 @@ task :spec_prep do
     end
     next if File::exists?(target)
 
+    working_dir = module_working_directory
+    target_dir = File.expand_path('spec/fixtures/modules')
+
     command = "puppet module install" + ref + flags + \
       " --ignore-dependencies" \
       " --force" \
-      " --target-dir spec/fixtures/modules #{remote}"
+      " --module_working_dir #{working_dir}" \
+      " --target-dir #{target_dir} #{remote}"
 
     unless system(command)
       fail "Failed to install module #{remote} to #{target}"
@@ -262,6 +347,8 @@ task :spec_clean do
     FileUtils::rm_rf(target)
   end
 
+  FileUtils::rm_rf(module_working_directory)
+
   fixtures("symlinks").each do |source, target|
     FileUtils::rm_f(target)
   end
@@ -272,19 +359,59 @@ task :spec_clean do
 
 end
 
-desc "Run spec tests in a clean fixtures directory"
+desc "Run spec tests and clean the fixtures directory if successful"
 task :spec do
   Rake::Task[:spec_prep].invoke
   Rake::Task[:spec_standalone].invoke
   Rake::Task[:spec_clean].invoke
 end
 
+desc "Parallel spec tests"
+task :parallel_spec do
+  begin
+    require 'parallel_tests'
+
+    args = ['-t', 'rspec'].
+      concat(Rake::FileList[pattern].to_a)
+
+    Rake::Task[:spec_prep].invoke
+    ParallelTests::CLI.new.run(args)
+    Rake::Task[:spec_clean].invoke
+  rescue LoadError
+    fail 'Add the parallel_tests gem to Gemfile to enable this task'
+  end
+end
+
 desc "List available beaker nodesets"
-task :beaker_nodes do
-  Dir['spec/acceptance/nodesets/*.yml'].sort!.select { |node|
-    node.slice!('.yml')
-    puts File.basename(node)
-  }
+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
 
 desc "Build puppet module package"
@@ -314,11 +441,19 @@ PuppetLint::RakeTask.new(:lint) do |config|
   config.fail_on_warnings = true
   config.disable_checks = [
     '80chars',
+    '140chars',
     'class_inherits_from_params_class',
     'class_parameter_defaults',
     'documentation',
     'single_quote_string_with_variables']
-  config.ignore_paths = ["tests/**/*.pp", "vendor/**/*.pp","examples/**/*.pp", "spec/**/*.pp", "pkg/**/*.pp"]
+  config.ignore_paths = [
+    "bundle/**/*.pp",
+    "pkg/**/*.pp",
+    "spec/**/*.pp",
+    "tests/**/*.pp",
+    "types/**/*.pp",
+    "vendor/**/*.pp",
+  ]
 end
 
 require 'puppet-syntax/tasks/puppet-syntax'
@@ -326,6 +461,9 @@ PuppetSyntax.exclude_paths ||= []
 PuppetSyntax.exclude_paths << "spec/fixtures/**/*"
 PuppetSyntax.exclude_paths << "pkg/**/*"
 PuppetSyntax.exclude_paths << "vendor/**/*"
+if Puppet.version.to_f < 4.0
+  PuppetSyntax.exclude_paths << "types/**/*"
+end
 PuppetSyntax.future_parser = true if ENV['FUTURE_PARSER'] == 'yes'
 
 desc "Check syntax of Ruby files and call :syntax and :metadata_lint"
@@ -380,11 +518,11 @@ task :compute_dev_version do
   print new_version
 end
 
-desc "Runs all nessesary checks on a module in preparation for a release"
+desc "Runs all necessary checks on a module in preparation for a release"
 task :release_checks do
   Rake::Task[:lint].invoke
   Rake::Task[:validate].invoke
-  Rake::Task[:spec].invoke
+  Rake::Task[:parallel_spec].invoke
   Rake::Task["check:symlinks"].invoke
   Rake::Task["check:test_file"].invoke
   Rake::Task["check:dot_underscore"].invoke
@@ -394,7 +532,7 @@ end
 namespace :check do
   desc "Fails if symlinks are present in directory"
   task :symlinks do
-    symlink = `find . -type l -ls`
+    symlink = `find . -path ./.git -prune -o -type l -ls`
     unless symlink == ""
       puts symlink
       fail "A symlink exists within this directory"
@@ -436,3 +574,16 @@ desc "Display the list of available rake tasks"
 task :help do
   system("rake -T")
 end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    # These make the rubocop experience maybe slightly less terrible
+    task.options = ['-D', '-S', '-E']
+  end
+rescue LoadError
+  desc "rubocop is not available in this installation"
+  task :rubocop do
+    fail "rubocop is not available in this installation"
+  end
+end

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,8 @@
 module PuppetlabsSpecHelper
+  VERSION = "2.0.0"
+
+  # compat for pre-1.2.0 users; deprecated
   module Version
-    STRING = '1.1.1'
+    STRING = PuppetlabsSpecHelper::VERSION
   end
 end

data/puppetlabs_spec_helper.gemspec

@@ -1,88 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: puppetlabs_spec_helper 1.1.1 ruby lib
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppetlabs_spec_helper/version'
 
-Gem::Specification.new do |s|
-  s.name = "puppetlabs_spec_helper"
-  s.version = "1.1.1"
+Gem::Specification.new do |spec|
+  spec.name          = "puppetlabs_spec_helper"
+  spec.version       = PuppetlabsSpecHelper::VERSION
+  spec.authors       = ["Puppet, Inc.", "Community Contributors"]
+  spec.email         = ["modules-team@puppet.com"]
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Puppet Labs"]
-  s.date = "2016-03-02"
-  s.description = "Contains rake tasks and a standard spec_helper for running spec tests on puppet modules"
-  s.email = ["modules-dept@puppetlabs.com"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".noexec.yaml",
-    ".travis.yml",
-    "CHANGELOG.md",
-    "CONTRIBUTING.md",
-    "Gemfile",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "lib/puppetlabs_spec_helper/module_spec_helper.rb",
-    "lib/puppetlabs_spec_helper/puppet_spec_helper.rb",
-    "lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb",
-    "lib/puppetlabs_spec_helper/puppetlabs_spec/fixtures.rb",
-    "lib/puppetlabs_spec_helper/puppetlabs_spec/matchers.rb",
-    "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/version.rb",
-    "puppet_spec_helper.rb",
-    "puppetlabs_spec_helper.gemspec",
-    "puppetlabs_spec_helper.rb",
-    "spec/lib/puppet/type/spechelper.rb",
-    "spec/spec_helper.rb",
-    "spec/unit/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals_spec.rb",
-    "spec/watchr.rb"
-  ]
-  s.homepage = "http://github.com/puppetlabs/puppetlabs_spec_helper"
-  s.licenses = ["Apache-2.0"]
-  s.rubygems_version = "2.4.5.1"
-  s.summary = "Standard tasks and configuration for module spec tests"
+  spec.summary       = %q{Standard tasks and configuration for module spec tests.}
+  spec.description   = %q{Contains rake tasks and a standard spec_helper for running spec tests on puppet modules.}
+  spec.homepage      = "http://github.com/puppetlabs/puppetlabs_spec_helper"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rake>, [">= 0"])
-      s.add_runtime_dependency(%q<rspec-puppet>, [">= 0"])
-      s.add_runtime_dependency(%q<puppet-lint>, [">= 0"])
-      s.add_runtime_dependency(%q<puppet-syntax>, [">= 0"])
-      s.add_runtime_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<puppet>, ["~> 3.8.3"])
-    else
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rspec-puppet>, [">= 0"])
-      s.add_dependency(%q<puppet-lint>, [">= 0"])
-      s.add_dependency(%q<puppet-syntax>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<puppet>, ["~> 3.8.3"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rspec-puppet>, [">= 0"])
-    s.add_dependency(%q<puppet-lint>, [">= 0"])
-    s.add_dependency(%q<puppet-syntax>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<puppet>, ["~> 3.8.3"])
-  end
-end
+  spec.add_runtime_dependency "mocha", "~> 1.0"
+  spec.add_runtime_dependency "puppet-lint", "~> 2.0"
+  spec.add_runtime_dependency "puppet-syntax", "~> 2.0"
+  spec.add_runtime_dependency "rspec-puppet", "~> 2.0"
 
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "puppet", "~> 3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "gettext-setup", "~> 0.13"
+end