pidlock 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2471de94b25e794aa754db7b6ce0f31b6600b1f0
+  data.tar.gz: a3c7c1d857ea226924f16ac18075b2b8551de2e8
+SHA512:
+  metadata.gz: 88dd41c285f7734d26bd7b9a0e8dfffce7416a7335fd6cb187bac1f104416e319e9d5dd37ae822a64c4a69925d227b7e091a01a0c00f0a7fd090e9739f034d7d
+  data.tar.gz: 951f0bcf0c69b2aaeabef0077adafb794dfe0bce94eb2a0f3711e1cedfdf7b5f372a0da9a6b23fd77345d2e868671e11fd0b66ad71a58cb01d319b7034f2fe3a

data/README.mkd

@@ -1,6 +1,6 @@
 # Pidlock
 
-[![Build Status](https://secure.travis-ci.org/abangratz/pidlock.png)](http://travis-ci.org/abangratz/pidlock)
+[![Build Status](https://travis-ci.org/abangratz/pidlock.png?branch=master)](https://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.
 
@@ -13,12 +13,24 @@ The gem ``sys/proctable`` is required.
 ```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')
+pidlock = Pidlock.new('my.pid')   # Instantiates a lock
+pidlock.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')
 ...
+pidlock.unlock                    # closes and removes the file
 ```
 
 ## TODO
 
-Lots still. First release.
+* test unlocking in projects.
+
+
+## LICENSE
+
+[ISC License](LICENSE)
+
+
+## CONTRIBUTORS
+
+  - Greg Whiteley (https:/github/com/whitty)

data/lib/pidlock.rb

@@ -13,6 +13,7 @@ class Pidlock
     @name = File.basename(name)
     @filename = File.expand_path(File.join('/', 'var', 'run', dir, @name))
     @logger = Logger.new(STDERR)
+    @file = nil
   end
 
 
@@ -28,10 +29,11 @@ class Pidlock
           raise ProcessRunning if old_process.comm == File.basename(@name, File.extname(@name))
         else
           @logger.warn "WARNING: resetting stale lockfile"
-          @file.rewind
         end
       end
       @file.flock(File::LOCK_EX | File::LOCK_NB) or raise FileLockedException
+      @file.rewind
+      @file.truncate(0)
       @file.write Process.pid
       @file.flush
     end

data/spec/lib/pidlock_filesystem_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe "Pidlock", :filesystem => true do
+  let(:logger) { mock(Logger) }
+
+  context "filesystem testing" do
+    before(:each) do
+      Logger.stub!(:new => logger)
+
+      path = Pathname(File.writable?('/var/run') ? '/var/run' : '/tmp')
+      @pid_name = 'my.pid'
+      @pid_file = path + @pid_name
+      File.unlink(@pid_file) if @pid_file.exist?
+
+      Process.stub(:pid).and_return(666)
+      logger.stub!(:warn)
+    end
+
+    after(:each) do
+      File.unlink(@pid_file) if @pid_file.exist?
+    end
+
+    it "enters the correct PID in the pidfile" do
+
+      Pidlock.new(@pid_name).lock
+      @pid_file.should exist
+
+      File.read(@pid_file).should eq('666')
+    end
+
+    it "cleans up the PID in the pidfile" do
+
+      pidlock = Pidlock.new(@pid_name)
+      pidlock.lock
+      @pid_file.should exist
+
+      File.read(@pid_file).should eq('666')
+      pidlock.unlock
+
+      @pid_file.should_not exist
+    end
+
+    it "enters the correct PID in the pidfile when the pidfile is stale" do
+      # start with a stale PID in the file
+      open(@pid_file, "w") {|f| f.write('1111') }
+      File.read(@pid_file).should eq('1111')
+      ::Sys::ProcTable.should_receive(:ps).with(1111).and_return(nil)
+      logger.should_receive(:warn).with('WARNING: resetting stale lockfile')
+
+      Pidlock.new(@pid_name).lock
+      @pid_file.should exist
+
+      File.read(@pid_file).should eq('666')
+    end
+
+    it "enters the correct PID in the pidfile when the pid matches a different process" do
+      # start with a stale PID in the file
+      open(@pid_file, "w") {|f| f.write('1111') }
+      File.read(@pid_file).should eq('1111')
+      ps = stub("ProcTableStruct", :comm => 'other')
+      ::Sys::ProcTable.should_receive(:ps).with(1111).and_return(ps)
+
+      Pidlock.new(@pid_name).lock
+      @pid_file.should exist
+
+      File.read(@pid_file).should eq('666')
+    end
+
+  end
+
+end

data/spec/lib/pidlock_spec.rb

@@ -9,6 +9,8 @@ describe Pidlock do
     @file.stub(:flock => 0)
     @file.stub(:flush)
     @file.stub(:gets)
+    @file.stub(:rewind)
+    @file.stub(:truncate)
     File.stub(:open).with('/var/run/my.pid', File::RDWR|File::CREAT, 0600).and_return(@file)
     File.stub(:writable?).with('/var/run').and_return(true)
     Logger.stub!(:new => logger)
@@ -66,21 +68,21 @@ describe Pidlock do
     end
     it "warns 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)
       logger.should_receive(:warn).with('WARNING: resetting stale lockfile')
       @file.should_receive(:rewind)
+      @file.should_receive(:truncate).with(0)
       @file.should_receive(:write).with(666)
       Pidlock.new('my.pid').lock
     end
     it "should use a logger if injected" do
       logger2 = mock(Logger)
       @file.should_receive(:gets).and_return('667')
-      ps = stub("ProcTableStruct", :comm => 'test')
       ::Sys::ProcTable.should_receive(:ps).with(667).and_return(nil)
       logger.should_not_receive(:warn).with('WARNING: resetting stale lockfile')
       logger2.should_receive(:warn).with('WARNING: resetting stale lockfile')
       @file.should_receive(:rewind)
+      @file.should_receive(:truncate).with(0)
       @file.should_receive(:write).with(666)
       pidlock = Pidlock.new('my.pid')
       pidlock.logger = logger2
@@ -88,10 +90,10 @@ describe Pidlock do
     end
     it "should close and remove the file if unlocked" do
       @file.should_receive(:gets).and_return('667')
-      ps = stub("ProcTableStruct", :comm => 'test')
       ::Sys::ProcTable.should_receive(:ps).with(667).and_return(nil)
       logger.should_receive(:warn).with('WARNING: resetting stale lockfile')
       @file.should_receive(:rewind)
+      @file.should_receive(:truncate).with(0)
       @file.should_receive(:write).with(666)
       lock = Pidlock.new('my.pid')
       lock.lock

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: pidlock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Anton Bangratz
+- Greg Whiteley
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,52 +14,51 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
 description: Used for locking processes via PID and file (daemon style).
-email: anton.bangratz@gmail.com
+email:
+- anton.bangratz@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.mkd
 files:
+- README.mkd
 - lib/pidlock.rb
+- spec/lib/pidlock_filesystem_spec.rb
 - spec/lib/pidlock_spec.rb
 - spec/spec_helper.rb
-- README.mkd
 homepage: https://github.com/abangratz/pidlock
 licenses: []
+metadata: {}
 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.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Using PID/file locking for daemons and long running tasks made easy.
 test_files: []