svdir 0.2

data/lib/sys/sv/util.rb

@@ -0,0 +1,36 @@
+#
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+#
+
+require 'fcntl' # O_RDONLY | O_NONBLOCK
+
+module Sys # :nodoc:
+module Sv  # :nodoc:
+
+  module Util #:nodoc:
+    def self.open_read(fn, &p)
+      open_nonblock(fn, Fcntl::O_RDONLY, p)
+    end
+
+    def self.open_write(fn, &p)
+      open_nonblock(fn, Fcntl::O_WRONLY, p)
+    end
+
+    private
+    def self.open_nonblock(fn, mode, p)
+      mode |= Fcntl::O_NONBLOCK
+      return File.open(fn, mode) if p.nil?
+
+      begin
+        f = File.open(fn, mode)
+        return p.call(f)
+      ensure
+        f.close if f
+      end
+    end
+  end #-- module Util
+
+end #-- module Sv
+end #-- module Sys

data/test/fixtures/PrefabSvDir.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+
+require 'sys/sv/svdir'
+
+module Fixtures
+  module PrefabSvDir
+  # Test::Unit::TestCase helper to recognize "static" supervisory
+  # directories.
+    def setup
+      dirname = self.class.name.gsub(/^TC_/, '').tr('_', '-')
+      dirname = File.join(File.dirname(__FILE__), '..', 'services', dirname)
+
+      raise RuntimeError.new("Expected static testing dir #{dirname} not found") unless File.directory? dirname
+      @svdir = Sys::Sv::SvDir.new dirname
+      super
+    end
+  end
+end # -- module Fixtures

data/test/fixtures/TempSvDir.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+
+require 'tmpdir'       # Dir.tmpdir
+require 'fileutils'    # FileUtils.rm_rf
+require 'sys/sv/svdir'
+
+module Fixtures
+  module TempSvDir
+    # Test::Unit::TestCase mixin to create one-off service directories
+
+    # Make a temp sv-style dir with supervise/ subdir and two FIFOs
+    def setup
+      i = 0
+
+      # make a temporary dir
+      begin
+        @svdirname = File.join(Dir::tmpdir, "TempSvDir.#{$$}.#{i}")
+        i += 1
+        Dir::mkdir(@svdirname)
+      rescue Errno::EEXIST
+        retry if i < 100
+        raise RuntimeError.new("Unable to create a mock svc dir.  Check #{Dir::tmpdir}")
+      end
+
+      Dir::mkdir File.join(@svdirname, "supervise")
+
+      # Make and hold open our FIFOs
+      @fifos = {}
+      for fn in %w(control ok)
+        @fifos[ fn.to_sym ] = openfifo(File.join(@svdirname, "supervise", fn))
+      end
+
+      @svdir = Sys::Sv::SvDir.new(@svdirname)
+      super
+    end
+
+    def fifo_control
+      @fifos[:control]
+    end
+
+    def fifo_ok
+      @fifos[:ok]
+    end
+
+    def teardown
+      @fifos.each_value {|f| f.close rescue nil}
+      FileUtils.rm_rf( @svdirname )
+      super
+    end
+
+    private
+    def openfifo(fn)
+      system "mkfifo #{Regexp.quote(fn)}"
+      File.open(fn, Fcntl::O_NONBLOCK|Fcntl::O_RDONLY)
+    end
+  end
+
+end # -- module Fixtures

data/test/testbase.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+
+require 'test/unit'
+
+class Test::Unit::TestCase
+  # Load the appropriate Fixtures::Blah
+  def self.include_fixtures(sym, *optional)
+    raise RuntimeError.new("Must subclass Test::Unit::TestCase") \
+      if self == Test::Unit::TestCase
+
+    for s in [sym, *optional]
+      load "fixtures/#{sym}.rb"
+      self.__send__(:include, Module.const_get(:Fixtures).const_get(sym))
+    end
+
+  end
+
+  def self.include_fixture(sym)
+    include_fixtures(sym)
+  end
+                               
+  def assert_elapsed_time(elapsed)
+    assert_kind_of(::Float, elapsed, "elapsed time measurement was wrong type")
+    assert(elapsed > 0.0, "elapsed time measurement was not > 0")
+  end
+end

data/test/ts_corrupt.rb

@@ -0,0 +1,133 @@
+# Test the basics of service status interrogation
+#
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+#
+
+require 'testbase'
+require 'sys/sv/svdir'
+
+class TC_corrupt_normu < Test::Unit::TestCase
+  include_fixture :PrefabSvDir
+
+  def test_down?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.down?
+    end
+  end
+
+  def test_want_up?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.want_up?
+    end
+  end
+
+  def test_pid
+    assert_raise(::Errno::EPROTO) do
+      @svdir.pid
+    end
+  end
+
+  def test_want_down?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.want_down?
+    end
+  end
+
+  def test_normally_up?
+    assert(@svdir.normally_up?, "normally_up? should still succeed even on corrupted SvDir")
+  end
+
+  def test_paused?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.paused?
+    end
+  end
+
+  def test_normally_down?
+    assert(!@svdir.normally_down?, "normally_down? should still succeed even on corrupted SvDir")
+  end
+
+  def test_up?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.up?
+    end
+  end
+
+  def test_downtime
+    assert_raise(::Errno::EPROTO) do
+      @svdir.downtime
+    end
+  end
+
+  def test_uptime
+    assert_raise(::Errno::EPROTO) do
+      @svdir.uptime
+    end
+  end
+end
+
+class TC_corrupt_normd < Test::Unit::TestCase
+  include_fixture :PrefabSvDir
+
+  def test_down?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.down?
+    end
+  end
+
+  def test_want_up?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.want_up?
+    end
+  end
+
+  def test_pid
+    assert_raise(::Errno::EPROTO) do
+      @svdir.pid
+    end
+  end
+
+  def test_want_down?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.want_down?
+    end
+  end
+
+  def test_normally_up?
+    assert(!@svdir.normally_up?, "normally_up? should still succeed even on corrupted SvDir")
+  end
+
+  def test_paused?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.paused?
+    end
+  end
+
+  def test_normally_down?
+    assert(@svdir.normally_down?, "normally_down? should still succeed even on corrupted SvDir")
+  end
+
+  def test_up?
+    assert_raise(::Errno::EPROTO) do
+      @svdir.up?
+    end
+  end
+
+  def test_downtime
+    assert_raise(::Errno::EPROTO) do
+      @svdir.downtime
+    end
+  end
+
+  def test_uptime
+    assert_raise(::Errno::EPROTO) do
+      @svdir.uptime
+    end
+  end
+end
+
+# Zero-byte status files take a slightly different code path to reach EPROTO
+class TC_corrupt_zero_normd < TC_corrupt_normd; end
+class TC_corrupt_zero_normu < TC_corrupt_normu; end

data/test/ts_nosupervisor.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# 
+# Handle the case of no supervisor running
+#
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2011 Qualys, Inc.
+# License:: MIT (see the file LICENSE)
+#
+
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+
+require 'testbase'
+require 'sys/sv/svdir'
+
+class TestSvcNoSupervisor < Test::Unit::TestCase
+
+  include_fixture :TempSvDir
+
+  def setup
+    ret = super
+    # close .../control and .../ok
+    fifo_control.close
+    fifo_ok.close
+    ret
+  end
+
+  # Verify that unknown signal arguments still throw ArgumentError
+  def test_signal_unknown
+    [ :invalid, 'invalid' ].each do |bogus|
+      assert_raise ArgumentError do
+        @svdir.signal bogus
+      end
+    end
+  end
+
+  # Verify that a known signal generates ENXIO
+  def test_signal_up
+    [ :up, 'up' ].each do |c|
+      assert_raise Errno::ENXIO do
+        @svdir.signal c
+      end
+    end
+  end
+
+  # Verify svok? == false
+  def test_not_svok
+    assert @svdir.svok? == false
+  end
+
+  # Verify that the StatusBytes delegates throw ENXIO
+  [:down?, :downtime, :paused?, :pid, :up?, :uptime, :want_down?, :want_up?].
+  each do |m|
+    define_method "test_err_#{m}" do
+      assert_raise Errno::ENXIO do
+        @svdir.__send__(m)
+      end
+    end
+  end
+
+  # Verify that normally_up? still functions
+  def test_normally_up?
+    assert_nothing_raised do
+      @svdir.normally_up?
+    end
+  end
+
+  # Verify that normally_down? still functions
+  def test_normally_down?
+    assert_nothing_raised do
+      @svdir.normally_down?
+    end
+  end
+ 
+  # Verify that log() still functions
+  def test_normally_down?
+    assert_nothing_raised do
+      @svdir.log
+    end
+  end
+
+end