pidlock 0.0.2

data/README.mkd

@@ -0,0 +1,24 @@
+# Pidlock
+
+[![Build Status](https://secure.travis-ci.org/abangratz/pidlock.png)](http://travis-ci.org/abangratz/pidlock)
+
+This is a ruby library for using pid-file based locking of programs/daemons to prevent multiple parallel running tasks.
+
+## Prerequisites
+
+The gem ``sys/proctable`` is required.
+
+## Usage
+
+```ruby
+require 'sys/proctable'
+
+Pidlock.new('my.pid').lock # tries to create a lock file '/var/run/my.pid';
+                           # raises an error if the file is locked or a program exists that 
+                           # has the same basename and pid (here: 'my')
+...
+```
+
+## TODO
+
+Lots still. First release.

data/lib/pidlock.rb

@@ -0,0 +1,31 @@
+class Pidlock
+
+
+  class FileLockedException < Exception; end
+  class ProcessRunning < Exception; end
+  def initialize(name)
+    @name = File.basename(name)
+    @filename = File.join('/', 'var', 'run', @name)
+  end
+
+  def lock
+    unless @file
+      unless (File.writable?(File.dirname(@filename)))
+        @filename = File.join('/', 'tmp', @name)
+      end
+      @file = File.open(@filename, 'w+') 
+      if (old_pid = @file.gets)
+        if (old_process = Sys::ProcTable.ps(old_pid.chomp.to_i))
+          raise ProcessRunning if old_process.comm == File.basename(@name, File.extname(@name))
+        else
+          STDERR.puts "WARNING: resetting stale lockfile"
+          @file.rewind
+        end
+      end
+      @file.flock(File::LOCK_EX | File::LOCK_NB) or raise FileLockedException
+      @file.write Process.pid
+      @file.flush
+    end
+  end
+
+end

data/spec/lib/pidlock_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Pidlock do
+  before(:each) do
+    @file = stub(File)
+    @file.stub(:flock)
+    @file.stub(:write)
+    @file.stub(:flock => 0)
+    @file.stub(:flush)
+    @file.stub(:gets)
+    File.stub(:open).with('/var/run/my.pid', 'w+').and_return(@file)
+    File.stub(:writable?).with('/var/run').and_return(true)
+  end
+  it "should create a file with the given name in /var/run" do
+    Pidlock.new('my.pid').lock
+  end
+  context "filehandling" do
+    before(:each) do
+      Process.stub(:pid).and_return(666)
+    end
+    it "should write the current pid to the file" do
+      @file.should_receive(:write).with(666)
+      Pidlock.new('my.pid').lock
+    end
+
+    it "should try to lock the file" do
+      @file.should_receive(:flock).with( File::LOCK_EX | File::LOCK_NB).and_return(0)
+      Pidlock.new('my.pid').lock
+    end
+
+    it "should raise if the lock does not succeed" do
+      @file.should_receive(:flock).with( File::LOCK_EX | File::LOCK_NB).and_return(false)
+      lambda {
+        Pidlock.new('my.pid').lock
+      }.should raise_error Pidlock::FileLockedException
+    end
+
+    it "should check if the program name matches the id" do
+      @file.should_receive(:gets).and_return('666')
+      ps = stub("ProcTableStruct", :comm => 'test')
+      ::Sys::ProcTable.should_receive(:ps).with(666).and_return(ps)
+      Pidlock.new('my.pid').lock
+    end
+    it "should raise if the program name does match the pid" do
+      @file.should_receive(:gets).and_return('666')
+      ps = stub("ProcTableStruct", :comm => 'my')
+      ::Sys::ProcTable.should_receive(:ps).with(666).and_return(ps)
+      lambda {
+        Pidlock.new('my.pid').lock
+      }.should raise_error Pidlock::ProcessRunning
+    end
+
+    it "should use /tmp if /var/run is not writeable" do
+      File.should_receive(:writable?).with('/var/run').and_return(false)
+      File.should_receive(:open).with('/tmp/my.pid', 'w+').and_return(@file)
+      Pidlock.new('my.pid').lock
+
+    end
+    it "should warn but continue if the file exists but the process name does not" do
+      @file.should_receive(:gets).and_return('667')
+      ps = stub("ProcTableStruct", :comm => 'test')
+      ::Sys::ProcTable.should_receive(:ps).with(667).and_return(nil)
+      STDERR.should_receive(:puts).with('WARNING: resetting stale lockfile')
+      @file.should_receive(:rewind)
+      @file.should_receive(:write).with(666)
+      Pidlock.new('my.pid').lock
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$: << '.'
+require 'bundler/setup'
+Bundler.setup(:default, :development)
+require 'stringio'
+
+require 'sys/proctable'
+require 'lib/pidlock'
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: pidlock
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Anton Bangratz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: &16613480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *16613480
+description: Used for locking processes via PID and file (daemon style).
+email: anton.bangratz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.mkd
+files:
+- lib/pidlock.rb
+- spec/lib/pidlock_spec.rb
+- spec/spec_helper.rb
+- README.mkd
+homepage: https://github.com/abangratz/pidlock
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Using PID/file locking for daemons and long running tasks made easy.
+test_files: []