cwninja-whenever 0.1.5.1

data/test/command_line_test.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class CommandLineTest < Test::Unit::TestCase
+  WHENEVER_CRON_CONTENTS = "Whenever CRON Contents"
+  EXPECTED_WHENEVER_GENERATED_SEGMENT = CommandLine::START_MARKER + "\n" + WHENEVER_CRON_CONTENTS + "\n" + CommandLine::END_MARKER
+  
+  context "Some crontab to write" do
+    setup do
+      Whenever.stubs(:cron).returns(WHENEVER_CRON_CONTENTS)
+      @command_line.stubs(:write_crontab).raises("Don't actually write the crontab, put an expectation on it!")
+    end
+
+    context "An empty crontab" do
+      setup do
+        @command_line = CommandLine.new
+        @command_line.stubs(:read_crontab).returns("")
+      end
+
+      should "just write a fresh crontab" do
+        @command_line.expects(:write_crontab).with(EXPECTED_WHENEVER_GENERATED_SEGMENT)
+        @command_line.update!
+      end
+    end
+
+    context "A crontab with some content" do
+      setup do
+        @command_line = CommandLine.new
+        @command_line.stubs(:read_crontab).returns("Hello World")
+      end
+
+      should "Put the existing content at the top" do
+        @command_line.expects(:write_crontab).with("Hello World\n" + EXPECTED_WHENEVER_GENERATED_SEGMENT)
+        @command_line.update!
+      end
+    end
+
+    context "A crontab with some content, and some existing whenever jobs" do
+      setup do
+        @command_line = CommandLine.new
+        @command_line.stubs(:read_crontab).returns("Hello World\n#{CommandLine::START_MARKER}\nSome other old content to be overridden\n#{CommandLine::END_MARKER}")
+      end
+
+      should "Put the existing content at the top" do
+        @command_line.expects(:write_crontab).with("Hello World\n" + EXPECTED_WHENEVER_GENERATED_SEGMENT)
+        @command_line.update!
+      end
+    end
+
+
+    context "A crontab with some content at the end, and some existing whenever jobs" do
+      setup do
+        @command_line = CommandLine.new
+        @command_line.stubs(:read_crontab).returns("#{CommandLine::START_MARKER}\nSome other old content to be overridden\n#{CommandLine::END_MARKER}\nHello World")
+      end
+
+      should "Put the existing content at the top" do
+        @command_line.expects(:write_crontab).with(EXPECTED_WHENEVER_GENERATED_SEGMENT + "\nHello World")
+        @command_line.update!
+      end
+    end
+  end
+
+end

data/test/cron_test.rb

@@ -0,0 +1,187 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class CronTest < Test::Unit::TestCase
+  
+  context "When parsing time in minutes" do
+    should "raise if less than 1 minute" do
+      assert_raises ArgumentError do
+        parse_time(59.seconds)
+      end
+      
+      assert_raises ArgumentError do
+        parse_time(0.minutes)
+      end
+    end
+    
+    # For santity, do some tests on straight String
+    should "parse correctly" do
+      assert_equal '* * * * *', parse_time(1.minute)
+      assert_equal '0,5,10,15,20,25,30,35,40,45,50,55 * * * *', parse_time(5.minutes)
+      assert_equal '7,14,21,28,35,42,49,56 * * * *', parse_time(7.minutes)
+      assert_equal '0,30 * * * *', parse_time(30.minutes)
+      assert_equal '32 * * * *', parse_time(32.minutes)
+      assert_not_equal '60 * * * *', parse_time(60.minutes) # 60 minutes bumps up into the hour range
+    end
+    
+    # Test all minutes
+    (2..59).each do |num|
+      should "parse correctly for #{num} minutes" do
+        start = 0
+        start += num unless 60.modulo(num).zero?
+        minutes = (start..59).step(num).to_a
+        
+        assert_equal "#{minutes.join(',')} * * * *", parse_time(num.minutes)
+      end
+    end
+  end
+  
+  context "When parsing time in hours" do
+    should "parse correctly" do
+      assert_equal '0 * * * *', parse_time(1.hour)
+      assert_equal '0 0,2,4,6,8,10,12,14,16,18,20,22 * * *', parse_time(2.hours)
+      assert_equal '0 0,3,6,9,12,15,18,21 * * *', parse_time(3.hours)
+      assert_equal '0 5,10,15,20 * * *', parse_time(5.hours)
+      assert_equal '0 17 * * *', parse_time(17.hours)
+      assert_not_equal '0 24 * * *', parse_time(24.hours) # 24 hours bumps up into the day range
+    end
+    
+    (2..23).each do |num|
+      should "parse correctly for #{num} hours" do
+        start = 0
+        start += num unless 24.modulo(num).zero?
+        hours = (start..23).step(num).to_a
+        
+        assert_equal "0 #{hours.join(',')} * * *", parse_time(num.hours)
+      end
+    end
+    
+    should "parse correctly when given an 'at' with minutes as an Integer" do
+      assert_minutes_equals "1",  1
+      assert_minutes_equals "14", 14
+      assert_minutes_equals "27", 27
+      assert_minutes_equals "55", 55
+    end
+    
+    should "parse correctly when given an 'at' with minutes as a Time" do
+      # Basically just testing that Chronic parses some times and we get the minutes out of it
+      assert_minutes_equals "1",  '3:01am'
+      assert_minutes_equals "1",  'January 21 2:01 PM'
+      assert_minutes_equals "0",  'midnight'
+      assert_minutes_equals "59", '13:59'
+    end
+  end
+  
+  context "When parsing time in days (of month)" do
+    should "parse correctly" do
+      assert_equal '0 0 * * *', parse_time(1.days)
+      assert_equal '0 0 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31 * *', parse_time(2.days)
+      assert_equal '0 0 1,5,9,13,17,21,25,29 * *', parse_time(4.days)
+      assert_equal '0 0 1,8,15,22 * *', parse_time(7.days)
+      assert_equal '0 0 1,17 * *', parse_time(16.days)
+      assert_equal '0 0 17 * *', parse_time(17.days)
+      assert_equal '0 0 29 * *', parse_time(29.days)
+      assert_not_equal '0 0 30 * *', parse_time(30.days) # 30 days bumps into the month range
+    end
+    
+    should "parse correctly when given an 'at' with hours, minutes as a Time" do
+      # first param is an array with [hours, minutes]
+      assert_hours_and_minutes_equals %w(3 45),  '3:45am'
+      assert_hours_and_minutes_equals %w(20 1),  '8:01pm'
+      assert_hours_and_minutes_equals %w(0 0),   'midnight'
+      assert_hours_and_minutes_equals %w(1 23),  '1:23 AM'
+      assert_hours_and_minutes_equals %w(23 59), 'March 21 11:59 pM'
+    end
+    
+    should "parse correctly when given an 'at' with hours as an Integer" do
+      # first param is an array with [hours, minutes]
+      assert_hours_and_minutes_equals %w(1 0),  1
+      assert_hours_and_minutes_equals %w(3 0),  3
+      assert_hours_and_minutes_equals %w(15 0), 15
+      assert_hours_and_minutes_equals %w(19 0), 19
+      assert_hours_and_minutes_equals %w(23 0), 23
+    end
+  end
+  
+  context "When parsing time in months" do
+    should "parse correctly" do
+      assert_equal '0 0 1 * *', parse_time(1.month)
+      assert_equal '0 0 1 1,3,5,7,9,11 *', parse_time(2.months)
+      assert_equal '0 0 1 1,4,7,10 *', parse_time(3.months)
+      assert_equal '0 0 1 1,5,9 *', parse_time(4.months)
+      assert_equal '0 0 1 1,6 *', parse_time(5.months)
+      assert_equal '0 0 1 7 *', parse_time(7.months)
+      assert_equal '0 0 1 8 *', parse_time(8.months)
+      assert_equal '0 0 1 9 *', parse_time(9.months)
+      assert_equal '0 0 1 10 *', parse_time(10.months)
+      assert_equal '0 0 1 11 *', parse_time(11.months)
+      assert_equal '0 0 1 12 *', parse_time(12.months)
+    end
+    
+    should "parse correctly when given an 'at' with days, hours, minutes as a Time" do
+      # first param is an array with [days, hours, minutes]
+      assert_days_and_hours_and_minutes_equals %w(1 3 45),  'January 1st 3:45am'
+      assert_days_and_hours_and_minutes_equals %w(11 23 0), 'Feb 11 11PM'
+      assert_days_and_hours_and_minutes_equals %w(22 1 1), 'march 22nd at 1:01 am'
+      assert_days_and_hours_and_minutes_equals %w(23 0 0), 'march 22nd at midnight' # looks like midnight means the next day
+    end
+    
+    should "parse correctly when given an 'at' with days as an Integer" do
+      # first param is an array with [days, hours, minutes]
+      assert_days_and_hours_and_minutes_equals %w(1 0 0),  1
+      assert_days_and_hours_and_minutes_equals %w(15 0 0), 15
+      assert_days_and_hours_and_minutes_equals %w(29 0 0), 29
+    end
+  end
+  
+  context "When parsing time in days (of week)" do
+    should "parse days of the week correctly" do
+      {
+        'sun' => %w(sun Sunday SUNDAY SUN),
+        'mon' => %w(mon Monday MONDAY MON),
+        'tue' => %w(tue tues Tuesday TUESDAY TUE),
+        'wed' => %w(wed Wednesday WEDNESDAY WED),
+        'thu' => %w(thu thurs thur Thursday THURSDAY THU),
+        'fri' => %w(fri Friday FRIDAY FRI),
+        'sat' => %w(sat Saturday SATURDAY SAT) 
+      }.each do |day, day_tests|
+        day_tests.each do |day_test|
+          assert_equal "0 0 * * #{day}", parse_time(day_test)
+        end
+      end
+    end
+    
+    should "parse weekday correctly" do
+      assert_equal '0 0 * * mon-fri', parse_time('weekday')
+      assert_equal '0 0 * * mon-fri', parse_time('Weekdays')
+    end
+    
+    should "parse weekend correctly" do
+      assert_equal '0 0 * * sat,sun', parse_time('weekend')
+      assert_equal '0 0 * * sat,sun', parse_time('Weekends')
+    end
+  end
+  
+private
+
+  def assert_days_and_hours_and_minutes_equals(expected, time)
+    cron = parse_time(2.months, 'some task', time)
+    minutes, hours, days, *garbage = cron.split(' ')
+    assert_equal expected, [days, hours, minutes]
+  end
+
+  def assert_hours_and_minutes_equals(expected, time)
+    cron = parse_time(2.days, 'some task', time)
+    minutes, hours, *garbage = cron.split(' ')
+    assert_equal expected, [hours, minutes]
+  end
+
+  def assert_minutes_equals(expected, time)
+    cron = parse_time(2.hours, 'some task', time)
+    assert_equal expected, cron.split(' ')[0]
+  end
+
+  def parse_time(time = nil, task = nil, at = nil)
+    Whenever::Output::Cron.new(time, task, at).time_in_cron_syntax
+  end
+  
+end

data/test/output_command_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputCommandTest < Test::Unit::TestCase
+  
+  context "A plain command" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command" do
+      assert_match /^.+ .+ .+ .+ blahblah$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command with the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> logfile.log 2>&1$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set and the comand overrides it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :cron_log => 'otherlog.log'
+        end
+      file
+    end
+    
+    should "output the command with the log syntax appended" do
+      assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> otherlog.log 2>&1$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set and the comand rejects it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :cron_log => false
+        end
+      file
+    end
+
+    should "output the command without the log syntax appended" do
+      assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
+      assert_match /^.+ .+ .+ .+ blahblah$/, @output
+    end
+  end
+  
+end

data/test/output_env_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputEnvTest < Test::Unit::TestCase
+
+  context "The output from Whenever with environment variables set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        env :MYVAR, 'blah'
+        env 'MAILTO', "someone@example.com"
+      file
+    end
+
+    should "output MYVAR environment variable" do
+      assert_match "MYVAR=blah", @output
+    end
+  
+    should "output MAILTO environment variable" do
+      assert_match "MAILTO=someone@example.com", @output
+    end
+  end
+
+end

data/test/output_rake_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputRakeTest < Test::Unit::TestCase
+  
+  # Rake are generated in an almost identical way to runners so we
+  # only need some basic tests to ensure they are output correctly
+  
+  context "A rake command with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah"
+        end
+      file
+    end
+    
+    should "output the rake command using that path" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command that overrides the path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah", :path => '/some/other/path'
+        end
+      file
+    end
+    
+    should "output the rake command using that path" do
+      assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command with environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah"
+        end
+      file
+    end
+    
+    should "output the rake command using that environment" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=silly /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command that overrides the environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah", :environment => :serious
+        end
+      file
+    end
+    
+    should "output the rake command using that environment" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=serious /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+end

data/test/output_runner_test.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputRunnerTest < Test::Unit::TestCase
+  
+  context "A runner with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + ' /my/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "A runner that overrides the path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah", :path => '/some/other/path'
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + ' /some/other/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "A runner with no path set and RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns('/my/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + ' /my/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "A runner with path set AND RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns('/my/rails/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "use the path" do
+      assert_match two_hours + ' /my/path/script/runner -e production "blahblah"', @output
+      assert_no_match /\/rails\/path/, @output
+    end
+  end
+  
+  context "A runner with no path set and no RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns(nil)
+      
+      @input = <<-file
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "raise an exception" do
+      assert_raises ArgumentError do
+        Whenever.cron(@input)
+      end
+    end
+  end
+  
+  context "A runner with an environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using that environment" do
+      assert_match two_hours + ' /my/path/script/runner -e silly "blahblah"', @output
+    end
+  end
+  
+  context "A runner that overrides the environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah", :environment => :serious
+        end
+      file
+    end
+    
+    should "output the runner using that environment" do
+      assert_match two_hours + ' /my/path/script/runner -e serious "blahblah"', @output
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/whenever")
+
+begin
+  require 'shoulda'
+rescue LoadError
+  warn 'To test Whenever you need the shoulda gem:'
+  warn '$ sudo gem install thoughtbot-shoulda'
+  exit(1)
+end
+
+begin
+  require 'mocha'
+rescue LoadError
+  warn 'To test Whenever you need the mocha gem:'
+  warn '$ sudo gem install mocha'
+  exit(1)
+end
+
+
+module TestExtensions
+  
+  def two_hours
+    "0 0,2,4,6,8,10,12,14,16,18,20,22 * * *"
+  end
+  
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end

data/whenever.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{whenever}
+  s.version = "0.1.5.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Javan Makhmali"]
+  s.date = %q{2009-02-20}
+  s.description = %q{Provides clean ruby syntax for defining messy cron jobs and running them Whenever.}
+  s.email = %q{javan@javan.us}
+  s.executables = ["whenever", "wheneverize"]
+  s.extra_rdoc_files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.rb", "lib/command_line.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/rake_task.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/version.rb", "lib/whenever.rb", "README.rdoc"]
+  s.files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.rb", "lib/command_line.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/rake_task.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/version.rb", "lib/whenever.rb", "Rakefile", "README.rdoc", "test/command_line_test.rb", "test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_rake_test.rb", "test/output_runner_test.rb", "test/test_helper.rb", "whenever.gemspec", "Manifest"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/javan/whenever}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whenever", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{whenever}
+  s.rubygems_version = %q{1.3.0}
+  s.summary = %q{Provides clean ruby syntax for defining messy cron jobs and running them Whenever.}
+  s.test_files = ["test/command_line_test.rb", "test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_rake_test.rb", "test/output_runner_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_dependency(%q<activesupport>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<chronic>, [">= 0.2.3"])
+    s.add_dependency(%q<activesupport>, [">= 1.3.0"])
+  end
+end