solaris-kstat 1.0.0 → 1.0.1

data/CHANGES

@@ -1,4 +1,15 @@
-== 1.0.0
+== 1.0.1 - 27-Aug-2009
+* Changed the license to Artistic 2.0.
+* Fixed warnings that could occur if the @module, @name, or @instance
+  variables were not set in the constructor. They are now explicitly
+  set to nil if they do not have any value.
+* Updates to the gemspec, including license and description.
+* Renamed and performed some minor refactoring of the test and example files.
+* Changed one test to use 'biostats' instead of 'flushmeter' because
+  the latter does not appear to be defined in a Solaris VM.
+* Added the 'example' rake task.
+
+== 1.0.0 - 4-Feb-2008
 * Updated the extconf.rb file so that it sets the target prefix properly.
 * Version bump to 1.0.0.
 * No actual source code changes.

data/MANIFEST

@@ -3,8 +3,8 @@
 * README
 * Rakefile
 * solaris-kstat.gemspec
-* examples/test.rb
+* examples/example_kstat.rb
 * ext/extconf.rb
 * ext/solaris/rkstat.c
 * ext/solaris/rkstat.h
-* test/tc_kstat.rb
+* test/test_solaris_kstat.rb

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+desc "Clean the build files for the solaris-kstat source"
+task :clean do
+   FileUtils.rm_rf('solaris') if File.exists?('solaris')
+
+   Dir.chdir('ext') do
+      FileUtils.rm_rf('rkstat.c') if File.exists?('rkstat.c')
+      FileUtils.rm_rf('rkstat.h') if File.exists?('rkstat.h')
+      sh 'make distclean' if File.exists?('kstat.so')
+      FileUtils.rm_rf('solaris/kstat.so') if File.exists?('solaris/kstat.so')
+   end
+end
+
+desc "Build the solaris-kstat package (but don't install it)"
+task :build => [:clean] do
+   Dir.chdir('ext') do
+      ruby 'extconf.rb'
+      sh 'make'
+      Dir.mkdir('solaris') unless File.exists?('solaris')
+      FileUtils.cp('kstat.so', 'solaris')
+   end
+end
+
+desc "Install the solaris-kstat package (non-gem)"
+task :install => [:build] do
+   Dir.chdir('ext') do
+      sh 'make install'
+   end
+end
+
+desc "Install the solaris-kstat package as a gem"
+task :install_gem do
+   ruby 'solaris-kstat.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+desc "Uninstall the solaris-kstat package. Use 'gem uninstall' for gem installs"
+task :uninstall => [:clean] do
+   file = File.join(CONFIG['sitearchdir'], 'solaris', 'kstat.so')
+   FileUtils.rm_rf(file) if File.exists?(file)
+end
+
+desc "Run the example program"
+task :example => [:build] do
+   ruby "-Iext examples/example_kstat.rb"
+end
+
+Rake::TestTask.new do |t|
+   task :test => :build
+   t.libs << 'ext'
+   t.verbose = true
+   t.warning = true
+end

data/examples/example_kstat.rb

@@ -0,0 +1,34 @@
+#######################################################################
+# example_kstat.rb
+#
+# Sample script for general futzing. You can run this script via
+# the 'rake example' task.
+#######################################################################
+require "solaris/kstat"
+require "pp"
+include Solaris
+
+puts "VERSION: " + Kstat::VERSION
+puts
+
+k1 = Kstat.new('cpu_info', 0)
+pp k1.record
+
+puts '=' * 40
+
+k2 = Kstat.new('unix', 0, 'biostats')
+pp k2
+
+# Print all modules
+k = Kstat.new
+k.record.each{ |k,v|
+   p k
+}
+
+=begin
+pp k.record["cpu_info"][0]["cpu_info0"]
+puts "=" * 40
+pp k.record["unix"][0]["flushmeter"]
+puts "=" * 40
+pp k.record["cpu_stat"][0]["cpu_stat0"]
+=end

data/ext/solaris/rkstat.c

@@ -44,18 +44,27 @@ VALUE ks_init(int argc, VALUE* argv, VALUE self){
 
    rb_scan_args(argc, argv, "03", &v_module, &v_instance, &v_name);
 
+
    if(!NIL_P(v_module)){
       SafeStringValue(v_module);
       rb_iv_set(self, "@module", v_module);
    }
+   else{
+      rb_iv_set(self, "@module", Qnil);
+   }
 
    if(!NIL_P(v_name)){
       SafeStringValue(v_name);
       rb_iv_set(self, "@name", v_name);
    }
+   else{
+      rb_iv_set(self, "@name", Qnil);
+   }
 
    if(!NIL_P(v_instance))
       rb_iv_set(self, "@instance", v_instance);
+   else
+      rb_iv_set(self, "@instance", Qnil);
 
    return self;
 }
@@ -199,7 +208,7 @@ void Init_kstat(){
    /* Unique name within module */
    rb_define_attr(cKstat, "name", 1, 1);
 
-   /* 1.0.0: The version of this library, returned as a String */
+   /* 1.0.1: The version of the solaris-kstat library */
    rb_define_const(cKstat, "VERSION", rb_str_new2(SOLARIS_KSTAT_VERSION));
 }
 

data/ext/solaris/rkstat.h

@@ -2,7 +2,7 @@
 extern "C" {
 #endif
 
-#define SOLARIS_KSTAT_VERSION "1.0.0"
+#define SOLARIS_KSTAT_VERSION "1.0.1"
 
 /* Function prototypes */
 static VALUE map_named_data_type(kstat_t* ksp);

data/solaris-kstat.gemspec

@@ -0,0 +1,35 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |gem|
+   gem.name       = 'solaris-kstat'
+   gem.version    = '1.0.1'
+   gem.author     = 'Daniel J. Berger'
+   gem.license    = 'Artistic 2.0'
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/solarisutils'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'Interface for the Solaris kstat library'
+   gem.has_rdoc   = true
+   gem.test_file  = 'test/test_solaris_kstat.rb'
+   gem.extensions = ['ext/extconf.rb']
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'solarisutils'
+
+   gem.extra_rdoc_files = [
+      'README',
+      'CHANGES',
+      'MANIFEST',
+      'ext/solaris/rkstat.c'
+   ]
+
+   gem.required_ruby_version = '>= 1.8.0'
+
+   gem.description = <<-EOF
+      The solaris-kstat library provides a Ruby interface for gathering kernel
+      statistics from the operating system. Each matching statistic is provided
+      with its module, instance, and name fields, as well as its actual value.
+   EOF
+end
+
+Gem::Builder.new(spec).build

data/test/test_solaris_kstat.rb

@@ -0,0 +1,165 @@
+###############################################################################
+# test_solaris_kstat.rb
+#
+# Test suite for the solaris-kstat Ruby library. You should run this via
+# the 'rake test' task.
+###############################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'solaris/kstat'
+require 'test/unit'
+require 'set'
+include Solaris
+
+class TC_Solaris_Kstat < Test::Unit::TestCase
+   def setup
+      @k = Kstat.new
+   end
+
+   def test_version
+      assert_equal('1.0.1', Kstat::VERSION)
+   end
+
+   def test_name
+      assert_respond_to(@k, :name)
+      assert_respond_to(@k, :name=)
+      assert_nil(@k.name)
+      assert_nothing_raised{ @k.name }
+      assert_nothing_raised{ @k.name = 'foo' }
+   end
+
+   def test_module
+      assert_respond_to(@k, :module)
+      assert_respond_to(@k, :module=)
+      assert_nil(@k.module)
+      assert_nothing_raised{ @k.module }
+      assert_nothing_raised{ @k.module = 'bar' }
+   end
+
+   def test_instance
+      assert_respond_to(@k, :instance)
+      assert_respond_to(@k, :instance=)
+      assert_nil(@k.instance)
+      assert_nothing_raised{ @k.instance }
+      assert_nothing_raised{ @k.instance = 0 }
+   end
+
+   def test_constructor_valid_values
+      assert_nothing_raised{ Kstat.new('cpu_info',0,'cpu_info0').record }
+      assert_nothing_raised{ Kstat.new(nil,0,'cpu_info0').record }
+      assert_nothing_raised{ Kstat.new('cpu_info',0,nil).record }
+   end
+
+   def test_constructor_invalid_values
+      assert_raises(Kstat::Error){ Kstat.new('bogus').record }
+      assert_raises(Kstat::Error){ Kstat.new('cpu_info',99).record }
+      assert_raises(Kstat::Error){ Kstat.new('cpu_info',0,'bogus').record }
+      assert_raises(TypeError){ Kstat.new('cpu_info','x').record }
+   end
+
+   def test_record_basic
+      assert_respond_to(@k, :record)
+   end
+
+   def test_record_named
+      assert_nothing_raised{ @k.record['cpu_info'][0]['cpu_info0'] }
+      assert_kind_of(Hash, @k.record['cpu_info'][0]['cpu_info0'])
+   end
+
+   def test_record_io
+      assert_nothing_raised{ @k.record['nfs'][1]['nfs1'] }
+      assert_kind_of(Hash, @k.record['nfs'][1]['nfs1'])
+   end
+
+   def test_record_intr
+      assert_nothing_raised{ @k.record['fd'][0]['fd0'] }
+      assert_kind_of(Hash, @k.record['fd'][0]['fd0'])
+   end
+
+   def test_record_raw_vminfo
+      keys = %w/freemem swap_alloc swap_avail swap_free swap_resv/
+
+      assert_nothing_raised{ @k.record['unix'][0]['vminfo'] }
+      assert_kind_of(Hash, @k.record['unix'][0]['vminfo'])
+      assert_equal(keys, @k.record['unix'][0]['vminfo'].keys.sort)
+   end
+
+   def test_record_raw_var
+      keys = %w/
+         v_autoup v_buf v_bufhwm v_call v_clist v_hbuf v_hmask
+         v_maxpmem v_maxsyspri v_maxup v_maxupttl v_nglobpris v_pbuf
+         v_proc v_sptmap
+      /
+
+      assert_nothing_raised{ @k.record['unix'][0]['var'] }
+      assert_kind_of(Hash, @k.record['unix'][0]['var'])
+      assert_equal(keys,  @k.record['unix'][0]['var'].keys.sort)
+   end
+
+   def test_record_raw_biostats
+      keys = %w/
+         buffer_cache_hits
+         buffer_cache_lookups
+         buffers_locked_by_someone
+         duplicate_buffers_found
+         new_buffer_requests
+         waits_for_buffer_allocs
+      /
+
+      assert_nothing_raised{ @k.record['unix'][0]['biostats'] }
+      assert_kind_of([Hash, NilClass], @k.record['unix'][0]['biostats'])
+      assert_equal(keys,  @k.record['unix'][0]['biostats'].keys.sort)
+   end
+
+   def test_record_raw_cpu_stat
+      keys = %w/
+         cpu_idle cpu_user cpu_kernel cpu_wait wait_io wait_swap
+         wait_pio bread bwrite lread lwrite phread phwrite pswitch
+         trap intr syscall sysread syswrite sysfork sysvfork sysexec
+         readch writech rcvint xmtint mdmint rawch canch outch msg
+         sema namei ufsiget ufsdirblk ufsipage ufsinopage inodeovf
+         fileovf procovf intrthread intrblk idlethread inv_swtch
+         nthreads cpumigrate xcalls mutex_adenters rw_rdfails
+         rw_wrfails modload modunload bawrite
+      /
+
+      assert_nothing_raised{ @k.record['cpu_stat'][0]['cpu_stat0'] }
+      assert_kind_of(Hash, @k.record['cpu_stat'][0]['cpu_stat0'])
+
+      # Too big and difficult to sort manually - so use a Set
+      set1 = Set.new(keys)
+      set2 = Set.new(@k.record['cpu_stat'][0]['cpu_stat0'].keys)
+      diff = set1 - set2
+
+      assert_equal(set1,set2,'Diff was: #{diff.to_a}')
+   end
+
+   def test_record_ncstats
+      keys = %w/
+         dbl_enters
+         enters
+         hits
+         long_enter
+         long_look misses
+         move_to_front
+         purges
+      /
+
+      assert_nothing_raised{ @k.record['unix'][0]['ncstats'] }
+      assert_kind_of(Hash, @k.record['unix'][0]['ncstats'])
+      assert_equal(keys, @k.record['unix'][0]['ncstats'].keys.sort)
+   end
+
+   def test_record_sysinfo
+      keys = %w/runocc runque swpocc swpque updates waiting/
+
+      assert_nothing_raised{ @k.record['unix'][0]['sysinfo'] }
+      assert_kind_of(Hash, @k.record['unix'][0]['sysinfo'])
+      assert_equal(keys, @k.record['unix'][0]['sysinfo'].keys.sort)
+   end
+
+   def teardown
+      @k = nil
+   end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: solaris-kstat
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-04 00:00:00 -07:00
+date: 2009-08-27 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: Interface for the Solaris kstat library
+description: "      The solaris-kstat library provides a Ruby interface for gathering kernel\n      statistics from the operating system. Each matching statistic is provided\n      with its module, instance, and name fields, as well as its actual value.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -25,17 +25,20 @@ extra_rdoc_files:
 - MANIFEST
 - ext/solaris/rkstat.c
 files: 
+- CHANGES
+- MANIFEST
+- README
+- Rakefile
+- solaris-kstat.gemspec
+- examples/example_kstat.rb
 - ext/extconf.rb
-- ext/solaris
 - ext/solaris/rkstat.c
 - ext/solaris/rkstat.h
-- test/tc_kstat.rb
-- examples/test.rb
-- README
-- CHANGES
-- MANIFEST
+- test/test_solaris_kstat.rb
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/solarisutils
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -56,9 +59,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: solarisutils
-rubygems_version: 1.0.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Interface for the Solaris kstat library
 test_files: 
-- test/tc_kstat.rb
+- test/test_solaris_kstat.rb

data/examples/test.rb

@@ -1,43 +0,0 @@
-########################################################
-# test_kstat.rb
-#
-# Sample script for general futzing.
-########################################################
-base = File.basename(Dir.pwd)
-
-if base == "examples" || base =~ /solaris-kstat.*/
-   require "ftools"
-   Dir.chdir ".." if base == "examples"
-   Dir.mkdir("solaris") unless File.exists?("solaris")
-   File.copy("kstat.so","solaris")
-   $LOAD_PATH.unshift Dir.pwd
-end
-
-require "solaris/kstat"
-require "pp"
-include Solaris
-
-puts "VERSION: " + Kstat::VERSION
-puts
-
-k1 = Kstat.new("cpu_info",0)
-pp k1.record
-
-puts "=" * 40
-
-k2 = Kstat.new("unix",0,"flushmeter")
-pp k2
-
-# Print all modules
-k = Kstat.new
-k.record.each{ |k,v|
-   p k
-}
-
-=begin
-pp k.record["cpu_info"][0]["cpu_info0"]
-puts "=" * 40
-pp k.record["unix"][0]["flushmeter"]
-puts "=" * 40
-pp k.record["cpu_stat"][0]["cpu_stat0"]
-=end

data/test/tc_kstat.rb

@@ -1,147 +0,0 @@
-###############################################################################
-# tc_kstat.rb
-#
-# Test suite for the solaris-kstat Ruby package. You should run this via
-# the 'rake test' task.
-###############################################################################
-require "solaris/kstat"
-require "test/unit"
-require "set"
-include Solaris
-
-class TC_Kstat < Test::Unit::TestCase
-   def setup
-      @k = Kstat.new
-   end
-
-   def test_version
-      assert_equal('1.0.0', Kstat::VERSION)
-   end
-
-   def test_name
-      assert_respond_to(@k, :name)
-      assert_respond_to(@k, :name=)
-      assert_nil(@k.name)
-      assert_nothing_raised{ @k.name }
-      assert_nothing_raised{ @k.name = "foo" }
-   end
-
-   def test_module
-      assert_respond_to(@k, :module)
-      assert_respond_to(@k, :module=)
-      assert_nil(@k.module)
-      assert_nothing_raised{ @k.module }
-      assert_nothing_raised{ @k.module = "bar" }
-   end
-
-   def test_instance
-      assert_respond_to(@k, :instance)
-      assert_respond_to(@k, :instance=)
-      assert_nil(@k.instance)
-      assert_nothing_raised{ @k.instance }
-      assert_nothing_raised{ @k.instance = 0 }
-   end
-
-   def test_constructor_valid_values
-      assert_nothing_raised{ Kstat.new("cpu_info",0,"cpu_info0").record }
-      assert_nothing_raised{ Kstat.new(nil,0,"cpu_info0").record }
-      assert_nothing_raised{ Kstat.new("cpu_info",0,nil).record }
-   end
-
-   def test_constructor_invalid_values
-      assert_raises(Kstat::Error){ Kstat.new("bogus").record }
-      assert_raises(Kstat::Error){ Kstat.new("cpu_info",99).record }
-      assert_raises(Kstat::Error){ Kstat.new("cpu_info",0,"bogus").record }
-      assert_raises(TypeError){ Kstat.new("cpu_info","x").record }
-   end
-
-   def test_record_basic
-      assert_respond_to(@k, :record)
-   end
-
-   def test_record_named
-      assert_nothing_raised{ @k.record["cpu_info"][0]["cpu_info0"] }
-      assert_kind_of(Hash, @k.record["cpu_info"][0]["cpu_info0"])
-   end
-
-   def test_record_io
-      assert_nothing_raised{ @k.record["nfs"][1]["nfs1"] }
-      assert_kind_of(Hash, @k.record["nfs"][1]["nfs1"])
-   end
-
-   def test_record_intr
-      assert_nothing_raised{ @k.record["fd"][0]["fd0"] }
-      assert_kind_of(Hash, @k.record["fd"][0]["fd0"])
-   end
-
-   def test_record_raw_vminfo
-      keys = %w/freemem swap_alloc swap_avail swap_free swap_resv/
-
-      assert_nothing_raised{ @k.record["unix"][0]["vminfo"] }
-      assert_kind_of(Hash, @k.record["unix"][0]["vminfo"])
-      assert_equal(keys, @k.record["unix"][0]["vminfo"].keys.sort)
-   end
-
-   def test_record_raw_var
-      keys = %w/v_autoup v_buf v_bufhwm v_call v_clist v_hbuf v_hmask/
-      keys.push %w/v_maxpmem v_maxsyspri v_maxup v_maxupttl v_nglobpris v_pbuf/
-      keys.push %w/v_proc v_sptmap/
-      keys.flatten!
-
-      assert_nothing_raised{ @k.record["unix"][0]["var"] }
-      assert_kind_of(Hash, @k.record["unix"][0]["var"])
-      assert_equal(keys,  @k.record["unix"][0]["var"].keys.sort)
-   end
-
-   def test_record_raw_flushmeter
-      keys = %w/f_ctx f_page f_partial f_region f_segment f_usr/
-
-      assert_nothing_raised{ @k.record["unix"][0]["flushmeter"] }
-      assert_kind_of(Hash, @k.record["unix"][0]["flushmeter"])
-      assert_equal(keys,  @k.record["unix"][0]["flushmeter"].keys.sort)
-   end
-
-   def test_record_raw_cpu_stat
-      keys = %w/cpu_idle cpu_user cpu_kernel cpu_wait wait_io wait_swap/
-      keys << %w/wait_pio bread bwrite lread lwrite phread phwrite pswitch/
-      keys << %w/trap intr syscall sysread syswrite sysfork sysvfork sysexec/
-      keys << %w/readch writech rcvint xmtint mdmint rawch canch outch msg/
-      keys << %w/sema namei ufsiget ufsdirblk ufsipage ufsinopage inodeovf/
-      keys << %w/fileovf procovf intrthread intrblk idlethread inv_swtch/
-      keys << %w/nthreads cpumigrate xcalls mutex_adenters rw_rdfails/
-      keys << %w/rw_wrfails modload modunload bawrite/
-      keys.flatten!
-
-      assert_nothing_raised{ @k.record["cpu_stat"][0]["cpu_stat0"] }
-      assert_kind_of(Hash, @k.record["cpu_stat"][0]["cpu_stat0"])
-
-      # Too big and difficult to sort manually - so use a Set
-      set1 = Set.new(keys)
-      set2 = Set.new(@k.record["cpu_stat"][0]["cpu_stat0"].keys)
-      diff = set1 - set2
-
-      assert_equal(set1,set2,"Diff was: #{diff.to_a}")
-   end
-
-   def test_record_ncstats
-      keys = %w/dbl_enters enters hits long_enter long_look misses/
-      keys.push %w/move_to_front purges/
-      keys.flatten!
-
-      assert_nothing_raised{ @k.record["unix"][0]["ncstats"] }
-      assert_kind_of(Hash, @k.record["unix"][0]["ncstats"])
-      assert_equal(keys, @k.record["unix"][0]["ncstats"].keys.sort)
-   end
-
-   def test_record_sysinfo
-      keys = %w/runocc runque swpocc swpque updates waiting/
-
-      assert_nothing_raised{ @k.record["unix"][0]["sysinfo"] }
-      assert_kind_of(Hash, @k.record["unix"][0]["sysinfo"])
-      assert_equal(keys, @k.record["unix"][0]["sysinfo"].keys.sort)
-   end
-
-   def teardown
-      @k = nil
-   end
-end