richmeyers-whenever 0.6.2

data/lib/whenever/output_redirection.rb

@@ -0,0 +1,58 @@
+module Whenever
+  module Output
+    class Redirection
+      
+      def initialize(output)
+        @output = output
+      end
+      
+      def to_s
+        return '' unless defined?(@output)
+        case @output
+          when String   then redirect_from_string
+          when Hash     then redirect_from_hash
+          when NilClass then ">> /dev/null 2>&1"
+          else ''
+        end 
+      end
+      
+    protected
+      
+      def stdout
+        return unless @output.has_key?(:standard)
+        @output[:standard].nil? ? '/dev/null' : @output[:standard]
+      end
+
+      def stderr
+        return unless @output.has_key?(:error)
+        @output[:error].nil? ? '/dev/null' : @output[:error]
+      end
+
+      def redirect_from_hash
+        case
+          when stdout == '/dev/null' && stderr == '/dev/null'
+            "> /dev/null 2>&1"
+          when stdout && stderr == '/dev/null'
+            ">> #{stdout} 2> /dev/null"
+          when stdout && stderr
+            ">> #{stdout} 2>> #{stderr}"
+          when stderr == '/dev/null'
+            "2> /dev/null"
+          when stderr
+            "2>> #{stderr}"
+          when stdout == '/dev/null'
+            "> /dev/null"
+          when stdout
+            ">> #{stdout}"
+          else
+            ''
+        end
+      end
+
+      def redirect_from_string
+        ">> #{@output} 2>&1"
+      end
+      
+    end
+  end
+end

data/lib/whenever/setup.rb

@@ -0,0 +1,18 @@
+# Environemnt defaults to production
+set :environment, "production"
+# Path defaults to the directory `whenever` was run from
+set :path, Whenever.path
+
+# All jobs are wrapped in this template.
+# http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production
+set :job_template, "/bin/bash -l -c ':job'"
+
+job_type :command, ":task :output"
+job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task --silent :output"
+
+# Create a runner job that's appropriate for the Rails version,
+if File.exists?(File.join(path, 'script', 'rails'))
+  job_type :runner, "cd :path && script/rails runner -e :environment ':task' :output"
+else
+  job_type :runner, "cd :path && script/runner -e :environment ':task' :output"
+end

data/lib/whenever/version.rb

@@ -0,0 +1,3 @@
+module Whenever
+  VERSION = '0.6.2' 
+end unless defined?(Whenever::VERSION)

data/test/functional/command_line_test.rb

@@ -0,0 +1,322 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class CommandLineTest < Test::Unit::TestCase
+  
+  context "A command line write" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      @command = Whenever::CommandLine.new(:write => true, :identifier => 'My identifier')
+      @task = "#{two_hours} /my/command"
+      Whenever.expects(:cron).returns(@task)
+    end
+
+    should "output the cron job with identifier blocks" do
+      output = <<-EXPECTED
+# Begin Whenever generated tasks for: My identifier
+#{@task}
+# End Whenever generated tasks for: My identifier
+EXPECTED
+      
+      assert_equal output, @command.send(:whenever_cron)
+    end
+    
+    should "write the crontab when run" do
+      @command.expects(:write_crontab).returns(true)
+      assert @command.run
+    end
+  end
+  
+  context "A command line update" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
+      @task = "#{two_hours} /my/command"
+      Whenever.expects(:cron).returns(@task)
+    end
+
+    should "add the cron to the end of the file if there is no existing identifier block" do
+      existing = '# Existing crontab'
+      @command.expects(:read_crontab).at_least_once.returns(existing)
+      
+      new_cron = <<-EXPECTED
+#{existing}
+
+# Begin Whenever generated tasks for: My identifier
+#{@task}
+# End Whenever generated tasks for: My identifier
+EXPECTED
+      
+      assert_equal new_cron, @command.send(:updated_crontab)
+      
+      @command.expects(:write_crontab).with(new_cron).returns(true)
+      assert @command.run
+    end
+    
+    should "replace an existing block if the identifier matches" do
+      existing = <<-EXISTING_CRON
+# Something
+
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+
+# Begin Whenever generated tasks for: Other identifier
+This shouldn't get replaced
+# End Whenever generated tasks for: Other identifier
+EXISTING_CRON
+
+      new_cron = <<-NEW_CRON
+# Something
+
+# Begin Whenever generated tasks for: My identifier
+#{@task}
+# End Whenever generated tasks for: My identifier
+
+# Begin Whenever generated tasks for: Other identifier
+This shouldn't get replaced
+# End Whenever generated tasks for: Other identifier
+NEW_CRON
+      
+      @command.expects(:read_crontab).at_least_once.returns(existing)
+      assert_equal new_cron, @command.send(:updated_crontab)
+      
+      @command.expects(:write_crontab).with(new_cron).returns(true)
+      assert @command.run
+    end
+  end
+  
+  context "A command line update that contains backslashes" do
+    setup do
+      @existing = <<-EXISTING_CRON
+# Begin Whenever generated tasks for: My identifier
+script/runner -e production 'puts '\\''hello'\\'''
+# End Whenever generated tasks for: My identifier
+EXISTING_CRON
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
+      @command.expects(:read_crontab).at_least_once.returns(@existing)
+      @command.expects(:whenever_cron).returns(@existing)
+    end
+    
+    should "replace the existing block with the backslashes in tact" do
+      assert_equal @existing, @command.send(:updated_crontab)
+    end
+  end
+  
+  context "A command line update with an identifier similar to an existing one in the crontab already" do
+    setup do
+      @existing = <<-EXISTING_CRON
+# Begin Whenever generated tasks for: WheneverExisting
+# End Whenever generated tasks for: WheneverExisting
+EXISTING_CRON
+      @new = <<-NEW_CRON
+# Begin Whenever generated tasks for: Whenever
+# End Whenever generated tasks for: Whenever
+NEW_CRON
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'Whenever')
+      @command.expects(:read_crontab).at_least_once.returns(@existing)
+      @command.expects(:whenever_cron).returns(@new)
+    end
+    
+    should "append the similarly named command" do
+      assert_equal @existing + "\n" + @new, @command.send(:updated_crontab)
+    end
+  end
+
+  context "A command line clear" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      @command = Whenever::CommandLine.new(:clear => true, :identifier => 'My identifier')
+      @task = "#{two_hours} /my/command"
+    end
+
+    should "clear an existing block if the identifier matches" do
+      existing = <<-EXISTING_CRON
+# Something
+
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+
+# Begin Whenever generated tasks for: Other identifier
+This shouldn't get replaced
+# End Whenever generated tasks for: Other identifier
+EXISTING_CRON
+
+      @command.expects(:read_crontab).at_least_once.returns(existing)
+
+      new_cron = <<-NEW_CRON
+# Something
+
+# Begin Whenever generated tasks for: Other identifier
+This shouldn't get replaced
+# End Whenever generated tasks for: Other identifier
+NEW_CRON
+
+      assert_equal new_cron, @command.send(:updated_crontab)
+
+      @command.expects(:write_crontab).with(new_cron).returns(true)
+      assert @command.run
+    end
+  end
+  
+  context "A command line update with no identifier" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+      Whenever::CommandLine.any_instance.expects(:default_identifier).returns('DEFAULT')
+      @command = Whenever::CommandLine.new(:update => true, :file => @file)
+    end
+
+    should "use the default identifier" do
+      assert_equal "Whenever generated tasks for: DEFAULT", @command.send(:comment_base)
+    end
+  end
+
+  context "combined params" do
+    setup do
+      Whenever::CommandLine.any_instance.expects(:exit)
+      Whenever::CommandLine.any_instance.expects(:warn)
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+    end
+
+    should "exit with write and clear" do
+      @command = Whenever::CommandLine.new(:write => true, :clear => true)
+    end
+    
+    should "exit with write and update" do
+      @command = Whenever::CommandLine.new(:write => true, :update => true)
+    end
+
+    should "exit with update and clear" do
+      @command = Whenever::CommandLine.new(:update => true, :clear => true)
+    end
+  end
+  
+  context "A runner where the environment is overridden using the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'environment=serious', :string => \
+      <<-file
+        set :job_template, nil
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the override environment" do
+      assert_match two_hours + %( cd /my/path && script/runner -e serious 'blahblah'), @output
+    end
+  end
+  
+  context "A runner where the environment and path are overridden using the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'environment=serious&path=/serious/path', :string => \
+      <<-file
+        set :job_template, nil
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the overridden path and environment" do
+      assert_match two_hours + %( cd /serious/path && script/runner -e serious 'blahblah'), @output
+    end
+  end
+  
+  context "A runner where the environment and path are overridden using the :set option with spaces in the string" do
+    setup do
+      @output = Whenever.cron :set => ' environment = serious&  path =/serious/path', :string => \
+      <<-file
+        set :job_template, nil
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the overridden path and environment" do
+      assert_match two_hours + %( cd /serious/path && script/runner -e serious 'blahblah'), @output
+    end
+  end
+  
+  context "A runner where the environment is overridden using the :set option but no value is given" do
+    setup do
+      @output = Whenever.cron :set => ' environment=', :string => \
+      <<-file
+        set :job_template, nil
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the original environmnet" do
+      assert_match two_hours + %( cd /silly/path && script/runner -e silly 'blahblah'), @output
+    end
+  end
+
+  context "prepare-ing the output" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+    end
+
+    should "not trim off the top lines of the file" do
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier', :cut => 0)
+      existing = <<-EXISTING_CRON
+# Useless Comments
+# at the top of the file
+
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+EXISTING_CRON
+
+      assert_equal existing, @command.send(:prepare, existing)
+    end
+    
+    should "trim off the top lines of the file" do
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier', :cut => '3')
+      existing = <<-EXISTING_CRON
+# Useless Comments
+# at the top of the file
+
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+EXISTING_CRON
+
+      new_cron = <<-NEW_CRON
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+NEW_CRON
+
+      assert_equal new_cron, @command.send(:prepare, existing)
+    end
+    
+    should "preserve terminating newlines in files" do
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
+      existing = <<-EXISTING_CRON
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+
+# A non-Whenever task
+My non-whenever job that was already here
+EXISTING_CRON
+
+      assert_equal existing, @command.send(:prepare, existing)
+    end
+  end
+
+end

data/test/functional/output_at_test.rb

@@ -0,0 +1,251 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class OutputAtTest < Test::Unit::TestCase
+  
+  context "weekday at a (single) given time" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every "weekday", :at => '5:02am' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple diverse times, via an array" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every "weekday", :at => %w(5:02am 3:52pm) do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the commands for both times given" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+      assert_match '52 15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple diverse times, comma separated" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every "weekday", :at => '5:02am, 3:52pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the commands for both times given" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+      assert_match '52 15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple aligned times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every "weekday", :at => '5:02am, 3:02pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "various days at a various aligned times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1,3,5 blahblah', @output
+    end
+  end
+  
+  context "various days at a various aligned times using a runner" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/your/path'
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using one entry because the times are aligned" do
+      assert_match %(2 5,15 * * 1,3,5 cd /your/path && script/runner -e production 'blahblah'), @output
+    end
+  end
+  
+  context "various days at a various aligned times using a rake task" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/your/path'
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          rake "blah:blah"
+        end
+      file
+    end
+    
+    should "output the rake task using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1,3,5 cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
+    end
+  end
+  
+  context "A command every 1.month at very diverse times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every [1.month, 1.day], :at => 'january 5:02am, june 17th at 2:22pm, june 3rd at 3:33am' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output 6 commands since none align" do
+      # The 1.month commands
+      assert_match '2 5 1 * * blahblah', @output
+      assert_match '22 14 17 * * blahblah', @output
+      assert_match '33 3 3 * * blahblah', @output
+      
+      # The 1.day commands
+      assert_match '2 5 * * * blahblah', @output
+      assert_match '22 14 * * * blahblah', @output
+      assert_match '33 3 * * * blahblah', @output
+    end
+  end
+  
+  context "Multiple commands output every :reboot" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every :reboot do
+          command "command_1"
+          command "command_2"
+        end
+      file
+    end
+    
+    should "output both commands @reboot" do
+      assert_match "@reboot command_1", @output
+      assert_match "@reboot command_2", @output
+    end
+  end
+  
+  context "Many different job types output every :day" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/your/path'
+        every :day do
+          rake "blah:blah"
+          runner "runner_1"
+          command "command_1"
+          runner "runner_2"
+          command "command_2"
+        end
+      file
+    end
+    
+    should "output all of the commands @daily" do
+      assert_match '@daily cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
+      assert_match %(@daily cd /your/path && script/runner -e production 'runner_1'), @output
+      assert_match '@daily command_1', @output
+      assert_match %(@daily cd /your/path && script/runner -e production 'runner_2'), @output
+      assert_match '@daily command_2', @output
+    end
+  end
+  
+  context "every 5 minutes but but starting at 1" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 5.minutes, :at => 1 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '1,6,11,16,21,26,31,36,41,46,51,56 * * * * blahblah', @output
+    end
+  end
+
+  context "every 4 minutes but starting at 2" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 4.minutes, :at => 2 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '2,6,10,14,18,22,26,30,34,38,42,46,50,54,58 * * * * blahblah', @output
+    end
+  end
+
+  context "every 3 minutes but starting at 7" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 3.minutes, :at => 7 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '7,10,13,16,19,22,25,28,31,34,37,40,43,46,49,52,55,58 * * * * blahblah', @output
+    end
+  end
+
+  context "every 2 minutes but starting at 27" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.minutes, :at => 27 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59 * * * * blahblah', @output
+    end
+  end
+end