Merge pull request #110 from mizzy/explicit-cron-subject-type

Explicit cron subject type

lib/serverspec/commands/base.rb

@@ -109,7 +109,11 @@ def check_grouped file, group
 
       def check_cron_entry user, entry
         entry_escaped = entry.gsub(/\*/, '\\*')
-        "crontab -u #{escape(user)} -l | grep -- #{escape(entry_escaped)}"
+        if user.nil?
+          "crontab -l | grep -- #{escape(entry_escaped)}"
+        else
+          "crontab -u #{escape(user)} -l | grep -- #{escape(entry_escaped)}"
+        end
       end
 
       def check_link link, target

lib/serverspec/commands/solaris.rb

@@ -20,7 +20,11 @@ def check_running service
 
       def check_cron_entry user, entry
         entry_escaped = entry.gsub(/\*/, '\\*')
-        "crontab -l #{escape(user)} | grep -- #{escape(entry_escaped)}"
+        if user.nil?
+          "crontab -l | grep -- #{escape(entry_escaped)}"
+        else
+          "crontab -l #{escape(user)} | grep -- #{escape(entry_escaped)}"
+        end
       end
 
       def check_zfs zfs, property=nil

lib/serverspec/helper/type.rb

@@ -3,12 +3,14 @@
 require 'serverspec/type/package'
 require 'serverspec/type/port'
 require 'serverspec/type/file'
+require 'serverspec/type/cron'
 
 module Serverspec
   module Helper
     module Type
-      %w( service package port file ).each do |type|
-        define_method type do |name|
+      %w( service package port file cron ).each do |type|
+        define_method type do |*args|
+          name = args.first
           self.class.const_get('Serverspec').const_get('Type').const_get(type.capitalize).new(name)
         end
       end

lib/serverspec/matchers/have_entry.rb

@@ -1,5 +1,13 @@
-RSpec::Matchers.define :have_entry do |attr|
+RSpec::Matchers.define :have_entry do |entry|
   match do |subject|
-    backend.check_routing_table(example, attr)
+    if subject.class.name == 'Serverspec::Type::Cron'
+       subject.has_entry?(@user, entry)
+    else
+      backend.check_routing_table(example, entry)
+    end
+  end
+  # For cron type
+  chain :with_user do |user|
+    @user = user
   end
 end

lib/serverspec/type/base.rb

@@ -1,7 +1,7 @@
 module Serverspec
   module Type
     class Base
-      def initialize name
+      def initialize(name=nil)
         @name = name
       end
 

lib/serverspec/type/cron.rb

@@ -0,0 +1,12 @@
+module Serverspec
+  module Type
+    class Cron < Base
+      def has_entry?(user, entry)
+        backend.check_cron_entry(nil, user, entry)
+      end
+      def to_s
+        'Cron'
+      end
+    end
+  end
+end

spec/darwin/commands_spec.rb

@@ -130,8 +130,15 @@
 end
 
 describe 'check_cron_entry' do
-  subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
-  it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  context 'specify root user' do
+    subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
+
+  context 'no specified user' do
+    subject { commands.check_cron_entry(nil, '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
 end
 
 describe 'check_link' do

spec/darwin/cron_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Darwin
+
+describe 'Serverspec cron matchers of Darwin family' do
+  it_behaves_like 'support cron have_entry matcher', '* * * * * /usr/local/bin/batch.sh'
+  it_behaves_like 'support cron have_entry with user matcher', '* * * * * /usr/local/bin/batch.sh', 'root'
+end

spec/darwin/file_spec.rb

@@ -2,7 +2,7 @@
 
 include Serverspec::Helper::Darwin
 
-describe 'Serverspec service matchers of Darwin family' do
+describe 'Serverspec file matchers of Darwin family' do
   it_behaves_like 'support file be_file matcher', '/etc/ssh/sshd_config'
   it_behaves_like 'support file be_directory matcher', '/etc/ssh'
   it_behaves_like 'support file contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'

spec/darwin/port_spec.rb

@@ -2,6 +2,6 @@
 
 include Serverspec::Helper::Darwin
 
-describe 'Serverspec package matchers of Darwin family' do
+describe 'Serverspec port matchers of Darwin family' do
   it_behaves_like 'support port listening matcher', 80
 end

spec/debian/commands_spec.rb

@@ -142,8 +142,15 @@
 end
 
 describe 'check_cron_entry' do
-  subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
-  it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  context 'specify root user' do
+    subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
+
+  context 'no specified user' do
+    subject { commands.check_cron_entry(nil, '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
 end
 
 describe 'check_link' do

spec/debian/cron_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Debian
+
+describe 'Serverspec cron matchers of Debian family' do
+  it_behaves_like 'support cron have_entry matcher', '* * * * * /usr/local/bin/batch.sh'
+  it_behaves_like 'support cron have_entry with user matcher', '* * * * * /usr/local/bin/batch.sh', 'root'
+end

spec/debian/file_spec.rb

@@ -2,7 +2,7 @@
 
 include Serverspec::Helper::Debian
 
-describe 'Serverspec service matchers of Debian family' do
+describe 'Serverspec file matchers of Debian family' do
   it_behaves_like 'support file be_file matcher', '/etc/ssh/sshd_config'
   it_behaves_like 'support file be_directory matcher', '/etc/ssh'
   it_behaves_like 'support file contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'

spec/debian/port_spec.rb

@@ -2,6 +2,6 @@
 
 include Serverspec::Helper::Debian
 
-describe 'Serverspec package matchers of Debian family' do
+describe 'Serverspec port matchers of Debian family' do
   it_behaves_like 'support port listening matcher', 80
 end

spec/gentoo/commands_spec.rb

@@ -138,8 +138,15 @@
 end
 
 describe 'check_cron_entry' do
-  subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
-  it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  context 'specify root user' do
+    subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
+
+  context 'no specified user' do
+    subject { commands.check_cron_entry(nil, '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
 end
 
 describe 'check_link' do

spec/gentoo/cron_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Gentoo
+
+describe 'Serverspec cron matchers of Gentoo family' do
+  it_behaves_like 'support cron have_entry matcher', '* * * * * /usr/local/bin/batch.sh'
+  it_behaves_like 'support cron have_entry with user matcher', '* * * * * /usr/local/bin/batch.sh', 'root'
+end

spec/gentoo/file_spec.rb

@@ -2,7 +2,7 @@
 
 include Serverspec::Helper::Gentoo
 
-describe 'Serverspec service matchers of Gentoo family' do
+describe 'Serverspec file matchers of Gentoo family' do
   it_behaves_like 'support file be_file matcher', '/etc/ssh/sshd_config'
   it_behaves_like 'support file be_directory matcher', '/etc/ssh'
   it_behaves_like 'support file contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'

spec/gentoo/port_spec.rb

@@ -2,6 +2,6 @@
 
 include Serverspec::Helper::Gentoo
 
-describe 'Serverspec package matchers of Gentoo family' do
+describe 'Serverspec port matchers of Gentoo family' do
   it_behaves_like 'support port listening matcher', 80
 end

spec/redhat/commands_spec.rb

@@ -140,8 +140,15 @@
 end
 
 describe 'check_cron_entry' do
-  subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
-  it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  context 'specify root user' do
+    subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -u root -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
+
+  context 'no specified user' do
+    subject { commands.check_cron_entry(nil, '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
 end
 
 describe 'check_link' do

spec/redhat/cron_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include Serverspec::Helper::RedHat
+
+describe 'Serverspec cron matchers of Red Hat family' do
+  it_behaves_like 'support cron have_entry matcher', '* * * * * /usr/local/bin/batch.sh'
+  it_behaves_like 'support cron have_entry with user matcher', '* * * * * /usr/local/bin/batch.sh', 'root'
+end

spec/redhat/file_spec.rb

@@ -2,7 +2,7 @@
 
 include Serverspec::Helper::RedHat
 
-describe 'Serverspec service matchers of Red Hat family' do
+describe 'Serverspec file matchers of Red Hat family' do
   it_behaves_like 'support file be_file matcher', '/etc/ssh/sshd_config'
   it_behaves_like 'support file be_directory matcher', '/etc/ssh'
   it_behaves_like 'support file contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'

spec/redhat/port_spec.rb

@@ -2,6 +2,6 @@
 
 include Serverspec::Helper::RedHat
 
-describe 'Serverspec package matchers of Red Hat family' do
+describe 'Serverspec port matchers of Red Hat family' do
   it_behaves_like 'support port listening matcher', 80
 end

spec/solaris/commands_spec.rb

@@ -140,8 +140,15 @@
 end
 
 describe 'check_cron_entry' do
-  subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
-  it { should eq 'crontab -l root | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  context 'specify root user' do
+    subject { commands.check_cron_entry('root', '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l root | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
+
+  context 'no specified user' do
+    subject { commands.check_cron_entry(nil, '* * * * * /usr/local/bin/batch.sh') }
+    it { should eq 'crontab -l | grep -- \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ \\\\\\*\\ /usr/local/bin/batch.sh' }
+  end
 end
 
 describe 'check_link' do

spec/solaris/cron_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Solaris
+
+describe 'Serverspec cron matchers of Solaris family' do
+  it_behaves_like 'support cron have_entry matcher', '* * * * * /usr/local/bin/batch.sh'
+  it_behaves_like 'support cron have_entry with user matcher', '* * * * * /usr/local/bin/batch.sh', 'root'
+end

spec/solaris/file_spec.rb

@@ -2,7 +2,7 @@
 
 include Serverspec::Helper::Solaris
 
-describe 'Serverspec service matchers of Solaris family' do
+describe 'Serverspec file matchers of Solaris family' do
   it_behaves_like 'support file be_file matcher', '/etc/ssh/sshd_config'
   it_behaves_like 'support file be_directory matcher', '/etc/ssh'
   it_behaves_like 'support file contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'

spec/solaris/port_spec.rb

@@ -2,6 +2,6 @@
 
 include Serverspec::Helper::Solaris
 
-describe 'Serverspec package matchers of Solaris family' do
+describe 'Serverspec port matchers of Solaris family' do
   it_behaves_like 'support port listening matcher', 80
 end

spec/support/shared_cron_examples.rb

@@ -0,0 +1,23 @@
+shared_examples_for 'support cron have_entry matcher' do |entry|
+  describe 'have_cron_entry' do
+    describe cron do
+      it { should have_cron_entry entry }
+    end
+
+    describe cron do
+      it { should_not have_cron_entry 'invalid entry' }
+    end
+  end
+end
+
+shared_examples_for 'support cron have_entry with user matcher' do |entry, user|
+  describe 'have_cron_entry' do
+    describe cron do
+      it { should have_cron_entry(entry).with_user(user) }
+    end
+
+    describe cron do
+      it { should_not have_cron_entry('invalid entry').with_user(user) }
+    end
+  end
+end