rbdaemon 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rbdaemon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Changli Gao
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# RBDaemon
+
+A daemon library in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rbdaemon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbdaemon
+
+## Usage
+
+````ruby
+require 'rubygems'
+gem 'rbdaemon'
+require 'rbdaemon'
+
+RBDaemon::Daemon.new do
+  loop do
+    sleep(3)
+  end
+end
+````
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task :default => :build

data/lib/rbdaemon/conventions.rb

@@ -0,0 +1,7 @@
+
+module RBDaemon
+  PID_FILE_DIR = File.join('/', 'var', 'run')
+  WORK_DIR     = '/'
+  STDIO_PATH   = File.join('/', 'dev', 'null')
+  UMASK        = 0
+end

data/lib/rbdaemon/daemon.rb

@@ -0,0 +1,92 @@
+
+require 'rbdaemon/conventions'
+require 'rbdaemon/pidfile'
+require 'etc'
+require 'syslog'
+
+module RBDaemon
+  class DaemonError < StandardError; end
+
+  class Daemon
+    def initialize(options = {}, *args)
+      exit!(0) if fork
+      Process.setsid
+      Signal.trap('HUP'){}
+      exit!(0) if fork
+
+      options[:no_change_umask] or File.umask(RBDaemon::UMASK)
+
+      unless options[:no_close]
+        ObjectSpace.each_object(IO) do |io|
+          [STDIN, STDOUT, STDERR].include?(io) and next
+          io.closed? or io.close rescue nil
+        end
+        STDIN.reopen(RBDaemon::STDIO_PATH)
+        STDOUT.reopen(RBDaemon::STDIO_PATH, 'w')
+        STDERR.reopen(RBDaemon::STDIO_PATH, 'w')
+      end
+
+      @pid_file = PidFile.new(options[:pid_file])
+
+      unless options[:no_trap_term]
+        Signal.trap('TERM') do
+          exit(0)
+        end
+      end
+
+      ident = options[:pid_file] ? options[:pid_file] : $0
+      ident = File.basename(ident).split(/\./)[0]
+
+      Signal.trap('EXIT') do
+        Syslog::log(Syslog::LOG_INFO, "#{ident} exited")
+        options[:change_root] or (@pid_file and @pid_file.delete) rescue nil
+      end
+
+      if options[:user]
+        user = options[:user]
+        options[:groups] ||= [user]
+        uid = user.class == String ? Etc.getpwnam(user).uid : user
+      end
+
+      if options[:groups]
+        groups = options[:groups].map do |group|
+          case group
+          when Fixnum
+            group
+          when String
+            Etc.getgrnam(group).gid
+          else
+            raise ArgumentError, 'invalid group: ' + group
+          end
+        end
+        if options[:user]
+          groups.concat(Process.initgroups(options[:user], groups[0]))
+        end
+        if options[:user] and groups.include?(uid) 
+          gid = uid
+        else
+          gid = groups[0]
+        end
+        Process::groups = groups.uniq
+        Process::GID::change_privilege(gid)
+      end
+
+      Syslog::open(ident, Syslog::LOG_NDELAY | Syslog::LOG_PID,
+                   Syslog::LOG_DAEMON)
+
+      if options[:change_root]
+        Dir.chdir(options[:change_root])
+        Dir.chroot('.')
+      elsif not options[:no_change_dir]
+        Dir.chdir(RBDaemon::WORK_DIR)
+      end
+
+      Process::UID::change_privilege(uid) if options[:user]
+
+      Syslog::log(Syslog::LOG_INFO, "#{ident} started")
+      yield self, *args
+
+      exit(0)
+    end
+  end
+end

data/lib/rbdaemon/pidfile.rb

@@ -0,0 +1,28 @@
+
+require 'rbdaemon/conventions'
+
+module RBDaemon
+  class PidFileError < StandardError; end
+
+  class PidFile
+    def initialize(pid_file = nil)
+      if pid_file
+        @path = pid_file
+      else
+        program = File.basename($0).split(/\./)[0]
+        @path = File.join(RBDaemon::PID_FILE_DIR, program + '.pid')
+      end
+      @file = File.new(@path, File::WRONLY | File::CREAT, 0644)
+      unless @file.flock(File::LOCK_NB | File::LOCK_EX)
+        raise PidFileError, 'failed to lock ' + @path
+      end
+      @file.truncate(0)
+      @file.write("#{$$}\n")
+      @file.flush
+    end
+
+    def delete
+      File.delete(@path)
+    end
+  end
+end

data/lib/rbdaemon/version.rb

@@ -0,0 +1,4 @@
+
+module RBDaemon
+  VERSION = '0.0.1'
+end

data/lib/rbdaemon.rb

@@ -0,0 +1,5 @@
+
+require 'rbdaemon/conventions'
+require 'rbdaemon/daemon'
+require 'rbdaemon/pidfile'
+require 'rbdaemon/version'

data/rbdaemon.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rbdaemon/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rbdaemon"
+  gem.version       = RBDaemon::VERSION
+  gem.authors       = ["Changli Gao"]
+  gem.email         = ["xiaosuo@gmail.com"]
+  gem.description   = %q{A daemon library in Ruby}
+  gem.summary       = %q{Yet another daemon library in Ruby}
+  gem.homepage      = "http://github.com/xiaosuo/rbdaemon"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+end

data/test/tc_daemon.rb

@@ -0,0 +1,130 @@
+
+require 'test/unit'
+require 'rbdaemon/daemon'
+require 'tempfile'
+
+class TC_Daemon < Test::Unit::TestCase
+  def test_smoke
+    assert_equal(0, Process.uid)
+    tmpfile = ::Tempfile.new('tc_daemon', '/tmp')
+    File::chmod(0666, tmpfile.path)
+    Process.fork do 
+      RBDaemon::Daemon.new({:user => 'nobody', :groups => 'nobody',
+                            :change_root => '/tmp'},
+                           3, "ok\n", tmpfile.path) do |daemon, times, str, path|
+        tmpfile = File.new(File.basename(path), 'w')
+        times.times do
+          tmpfile.write(str)
+        end
+        tmpfile.flush
+        loop do
+          sleep(3)
+        end
+      end
+    end
+    # let the daemon process run
+    sleep(1)
+
+    # check pid
+    pid_file = "/var/run/#{File.basename($0).split(/\./)[0]}.pid"
+    assert(File.exist?(pid_file))
+    pid = IO.read(pid_file).rstrip.to_i
+    assert_nothing_raised{Process::kill(0, pid)}
+    proc_root = "/proc/#{pid}"
+    status = {}
+    IO.foreach("#{proc_root}/status") do |l|
+      k, v = l.rstrip.split(/:\s*/)
+      status[k] = v
+    end
+    assert_equal(pid, status['Pid'].to_i)
+
+    stat = IO.read("#{proc_root}/stat").rstrip.split(/\s+/)
+    assert_equal(pid, stat[0].to_i)
+    # the current ppid should 1
+    assert_equal(1, stat[3].to_i)
+    # must not be the group leader
+    assert_not_equal(pid, stat[4].to_i)
+    # a different session id
+    assert_not_equal(IO.read("/proc/self/stat").rstrip.split(/\s+/)[5], stat[5])
+    # pgid == sid
+    assert_equal(stat[4], stat[5])
+
+    # check daemon's work
+    lines = IO.readlines(tmpfile.path)
+    assert_equal(3, lines.length)
+    assert_equal("ok\n", lines[0])
+
+    # check uid and gid
+    uid = Etc.getpwnam('nobody').uid
+    gid = Etc.getgrnam('nobody').gid
+    status['Uid'].split(/\s+/).each do |s|
+      assert_equal(uid, s.to_i)
+    end
+    status['Gid'].split(/\s+/).each do |s|
+      assert_equal(gid, s.to_i)
+    end
+
+    # check fds
+    Dir["#{proc_root}/fd/*"].each do |fn|
+      fd = File.basename(fn).to_i
+      assert((0..5).to_a.include?(fd))
+      case fd
+      when 0, 1, 2
+        assert_equal('/dev/null', File::readlink(fn))
+      when 3
+        assert_equal(pid_file, File::readlink(fn))
+      when 4
+        assert_match(/socket:\[\d+\]/, File::readlink(fn))
+      when 5
+        assert_equal(tmpfile.path, File::readlink(fn))
+      end
+    end
+
+    # check root directory
+    assert_equal('/tmp', File::readlink("#{proc_root}/root"))
+    assert_equal('/tmp', File::readlink("#{proc_root}/cwd"))
+
+    # terminate daemon
+    assert_nothing_raised{Process::kill('TERM', pid)}
+    sleep(1)
+    # check pid file
+    assert(File.exist?(pid_file))
+    assert_raise(Errno::ESRCH){Process::kill(0, pid)}
+  end
+
+  def test_normal_use
+    assert_equal(0, Process.uid)
+    Process.fork do
+      RBDaemon::Daemon.new do
+        loop{sleep(3)}
+      end
+    end
+    sleep(1)
+    pid_file = "/var/run/#{File.basename($0).split(/\./)[0]}.pid"
+    assert(File.exist?(pid_file))
+    pid = IO.read(pid_file).rstrip.to_i
+    assert_nothing_raised{Process::kill(0, pid)}
+    proc_root = "/proc/#{pid}"
+    assert_equal('/', File::readlink("#{proc_root}/root"))
+    assert_equal('/', File::readlink("#{proc_root}/cwd"))
+    assert_nothing_raised{Process::kill('TERM', pid)}
+    sleep(1)
+    assert_equal(false, File.exist?(pid_file))
+  end
+
+  def test_non_root
+    Process.uid == 0 and Process.euid = 1000
+    pid_file = Tempfile.new('tc_daemon')
+    Process.fork do
+      RBDaemon::Daemon.new(:pid_file => pid_file.path) do
+        loop{sleep(3)}
+      end
+    end
+    sleep(1)
+    pid = pid_file.read.rstrip.to_i
+    assert_nothing_raised{Process::kill('TERM', pid)}
+    sleep(1)
+    assert_equal(false, File.exist?(pid_file.path))
+    Process.uid == 0 and Process.euid = 0
+  end
+end

data/test/tc_pidfile.rb

@@ -0,0 +1,16 @@
+
+require 'test/unit'
+require 'rbdaemon/pidfile'
+
+class TC_PidFile < Test::Unit::TestCase
+  def test_smoke
+    assert_equal(0, Process.uid)
+    path = "/var/run/#{File.basename($0).split(/\./)[0]}.pid"
+    pid_file = RBDaemon::PidFile.new
+    assert(File.exist?(path))
+    assert_equal($$, IO.read(path).rstrip.to_i)
+    assert_raise(RBDaemon::PidFileError){RBDaemon::PidFile.new}
+    pid_file.delete
+    assert_equal(false, File.exist?(path))
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: rbdaemon
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Changli Gao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-30 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: A daemon library in Ruby
+email: 
+- xiaosuo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rbdaemon.rb
+- lib/rbdaemon/conventions.rb
+- lib/rbdaemon/daemon.rb
+- lib/rbdaemon/pidfile.rb
+- lib/rbdaemon/version.rb
+- rbdaemon.gemspec
+- test/tc_daemon.rb
+- test/tc_pidfile.rb
+has_rdoc: true
+homepage: http://github.com/xiaosuo/rbdaemon
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Yet another daemon library in Ruby
+test_files: 
+- test/tc_daemon.rb
+- test/tc_pidfile.rb