moneypools-whenever 0.1.0

data/test/output_at_test.rb

@@ -0,0 +1,180 @@
+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
+        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
+        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
+        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
+        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
+        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 :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 /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 :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 /usr/bin/env rake blah:blah', @output
+    end
+  end
+  
+  context "A command every 1.month at very diverse times" do
+    setup do
+      Timecop.freeze(Date.new(2009, 1, 1)) do
+        @output = Whenever.cron \
+        <<-file
+          every [1.month, 1.day], :at => 'beginning of the month at 5:02am, june 17th at 2:22pm, june 3rd at 3:33am' do
+            command "blahblah"
+          end
+        file
+      end
+    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
+        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 :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 /usr/bin/env rake blah:blah', @output
+      assert_match '@daily /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 command_2', @output
+    end
+  end
+  
+end

data/test/output_cap_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputCapTest < 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
+          cap "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 cap blahblah', @output
+    end
+  end
+end

data/test/output_command_test.rb

@@ -0,0 +1,37 @@
+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 "An every statement with two commands in it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 1.hour do
+          command "first"
+          command "second"
+        end
+      file
+    end
+
+    should "output both commands" do
+      assert_match "0 * * * * first", @output
+      assert_match "0 * * * * second", @output
+    end
+  end
+    
+end

data/test/output_env_test.rb

@@ -0,0 +1,56 @@
+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
+  
+  context "No PATH environment variable set" do
+    setup do
+      Whenever::JobList.any_instance.expects(:read_path).at_least_once.returns('/usr/local/bin')
+      @output = Whenever.cron ""
+    end
+    
+    should "add a PATH variable based on the user's PATH" do
+      assert_match "PATH=/usr/local/bin", @output
+    end
+  end
+  
+  context "A PATH environment variable set" do
+    setup do
+      Whenever::JobList.stubs(:read_path).returns('/usr/local/bin')
+      @output = Whenever.cron "env :PATH, '/my/path'"
+    end
+    
+    should "use that path and the user's PATH" do
+      assert_match "PATH=/my/path", @output
+      assert_no_match /local/, @output
+    end
+  end
+  
+  context "No PATH set and instructed not to automatically load the user's path" do
+    setup do
+      @output = Whenever.cron "set :set_path_automatically, false"
+    end
+    
+    should "not have a PATH set" do
+      assert_no_match /PATH/, @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_redirection_test.rb

@@ -0,0 +1,319 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputRedirectionTest < Test::Unit::TestCase
+
+  context "A command when the output is set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, nil
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+  
+    should "output the command with the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2>&1$/, @output
+    end
+  end
+
+
+  context "A command when the output is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, '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 error and standard output is set by the command" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:standard => 'dev_null', :error => 'dev_err'}
+        end
+      file
+    end
+
+    should "output the command without the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2> dev_err$/, @output
+    end
+  end
+
+  context "A command when the output is set and the comand overrides it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :output => 'otherlog.log'
+        end
+      file
+    end
+  
+    should "output the command with the command 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 output is set and the comand overrides with standard and error" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :output => {:error => 'dev_err', :standard => 'dev_null' }
+        end
+      file
+    end
+  
+    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
+    end
+  end
+
+  context "A command when the output is set and the comand rejects it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :output => 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
+
+  context "A command when the output is set and is overridden by the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'output=otherlog.log', :string => \
+      <<-file
+        set :output, 'logfile.log'
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the otherlog.log as the log file" 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 error and standard output is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, {:error => 'dev_err', :standard => 'dev_null' }
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command without the redirection syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_null 2> dev_err$/, @output
+    end
+  end
+
+  context "A command when error output is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, {:error => 'dev_null'}
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command without the standard errror syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah 2> dev_null$/, @output
+    end
+  end
+
+  context "A command when the standard output is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :output, {:standard => 'dev_out'}
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command with standard output syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_out$/, @output
+    end
+  end
+
+  context "A command when error output is set by the command" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:error => 'dev_err'}
+        end
+      file
+    end
+
+    should "output the command without the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah 2> dev_err$/, @output
+    end
+  end
+
+  context "A command when standard output is set by the command" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:standard => 'dev_out'}
+        end
+      file
+    end
+
+    should "output the command without the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> dev_out$/, @output
+    end
+  end
+
+  context "A command when standard output is set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:standard => nil}
+        end
+      file
+    end
+
+    should "output the command with stdout directed to /dev/null" do
+      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null$/, @output
+    end
+  end
+
+  context "A command when standard error is set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:error => nil}
+        end
+      file
+    end
+
+    should "output the command with stderr directed to /dev/null" do
+      assert_match /^.+ .+ .+ .+ blahblah 2> \/dev\/null$/, @output
+    end
+  end
+
+  context "A command when standard output and standard error is set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:error => nil, :standard => nil}
+        end
+      file
+    end
+
+    should "output the command with stderr directed to /dev/null" do
+      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2>&1$/, @output
+    end
+  end
+
+  context "A command when standard output is set and standard error is set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:error => nil, :standard => 'my.log'}
+        end
+      file
+    end
+
+    should "output the command with stderr directed to /dev/null" do
+      assert_match /^.+ .+ .+ .+ blahblah >> my.log 2> \/dev\/null$/, @output
+    end
+  end
+
+  context "A command when standard output is nil and standard error is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => {:error => 'my_error.log', :standard => nil}
+        end
+      file
+    end
+
+    should "output the command with stderr directed to /dev/null" do
+      assert_match /^.+ .+ .+ .+ blahblah >> \/dev\/null 2> my_error.log$/, @output
+    end
+  end
+  
+  context "A command when standard error should be redirected to standard output" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => :stdout
+        end
+      file
+    end
+
+    should "output the command with stderr directed to stdout" do
+      assert_match /^.+ .+ .+ .+ blahblah 2>&1$/, @output
+    end
+  end
+  
+  context "A command when standard output should be redirected to standard error" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah", :output => :stderr
+        end
+      file
+    end
+
+    should "output the command with stdout directed to stderr" do
+      assert_match /^.+ .+ .+ .+ blahblah 1>&2$/, @output
+    end
+  end
+
+  context "A command when the deprecated :cron_log is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, "cron.log"
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command with with the stdout and stderr going to the log" do
+      assert_match /^.+ .+ .+ .+ blahblah >> cron.log 2>&1$/, @output
+    end
+  end
+end