From 6fb1eaa76f5e1a80d70e32c33cbd5701e0842eda Mon Sep 17 00:00:00 2001
From: Urs Roesch <github@bun.ch>
Date: Tue, 23 Feb 2016 00:35:56 +0100
Subject: [PATCH] Adding better matcher descriptions

Summary:
  When running rspec with the '-f d' option the optional matchers
  are being omitted. This patch adds better descriptions for
   * be_enabled.rb
   * be_listening.rb
   * be_running.rb
   * have_rule.rb

Examples:
  describe service('dovecot') do
    it { should be_enabled.with_level(3) }
    it { should be_running.under('init') }
  end

  Before:
    Service "dovecot"
        should be enabled
        should be running

  After:
    Service "dovecot"
        should be enabled with level 3
        should be running under init

  ---

  describe port(143) do
    it { should be_listening.on('127.0.0.1').with('tcp') }
    it { should be_listening.on('::1').with('tcp6') }
  end

  Before:
    Port "143"
        should not be listening
        should not be listening

  After:
    Port "143"
        should be listening on 127.0.0.1 with tcp
        should be listening on ::1 with tcp6

  ---

  describe iptables do
    it { should have_rule('-j IMAP').with_chain('INPUT').with_table('filter') }
  end

  Before:
    Iptables
        should have rule "-j IMAP"

  After:
    Iptables
        should have rule "-j IMAP" with table filter and with chain INPUT
---
 lib/serverspec/matcher/be_enabled.rb   | 6 ++++++
 lib/serverspec/matcher/be_listening.rb | 7 +++++++
 lib/serverspec/matcher/be_running.rb   | 6 ++++++
 lib/serverspec/matcher/have_rule.rb    | 8 ++++++++
 4 files changed, 27 insertions(+)

diff --git a/lib/serverspec/matcher/be_enabled.rb b/lib/serverspec/matcher/be_enabled.rb
index 9bcfe84a..48420123 100644
--- a/lib/serverspec/matcher/be_enabled.rb
+++ b/lib/serverspec/matcher/be_enabled.rb
@@ -7,6 +7,12 @@
     end
   end
 
+  description do
+    message = 'be enabled'
+    message << " with level #{@level}" if @level
+    message
+  end
+
   chain :with_level do |level|
     @level = level
   end
diff --git a/lib/serverspec/matcher/be_listening.rb b/lib/serverspec/matcher/be_listening.rb
index 67c99dc1..fb026fa8 100644
--- a/lib/serverspec/matcher/be_listening.rb
+++ b/lib/serverspec/matcher/be_listening.rb
@@ -3,6 +3,13 @@
     port.listening? @with, @local_address
   end
 
+  description do
+    message = 'be listening'
+    message << " on #{@local_address}" if @local_address
+    message << " with #{@with}" if @with
+    message
+  end
+
   chain :with do |with|
     @with = with
   end
diff --git a/lib/serverspec/matcher/be_running.rb b/lib/serverspec/matcher/be_running.rb
index 3f80544f..ed7f42bc 100644
--- a/lib/serverspec/matcher/be_running.rb
+++ b/lib/serverspec/matcher/be_running.rb
@@ -7,6 +7,12 @@
     end
   end
 
+  description do
+    message = 'be running'
+    message << " under #{@under}" if @under
+    message
+  end
+
   chain :under do |under|
     @under = under
   end
diff --git a/lib/serverspec/matcher/have_rule.rb b/lib/serverspec/matcher/have_rule.rb
index 88982ec8..53bba1c9 100644
--- a/lib/serverspec/matcher/have_rule.rb
+++ b/lib/serverspec/matcher/have_rule.rb
@@ -7,6 +7,14 @@
     end
   end
 
+  description do
+    message = %Q{have rule "#{rule}"}
+    message << " with table #{@table}" if @table
+    message << ' and' if @table && @chain
+    message << " with chain #{@chain}" if @chain
+    message
+  end
+
   chain :with_table do |table|
     @table = table
   end