Permalink
Browse files

Tests passing means a good time to commit

  • Loading branch information...
1 parent d9af5aa commit a0caf67d78f7805f20886956c1a6febd0443475f Jacob Harris committed Apr 13, 2010
Showing with 455 additions and 25 deletions.
  1. +199 −18 LICENSE
  2. +19 −1 README.rdoc
  3. +4 −3 Rakefile
  4. +132 −0 lib/lifeline.rb
  5. +1 −0 test/helper.rb
  6. +100 −3 test/test_lifeline.rb
View
@@ -1,20 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
Copyright (c) 2009 The New York Times
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
View
@@ -1,6 +1,24 @@
= lifeline
-Description goes here.
+Methods for creating lifeline tasks. This allows you to write cron jobs that
+restart processes that die while ensuring the code is only executing only once
+(avoiding the duplication that sometimes happens using the 'daemons') gem.
+Both a generic lifeline method is provided as well as methods to create 3
+lifeline rake tasks for managing lifelines.
+
+== The Lifeline Approach
+
+== Examples
+
+ Lifeline.lifeline do
+ # some code you want to run in only a single process
+ end
+
+ Lifeline.define_lifeline_tasks("appname") do
+ # some code you want to run in a single lifeline
+ end
+
+ > rake -T appname
== Note on Patches/Pull Requests
View
@@ -6,12 +6,13 @@ begin
Jeweler::Tasks.new do |gem|
gem.name = "lifeline"
gem.summary = %Q{A cron-based alternative to running daemon scripts}
- gem.description = %Q{TODO: longer description of your gem}
+ gem.description = %Q{A cron-based alternative to running daemon scripts}
gem.email = "open@nytimes.com"
gem.homepage = "http://github.com/harrisj/lifeline"
- gem.authors = ["The New York Times"]
- gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+ gem.authors = ["Jacob Harris", "Ben Koski", "Matt Todd"]
+ gem.add_development_dependency "shoulda", ">= 0"
gem.add_development_dependency "yard", ">= 0"
+ gem.add_development_dependency "mocha", ">= 0"
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
end
Jeweler::GemcutterTasks.new
View
@@ -0,0 +1,132 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Lifeline
+ ##
+ # @private
+ def get_process_list
+ processes = %x{ps ax -o pid,command}
+
+ return nil if processes.nil?
+
+ processes.split(/\n/).map do |p|
+ if p =~ /^(\d+)\s(.+)$/
+ {:pid => $1.to_i, :command => $2.strip}
+ end
+ end.compact
+ end
+
+ ##
+ # A method for executing a block of code only if there is no other process with the same command running. This is useful if you want
+ # to have a perpetually running daemon that only executes once at a time. It uses the process name returned by ps ax to see if there is
+ # a process with the same command name but a different PID already executing. If so, it terminates without running the block. NOTE: since it
+ # uses the command name returned from <tt>ps ax</tt>, it us up to to you to name the process containing this code with a distinctly unique name. If two
+ # separate Rails projects both have a <tt>rake lifeline</tt> task they WILL interfere with each other. I'd suggest prefixing with the project name (ie,
+ # <tt>doc_viewer:lifeline</tt>) to be sure
+ #
+ # @param &block a block which is executed if there is not already a lifeline running.
+ # @raise [ArgumentError] if you do not pass in a block argument
+ def lifeline
+ if !block_given?
+ raise ArgumentError, "You must pass in a block to be the body of the run rake task"
+ end
+
+ my_pid = $$
+ processes = get_process_list
+
+ if processes.nil? || processes.empty?
+ raise "No processes being returned by get_process_list. Aborting!"
+ end
+
+ myself = processes.detect {|p| p[:pid] == my_pid}
+ if myself.nil?
+ raise "Unable to find self in process list. This is bizarre to say the least. Exiting"
+ end
+
+ # there isn't already another process running with the same command
+ if !processes.any? {|p| p[:pid] != my_pid && p[:command] == myself[:command]}
+ yield
+ end
+ end
+
+ # Define rake tasks for running, starting, and terminating
+ class LifelineRakeTask < ::Rake::TaskLib
+ # The namespace to define the tasks in
+ # @return [String] the namespace for the tasks
+ attr_accessor :namespace
+
+ ##
+ # Creates 3 new tasks for the lifeline in the namespace specified. These
+ # tasks are
+ # * run - a task for running the code provided in the block
+ # * lifeline - a lifeline task for running the run task if it's not already running
+ # * terminate - a task for terminating all lifelines.
+ #
+ # @param [String, Symbol] name the namespace of the rake tasks
+ # @param [optional, Hash] opts Additional options for the method
+ # @option opts [Array<String, Symbol>] :prereqs ([]) If there any any rake tasks that should be prerequisites of the :run task, specify them here (For Rails, you would do :prereqs => :environment)
+ # @param a block that defines the body of the run task
+ def initialize(namespace, opts={}, &block)
+ if !block_given?
+ raise ArgumentError, "You must pass in a block to be the body of the run rake task"
+ end
+
+ @namespace = namespace
+
+ define_run_task(opts, &block)
+ define_lifeline_task
+ define_terminate_task
+ end
+
+ protected
+
+ def run_task_name
+ "#{namespace}:run"
+ end
+
+ def define_run_task(opts={}, &block)
+ desc "Runs the #{namespace}:run task"
+
+ task_arg = if opts[:prereqs]
+ {run_task_name => opts[:prereqs]}
+ else
+ run_task_name
+ end
+
+ task(task_arg, &block)
+ end
+
+ def define_lifeline_task
+ desc "A lifeline task for executing only one process of #{namespace}:run at a time"
+ task("#{namespace}:lifeline") do
+ lifeline do
+ Rake::Task["#{namespace}:run"].invoke
+ end
+ end
+ end
+
+ def define_terminate_task
+ desc "Terminates any running #{namespace}:lifeline tasks"
+ task("#{namespace}:terminate") do
+ unless (process = %x{ps aux | grep "#{namespace}:lifeline" | grep ruby | grep -v grep}.chomp).empty?
+ runner_pid = process.gsub(/(\s+)/, ' ').split(' ')[1]
+ puts %x{kill -9 #{runner_pid}}
+ end
+ end
+ end
+ end
+
+ ##
+ # A method that defines 3 rake tasks for doing lifelines:
+ # * <tt>namespace:run</tt> runs the specified block
+ # * <tt>namespace:lifeline</tt> a lifeline for executing only a single copy of <tt>namespace:run</tt> at a time
+ # * <tt>namespace:terminate</tt> a task for terminating the lifelines
+ #
+ # @param [String,Symbol] namespace the namespace to define the 3 tasks in
+ # @param &block a block which defines the body of the namespace:run method
+ #
+ # @raise [ArgumentError] if you do not pass in a block argument
+ def define_lifeline_tasks(namespace, &block)
+ LifelineRakeTask.new(namespace, &block)
+ end
+end
Oops, something went wrong. Retry.

0 comments on commit a0caf67

Please sign in to comment.