net-tnsping 1.2.0 → 1.3.0

data/CHANGES

@@ -1,3 +1,14 @@
+== 1.3.0 - 22-Jul-2009
+* Removed the old constant aliases. Use Ping::TNS and Ping::TNS::Error.
+* Added documentation for individual accessors.
+* Added aliases for Ping::TNS#db and Ping::TNS#dsn.
+* Bug fix for Ping::TNS#port= where an instance variable wasn't set.
+* Updated test suite to use test-unit 2.x features. Added test-unit 2.x as
+  a dependency as a result.
+* Renamed the example program to avoid any confusion with test files.
+* Updated the license to Artistic 2.0.
+* Some gemspec updates.
+
 == 1.2.0 - 20-Jul-2007
 * Changed the TNSPing class name to Ping::TNS in order to follow the naming
   convention in net-ping. The TNSPingError class was likewise changed to

data/MANIFEST

@@ -3,6 +3,6 @@
 * README
 * Rakefile
 * net-tnsping.gemspec
-* examples/test_tnsping.rb
+* examples/example_tnsping.rb
 * lib/net/tnsping.rb
-* test/tc_tns_ping.rb
+* test/test_net_tnsping.rb

data/README

@@ -18,10 +18,10 @@
    ruby net-tnsping.gemspec
    gem install net-tnsping-<version>.gem
 	
-=== Installation Note
-   You will have to manually tweak one instance variable (@db) in the
-   test suite in order to get all tests to pass. Set it to a known database
-   name.
+=== Test Note
+   You may want to manually tweak one instance variable (@@database) in the
+   test suite in order to get a more robust set of test results. Set it to
+   a known database name.
 
 == Synopsis
    require "net/tnsping"
@@ -173,7 +173,7 @@ Ping::TNS#tns_file=(path)
    with some questions I had.
 
 == Copyright
-   (C) 2003-2007 Daniel J. Berger
+   (C) 2003-2009 Daniel J. Berger
    All rights reserved.
 	
 == Warranty
@@ -182,7 +182,7 @@ Ping::TNS#tns_file=(path)
    warranties of merchantability and fitness for a particular purpose.
 	
 == License
-	Ruby's
+   Artistic 2.0
 
 == Author
    Daniel J. Berger

data/Rakefile

@@ -1,22 +1,24 @@
 require 'rake'
 require 'rake/testtask'
 
-desc "Install the net-tnsping package (non-gem)"
+desc "Install the net-tnsping library (non-gem)"
 task :install do
    dest = File.join(Config::CONFIG['sitelibdir'], 'net')
    Dir.mkdir(dest) unless File.exists? dest
    cp 'lib/net/tnsping.rb', dest, :verbose => true
 end
 
-desc "Install the net-tnsping package as a gem"
+desc "Install the net-tnsping library as a gem"
 task :install_gem do
    ruby 'net-tnsping.gemspec'
    file = Dir["*.gem"].first
    sh "gem install #{file}"
 end
 
+desc "Run the example program"
+task :example do |dsn|
+   ruby "-Ilib examples/example_tnsping.rb #{dsn}"
+
 Rake::TestTask.new do |t|
-   t.libs << 'lib'
    t.warning = true
-   t.test_files = FileList['test/tc*']
 end

data/examples/example_tnsping.rb

@@ -0,0 +1,28 @@
+#######################################################################
+# example_tnsping.rb
+#
+# Simple test script. Not required for installation. Modify as you see
+# fit. You can run this program via the 'example' rake task.
+#######################################################################
+require "net/tnsping"
+
+dsn = ARGV[0]
+
+if dsn.nil?
+   puts "Usage: ruby test.rb <datasource>"
+   exit
+end
+
+t = Net::Ping::TNS.new(dsn)
+
+if t.ping_listener?
+   puts "Listener ping successful"
+else
+   puts "Listener ping problems: " + t.exception
+end
+
+if t.ping_database?
+   puts "Database ping successful"
+else
+   puts "Database ping problems: " + t.exception
+end

data/lib/net/tnsping.rb

@@ -1,20 +1,49 @@
-require "dbi"
-require "net/ping"
+require 'dbi'
+require 'net/ping'
 
 module Net
    class Ping::TNS < Ping::TCP
       class Error < StandardError; end
 
-      VERSION = '1.2.0'
+      VERSION = '1.3.0'
 
-      attr_accessor :db, :dsn, :tns_file, :host, :tns_admin
-      attr_accessor :ora_home, :driver, :timeout
-      attr_reader :hosts, :ports, :port
+      # Database name.
+      attr_accessor :db
+
+      # Database source name.
+      attr_accessor :dsn
+
+      # The full path to the tnsnames.ora file.
+      attr_accessor :tns_file
+
+      # The name of the host the database sits on.
+      attr_accessor :host
+
+      # The toplevel tns admin path.
+      attr_accessor :tns_admin
+
+      # The value of your ORACLE_HOME or ORA_HOME environment variable.
+      attr_accessor :ora_home
+
+      # The name of the oracle driver to use for connections. Defaults to OCI8.
+      attr_accessor :driver
+
+      # The timeout value for connection attempts. The default is 5 seconds.
+      attr_accessor :timeout
+
+      # A list of hosts for the given database name.
+      attr_reader :hosts
+
+      # A list of ports for the given database name
+      attr_reader :ports
+
+      # The port used when attempting a connection. The default is 1521.
+      attr_reader :port
 
       # Creates and returns a new Ping::TNS object. If the db specified cannot
       # be found in the tnsnames.ora file, then a Ping::TNS::Error is raised.
       #
-      def initialize(db, driver="OCI8", host=nil, port=1521, timeout=5)
+      def initialize(db, driver='OCI8', host=nil, port=1521, timeout=5)
          @db        = db
          @dsn       = "dbi:#{driver}:" << db
          @host      = host
@@ -33,12 +62,12 @@ module Net
          elsif @ora_home
             @tns_file = File.join(@ora_home, 'network', 'admin', 'tnsnames.ora')
          else
-            @tns_file = File.join(ENV["HOME"] + 'tnsnames.ora')
+            @tns_file = File.join((ENV['HOME'] || ENV['USERPROFILE']), 'tnsnames.ora')
          end
 
          yield self if block_given?
 
-         # If the host is not specified, look for it in the tnsnames.or file
+         # If the host is not specified, look for it in the tnsnames.ora file
          if host.nil?
             err_msg = "tnsnames.ora file could not be found"
             raise Error, err_msg unless File.exists?(@tns_file)
@@ -54,6 +83,7 @@ module Net
       # regardless of what is in the tnsnames.ora file.
       #
       def port=(num)
+         @port = num
          @ports = [num]
       end
 
@@ -191,21 +221,20 @@ module Net
             value.strip!
             next unless re_keys.match(key)
             case key.downcase
-               when "host"
+               when 'host'
                   @hosts.push(value)
-               when "port"
+               when 'port'
                   @ports.push(value.to_i)
-               when "sid"
+               when 'sid'
                   @sid = value
             end
          }
       end
 
+      alias database db
+      alias database_source_name dsn
       alias ping_listener? ping?
       alias oracle_home ora_home
       alias oracle_home= ora_home=
    end
-
-   TNSPing = Ping::TNS             # Alias for backwards compatability
-   TNSPingError = Ping::TNS::Error # Alias for backwards compatability
 end

data/net-tnsping.gemspec

@@ -0,0 +1,31 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |gem|
+   gem.name      = 'net-tnsping'
+   gem.version   = '1.3.0'
+   gem.license   = 'Artistic 2.0'
+   gem.author    = 'Daniel J. Berger'
+   gem.email     = 'djberg96@gmail.com'
+   gem.homepage  = 'http://www.rubyforge.org/projects/shards'
+   gem.platform  = Gem::Platform::RUBY
+   gem.summary   = 'A library for pinging Oracle listeners and databases'
+   gem.test_file = 'test/test_net_tnsping.rb'
+   gem.has_rdoc  = true
+   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'shards'
+   gem.extra_rdoc_files  = ['CHANGES', 'MANIFEST', 'README']
+
+   gem.add_dependency('net-ping', '>= 1.0.0')
+   gem.add_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The net-tnsping library provides a way to ping Oracle databases and
+      ensure that they're up and running. Unlike the tnsping command line
+      program, which only pings the listener, the net-tnsping library
+      pings both the listener and the database itself.
+   EOF
+end
+
+Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
+Gem::Builder.new(spec).build

data/test/test_net_tnsping.rb

@@ -0,0 +1,158 @@
+########################################################################
+# test_tns_ping.rb
+#
+# Test suite for the net-tnsping library. This should be run via the
+# 'rake test' task.
+########################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'net/tnsping'
+include Net
+
+class TC_TNS_Ping < Test::Unit::TestCase
+   def self.startup
+      @@database = 'change_me' # Change to a valid host name
+      @@hostname = Socket.gethostname
+   end
+
+   def setup
+      if @@database == 'change_me'
+         @tnsp = Ping::TNS.new(@@database, 'OCI8', @@hostname)
+      else
+         @tnsp = Ping::TNS.new(@@database)
+      end
+   end
+   
+   def test_version
+      assert_equal('1.3.0', Ping::TNS::VERSION)
+   end
+
+   def test_db_get
+      assert_respond_to(@tnsp, :db)
+      assert_nothing_raised{ @tnsp.db }
+      assert_equal(@@database, @tnsp.db)
+   end
+
+   def test_db_set
+      assert_respond_to(@tnsp, :db=)
+      assert_nothing_raised{ @tnsp.db = 'fubar' }
+      assert_equal('fubar', @tnsp.db)
+   end
+
+   def test_dsn_get
+      assert_respond_to(@tnsp, :dsn)
+      assert_nothing_raised{ @tnsp.dsn }
+      assert_equal("dbi:OCI8:#{@@database}", @tnsp.dsn)
+   end
+
+   def test_dsn_set
+      assert_respond_to(@tnsp, :dsn=)
+      assert_nothing_raised{ @tnsp.dsn = 'dbi:OCI8:fubar' }
+      assert_equal('dbi:OCI8:fubar', @tnsp.dsn)
+   end
+
+   def test_port_get
+      assert_respond_to(@tnsp, :port)
+      assert_equal(1521, @tnsp.port)
+   end
+
+   def test_port_set
+      assert_respond_to(@tnsp, :port=)
+      assert_nothing_raised{ @tnsp.port = 1555 }
+      assert_equal(1555, @tnsp.port)
+   end
+
+   def test_ports
+      assert_respond_to(@tnsp, :ports)
+      assert_kind_of(Array, @tnsp.ports)
+      assert(@tnsp.ports.length > 0)
+   end
+
+   def test_host_get
+      assert_respond_to(@tnsp, :host)
+      assert_equal(@@hostname, @tnsp.host)
+   end
+
+   def test_host_set
+      assert_respond_to(@tnsp, :host=)
+      assert_nothing_raised{ @tnsp.host = 'fubar' }
+      assert_equal('fubar', @tnsp.host)
+   end
+
+   def tests_hosts
+      assert_respond_to(@tnsp, :hosts)
+      assert_kind_of(Array, @tnsp.hosts)
+      assert(@tnsp.hosts.length > 0)
+   end
+
+   def test_tns_file_get
+      assert_respond_to(@tnsp, :tns_file)
+      omit_if(@@database == 'change_me', 'tns_file test skipped without real database')
+      assert_true(File.exist?(@tnsp.tns_file))
+   end
+
+   def test_tns_file_set
+      assert_respond_to(@tnsp, :tns_file=)
+      assert_nothing_raised{ @tnsp.tns_file = 'fu_tnsnames.ora' }
+      assert_equal('fu_tnsnames.ora', @tnsp.tns_file)
+   end
+
+   def test_oracle_home_get
+      assert_respond_to(@tnsp, :oracle_home)
+      assert_kind_of([String, NilClass], @tnsp.oracle_home)
+   end
+
+   def test_oracle_home_set
+      assert_respond_to(@tnsp, :oracle_home=)
+      assert_nothing_raised{ @tnsp.oracle_home = ENV['HOME'] }
+      assert_equal(ENV['HOME'], @tnsp.oracle_home)
+   end
+
+   def test_tns_admin_get
+      assert_respond_to(@tnsp, :tns_admin)
+      assert_kind_of([String, NilClass], @tnsp.tns_admin)
+   end
+
+   def test_tns_admin_set
+      assert_respond_to(@tnsp, :tns_admin=)
+      assert_nothing_raised{ @tnsp.tns_admin = ENV['HOME'] }
+      assert_equal(ENV['HOME'], @tnsp.tns_admin)
+   end
+
+   def test_ping_listener
+      assert_respond_to(@tnsp, :ping?)
+      assert_nothing_raised{ @tnsp.ping? }
+      omit_if(@@database == 'change_me', 'ping listener test skipped without real database')
+      assert_equal(true, @tnsp.ping?)
+   end
+
+   def test_ping_database
+      assert_respond_to(@tnsp, :ping_database?)
+      assert_nothing_raised{ @tnsp.ping_database? }
+      omit_if(@@database == 'change_me', 'ping database test skipped without real database')
+      assert_equal(true, @tnsp.ping_database?)
+   end
+
+   def test_ping_all
+      assert_respond_to(@tnsp, :ping_all?)
+      assert_nothing_raised{ @tnsp.ping_all? }
+      omit_if(@@database == 'change_me', 'ping all test skipped without real database')
+      assert_equal(true, @tnsp.ping_all?)
+   end
+
+   def test_bad_db
+      assert_raises(Ping::TNS::Error){ Ping::TNS.new('bogus_db') }
+      @tnsp.port = 9999
+      assert_equal(false, @tnsp.ping_listener?)
+   end
+
+   def teardown
+      @tnsp = nil
+   end
+
+   def self.shutdown
+      @@database = nil
+   end
+end

metadata

@@ -1,60 +1,83 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: net-tnsping
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2007-07-20 00:00:00 -06:00
-summary: A package for pinging Oracle listeners and databases
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/shards
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.3.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
-files: 
-- lib/net/tnsping.rb
-- CHANGES
-- MANIFEST
-- README
-- Rakefile
-- test/tc_tns_ping.rb
-test_files: 
-- test/tc_tns_ping.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- CHANGES
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2009-07-22 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ping
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+description: "      The net-tnsping library provides a way to ping Oracle databases and\n      ensure that they're up and running. Unlike the tnsping command line\n      program, which only pings the listener, the net-tnsping library\n      pings both the listener and the database itself.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- MANIFEST
+- README
+files: 
+- CHANGES
+- examples/example_tnsping.rb
+- lib/net/tnsping.rb
+- MANIFEST
+- net-tnsping.gemspec
+- Rakefile
+- README
+- test/test_net_tnsping.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shards
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A library for pinging Oracle listeners and databases
+test_files: 
+- test/test_net_tnsping.rb

data/test/tc_tns_ping.rb

@@ -1,103 +0,0 @@
-########################################################################
-# tc_tns_ping.rb
-#
-# Test suite for the tns-ping package. This should be run via the
-# 'rake test' Rake task.
-########################################################################
-require "test/unit"
-require "net/tnsping"
-include Net
-
-class TC_TNS_Ping < Test::Unit::TestCase
-   def setup
-      @db = 'changme' # Change to a valid host in your network
-      @tp = Ping::TNS.new(@db)
-   end
-   
-   def test_version
-      assert_equal("1.2.0", Ping::TNS::VERSION)
-      assert_equal("1.2.0", TNSPing::VERSION) # Testing the alias really
-   end
-
-   def test_db
-      assert_respond_to(@tp, :db)
-      assert_respond_to(@tp, :db=)
-      assert_nothing_raised{ @tp.db }
-      assert_equal(@db, @tp.db)
-   end
-
-   def test_dsn
-      assert_respond_to(@tp, :dsn)
-      assert_respond_to(@tp, :dsn=)
-   end
-
-   def test_port
-      assert_respond_to(@tp, :port)
-      assert_respond_to(@tp, :port=)
-      assert_equal(1521, @tp.port)
-   end
-
-   def test_ports
-      assert_respond_to(@tp, :ports)
-      assert_kind_of(Array, @tp.ports)
-      assert(@tp.ports.length > 0)
-   end
-
-   def test_host
-      assert_respond_to(@tp, :host)
-      assert_respond_to(@tp, :host=)
-   end
-
-   def tests_hosts
-      assert_respond_to(@tp, :hosts)
-      assert_kind_of(Array, @tp.hosts)
-      assert(@tp.hosts.length > 0)
-   end
-
-   def test_tns_file
-      assert_respond_to(@tp, :tns_file)
-      assert_respond_to(@tp, :tns_file=)
-      assert(File.exist?(@tp.tns_file))
-   end
-
-   def test_oracle_home
-      assert_respond_to(@tp, :oracle_home)
-      assert_respond_to(@tp, :oracle_home=)
-      assert_kind_of(String, @tp.oracle_home)
-   end
-
-   def test_tns_admin
-      assert_respond_to(@tp, :tns_admin)
-      assert_respond_to(@tp, :tns_admin=)
-   end
-
-   def test_ping_listener
-      assert_respond_to(@tp, :ping?)
-      assert_nothing_raised{ @tp.ping? }
-      assert_equal(true, @tp.ping?)
-   end
-
-   def test_ping_database
-      assert_respond_to(@tp, :ping_database?)
-      assert_nothing_raised{ @tp.ping_database? }
-      assert_equal(true, @tp.ping_database?)
-   end
-
-   def test_ping_all
-      assert_respond_to(@tp, :ping_all?)
-      assert_nothing_raised{ @tp.ping_all? }
-      assert_equal(true, @tp.ping_all?)
-   end
-
-   def test_bad_db
-      assert_raises(Ping::TNS::Error){ Ping::TNS.new('bogus_db') }
-      assert_raises(TNSPingError){ Ping::TNS.new('bogus_db') } # Alias test
-      @tp.port = 9999
-      assert_equal(false, @tp.ping_listener?)
-   end
-
-   def teardown
-      @db = nil
-      @tp = nil
-   end
-end