proc-wait3 1.7.1 → 1.9.0

data/Rakefile

@@ -1,20 +1,22 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 require 'fileutils'
 require 'rbconfig'
 include RbConfig
 
 CLEAN.include(
-  '**/*.gem',               # Gem files
-  '**/*.rbc',               # Rubinius
-  '**/*.o',                 # C object file
-  '**/*.log',               # Ruby extension build log
-  '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
-  "**/*.#{CONFIG['DLEXT']}" # C shared object
+  '**/*.gem',                # Gem files
+  '**/*.rbc',                # Rubinius
+  '**/*.o',                  # C object file
+  '**/*.log',                # Ruby extension build log
+  '**/Makefile',             # C Makefile
+  '**/conftest.dSYM',        # OS X build directory
+  "**/*.#{CONFIG['DLEXT']}", # C shared object
+  '**/*.lock'                # Bundler
 )
 
+
 desc "Build the source (but don't install it)"
 task :build => [:clean] do |t|
   Dir.chdir('ext') do
@@ -27,19 +29,16 @@ end
 namespace :gem do
   desc "Create the proc-wait3 gem"
   task :create => [:clean] do
+    require 'rubygems/package'
     spec = eval(IO.read('proc-wait3.gemspec'))
-    if Gem::VERSION < "2.0"
-      Gem::Builder.new(spec).build
-    else
-      require 'rubygems/package'
-      Gem::Package.build(spec)
-    end
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
   end
 
   desc "Install the proc-wait3 gem"
   task :install => [:create] do |t|
     file = Dir['*.gem'].first
-    sh "gem install #{file}"
+    sh "gem install -l #{file}"
   end
 end
 
@@ -70,11 +69,9 @@ namespace :example do
   end
 end
 
-Rake::TestTask.new do |t|
-  task :test => [:build]
-  t.libs << 'ext'
-  t.warning = true
-  t.verbose = true
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '-Iext'
 end
 
-task :default => :test
+task :default => [:build, :spec]

data/certs/djberg96_pub.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+-----END CERTIFICATE-----

data/doc/wait3.txt

@@ -174,10 +174,10 @@ Process::RLIM_SAVED_MAX
    page at https://github.com/djberg96/proc-wait3.
 
 == License
-   Artistic 2.0
+   Apache-2.0
 
 == Copyright
-   (C) 2003-2014 Daniel J. Berger
+   (C) 2003-2019 Daniel J. Berger
    All Rights Reserved.
 
 == Warranty

data/ext/extconf.rb

@@ -6,29 +6,6 @@ require 'mkmf'
 
 dir_config('proc-wait3')
 
-# We need this for older versions of Ruby.
-def have_const(const, header = nil, opt = "", &b)
-  checking_for const do
-    header = cpp_include(header)
-    if try_compile(<<"SRC", opt, &b)
-#{COMMON_HEADERS}
-#{header}
-/* top */
-static int t = #{const};
-SRC
-     $defs.push(
-        format(
-          "-DHAVE_CONST_%s",
-          const.strip.upcase.tr_s("^A-Z0-9_", "_")
-        )
-      )
-      true
-    else
-      false
-    end
-  end
-end
-
 have_header('wait.h')
 have_header('sys/resource.h')
 have_header('sys/wait.h')
@@ -41,7 +18,16 @@ end
 
 # Yay, Linux
 have_func('str2sig')
-have_func('strlcpy')
+
+if have_library('bsd')
+  if have_header('bsd/string.h')
+    have_func('strlcpy', 'bsd/string.h')
+  else
+    have_func('strlcpy')
+  end
+else
+  have_func('strlcpy')
+end
 
 # wait4, waitid, etc, are optional (HPUX, et al)
 have_func('wait4')
@@ -92,4 +78,7 @@ have_const('P_PID', 'signal.h') || have_const('P_PID', 'sys/wait.h')
 have_const('P_PROJID', 'signal.h')
 have_const('P_TASKID', 'signal.h')
 
+# RUSAGE_THREAD is Linux-specific
+have_const('RUSAGE_THREAD', 'sys/resource.h')
+
 create_makefile('proc/wait3', 'proc')

data/ext/proc/wait3.c

@@ -18,33 +18,12 @@
 #include <signal.h>
 #endif
 
-#ifndef SIG2STR_MAX
-#define SIG2STR_MAX 32
-#endif
-
-/* Ruby 1.9.x */
-#ifndef RSTRING_PTR
-#define RSTRING_PTR(v) (RSTRING(v)->ptr)
-#define RSTRING_LEN(v) (RSTRING(v)->len)
-#endif
-
-#ifndef RARRAY_PTR
-#define RARRAY_PTR(v) (RARRAY(v)->ptr)
-#define RARRAY_LEN(v) (RARRAY(v)->len)
+#ifdef HAVE_BSD_STRING_H
+#include <bsd/string.h>
 #endif
 
-/* Copied from process.c in Ruby 1.8.5 */
-#ifndef RUBY_HAS_RLIMIT
-#if SIZEOF_RLIM_T == SIZEOF_INT
-# define RLIM2NUM(v) UINT2NUM(v)
-# define NUM2RLIM(v) NUM2UINT(v)
-#elif SIZEOF_RLIM_T == SIZEOF_LONG
-# define RLIM2NUM(v) ULONG2NUM(v)
-# define NUM2RLIM(v) NUM2ULONG(v)
-#elif SIZEOF_RLIM_T == SIZEOF_LONG_LONG
-# define RLIM2NUM(v) ULL2NUM(v)
-# define NUM2RLIM(v) NUM2ULL(v)
-#endif
+#ifndef SIG2STR_MAX
+#define SIG2STR_MAX 32
 #endif
 
 VALUE v_last_status;
@@ -184,8 +163,8 @@ static VALUE proc_wait3(int argc, VALUE *argv, VALUE mod){
       v_last_status = rb_struct_new(v_procstat_struct,
          INT2FIX(pid),
          INT2FIX(status),
-         INT2FIX(r.ru_utime.tv_sec + (r.ru_utime.tv_usec/1000.0)),
-         INT2FIX(r.ru_stime.tv_sec + (r.ru_stime.tv_usec/1000.0)),
+         INT2FIX(r.ru_utime.tv_sec + (r.ru_utime.tv_usec/1e6)),
+         INT2FIX(r.ru_stime.tv_sec + (r.ru_stime.tv_usec/1e6)),
          INT2FIX(r.ru_maxrss),
          INT2FIX(r.ru_ixrss),
          INT2FIX(r.ru_idrss),
@@ -256,8 +235,8 @@ static VALUE proc_wait4(int argc, VALUE *argv, VALUE mod){
       v_last_status = rb_struct_new(v_procstat_struct,
          INT2FIX(pid),
          INT2FIX(status),
-         INT2FIX(r.ru_utime.tv_sec + (r.ru_utime.tv_usec/1000.0)),
-         INT2FIX(r.ru_stime.tv_sec + (r.ru_stime.tv_usec/1000.0)),
+         INT2FIX(r.ru_utime.tv_sec + (r.ru_utime.tv_usec/1e6)),
+         INT2FIX(r.ru_stime.tv_sec + (r.ru_stime.tv_usec/1e6)),
          INT2FIX(r.ru_maxrss),
          INT2FIX(r.ru_ixrss),
          INT2FIX(r.ru_idrss),
@@ -730,6 +709,9 @@ static VALUE proc_sigsend(int argc, VALUE* argv, VALUE mod){
  * process. If +children+ is set to true, it will return information for
  * terminated and waited for children of the current process.
  *
+ * On Linux platforms the +children+ argument can be set to RUSAGE_THREAD to
+ * retrieve thread information instead.
+ *
  * The RUsage struct contains the following members:
  *
  * * utime     - User time
@@ -758,7 +740,9 @@ static VALUE proc_getrusage(int argc, VALUE* argv, VALUE mod){
 
   rb_scan_args(argc, argv, "01", &v_children);
 
-  if(RTEST(v_children))
+  if(TYPE(v_children) == T_FIXNUM)
+    who = FIX2INT(v_children);
+  else if(RTEST(v_children))
     who = RUSAGE_CHILDREN;
 
   if(getrusage(who,&r) == -1)
@@ -966,8 +950,12 @@ void Init_wait3()
   rb_define_const(rb_mProcess, "P_PROJID", INT2FIX(P_PROJID));
 #endif
 
-  /* 1.7.1: The version of the proc-wait3 library */
-  rb_define_const(rb_mProcess, "WAIT3_VERSION", rb_str_new2("1.7.1"));
+#ifdef HAVE_CONST_RUSAGE_THREAD
+  rb_define_const(rb_mProcess, "RUSAGE_THREAD", INT2FIX(RUSAGE_THREAD));
+#endif
+
+  /* 1.9.0: The version of the proc-wait3 library */
+  rb_define_const(rb_mProcess, "WAIT3_VERSION", rb_str_freeze(rb_str_new2("1.9.0")));
 
   /* Define this last in our Init_wait3 function */
   rb_define_readonly_variable("$last_status", &v_last_status);

data/lib/proc-wait3.rb

@@ -0,0 +1 @@
+require 'proc/wait3'

data/proc-wait3.gemspec

@@ -2,20 +2,28 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'proc-wait3'
-  spec.version    = '1.7.1'
+  spec.version    = '1.9.0'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Artistic 2.0'
+  spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/proc-wait3'
   spec.summary    = 'Adds wait3, wait4 and other methods to the Process module'
-  spec.test_file  = 'test/test_proc_wait3.rb'
+  spec.test_file  = 'spec/proc_wait3_spec.rb'
   spec.extensions = ['ext/extconf.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST', 'ext/proc/wait3.c']
-
-  spec.add_development_dependency('test-unit')
   spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+
+  spec.metadata = {
+    'homepage_uri'      => 'https://github.com/djberg96/proc-wait3',
+    'bug_tracker_uri'   => 'https://github.com/djberg96/proc-wait3/issues',
+    'changelog_uri'     => 'https://github.com/djberg96/proc-wait3/blob/master/CHANGES.md',
+    'documentation_uri' => 'https://github.com/djberg96/proc-wait3/wiki',
+    'source_code_uri'   => 'https://github.com/djberg96/proc-wait3',
+    'wiki_uri'          => 'https://github.com/djberg96/proc-wait3/wiki'
+  }
 
   spec.description = <<-EOF
     The proc-wait3 library adds the wait3, wait4, waitid, pause, sigsend,

data/spec/proc_wait3_spec.rb

@@ -0,0 +1,234 @@
+#######################################################################
+# proc_wait3_spec.rb
+#
+# Test suite for the Ruby proc-wait3 library. You should run these
+# via the 'rake spec' task.
+#######################################################################
+require 'proc/wait3'
+require 'rspec'
+require 'rbconfig'
+
+RSpec.describe Process do
+  let(:solaris) { RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i }
+  let(:darwin)  { RbConfig::CONFIG['host_os'] =~ /darwin|osx/i }
+  let(:hpux)    { RbConfig::CONFIG['host_os'] =~ /hpux/i }
+  let(:linux)   { RbConfig::CONFIG['host_os'] =~ /linux/i }
+  let(:freebsd) { RbConfig::CONFIG['host_os'] =~ /bsd/i }
+
+  let(:proc_stat_members) {
+    %i[
+      pid status utime stime maxrss ixrss idrss isrss minflt majflt nswap
+      inblock oublock msgsnd msgrcv nsignals nvcsw nivcsw stopped signaled
+      exited success coredump exitstatus termsig stopsig
+    ]
+  }
+
+  before do
+    @proc_stat = nil
+  end
+
+  example "version constant is set to expected value" do
+    expect(Process::WAIT3_VERSION).to eq('1.9.0')
+    expect(Process::WAIT3_VERSION).to be_frozen
+  end
+
+  example "wait3 method is defined" do
+    expect(Process).to respond_to(:wait3)
+  end
+
+  example "wait3 works as expected" do
+    skip 'wait3 test skipped on this platform' if darwin
+    fork{ sleep 0.5 }
+    expect{ Process.wait3 }.not_to raise_error
+  end
+
+  example "wait3 returns the expected proc status members" do
+    skip 'wait3 test skipped on this platform' if darwin
+    fork{ sleep 0.5 }
+    expect{ @proc_stat = Process.wait3 }.not_to raise_error
+    expect( @proc_stat.members).to eq(proc_stat_members)
+  end
+
+  example "wait3 with WNOHANG works as expected" do
+    fork{ sleep 0.5 }
+    expect{ Process.wait3(Process::WNOHANG) }.not_to raise_error
+  end
+
+  example "wait3 sets and returns $last_status to expected values" do
+    skip 'wait3 test skipped on this platform' if darwin
+    fork{ sleep 0.5 }
+    Process.wait3
+    expect($last_status).to be_kind_of(Struct::ProcStat)
+    expect($last_status).not_to be_nil
+  end
+
+  example "wait3 sets pid and status members of $?" do
+    skip 'wait3 test skipped on this platform' if darwin
+    fork{ sleep 0.5 }
+    Process.wait3
+    expect($?).not_to be_nil
+  end
+
+  example "wait3 returns frozen struct" do
+    skip 'wait3 test skipped on this platform' if darwin
+    fork{ sleep 0.5 }
+    struct = Process.wait3
+    expect(struct).to be_frozen
+  end
+
+  example "getdtablesize works as expected" do
+    skip 'getdtablesize skipped on this platform' unless solaris
+
+    expect(Process).to respond_to(:getdtablesize)
+    expect(Process.getdtablesize).to be_kind_of(Fixnum)
+    assert(Process.getdtablesize > 0)
+  end
+
+  example "wait4 method is defined" do
+    skip 'wait4 test skipped on this platform' if hpux
+    expect(Process).to respond_to(:wait4)
+  end
+
+  example "wait4 requires at least one argument" do
+    skip 'wait4 test skipped on this platform' if hpux
+    expect{ Process.wait4 }.to raise_error(ArgumentError)
+  end
+
+  example "wait4 works as expected" do
+    skip 'wait4 test skipped on this platform' if hpux || darwin
+
+    pid = fork{ sleep 0.5 }
+    expect{ @proc_stat = Process.wait4(pid) }.not_to raise_error
+    expect(@proc_stat).to be_kind_of(Struct::ProcStat)
+  end
+
+  example "wait4 sets and returns $last_status to expected values" do
+    skip 'wait4 test skipped on this platform' if hpux || darwin
+
+    pid = fork{ sleep 0.5 }
+    Process.wait4(pid)
+    expect($last_status).to be_kind_of(Struct::ProcStat)
+    expect($last_status).not_to be_nil
+  end
+
+  example "wait4 sets pid and status members of $?" do
+    skip 'wait4 test skipped on this platform' if hpux || darwin
+
+    pid = fork{ sleep 0.5 }
+    Process.wait4(pid)
+    expect($?).not_to be_nil
+  end
+
+  example "wait4 returns frozen struct" do
+    skip 'wait4 test skipped on this platform' if hpux || darwin
+
+    pid = fork{ sleep 0.5 }
+    struct = Process.wait4(pid)
+    expect(struct).to be_frozen
+  end
+
+  example "waitid method is defined" do
+    skip 'waitid test skipped on this platform' if hpux || darwin || freebsd
+
+    expect(Process).to respond_to(:waitid)
+  end
+
+  example "waitid method works as expected" do
+    skip 'waitid test skipped on this platform' if hpux || darwin || freebsd
+
+    pid = fork{ sleep 0.5 }
+    expect{ Process.waitid(Process::P_PID, pid, Process::WEXITED) }.not_to raise_error
+  end
+
+  example "waitid method raises expected errors if wrong argument type is passed" do
+    skip 'waitid test skipped on this platform' if hpux || darwin || freebsd
+
+    pid = fork{ sleep 0.5 }
+    expect{ Process.waitid("foo", pid, Process::WEXITED) }.to raise_error(TypeError)
+    expect{ Process.waitid(Process::P_PID, pid, "foo") }.to raise_error(TypeError)
+    expect{ Process.waitid(Process::P_PID, "foo", Process::WEXITED) }.to raise_error(TypeError)
+  end
+
+  example "waitid method raises expected error if invalid argument is passed" do
+    skip 'waitid test skipped on this platform' if hpux || darwin || freebsd
+
+    fork{ sleep 0.5 }
+    expect{ Process.waitid(Process::P_PID, 99999999, Process::WEXITED) }.to raise_error(Errno::ECHILD)
+  end
+
+  example "sigsend method is defined" do
+    skip 'sigsend test skipped on this platform' unless solaris
+
+    expect(Process).to respond_to(:sigsend)
+  end
+
+  example "sigsend works as expected" do
+    skip 'sigsend test skipped on this platform' unless solaris
+
+    pid = fork{ sleep 0.5 }
+    expect{ Process.sigsend(Process::P_PID, pid, 0) }.not_to raise_error
+  end
+
+  example "getrusage method is defined" do
+    expect(Process).to respond_to(:getrusage)
+  end
+
+  example "getrusage works as expected" do
+    fork{ sleep 0.5 }
+
+    expect{ Process.getrusage }.not_to raise_error
+    expect{ Process.getrusage(true) }.not_to raise_error
+  end
+
+  example "getrusage can get thread info on Linux" do
+    skip 'getrusage only tested on Linux' unless linux
+    expect{ Process.getrusage(Process::RUSAGE_THREAD) }.not_to raise_error
+  end
+
+  example "getrusage returns the expected struct" do
+    skip 'getrusage only tested on Linux' unless linux
+
+    fork{ sleep 0.5 }
+    expect(Process.getrusage).to be_kind_of(Struct::RUsage)
+    expect(Process.getrusage.stime).to be_kind_of(Float)
+    expect(Process.getrusage.utime).to be_kind_of(Float)
+  end
+
+  example "pause method is defined" do
+    expect(Process).to respond_to(:pause)
+  end
+
+  example "expected constants are defined" do
+    skip 'wait constant check skipped on this platform' if darwin || freebsd
+
+    expect(Process::WCONTINUED).not_to be_nil
+    expect(Process::WEXITED).not_to be_nil
+    expect(Process::WNOWAIT).not_to be_nil
+    expect(Process::WSTOPPED).not_to be_nil
+
+    skip 'WTRAPPED constant check skipped on this platform' if linux
+    expect(Process::WTRAPPED).not_to be_nil
+  end
+
+  example "expected process type flag constants are defined" do
+    skip 'process type flag check skipped on this platform' if linux || darwin || freebsd
+
+    expect(Process::P_ALL).not_to be_nil
+    expect(Process::P_CID).not_to be_nil
+    expect(Process::P_GID).not_to be_nil
+    expect(Process::P_PGID).not_to be_nil
+    expect(Process::P_PID).not_to be_nil
+    expect(Process::P_SID).not_to be_nil
+    expect(Process::P_UID).not_to be_nil
+
+    skip 'P_MYID constant check skipped on this platform' unless solaris
+    expect(Process::P_MYID).not_to be_nil
+  end
+
+  example "solaris-specific process type flags are defined on solaris" do
+    skip 'P_TASKID and P_PROJID constant check skipped on this platform' unless solaris
+
+    expect(Process::P_TASKID).not_to be_nil
+    expect(Process::P_PROJID).not_to be_nil
+  end
+end