technicalpickles-whenever 0.3.7

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_lockrun_test.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputLockrunTest < Test::Unit::TestCase
+
+  context "A lockrun on a command" do
+    setup do
+      
+      @output = Whenever.cron \
+        <<-file
+          set :path, '/some/directory'
+          every 2.hours do
+            command "blahblah", :lockrun => true
+          end
+      file
+    end
+
+    should "output the command wrapped by lockrun with the default lockfile" do
+      assert_match two_hours + %Q{ /usr/bin/env lockrun --lockfile=/some/directory/log/default.lockrun -- sh -c "blahblah"}, @output
+    end
+  end
+
+  context "A lockrun on a rake task" do
+    setup do
+      @output = Whenever.cron \
+        <<-file
+          set :path, '/my/super/directory'
+          every 2.hours do
+            rake "blahblah", :lockrun => true
+          end
+      file
+    end
+
+    "cd #{@path} && RAILS_ENV=#{@environment} /usr/bin/env rake #{task}"
+
+    should "output the command wrapped by lockrun with the default lockfile" do
+      assert_includes %Q{#{two_hours} /usr/bin/env lockrun --lockfile=/my/super/directory/log/default.lockrun -- sh -c "cd /my/super/directory && RAILS_ENV=production /usr/bin/env rake blahblah"}, @output
+    end
+  end
+
+  context "A lockrun on a runner" do
+    setup do
+      @output = Whenever.cron \
+        <<-file
+          set :path, '/my/directory'
+          every 2.hours do
+            runner "blahblah", :lockrun => true
+          end
+      file
+    end
+
+    should "output the command wrapped by lockrun with the default lockfile" do
+      assert_includes %Q{#{two_hours} /usr/bin/env lockrun --lockfile=/my/directory/log/default.lockrun -- sh -c "/my/directory/script/runner -e production \"blahblah\""}, @output
+    end
+  end
+
+  context "A lockrun with a custom lockfile" do
+    setup do
+      @output = Whenever.cron \
+        <<-file
+          set :path, '/some/directory'
+          every 2.hours do
+            command "blahblah", :lockrun => "zomg"
+          end
+      file
+    end
+
+    should "output the command wrapped by lockrun with the zomg lockfile" do
+      assert_includes %Q{#{two_hours} /usr/bin/env lockrun --lockfile=/some/directory/log/zomg.lockrun -- sh -c "blahblah"}, @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,209 @@
+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
+  
+  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 + ' /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 + ' /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 + ' /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 + ' /silly/path/script/runner -e silly "blahblah"', @output
+    end
+  end
+  
+  context "A runner which makes use of double quotes" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner 'Product.import("http://example.com/product.xml")'
+        end
+      file
+    end
+    
+    should "output the runner using the original environmnet" do
+      assert_match two_hours + ' /my/path/script/runner -e production "Product.import(\"http://example.com/product.xml\")"', @output
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,56 @@
+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 'redgreen'
+rescue LoadError
+end
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+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
+
+  def assert_includes(substring, string)
+    message = build_message message, "<?>\n\ndoes not include:\n\n <?>.", string, substring
+    assert_block message do
+      string.include? substring
+    end
+  end
+
+  def cron(string)
+    assert_nothing_raised do
+      Whenever.cron string
+    end
+  end
+  
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end