svdir 0.2 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4b6357ab1c95fa4608ee186cc532dae0e0f50e8317b54ee3e09cb2665feffa4
+  data.tar.gz: cda53444f8c7175634cc4bc8f95a796b6c8c51e0f47851e25eb0595eafe640aa
+SHA512:
+  metadata.gz: 1a0e227bcbfd23d90398446612ae6742613b3f1c405606ed66aa08dae06cc2a26c1bcf6aa64ce5ae817b51333ef0e54f4e10631837ea807072739e4337a9ec0e
+  data.tar.gz: edf2e03c564aa99b0faa6e8d6c38abd43cc381434ab4e6a52206ee5061bcbb2658e62b5e982733b3b99c1c5f16203bc7986c6ab946876e91575abfc6fb940c08

data/CHANGELOG

@@ -1,3 +1,12 @@
+2026-06-19 mjp version 0.2.1
+  [bug] Replace deprecated `File.exists?`/`Dir::mkdir`/`Dir::tmpdir` calls for
+  Ruby 3.2+ compatibility.  Fix TAI64N nanosecond divisor (`10e9` → `1e9`).
+  [pkg] Modernize Rakefile, extract svdir.gemspec.
+  [tst] Fix duplicate test name and loop variable in test helpers.  Add TAI64N
+  timestamp tests.
+  [int] Freeze mutable constants (`VERSION`, `Commands`).
+  [doc] Update copyright notices.
+
 2011-02-28 mjp version 0.2
   [doc] Documentation touch-up, move from Qualys SVN to github.
 

data/README

@@ -1,5 +1,5 @@
+Copyright (c) 2026 Mike Pomraning
 Copyright (c) 2010, 2011 Qualys, Inc.
-
 Copyright (c) 2008 - 2010 Nemean Networks, LLC.
 
 = Overview
@@ -54,14 +54,10 @@ generate module documentation.
 
 = To Do
 
-* Further testing
-  - log()
-  - TAI64 testing
-
 * Possible extensions
   - <tt>SvDir.new(d) &block</tt> - persist StatusBytes object for block?
   - <tt>normally_down!</tt> and <tt>normally_up!</tt>
 
 = Author
 
-Mike Pomraning ("mpomraning" at "qualys" dot "com")
+Mike Pomraning ("mjp" at "pilcrow" dot "madison" dot "wi" dot "us")

data/Rakefile

@@ -1,41 +1,19 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
 
-FILES = FileList['Rakefile', 'CHANGELOG', 'LICENSE', 'README',
-                 'lib/**/*.rb', 'test/**/*', 'example/*'].to_a
-TESTS = FileList['test/ts_*.rb']
+spec = Gem::Specification.load('svdir.gemspec')
 
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.author = "Mike Pomraning"
-  s.summary = "An interface to service directories ala supervise/runsv"
-  s.name = 'svdir'
-  s.version = '0.2'
-  s.require_path = 'lib'
-  s.description = <<eodesc
-The svdir package controls service directories, a scheme for reliably
-controlling daemon processes as implemented in Dan Bernstein's daemontools
-software ("supervise") or Gerit Pape's runit software ("runsv").
-eodesc
-  s.files = FILES
-  s.test_files = TESTS
-  s.has_rdoc = true
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.package_dir = 'pkg'
-    pkg.need_tar = true
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.package_dir = 'pkg'
+  pkg.need_tar = true
 end
 
 desc "Generate rdoc"
-Rake::RDocTask.new("rdoc") do |rdoc|
+RDoc::Task.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc/rdoc'
   rdoc.title    = "svdir"
-  # Show source inline with line numbers
   rdoc.options << "--inline-source" << "--line-numbers"
-  # Make the readme file the start page for the generated html
   rdoc.options << '--main' << 'README'
   rdoc.rdoc_files.include('lib/**/*.rb',
                           'CHANGELOG',
@@ -46,7 +24,7 @@ end
 desc "Run included tests"
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = TESTS
+  t.test_files = Dir['test/ts_*.rb']
   t.libs << "lib"
 end
 
@@ -54,7 +32,7 @@ desc "Run test coverage (rcov)"
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |t|
-    t.test_files = TESTS
+    t.test_files = Dir['test/ts_*.rb']
     t.libs << "test" << "lib"
     t.rcov_opts << '--exclude /gems/,/Library/,/usr/,spec,lib/tasks'
   end

data/lib/sys/sv/statusbytes.rb

@@ -1,6 +1,7 @@
 #
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2026 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 # 
 
@@ -42,7 +43,7 @@ module Sv  # :nodoc:
       if @epoch <= 0
         @epoch = 0.0
       else
-        @epoch += nano/10e9
+        @epoch += nano / 1e9
       end
 
       @epoch

data/lib/sys/sv/svdir.rb

@@ -2,6 +2,7 @@
 
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2026 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 #
 
@@ -31,7 +32,7 @@ module Sv  # :nodoc:
  
   class SvDir
 
-    VERSION = '0.2'
+    VERSION = '0.2.1'.freeze
 
     attr_reader :path
 
@@ -55,6 +56,8 @@ module Sv  # :nodoc:
       }.each do | cmds, byte |
         cmds.each { |c| h[c] = byte }
       end
+      h.each_value(&:freeze)
+      h.freeze
       const_set(:Commands, h)
     end
 
@@ -110,7 +113,7 @@ module Sv  # :nodoc:
     #   end
     def log
       fn = File.join(@path, 'log')
-      return self.class.new(fn) if File.exists? fn
+      return self.class.new(fn) if File.directory? fn
     end
 
     # Returns +true+ if the service directory's _supervisor_ is running.
@@ -142,7 +145,7 @@ module Sv  # :nodoc:
     # 
     # See also the #want_down? method documentation.
     def normally_down?
-      File.exists? File.join(@path, 'down')
+      File.exist? File.join(@path, 'down')
     end
 
     # Returns the number of seconds the service has been down,

data/lib/sys/sv/util.rb

@@ -1,6 +1,7 @@
 #
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2016 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 #
 

data/test/fixtures/TempSvDir.rb

@@ -2,6 +2,7 @@
 
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2026 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 
 require 'tmpdir'       # Dir.tmpdir
@@ -18,15 +19,15 @@ module Fixtures
 
       # make a temporary dir
       begin
-        @svdirname = File.join(Dir::tmpdir, "TempSvDir.#{$$}.#{i}")
+        @svdirname = File.join(Dir.tmpdir, "TempSvDir.#{$$}.#{i}")
         i += 1
-        Dir::mkdir(@svdirname)
+        Dir.mkdir(@svdirname)
       rescue Errno::EEXIST
         retry if i < 100
-        raise RuntimeError.new("Unable to create a mock svc dir.  Check #{Dir::tmpdir}")
+        raise RuntimeError.new("Unable to create a mock svc dir.  Check #{Dir.tmpdir}")
       end
 
-      Dir::mkdir File.join(@svdirname, "supervise")
+      Dir.mkdir File.join(@svdirname, "supervise")
 
       # Make and hold open our FIFOs
       @fifos = {}

data/test/testbase.rb

@@ -2,6 +2,7 @@
 
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2026 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 
 require 'test/unit'
@@ -13,8 +14,8 @@ class 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))
+      load "fixtures/#{s}.rb"
+      self.__send__(:include, Module.const_get(:Fixtures).const_get(s))
     end
 
   end

data/test/ts_nosupervisor.rb

@@ -4,6 +4,7 @@
 #
 # Author::  Mike Pomraning
 # Copyright:: Copyright (c) 2011 Qualys, Inc.
+# Copyright:: Copyright (c) 2026 Mike Pomraning
 # License:: MIT (see the file LICENSE)
 #
 
@@ -72,7 +73,7 @@ class TestSvcNoSupervisor < Test::Unit::TestCase
   end
  
   # Verify that log() still functions
-  def test_normally_down?
+  def test_log
     assert_nothing_raised do
       @svdir.log
     end

data/test/ts_tai64n.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+#
+# Test TAI64N timestamp parsing and the nanosecond field
+#
+# Author::  Mike Pomraning
+# Copyright:: Copyright (c) 2026 Mike Pomraning
+# License:: MIT (see the file LICENSE)
+#
+
+require 'testbase'
+require 'sys/sv/statusbytes'
+
+class TC_Tai64N < Test::Unit::TestCase
+  include Sys::Sv
+
+  # Build an 18-byte status buffer from a raw TAI64N timestamp.
+  # The 12-byte TAI64N label stores (tai64_secs) as an 8-byte big-endian
+  # uint64 split into hi/lo 32-bit words, plus nanoseconds as 4 bytes.
+  def make_status(tai64_hi, tai64_lo, nano, pid = 0, pause = 0, want = "\x00")
+    [tai64_hi, tai64_lo, nano].pack('NNN') +
+    [pid].pack('V') + [pause].pack('c') + [want].pack('a')
+  end
+
+  # The on-wire TAI64 value is:  tai64 = unix_epoch + TAI_EPOCH
+  # where TAI_EPOCH = 2^62 + 10 (the TAI representation of Unix time 0).
+  # StatusBytes reverses this:  unix_epoch = tai64 - TAI_EPOCH.
+  def tai64_from_unix(unix_epoch)
+    unix_epoch + StatusBytes::TAI_EPOCH
+  end
+
+  # split a 64-bit value into hi/lo 32-bit halves for big-endian packing
+  def hi32(val)
+    val >> 32
+  end
+
+  def lo32(val)
+    val & 0xFFFFFFFF
+  end
+
+  # Unix epoch 2009-02-13 23:31:20 +0000 = 1234567880
+  def test_known_timestamp
+    tai64 = tai64_from_unix(1234567880)
+    buf = make_status(hi32(tai64), lo32(tai64), 500_000_000)
+    sb  = StatusBytes.new(buf)
+    assert_in_delta(1234567880.5, sb.epoch, 0.000_001)
+  end
+
+  # Zero nanoseconds
+  def test_zero_nano
+    tai64 = tai64_from_unix(1000)
+    buf = make_status(hi32(tai64), lo32(tai64), 0)
+    sb  = StatusBytes.new(buf)
+    assert_in_delta(1000.0, sb.epoch, 0.000_001)
+  end
+
+  # Max nanoseconds (999999999)
+  def test_max_nano
+    tai64 = tai64_from_unix(1000)
+    buf = make_status(hi32(tai64), lo32(tai64), 999_999_999)
+    sb  = StatusBytes.new(buf)
+    assert_in_delta(1000.999999999, sb.epoch, 0.000_001)
+  end
+
+  # elapsed returns a positive Float (epoch 0 edge case)
+  def test_elapsed
+    tai64 = tai64_from_unix(0)
+    buf = make_status(hi32(tai64), lo32(tai64), 500_000_000)
+    sb  = StatusBytes.new(buf)
+    assert_kind_of(Float, sb.elapsed)
+    assert(sb.elapsed > 0)
+  end
+end

metadata

@@ -1,117 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: svdir
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: "0.2"
+version: !ruby/object:Gem::Version
+  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Mike Pomraning
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-28 00:00:00 -06:00
-default_executable: 
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-
 description: |
   The svdir package controls service directories, a scheme for reliably
   controlling daemon processes as implemented in Dan Bernstein's daemontools
   software ("supervise") or Gerit Pape's runit software ("runsv").
-
-email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- Rakefile
+files:
 - CHANGELOG
 - LICENSE
 - README
-- lib/sys/sv/util.rb
+- Rakefile
+- example/svctl
 - lib/sys/sv/statusbytes.rb
 - lib/sys/sv/svdir.rb
-- test/services/corrupt-zero-normu/supervise/ok
-- test/services/corrupt-zero-normu/supervise/status
-- test/services/up-12816-normd-nowant/down
-- test/services/up-12816-normd-nowant/supervise/ok
-- test/services/up-12816-normd-nowant/supervise/status
-- test/services/up-16464-normd-wantd/down
-- test/services/up-16464-normd-wantd/supervise/ok
-- test/services/up-16464-normd-wantd/supervise/status
-- test/services/up-12868-normd-wantu/down
-- test/services/up-12868-normd-wantu/supervise/ok
-- test/services/up-12868-normd-wantu/supervise/status
-- test/services/down-0-normu-nowant/supervise/ok
-- test/services/down-0-normu-nowant/supervise/status
-- test/services/corrupt-normu/supervise/ok
-- test/services/corrupt-normu/supervise/status
+- lib/sys/sv/util.rb
+- test/fixtures/PrefabSvDir.rb
+- test/fixtures/TempSvDir.rb
 - test/services/corrupt-normd/down
 - test/services/corrupt-normd/supervise/ok
 - test/services/corrupt-normd/supervise/status
-- test/services/up-12581-normd-wantd-paused/down
-- test/services/up-12581-normd-wantd-paused/supervise/ok
-- test/services/up-12581-normd-wantd-paused/supervise/status
-- test/services/up-12868-normu-wantu-paused/supervise/ok
-- test/services/up-12868-normu-wantu-paused/supervise/status
-- test/services/up-12581-normu-wantd-paused/supervise/ok
-- test/services/up-12581-normu-wantd-paused/supervise/status
+- test/services/corrupt-normu/supervise/ok
+- test/services/corrupt-normu/supervise/status
 - test/services/corrupt-zero-normd/down
 - test/services/corrupt-zero-normd/supervise/ok
 - test/services/corrupt-zero-normd/supervise/status
-- test/services/up-12868-normu-wantu/supervise/ok
-- test/services/up-12868-normu-wantu/supervise/status
-- test/services/up-12816-normu-nowant/supervise/ok
-- test/services/up-12816-normu-nowant/supervise/status
+- test/services/corrupt-zero-normu/supervise/ok
+- test/services/corrupt-zero-normu/supervise/status
 - test/services/down-0-normd-nowant/down
 - test/services/down-0-normd-nowant/supervise/ok
 - test/services/down-0-normd-nowant/supervise/status
+- test/services/down-0-normu-nowant/supervise/ok
+- test/services/down-0-normu-nowant/supervise/status
 - test/services/up-12526-normu-wantd/supervise/ok
 - test/services/up-12526-normu-wantd/supervise/status
+- test/services/up-12581-normd-wantd-paused/down
+- test/services/up-12581-normd-wantd-paused/supervise/ok
+- test/services/up-12581-normd-wantd-paused/supervise/status
+- test/services/up-12581-normu-wantd-paused/supervise/ok
+- test/services/up-12581-normu-wantd-paused/supervise/status
+- test/services/up-12816-normd-nowant/down
+- test/services/up-12816-normd-nowant/supervise/ok
+- test/services/up-12816-normd-nowant/supervise/status
+- test/services/up-12816-normu-nowant/supervise/ok
+- test/services/up-12816-normu-nowant/supervise/status
 - test/services/up-12868-normd-wantu-paused/down
 - test/services/up-12868-normd-wantu-paused/supervise/ok
 - test/services/up-12868-normd-wantu-paused/supervise/status
+- test/services/up-12868-normd-wantu/down
+- test/services/up-12868-normd-wantu/supervise/ok
+- test/services/up-12868-normd-wantu/supervise/status
+- test/services/up-12868-normu-wantu-paused/supervise/ok
+- test/services/up-12868-normu-wantu-paused/supervise/status
+- test/services/up-12868-normu-wantu/supervise/ok
+- test/services/up-12868-normu-wantu/supervise/status
+- test/services/up-16464-normd-wantd/down
+- test/services/up-16464-normd-wantd/supervise/ok
+- test/services/up-16464-normd-wantd/supervise/status
+- test/testbase.rb
 - test/ts_corrupt.rb
-- test/fixtures/TempSvDir.rb
-- test/fixtures/PrefabSvDir.rb
+- test/ts_nosupervisor.rb
 - test/ts_signal.rb
 - test/ts_svstat.rb
-- test/testbase.rb
-- test/ts_nosupervisor.rb
-- example/svctl
-has_rdoc: true
-homepage: 
-licenses: []
-
-post_install_message: 
+- test/ts_tai64n.rb
+licenses:
+- MIT
+metadata: {}
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.0
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.9
+specification_version: 4
 summary: An interface to service directories ala supervise/runsv
-test_files: 
+test_files:
 - test/ts_corrupt.rb
+- test/ts_nosupervisor.rb
 - test/ts_signal.rb
 - test/ts_svstat.rb
-- test/ts_nosupervisor.rb
+- test/ts_tai64n.rb