rspec-puppet-augeas 0.2.1 → 0.2.2

data/lib/rspec-puppet-augeas/fixtures.rb

@@ -33,12 +33,20 @@ module RSpec::Puppet::Augeas
       end
     end
 
-    # Runs a particular resource via a catalog
-    def apply(resource)
+    # Runs a particular resource via a catalog and stores logs in the caller's
+    # supplied array
+    def apply(resource, logs)
+      logs.clear
+      Puppet::Util::Log.newdestination(Puppet::Test::LogCollector.new(logs))
+      Puppet::Util::Log.level = 'debug'
+
       catalog = Puppet::Resource::Catalog.new
       catalog.add_resource resource
       catalog = catalog.to_ral if resource.is_a? Puppet::Resource
-      catalog.apply
+      txn = catalog.apply
+
+      Puppet::Util::Log.close_all
+      txn
     end
   end
 end

data/lib/rspec-puppet-augeas/matchers/execute.rb

@@ -43,24 +43,37 @@ module RSpec::Puppet::Augeas::Matchers
     end
 
     def failure_message_for_should
-      # FIXME: the branch should depend on outcome, not chaining
-      if idempotent
-        "#{resource} isn't idempotent, it changes on every run"
-      elsif change
-        "#{resource} doesn't change when executed"
-      else
-        "#{resource} fails when executed"
+      if resource.txn.any_failed?
+        "#{resource} fails when executing:\n#{format_logs(resource.logs)}"
+      elsif change and !resource.txn.changed?.any?
+        "#{resource} doesn't change when executed:\n#{format_logs(resource.logs)}"
+      elsif idempotent and resource.idempotent.changed?.any?
+        "#{resource} isn't idempotent, it changes on every run:\n#{format_logs(resource.logs_idempotent)}"
       end
     end
 
     def failure_message_for_should_not
-      if idempotent
-        "#{resource} is idempotent, it doesn't change on every run"
-      elsif change
-        "#{resource} changes when executed"
-      else
-        "#{resource} succeeds when executed"
+      if resource.txn.any_failed?
+        "#{resource} succeeds when executed:\n#{format_logs(resource.logs)}"
+      elsif change and !resource.txn.changed?.any?
+        "#{resource} changes when executed:\n#{format_logs(resource.logs)}"
+      elsif idempotent and resource.idempotent.changed?.any?
+        "#{resource} is idempotent, it doesn't change on every run:\n#{format_logs(resource.logs_idempotent)}"
+      end
+    end
+
+    private
+
+    def format_logs(logs)
+      # Sometimes two transactions are run, sometimes one, so filter out the
+      # first (it appears the idempotent test only sees one txn)
+      if logs.map { |log| log.message }.grep(/Finishing transaction/).size > 1
+        logs = logs.clone.drop_while { |log| log.message !~ /Finishing transaction/ }
+        logs.shift
       end
+      # Ignore everything after the txn end
+      logs = logs.take_while { |log| log.message !~ /Finishing transaction/ }
+      logs.map { |log| "#{log.level}: #{log.message}" }.join("\n")
     end
   end
 

data/lib/rspec-puppet-augeas/resource.rb

@@ -2,10 +2,11 @@ require 'rspec-puppet-augeas/fixtures'
 
 module RSpec::Puppet::Augeas
   class Resource
-    attr_reader :resource, :txn, :txn_idempotent, :root
+    attr_reader :resource, :txn, :txn_idempotent, :root, :logs, :logs_idempotent
 
     def initialize(resource, fixtures)
       @resource = resource
+      @logs = []
 
       # The directory where the resource has run will be valuable, so keep it
       # for analysis and tests by the user
@@ -13,7 +14,7 @@ module RSpec::Puppet::Augeas
       ObjectSpace.define_finalizer(self, self.class.finalize(@root))
 
       resource[:root] = @root
-      @txn = apply(resource)
+      @txn = apply(resource, @logs)
     end
 
     def self.finalize(root)
@@ -24,11 +25,12 @@ module RSpec::Puppet::Augeas
     #
     # @return [Puppet::Transaction] repeated transaction
     def idempotent
+      @logs_idempotent = []
       root = load_fixtures(resource, {"." => "#{@root}/."})
 
       oldroot = resource[:root]
       resource[:root] = root
-      @txn_idempotent = apply(resource)
+      @txn_idempotent = apply(resource, @logs_idempotent)
       FileUtils.rm_r root
       resource[:root] = oldroot
 

data/rspec-puppet-augeas.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet-augeas'
-  s.version = '0.2.1'
+  s.version = '0.2.2'
   s.homepage = 'https://github.com/domcleal/rspec-puppet-augeas/'
   s.summary = 'RSpec tests for Augeas resources in Puppet manifests'
   s.description = 'RSpec tests for Augeas resources in Puppet manifests'

data/spec/classes/sshd_config_spec.rb

@@ -33,6 +33,11 @@ describe 'sshd' do
     describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config', :fixture => 'etc/ssh/sshd_config_2' do
       it 'should test resource with second fixture' do
         aug_get('#comment[1]').should == 'Fixture 2'
+
+        # Example of increasing logging, which captures augeas provider's
+        # debug logging on failure
+        Puppet::Util::Log.level = 'debug'
+
         should execute.with_change
         aug_get('PermitRootLogin').should == 'yes'
         should execute.idempotently
@@ -100,7 +105,33 @@ describe 'sshd' do
   # Testing for deliberate failure
   describe_augeas 'fail to add root login' do
     it 'should fail to run entirely' do
+      # Deliberate failure means this is inverted with "not"
       should_not execute
+
+      # Verify the matcher message contains logs
+      e = execute
+      e.matches? subject
+      e.description.should =~ /should execute/
+      e.failure_message_for_should.should =~ /^err:.*false/
+      e.failure_message_for_should_not.should =~ /^err:.*false/
+      # Check for debug logs
+      e.failure_message_for_should.should =~ /^debug:.*Opening augeas/
+      # Ignore transaction stuff
+      e.failure_message_for_should.split("\n").grep(/Finishing transaction/).empty?.should be_true
+    end
+  end
+
+  # Testing for deliberate no-op
+  run_augeas 'make no change' do
+    it 'should fail on with_change' do
+      should_not execute.with_change
+
+      # Verify the matcher message contains logs
+      e = execute
+      e.with_change.matches? subject
+      e.description.should =~ /should change successfully/
+      e.failure_message_for_should.should =~ /doesn't change/
+      e.failure_message_for_should_not.should =~ /changes/
     end
   end
 
@@ -110,6 +141,13 @@ describe 'sshd' do
       should execute.with_change
       aug_match('PermitRootLogin').size.should == 2
       should_not execute.idempotently
+
+      # Verify the matcher message contains logs
+      e = execute
+      e.idempotently.matches? subject
+      e.description.should =~ /should change once only/
+      e.failure_message_for_should.should =~ /^notice:.*success/
+      e.failure_message_for_should_not.should =~ /^notice:.*success/
     end
   end
 end

data/spec/fixtures/modules/sshd/manifests/init.pp

@@ -22,4 +22,9 @@ class sshd {
     context => '/files/etc/ssh/sshd_config',
     changes => 'ins PermitRootLogin after *[last()]',
   }
+
+  augeas { "make no change":
+    context => '/files/etc/ssh/sshd_config',
+    changes => 'set /foo bar',
+  }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-augeas
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-puppet