foreground 0.0.4 → 0.1.0

data/README.md

@@ -27,7 +27,7 @@ Install it via RubyGems:
 
 Wrap your daemon command inside your launchd.plist:
 
-    foreground --pid_file /tmp/foreground_sample_daemon.pid foreground_sample_daemon
+    foreground --pid_file /tmp/foreground_sample_daemon.pid --command "foreground_sample_daemon --with arguments"
 
 ## Limitations
 

data/features/start_stop.feature

@@ -1,4 +1,4 @@
-Feature: Start and stop
+Feature: Start and stop daemon
 
   In order to start and stop a background daemon
   As a funky user

data/features/steps/sample_daemon_steps.rb

@@ -40,7 +40,7 @@ end
 
 When /^I run the sample daemon via foreground$/ do
   @foreground = fork do
-    exec('foreground', '--pid_file', '/tmp/foreground_sample_daemon.pid', 'foreground_sample_daemon')
+    exec('foreground', '--pid_file', '/tmp/foreground_sample_daemon.pid', '--command', 'foreground_sample_daemon')
   end
 end
 

data/features/watch_daemon.feature

@@ -0,0 +1,14 @@
+Feature: Watch daemon
+
+  In order to notify launchd about a terminated daemon
+  As a funky user
+  I want foreground to terminate as well
+
+  Scenario: Terminate when daemon goes down
+    Given I run the sample daemon via foreground
+    Then foreground should run
+    And the sample daemon should run
+    Given I run `sleep 2`
+    When I kill the sample daemon
+    Then foreground should not run
+    And the sample daemon should not run

data/lib/foreground.rb

@@ -1,8 +1,28 @@
+require 'logger'
 require 'mixlib/cli'
 require 'foreground/version'
 require 'foreground/daemon'
 require 'foreground/cli'
 
 module Foreground
-  # Your code goes here... or not.
+  class << self
+    # The global configuration based on command line options.
+    attr_accessor :config
+  end
+
+  def logger
+    @logger ||= create_logger
+  end
+
+  private
+
+  def create_logger
+    STDOUT.sync = true
+    l = Logger.new(STDOUT)
+    #TODO: Test this!
+    l.formatter = proc do |severity, datetime, progname, msg|
+      "#{progname} [#{severity}]: #{msg}\n"
+    end
+    l
+  end
 end

data/lib/foreground/cli.rb

@@ -8,6 +8,20 @@ module Foreground
       :description => 'PID file for the daemon',
       :required => true
 
+    option :command,
+      :short => '-c COMMAND',
+      :long  => '--command COMMAND',
+      :description => 'Daemon command line',
+      :required => true
+
+    option :timeout,
+      :short => '-t SECONDS',
+      :long  => '--timeout SECONDS',
+      :description => 'Timeout for the daemon to generate a valid PID file',
+      :required => false,
+      :default => 2,
+      :proc => Proc.new { |t| t.to_i }
+
     class << self
       def run(argv=ARGV)
         new.run(argv)
@@ -16,7 +30,8 @@ module Foreground
 
     def run(argv)
       cmd = parse_options(argv)
-      Daemon.run(cmd, config[:pid_file])
+      Foreground.config = config
+      Daemon.run(config[:command], config[:pid_file])
     end
   end
 end

data/lib/foreground/daemon.rb

@@ -1,6 +1,8 @@
 require 'foreground'
 
 module Foreground
+  class DaemonError < StandardError; end
+
   class Daemon
     @daemon = nil
 
@@ -34,15 +36,35 @@ module Foreground
       Process.kill(signal, pid)
     end
 
+    #TODO: Add scenario for this stuff!
     def pid
-      #TODO: Replace sleep with timeout!
-      sleep 0.1 # Give the daemon time to write its PID file.
-      File.read(@pid_file).chomp.to_i
+      return @pid unless @pid.nil?
+      elapsed_time = 0
+      sleep_time = 0.1
+      begin
+        break if @pid = read_pid
+      rescue
+        raise unless elapsed_time < Foreground.config[:timeout]
+        elapsed_time += sleep_time
+      end while sleep(sleep_time)
+      @pid
     end
 
     def watch
-      #TODO: Implement watch feature!
-      loop { sleep 1 }
+      watch_interval = 10
+      begin
+        kill(0)
+      rescue Errno::ESRCH
+        raise DaemonError, "No process with PID #{pid} found."
+      end while sleep(watch_interval)
+    end
+
+    private
+
+    def read_pid
+      pid = File.read(@pid_file).to_i
+      raise DaemonError, "PID not readable from #{@pid_file}" unless pid > 0
+      pid
     end
   end
 end

data/lib/foreground/signal_handlers.rb

@@ -1,7 +1,7 @@
 module Foreground
   [:TERM, :INT].each do |signal|
     trap(signal) do
-      Daemon.kill(:TERM)
+      Daemon.kill(:TERM) rescue Errno::ESRCH
       exit
     end
   end

data/lib/foreground/version.rb

@@ -1,3 +1,3 @@
 module Foreground
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/spec/foreground/cli_spec.rb

@@ -4,7 +4,8 @@ module Foreground
   describe CLI do
     before do
       Daemon.stub(:run)
-      @argv = ['--pid_file', '/tmp/foreground_sample_daemon.pid', 'foreground_sample_daemon']
+      @cmd = 'foreground_sample_daemon --with "some arguments"'
+      @argv = ['--pid_file', '/tmp/foreground_sample_daemon.pid', '--command', @cmd]
       @cli = CLI.new
     end
 
@@ -23,8 +24,13 @@ module Foreground
         @cli.run(@argv)
       end
 
+      it 'should make the config globally available' do
+        @cli.run(@argv)
+        Foreground.config.should eql(@cli.config)
+      end
+
       it 'should run the daemon' do
-        Daemon.should_receive(:run).with(['foreground_sample_daemon'], '/tmp/foreground_sample_daemon.pid')
+        Daemon.should_receive(:run).with(@cmd, '/tmp/foreground_sample_daemon.pid')
         @cli.run(@argv)
       end
     end

data/spec/foreground/daemon_spec.rb

@@ -4,7 +4,8 @@ module Foreground
   describe Daemon do
     before do
       Process.stub(:kill)
-      @cmd = ['some_daemon', '--with', 'arguments']
+      #@cmd = ['some_daemon', '--with', 'arguments']
+      @cmd = 'some_daemon --with "many arguments"'
       @pid_file = 'some_daemon.pid'
       @pid = 42
       @args = [@cmd, @pid_file]
@@ -34,12 +35,31 @@ module Foreground
 
     describe '#run' do
       it 'should run and watch the daemon' do
-        @daemon.should_receive(:system).with(*@cmd).ordered
+        @daemon.should_receive(:system).with(@cmd).ordered
         @daemon.should_receive(:watch).ordered
         @daemon.run
       end
     end
 
+    describe '#watch' do
+      before do
+        @daemon = Daemon.new(@cmd, @pid_file)
+        @daemon.stub(:pid).and_return(@pid)
+      end
+
+      it 'should sleep if the daemon is still alive' do
+        @daemon.should_receive(:sleep).with(10).and_return(nil)
+        Process.should_receive(:kill).with(0, @pid).and_return(1)
+        @daemon.watch
+      end
+
+      it 'should raise error if the daemon is not alive' do
+        @daemon.should_not_receive(:sleep)
+        Process.should_receive(:kill).with(0, @pid).and_raise(Errno::ESRCH)
+        lambda { @daemon.watch }.should raise_error(DaemonError, /no process with pid #{@pid} found/i)
+      end
+    end
+
     describe '#kill' do
       it 'should send the daemon a SIGTERM' do
         @daemon.stub(:pid).and_return(42)
@@ -48,10 +68,42 @@ module Foreground
       end
     end
 
+    describe '#read_pid' do
+      context 'with existing PID file' do
+        it 'should return the PID' do
+          File.should_receive(:read).with(@pid_file).and_return("#{@pid}\n")
+          @daemon.send(:read_pid).should eql(@pid)
+        end
+      end
+
+      context 'with unreadable PID' do
+        it 'should raise error' do
+          File.should_receive(:read).with(@pid_file).and_return('fortytwo')
+          lambda { @daemon.send(:read_pid) }.should raise_error(DaemonError, /pid not readable from #{@pid_file}/i)
+        end
+      end
+    end
+
     describe '#pid' do
-      it 'should return the daemons PID by PID file' do
-        File.should_receive(:read).with(@pid_file).and_return("#{@pid}\n")
-        @daemon.pid.should eql(@pid)
+      context 'with readable PID' do
+        it 'should cache and return the PID' do
+          @daemon.should_receive(:read_pid).once.and_return(@pid)
+          2.times { @daemon.pid.should eql(@pid) }
+        end
+      end
+
+      context 'with unreadable PID' do
+        it 'should rescue and retry after sleep' do
+          @daemon.should_receive(:read_pid).and_raise(StandardError)
+          @daemon.should_receive(:sleep).with(0.1).and_return(nil)
+          @daemon.pid
+        end
+
+        it 'should reraise last exception after 2 seconds' do
+          @daemon.stub(:read_pid).and_raise(Errno::ENOENT)
+          @daemon.should_receive(:sleep).with(0.1).exactly(20).times.and_return(true)
+          lambda { @daemon.pid }.should raise_error(Errno::ENOENT)
+        end
       end
     end
   end

data/spec/foreground_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Foreground
+  class Foo
+    include Foreground
+  end
+
+  describe '#logger' do
+    before do
+      @logger = double('logger')
+      @logger.stub(:formatter=)
+      Logger.stub(:new).and_return(@logger)
+      @foo = Foo.new
+    end
+
+    it 'should initialize a new logger once' do
+      Logger.should_receive(:new).once.with(STDOUT)
+      2.times { @foo.logger }
+    end
+
+    it 'should return the logger' do
+      @foo.logger.should eql(@logger)
+    end
+
+    it 'should flush to stdout' do
+      original_sync_state = STDOUT.sync
+      STDOUT.sync = false
+      STDOUT.sync.should be_false
+      @foo.logger
+      STDOUT.sync.should be_true
+      STDOUT.sync = original_sync_state
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreground
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-08 00:00:00.000000000 Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -144,6 +144,7 @@ files:
 - features/start_stop.feature
 - features/steps/sample_daemon_steps.rb
 - features/support/env.rb
+- features/watch_daemon.feature
 - foreground.gemspec
 - lib/foreground.rb
 - lib/foreground/cli.rb
@@ -153,6 +154,7 @@ files:
 - script/bootstrap
 - spec/foreground/cli_spec.rb
 - spec/foreground/daemon_spec.rb
+- spec/foreground_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bjoernalbers/foreground
 licenses: []
@@ -168,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3093177780394288803
+      hash: 1710979522724105195
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -177,18 +179,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3093177780394288803
+      hash: 1710979522724105195
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: foreground-0.0.4
+summary: foreground-0.1.0
 test_files:
 - features/sample_daemon.feature
 - features/start_stop.feature
 - features/steps/sample_daemon_steps.rb
 - features/support/env.rb
+- features/watch_daemon.feature
 - spec/foreground/cli_spec.rb
 - spec/foreground/daemon_spec.rb
+- spec/foreground_spec.rb
 - spec/spec_helper.rb