whenever 0.4.1 → 0.5.2

data/test/functional/command_line_test.rb

@@ -0,0 +1,288 @@
+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
+
+      @command.expects(:read_crontab).at_least_once.returns(existing)
+      
+      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
+      
+      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 delete" 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 "add an empty identifier block if there is no existing one" do
+      existing = '# Existing crontab'
+      @command.expects(:read_crontab).at_least_once.returns(existing)
+      
+      new_cron = <<-EXPECTED
+#{existing}
+
+# Begin Whenever generated tasks for: My identifier
+# 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 "delete 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: My identifier
+# 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
+      
+      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 :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 :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 :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 :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
+
+      # here-doc adds an extra newline we need removed
+      assert_equal existing.strip, @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
+
+      # here-doc adds an extra newline we need removed
+      assert_equal new_cron.strip, @command.send(:prepare, existing)
+    end
+  end
+
+end

data/test/{output_at_test.rb → functional/output_at_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class OutputAtTest < Test::Unit::TestCase
   
@@ -91,7 +91,7 @@ class OutputAtTest < Test::Unit::TestCase
     end
     
     should "output the runner using one entry because the times are aligned" do
-      assert_match '2 5,15 * * 1,3,5 /your/path/script/runner -e production "blahblah"', @output
+      assert_match %(2 5,15 * * 1,3,5 cd /your/path && script/runner -e production 'blahblah'), @output
     end
   end
   
@@ -168,11 +168,70 @@ class OutputAtTest < Test::Unit::TestCase
     
     should "output all of the commands @daily" do
       assert_match '@daily cd /your/path && RAILS_ENV=production /usr/bin/env rake blah:blah', @output
-      assert_match '@daily /your/path/script/runner -e production "runner_1"', @output
+      assert_match %(@daily cd /your/path && script/runner -e production 'runner_1'), @output
       assert_match '@daily command_1', @output
-      assert_match '@daily /your/path/script/runner -e production "runner_2"', @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
+        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
+        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
+        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
+        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

data/test/{output_rake_test.rb → functional/output_default_defined_jobs_test.rb}

@@ -1,47 +1,64 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
-class OutputRakeTest < Test::Unit::TestCase
+class OutputDefaultDefinedJobsTest < 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
+  # command
   
-  context "A rake command with path set" do
+  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
+  
+  # runner
+  
+  context "A runner with path set" do
     setup do
       @output = Whenever.cron \
       <<-file
         set :path, '/my/path'
         every 2.hours do
-          rake "blahblah"
+          runner '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
+    should "output the runner using that path" do
+      assert_match two_hours + %( cd /my/path && script/runner -e production 'blahblah'), @output
     end
   end
   
-  context "A rake command that overrides the path set" do
+  context "A runner 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'
+          runner "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
+    should "output the runner using that path" do
+      assert_match two_hours + %( cd /some/other/path && script/runner -e production 'blahblah'), @output
     end
   end
   
-  context "A rake command with environment set" do
+  # rake
+  
+  context "A rake command with path set" do
     setup do
       @output = Whenever.cron \
       <<-file
-        set :environment, :silly
         set :path, '/my/path'
         every 2.hours do
           rake "blahblah"
@@ -49,25 +66,24 @@ class OutputRakeTest < Test::Unit::TestCase
       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
+    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 environment set" do
+  context "A rake command that overrides the path set" do
     setup do
       @output = Whenever.cron \
       <<-file
-        set :environment, :silly
         set :path, '/my/path'
         every 2.hours do
-          rake "blahblah", :environment => :serious
+          rake "blahblah", :path => '/some/other/path'
         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
+    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
   

data/test/functional/output_defined_job_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class OutputDefinedJobTest < Test::Unit::TestCase
+  
+  context "A defined job with a :task" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after"
+        every 2.hours do
+          some_job "during"
+        end
+      file
+    end
+    
+    should "output the defined job with the task" do
+      assert_match /^.+ .+ .+ .+ before during after$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and some options" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1 :option2"
+        every 2.hours do
+          some_job "during", :option1 => 'happy', :option2 => 'birthday'
+        end
+      file
+    end
+    
+    should "output the defined job with the task and options" do
+      assert_match /^.+ .+ .+ .+ before during after happy birthday$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option where the option is set globally" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        set :option1, 'happy'
+        every 2.hours do
+          some_job "during"
+        end
+      file
+    end
+    
+    should "output the defined job with the task and options" do
+      assert_match /^.+ .+ .+ .+ before during after happy$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option where the option is set globally and locally" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        set :option1, 'global'
+        every 2.hours do
+          some_job "during", :option1 => 'local'
+        end
+      file
+    end
+    
+    should "output the defined job using the local option" do
+      assert_match /^.+ .+ .+ .+ before during after local$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option that is not set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        every 2.hours do
+          some_job "during", :option2 => 'happy'
+        end
+      file
+    end
+    
+    should "output the defined job with that option removed" do
+      assert_match /^.+ .+ .+ .+ before during after$/, @output
+    end
+  end
+  
+  context "A defined job that uses a :path where none is explicitly set" do
+    setup do
+      Whenever.expects(:path).returns('/my/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "cd :path && :task"
+        every 2.hours do
+          some_job 'blahblah'
+        end
+      file
+    end
+    
+    should "default to using the Whenever.path" do
+      assert_match two_hours + %( cd /my/path && blahblah), @output
+    end
+  end
+
+end

data/test/{output_env_test.rb → functional/output_env_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class OutputEnvTest < Test::Unit::TestCase
 

data/test/{output_redirection_test.rb → functional/output_redirection_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class OutputRedirectionTest < Test::Unit::TestCase
 
@@ -46,7 +46,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command without the log syntax appended" do
-      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2> dev_err$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2>> dev_err$/, @output
     end
   end
 
@@ -80,7 +80,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
   
     should "output the command with the overridden redirection syntax appended" do
       assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
-      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2> dev_err$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2>> dev_err$/, @output
     end
   end
 
@@ -130,7 +130,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command without the redirection syntax appended" do
-      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2> dev_err$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2>> dev_err$/, @output
     end
   end
 
@@ -145,8 +145,8 @@ class OutputRedirectionTest < Test::Unit::TestCase
       file
     end
 
-    should "output the command without the standard errror syntax appended" do
-      assert_match /^.+ .+ .+ .+ blahblah 2> dev_null$/, @output
+    should "output the command without the standard error syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah 2>> dev_null$/, @output
     end
   end
 
@@ -177,7 +177,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command without the log syntax appended" do
-      assert_match /^.+ .+ .+ .+ blahblah 2> dev_err$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah 2>> dev_err$/, @output
     end
   end
 
@@ -207,7 +207,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command with stdout directed to /dev/null" do
-      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah > \/dev\/null$/, @output
     end
   end
 
@@ -237,7 +237,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command with stderr directed to /dev/null" do
-      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2>&1$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah > \/dev\/null 2>&1$/, @output
     end
   end
 
@@ -267,7 +267,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     end
 
     should "output the command with stderr directed to /dev/null" do
-      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2> my_error.log$/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2>> my_error.log$/, @output
     end
   end
 
@@ -286,4 +286,4 @@ class OutputRedirectionTest < Test::Unit::TestCase
       assert_match /^.+ .+ .+ .+ blahblah >> cron.log 2>&1$/, @output
     end
   end
-end
+end