crontest 0.1.0

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2010, Ari Russo
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of its contributors may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.org

@@ -0,0 +1,54 @@
+#+COMMENT: -*- org -*-
+#+TITLE:     crontest
+#+AUTHOR:    Ari Russo
+#+DATE:      2010-10-28 Wed
+#+TEXT: ruby command line tool/library for testing cron jobs
+#+KEYWORDS: cron, crontest, cron-test, crontab, linux, unix, test, tasks, jobs 
+#+LANGUAGE:  en
+#+LINK_HOME: http://github.com/arirusso/crontest
+
+* Summary
+
+Ruby libary and command line tool for testing cron jobs.
+
+* Description
+
+Execute an (almost) immediate and transient cron job using the same environment that is used to run your user's crontab.
+
+* Requires
+
+	- [[http://github.com/soveran/clap][clap]]  
+	
+* Usage
+
+	: gem install crontest
+
+to run crontest from the command line:
+
+	: crontest 'echo hello! > MY_CRON_TEST.txt' &
+	
+or, to call from another ruby program
+
+	: require 'crontest'
+	: Crontest.run("echo hello! > MY_CRON_TEST.txt")
+	
+these will both run =echo hello! > MY_CRON_TEST.txt= as a cron job.  it can take up to a minute to run as cron's timing resolution is one minute.
+
+crontest will create a backup file of your current crontab (cron-backup-[timestamp]) in the directory where directory you run it, and then restore it. 
+
+Options:
+
+pass in options from the command line or Crontest.run(command, options)
+
+: --no-backup 
+: -n
+: :backup => false 
+no backup file
+
+: -v
+: :verbose => true
+verbose output 
+
+* Caution
+
+I highly encourage you to keep a separate backup of your crontab before trying this tool as it is brand new and relatively untested.

data/bin/crontest

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'clap'
+require 'crontest'
+
+opts = {}
+
+args = Clap.run ARGV,
+   "--no-backup" => lambda { || opts[:backup] = false },
+   "-n" => lambda { || opts[:backup] = false },
+   "-v" => lambda { || opts[:verbose] = true }
+  
+command = args.first or raise "no command specified"
+ 
+Crontest.run(command, opts)

data/lib/crontest.rb

@@ -0,0 +1,115 @@
+module Crontest
+  
+  VERSION = "0.1.0"
+  
+  def self.run(command, opts = {})    
+    Process.new(command, opts).run  
+  end
+  
+  class CrontabFile
+  
+    attr_reader :path, :contents
+  
+    # create temp file with current cron + new cron task in it using current time + @offset second offset
+    def initialize(path)
+      @contents = Crontest::CrontabHelper.current_crontab
+      @path = path
+      File.open(@path, 'w') {|f| f.write(@contents) }
+    end
+  
+    # deletes the file
+    def delete
+      File.delete(@path)
+    end
+
+  end
+  
+  class CrontabHelper
+
+    def self.cronify(command)
+      "* * * * * #{command}"
+    end
+  
+    def self.activate(text, time)
+      if text.chomp.eql?('') 
+        %x[crontab -r]
+      else
+        tmpfile = "/tmp/cron-#{time}"
+        %x[echo \"#{text}\" >> #{tmpfile}]
+        %x[crontab #{tmpfile}]
+        result = system("crontab #{tmpfile}") # to get the result type - is there a better way to do this?
+        %x[rm #{tmpfile}]
+        result
+      end
+    end
+  
+    # get current crontab
+    def self.current_crontab
+      %x[crontab -l]
+    end 
+  
+  end
+  
+  class Process
+    
+    def initialize(command, opts = {})
+      @do_backup = opts[:backup] || true
+      @verbose = opts[:verbose] || false
+      @command = command
+    end
+    
+    def run
+      raise "current directory must be writable" unless pwd_writable?
+      
+      crontab_on_enter = CrontabHelper.current_crontab
+      time = Time.now.strftime('%Y%m%d%H%M%S')
+      @backup = CrontabFile.new("crontab-backup-#{time}")
+      
+      new_crontab = @backup.contents + CrontabHelper.cronify(@command)
+      out("testing command #{new_crontab}")
+      CrontabHelper.activate(new_crontab, time) || crontab_on_enter.eql?(CrontabHelper.current_crontab) or 
+        quit_with_error("command not accepted by cron")
+      
+      wait_time = calc_wait_time
+      out("test will run in #{wait_time} seconds", true)
+      sleep(wait_time)
+      
+      CrontabHelper.activate(@backup.contents, time) # restore to original crontab
+      
+      unless crontab_on_enter.eql?(CrontabHelper.current_crontab)
+        quit_with_error("restored crontab doesn't match original")
+      end
+      
+      cleanup(@do_backup)
+
+      out('finished', true)
+    end
+    
+    private
+
+    def cleanup(keep_backup)
+      keep_backup ? 
+        out("saved backup file #{Dir.pwd}/#{@backup.path}") :
+	  @backup.delete
+    end
+    
+    def calc_wait_time
+      2 + (60 - Time.now.strftime('%S').to_i)
+    end
+    
+    def out(text, always_show = false)
+      STDOUT.puts("crontest: #{text}") if (@verbose || always_show)
+    end
+    
+    def quit_with_error(error)
+      cleanup(true)
+      raise error
+    end
+    
+    def pwd_writable?
+      File.writable?('.')
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: crontest
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ari Russo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-02 00:00:00 -04:00
+default_executable: crontest
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: clap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: clap
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: ruby command line tool/library for testing cron jobs
+email: 
+- ari.russo@gmail.com
+executables: 
+- crontest
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/crontest
+- lib/crontest.rb
+- LICENSE
+- README.org
+has_rdoc: true
+homepage: http://github.com/arirusso/crontest
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Execute an (almost) immediate and transient cron job
+test_files: []
+