rspec-puppet 2.6.13 → 2.6.14

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.6.14]
+
+### Fixed
+
+ * If present, `Win32::Dir` will be used to managed the fixtures directory
+   junction on Windows as the builtin `File` module does not have complete
+   support for directory junctions on Ruby <= 2.1.
+
+### Changed
+
+ * Resource coverage results are now exposed to the configured RSpec reporter
+   rather than only being printed to STDOUT.
+ * If running with parallel\_tests, resource coverage data is stored in
+   per-process temp files and merged at the end of the final rspec process,
+   allowing for a complete coverage report to be generated when splitting
+   a test suite across multiple rspec processes.
+
 ## [2.6.13]
 
 ### Fixed

data/README.md

@@ -1055,8 +1055,9 @@ be excluded from the coverage report.
 * [puppetlabs_spec_helper](https://github.com/puppetlabs/puppetlabs_spec_helper): shared spec helpers to setup puppet
 * [rspec-puppet-augeas](https://github.com/domcleal/rspec-puppet-augeas): RSpec tests for Augeas resources inside Puppet manifests
 * [jimdo-rspec-puppet-helpers](https://github.com/Jimdo/jimdo-rspec-puppet-helpers): Tests the contents of a file with a source
-* [puppet-catalog_rspec](https://github.com/enterprisemodules/puppet-catalog_rspec): Ease development of specs by dumping the Puppet catalog as RSpec code
-
+* Ease development of specs
+  * [puppet-catalog_rspec](https://github.com/enterprisemodules/puppet-catalog_rspec): Dump the Puppet Catalog as RSpec code at compile time
+  * [create_specs](https://github.com/alexharv074/create_specs.git): A different implementation that takes a compiled catalog and writes out RSpec code with various options
 * Fact providers
   * [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts): Simplify your unit tests by looping on every supported Operating System and populating facts.
   * [rspec-puppet-osmash](https://github.com/Aethylred/rspec-puppet-osmash): Provides Operation System hashes and validations for rspec-puppet

data/lib/rspec-puppet/coverage.rb

@@ -1,3 +1,8 @@
+require 'tmpdir'
+require 'digest'
+require 'json'
+require 'fileutils'
+
 unless defined?(RSpec::Core::NullReporter)
   module RSpec::Core
     class NullReporter
@@ -32,6 +37,29 @@ module RSpec::Puppet
       @filters = ['Stage[main]', 'Class[Settings]', 'Class[main]', 'Node[default]']
     end
 
+    def save_results
+      slug = "#{Digest::MD5.hexdigest(Dir.pwd)}-#{Process.pid}"
+      File.open(File.join(Dir.tmpdir, "rspec-puppet-coverage-#{slug}"), 'w+') do |f|
+        f.puts @collection.to_json
+      end
+    end
+
+    def merge_results
+      pattern = File.join(Dir.tmpdir, "rspec-puppet-coverage-#{Digest::MD5.hexdigest(Dir.pwd)}-*")
+      Dir[pattern].each do |result_file|
+        load_results(result_file)
+        FileUtils.rm(result_file)
+      end
+    end
+
+    def load_results(path)
+      saved_results = JSON.parse(File.read(path))
+      saved_results.each do |resource, data|
+        add(resource)
+        cover!(resource) if data['touched']
+      end
+    end
+
     def add(resource)
       if !exists?(resource) && !filtered?(resource)
         @collection[resource.to_s] = ResourceWrapper.new(resource)
@@ -70,47 +98,49 @@ module RSpec::Puppet
     end
 
     def report!(coverage_desired = nil)
-      report = results
-      puts <<-EOH.gsub(/^ {8}/, '')
-
-        Total resources:   #{report[:total]}
-        Touched resources: #{report[:touched]}
-        Resource coverage: #{report[:coverage]}%
-      EOH
-
-      if report[:coverage] != "100.00"
-        puts <<-EOH.gsub(/^ {10}/, '')
-          Untouched resources:
-
-          #{
-            untouched_resources = report[:resources].reject do |_,rsrc|
-              rsrc[:touched]
-            end
-            untouched_resources.inject([]) do |memo, (name,_)|
-              memo << "  #{name}"
-            end.sort.join("\n")
-          }
-        EOH
-        if coverage_desired
-          coverage_test(coverage_desired, report[:coverage])
+      if parallel_tests?
+        require 'parallel_tests'
+
+        if ParallelTests.first_process?
+          ParallelTests.wait_for_other_processes_to_finish
+          run_report(coverage_desired)
+        else
+          save_results
         end
+      else
+        run_report(coverage_desired)
       end
     end
 
-    def coverage_test(coverage_desired, coverage_actual)
+    def parallel_tests?
+      !!ENV['TEST_ENV_NUMBER']
+    end
+
+    def run_report(coverage_desired = nil)
+      merge_results if ENV['TEST_ENV_NUMBER']
+
+      report = results
+
+      coverage_test(coverage_desired, report)
+
+      puts report[:text]
+    end
+
+    def coverage_test(coverage_desired, report)
+      coverage_actual = report[:coverage]
+      coverage_desired ||= 0
+
       if coverage_desired.is_a?(Numeric) && coverage_desired.to_f <= 100.00 && coverage_desired.to_f >= 0.0
-        coverage_test = RSpec.describe("Code coverage.")
-        coverage_results = coverage_test.example("Must be at least #{coverage_desired}% of code coverage") {
+        coverage_test = RSpec.describe("Code coverage")
+        coverage_results = coverage_test.example("must cover at least #{coverage_desired}% of resources") do
           expect( coverage_actual.to_f ).to be >= coverage_desired.to_f
-        }
-        coverage_test.run(RSpec::Core::NullReporter)
-        passed = if coverage_results.execution_result.respond_to? :status then
-                   coverage_results.execution_result.status == :passed
-                 else
-                   coverage_results.execution_result[:status] == 'passed'
-                 end
-
-        RSpec.configuration.reporter.example_failed coverage_results unless passed
+        end
+        coverage_test.run(RSpec.configuration.reporter)
+
+        # This is not available on RSpec 2.x
+        if coverage_results.execution_result.respond_to?(:pending_message)
+          coverage_results.execution_result.pending_message = report[:text]
+        end
       else
         puts "The desired coverage must be 0 <= x <= 100, not '#{coverage_desired.inspect}'"
       end
@@ -130,6 +160,19 @@ module RSpec::Puppet
         [name, wrapper.to_hash]
       end.flatten]
 
+      text = [
+        "Total resources:   #{report[:total]}",
+        "Touched resources: #{report[:touched]}",
+        "Resource coverage: #{report[:coverage]}%",
+      ]
+
+      if report[:untouched] > 0
+        text += ['', 'Untouched resources:']
+        untouched_resources = report[:resources].reject { |_, r| r[:touched] }
+        text += untouched_resources.map { |name, _| "  #{name}" }.sort
+      end
+      report[:text] = text.join("\n")
+
       report
     end
 
@@ -208,6 +251,10 @@ module RSpec::Puppet
         }
       end
 
+      def to_json(opts)
+        to_hash.to_json(opts)
+      end
+
       def touch!
         @touched = true
       end

data/lib/rspec-puppet/setup.rb

@@ -1,6 +1,12 @@
 require 'puppet'
 require 'fileutils'
 
+begin
+  require 'win32/dir'
+rescue LoadError
+  nil
+end
+
 module RSpec::Puppet
   class Setup
     def self.run(module_name=nil)
@@ -151,27 +157,40 @@ END
       safe_create_file('spec/spec_helper.rb', content)
     end
 
+    def self.link_to_source?(target, source)
+      return false unless link?(target)
+
+      link_target = Dir.respond_to?(:read_junction) ? Dir.read_junction(target) : File.readlink(target)
+
+      link_target == File.expand_path(source)
+    end
+
+    def self.link?(target)
+      Dir.respond_to?(:junction?) ? Dir.junction?(target) : File.symlink?(target)
+    end
+
     def self.safe_make_link(source, target, verbose=true)
-      if File.exist?(target)
-        unless File.symlink?(target) && File.readlink(target) == File.expand_path(source)
-          $stderr.puts "!! #{target} already exists and is not a symlink"
+      if File.exist?(target) && !link?(target)
+        $stderr.puts "!! #{target} already exists and is not a symlink"
+        return
+      end
+
+      return if link_to_source?(target, source)
+
+      if Puppet::Util::Platform.windows?
+        output = `call mklink /J "#{target.gsub('/', '\\')}" "#{source}"`
+        unless $?.success?
+          puts output
+          abort
         end
       else
-        if Puppet::Util::Platform.windows?
-          output = `call mklink /J "#{target.gsub('/', '\\')}" "#{source}"`
-          unless $?.success?
-            puts output
-            abort
-          end
-        else
-          begin
-            FileUtils.ln_s(File.expand_path(source), target)
-          rescue Errno::EEXIST => e
-            raise e unless File.symlink?(target) && File.readlink(target) == File.expand_path(source)
-          end
+        begin
+          FileUtils.ln_s(File.expand_path(source), target)
+        rescue Errno::EEXIST => e
+          raise e unless link_to_source?(target, source)
         end
-        puts " + #{target}" if verbose
       end
+      puts " + #{target}" if verbose
     end
 
     def self.safe_create_rakefile

metadata

@@ -1,27 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.6.13
+  version: 2.6.14
+  prerelease: 
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: RSpec tests for your Puppet manifests
@@ -33,64 +36,65 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - README.md
-- bin/rspec-puppet-init
 - lib/rspec-puppet.rb
-- lib/rspec-puppet/adapters.rb
-- lib/rspec-puppet/cache.rb
+- lib/rspec-puppet/matchers/create_generic.rb
+- lib/rspec-puppet/matchers/allow_value.rb
+- lib/rspec-puppet/matchers/compile.rb
+- lib/rspec-puppet/matchers/count_generic.rb
+- lib/rspec-puppet/matchers/type_matchers.rb
+- lib/rspec-puppet/matchers/parameter_matcher.rb
+- lib/rspec-puppet/matchers/include_class.rb
+- lib/rspec-puppet/matchers/dynamic_matchers.rb
+- lib/rspec-puppet/matchers/run.rb
 - lib/rspec-puppet/consts.rb
 - lib/rspec-puppet/coverage.rb
-- lib/rspec-puppet/errors.rb
 - lib/rspec-puppet/example.rb
+- lib/rspec-puppet/adapters.rb
+- lib/rspec-puppet/tasks/release_test.rb
+- lib/rspec-puppet/rake_task.rb
+- lib/rspec-puppet/monkey_patches.rb
+- lib/rspec-puppet/errors.rb
+- lib/rspec-puppet/raw_string.rb
+- lib/rspec-puppet/spec_helper.rb
+- lib/rspec-puppet/cache.rb
+- lib/rspec-puppet/support.rb
 - lib/rspec-puppet/example/application_example_group.rb
 - lib/rspec-puppet/example/class_example_group.rb
-- lib/rspec-puppet/example/define_example_group.rb
-- lib/rspec-puppet/example/function_example_group.rb
 - lib/rspec-puppet/example/host_example_group.rb
+- lib/rspec-puppet/example/type_example_group.rb
 - lib/rspec-puppet/example/provider_example_group.rb
 - lib/rspec-puppet/example/type_alias_example_group.rb
-- lib/rspec-puppet/example/type_example_group.rb
+- lib/rspec-puppet/example/function_example_group.rb
+- lib/rspec-puppet/example/define_example_group.rb
 - lib/rspec-puppet/matchers.rb
-- lib/rspec-puppet/matchers/allow_value.rb
-- lib/rspec-puppet/matchers/compile.rb
-- lib/rspec-puppet/matchers/count_generic.rb
-- lib/rspec-puppet/matchers/create_generic.rb
-- lib/rspec-puppet/matchers/dynamic_matchers.rb
-- lib/rspec-puppet/matchers/include_class.rb
-- lib/rspec-puppet/matchers/parameter_matcher.rb
-- lib/rspec-puppet/matchers/run.rb
-- lib/rspec-puppet/matchers/type_matchers.rb
-- lib/rspec-puppet/monkey_patches.rb
+- lib/rspec-puppet/setup.rb
 - lib/rspec-puppet/monkey_patches/win32/registry.rb
 - lib/rspec-puppet/monkey_patches/win32/taskscheduler.rb
 - lib/rspec-puppet/monkey_patches/windows/taskschedulerconstants.rb
-- lib/rspec-puppet/rake_task.rb
-- lib/rspec-puppet/raw_string.rb
-- lib/rspec-puppet/setup.rb
-- lib/rspec-puppet/spec_helper.rb
-- lib/rspec-puppet/support.rb
-- lib/rspec-puppet/tasks/release_test.rb
+- bin/rspec-puppet-init
 homepage: https://github.com/rodjek/rspec-puppet/
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: RSpec tests for your Puppet manifests
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 5020bbb4c2617605ec685fff03b6758f52e39618
-  data.tar.gz: 120375f102a07f4e70137d4775db43081aeb83bf
-SHA512:
-  metadata.gz: 3ce834172e14e490eabc25dfaf0b3a0232d273eb7cbb6138231731a42939bd63e5662968044b3e553511603b3d0645f75c4c2013ddb30503529792a9a0a70fe9
-  data.tar.gz: 2e0abd0830f9c3faed1028c618b94334c7ac73ae2b88543f2db4ba38abb2698566eda4fb3b697508a88d2e7279c25002fae8765c7b37dc966adaad7d98c4d444