foreground 0.0.2 → 0.0.3

data/features/sample_daemon.feature

@@ -4,16 +4,40 @@ Feature: Sample daemon
   As an BDD guy
   I want a sample daemon along with cucumber steps
 
-  Scenario: Run sample daemon
-    When I successfully run `foreground_sample_daemon`
+  Scenario: Start and stop sample daemon
+    When I run the sample daemon
     Then the sample daemon should run
     And a file named "/tmp/foreground_sample_daemon.pid" should exist
+    And the file "/tmp/foreground_sample_daemon.log" should contain exactly:
+      """
+      Daemon started...
+
+      """
+
+    When I kill the sample daemon
+    Then the sample daemon should not run
+    And a file named "/tmp/foreground_sample_daemon.pid" should not exist
+    But a file named "/tmp/foreground_sample_daemon.log" should exist
 
   Scenario: Run only one sample daemon at once
-    When I successfully run `foreground_sample_daemon`
-    And I successfully run `foreground_sample_daemon`
+    When I run the sample daemon
+    And I run the sample daemon
     Then the sample daemon should run
 
+  Scenario Outline: Log received signals
+    Given I run the sample daemon
+    When I send the sample daemon a <signal> signal
+    Then the sample daemon should <run_or_not>
+    And the file "/tmp/foreground_sample_daemon.log" should contain "received <signal> signal"
+    And the file "/tmp/foreground_sample_daemon.log" should contain "Daemon <message>."
+
+    Examples:
+      | signal | run_or_not | message   |
+      | TERM   | not run    | stopped   |
+      | INT    | not run    | stopped   |
+      | QUIT   | not run    | stopped   |
+      | HUP    | run        | refreshed |
+
   Scenario: Don't mess up the system with running sample daemons
     Then the sample daemon should not run
     And a file named "/tmp/foreground_sample_daemon.pid" should not exist

data/features/start_stop.feature

@@ -9,4 +9,7 @@ Feature: Start and stop
     Then the sample daemon should run
 
     When I kill foreground
-    Then the sample daemon should not run
+    And I run `sleep 1`
+    Then foreground should not run
+    And the sample daemon should not run
+    And the sample daemon should have received a TERM signal

data/features/steps/sample_daemon_steps.rb

@@ -1,3 +1,5 @@
+STDOUT.sync = true # for debugging
+
 def sample_daemons
   proclist = `/bin/ps -A -o pid,command`
   proclist.to_a.grep(%r{^\s*\d+\s+ruby\s+.*foreground_sample_daemon$}) { |l| l[/^\s*(\d+)\s+/,1].to_i }
@@ -5,25 +7,56 @@ end
 
 def kill_foreground
   if @foreground
-    Process.kill(:TERM, @foreground) unless Process.waitpid(@foreground, Process::WNOHANG)
+    begin
+      Process.kill(:TERM, @foreground)
+      Process.waitpid(@foreground)
+    rescue Errno::ESRCH, Errno::ECHILD
+    end
   end
 end
 
+def kill_all_sample_daemons(signal=:TERM)
+  sample_daemons.each { |pid| system("kill -#{signal} #{pid}") }
+  sleep 1 # Give the process time to say goodbye.
+end
+
 After do
   kill_foreground
-  sample_daemons.each { |pid| system("kill #{pid}") }
+  kill_all_sample_daemons
+end
+
+When /^I run the sample daemon$/ do
+  steps %q{
+    When I successfully run `foreground_sample_daemon`
+  }
 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', 'foreground_sample_daemon')
   end
 end
 
+When /^I kill the sample daemon$/ do
+  kill_all_sample_daemons
+end
+
+When /^I send the sample daemon a (\w+) signal$/ do |signal|
+  kill_all_sample_daemons(signal.to_sym)
+end
+
 When /^I kill foreground$/ do
+  sleep 1 # Give foreground some time to setup signal handling... or tests will break.
   kill_foreground
 end
 
+Then /^foreground should not run$/ do
+  unless @foreground
+    lambda { Process.kill(0, @foreground) }.should raise_error(Errno::ESRCH),
+      "foreground still running with PID #{@foreground}"
+  end
+end
+
 Then /^the sample daemon should run$/ do
   steps %q{
     Then 1 sample daemon should run
@@ -42,3 +75,9 @@ Then /^(\d+) sample daemons? should run$/ do |expected|
   actual.should eql(expected),
     "Expected #{expected} running sample daemon, but got #{actual} instead!"
 end
+
+Then /^the sample daemon should have received a (\w+) signal$/ do |signal|
+  steps %Q{
+    Then the file "/tmp/foreground_sample_daemon.log" should contain "received #{signal} signal"
+  }
+end

data/lib/foreground.rb

@@ -1,6 +1,6 @@
-require 'shellwords'
 require 'mixlib/cli'
 require 'foreground/version'
+require 'foreground/daemon'
 require 'foreground/cli'
 
 module Foreground

data/lib/foreground/cli.rb

@@ -16,26 +16,7 @@ module Foreground
 
     def run(argv)
       cmd = parse_options(argv)
-      system(cmd.shelljoin)
-      watch
-    end
-
-    def watch
-      ### <proof_of_concept>
-      #TODO: Unhackify this block of code!
-      STDOUT.sync = true
-      puts "hi, there!"
-      trap(:TERM) do
-        sleep 3 # Give the daemon time to write its PID file.
-        if File.exists?(config[:pid_file])
-          pid = File.read(config[:pid_file]).chomp.to_i
-          Process.kill(:TERM, pid)
-        end
-      end
-      ### </proof_of_concept>
-
-      #TODO: Implement watch feature!
-      loop { sleep 1 }
+      Daemon.run(cmd, config[:pid_file])
     end
   end
 end

data/lib/foreground/daemon.rb

@@ -0,0 +1,48 @@
+require 'foreground'
+
+module Foreground
+  class Daemon
+    @daemon = nil
+
+    class << self
+      attr_accessor :daemon
+
+      def run(*args)
+        @daemon = new(*args)
+        @daemon.run
+      end
+
+      def kill(*args)
+        @daemon.kill(*args)
+      end
+    end
+
+
+    def initialize(cmd, pid_file)
+      @cmd = cmd
+      @pid_file = pid_file
+    end
+
+    def run
+      STDOUT.sync = true
+      puts "hi, there (foreground #{Foreground::VERSION})!"
+      system(*@cmd)
+      watch
+    end
+
+    def kill(signal = :TERM)
+      Process.kill(signal, pid)
+    end
+
+    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
+    end
+
+    def watch
+      #TODO: Implement watch feature!
+      loop { sleep 1 }
+    end
+  end
+end

data/lib/foreground/signal_handlers.rb

@@ -0,0 +1,6 @@
+module Foreground
+  trap(:TERM) do
+    Daemon.kill(:TERM)
+    exit
+  end
+end

data/lib/foreground/version.rb

@@ -1,3 +1,3 @@
 module Foreground
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/foreground/cli_spec.rb

@@ -3,10 +3,9 @@ require 'spec_helper'
 module Foreground
   describe CLI do
     before do
-      CLI.stub(:system)
+      Daemon.stub(:run)
       @argv = ['--pid_file', '/tmp/foreground_sample_daemon.pid', 'foreground_sample_daemon']
       @cli = CLI.new
-      @cli.stub(:watch) # ...or we'll wait forever.
     end
 
     describe '.run' do
@@ -25,12 +24,7 @@ module Foreground
       end
 
       it 'should run the daemon' do
-        @cli.should_receive(:system).with('foreground_sample_daemon')
-        @cli.run(@argv)
-      end
-
-      it 'should watch the daemon' do
-        @cli.should_receive(:watch)
+        Daemon.should_receive(:run).with(['foreground_sample_daemon'], '/tmp/foreground_sample_daemon.pid')
         @cli.run(@argv)
       end
     end

data/spec/foreground/daemon_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module Foreground
+  describe Daemon do
+    before do
+      Process.stub(:kill)
+      @cmd = ['some_daemon', '--with', 'arguments']
+      @pid_file = 'some_daemon.pid'
+      @pid = 42
+      @args = [@cmd, @pid_file]
+      @daemon = Daemon.new(@cmd, @pid_file)
+      @daemon.stub(:watch) # ...or we'll wait forever.
+      @daemon.stub(:system) # ...so that we don't run any stupid commands in our tests.
+    end
+
+    describe '.run' do
+      it 'should run and register a new instance' do
+        daemon = mock('daemon')
+        daemon.should_receive(:run)
+        Daemon.should_receive(:new).with(*@args).and_return(daemon)
+        Daemon.daemon.should be_nil
+        Daemon.run(*@args)
+        Daemon.daemon.should be(daemon)
+      end
+    end
+
+    describe '.kill' do
+      it 'should forward signals to the daemon' do
+        Daemon.daemon = mock('daemon')
+        Daemon.daemon.should_receive(:kill).with(:FOO)
+        Daemon.kill(:FOO)
+      end
+    end
+
+    describe '#run' do
+      it 'should run and watch the daemon' do
+        @daemon.should_receive(:system).with(*@cmd).ordered
+        @daemon.should_receive(:watch).ordered
+        @daemon.run
+      end
+    end
+
+    describe '#kill' do
+      it 'should send the daemon a SIGTERM' do
+        @daemon.stub(:pid).and_return(42)
+        Process.should_receive(:kill).with(:TERM, 42)
+        @daemon.kill
+      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)
+      end
+    end
+  end
+end

metadata

@@ -1,137 +1,143 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: foreground
-version: !ruby/object:Gem::Version
-  version: 0.0.2
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
-- Björn Albers
+authors: 
+- "Bjo\xCC\x88rn Albers"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: mixlib-cli
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2012-09-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 2
+        - 2
         version: 1.2.2
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  name: mixlib-cli
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 4
+        - 11
         version: 0.4.11
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.11
-- !ruby/object:Gem::Dependency
-  name: aruba-doubles
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.1
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: aruba
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
         version: 1.2.1
-- !ruby/object:Gem::Dependency
-  name: guard-cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.7.5
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: aruba-doubles
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 7
+        - 5
         version: 0.7.5
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: guard-cucumber
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
         version: 0.5.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.0
   type: :development
+  name: guard-rspec
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: rake
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
         version: 0.9.0
+  prerelease: false
+  type: :development
+  name: rb-fsevent
+  version_requirements: *id007
 description: Control daemonizing background processes with launchd.
-email:
+email: 
 - bjoernalbers@googlemail.com
-executables:
+executables: 
 - foreground
 - foreground_sample_daemon
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Guardfile
@@ -147,6 +153,8 @@ files:
 - foreground.gemspec
 - lib/foreground.rb
 - lib/foreground/cli.rb
+- lib/foreground/daemon.rb
+- lib/foreground/signal_handlers.rb
 - lib/foreground/version.rb
 - script/bootstrap
 - spec/foreground/cli_spec.rb
@@ -154,35 +162,38 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bjoernalbers/foreground
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1540966374872401692
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1540966374872401692
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: foreground-0.0.2
-test_files:
+summary: foreground-0.0.3
+test_files: 
 - features/sample_daemon.feature
 - features/start_stop.feature
 - features/steps/sample_daemon_steps.rb