ruby-oci8 2.0.6 → 2.1.0

data/lib/oci8/properties.rb

@@ -1,11 +1,13 @@
 # properties.rb -- implements OCI8.properties
 #
-# Copyright (C) 2010 KUBO Takehiro <kubo@jiubao.org>
+# Copyright (C) 2010-2011 KUBO Takehiro <kubo@jiubao.org>
 
 class OCI8
 
   @@properties = {
+    :length_semantics => :byte,
     :bind_string_as_nchar => false,
+    :float_conversion_type => :ruby,
   }
 
   def @@properties.[](name)
@@ -16,8 +18,15 @@ class OCI8
   def @@properties.[]=(name, val)
     raise IndexError, "No such property name: #{name}" unless @@properties.has_key?(name)
     case name
+    when :length_semantic
+      if val != :byte and val != :char
+        raise ArgumentError, "Invalid property value #{val} for :length_semantics."
+      end
     when :bind_string_as_nchar
       val = val ? true : false
+    when :float_conversion_type
+      # handled by native code in oci8lib_xx.so.
+      OCI8.__set_property(name, val)
     end
     super(name, val)
   end
@@ -41,9 +50,30 @@ class OCI8
   #
   # Supported properties are listed below:
   #
+  # [:length_semantics]
+  #     (new in 2.1.0)
+  #     
+  #     +:char+ when Oracle character length is counted by the number of characters.
+  #     +:byte+ when it is counted by the number of bytes.
+  #     The default setting is +:byte+ because +:char+ causes unexpected behaviour on
+  #     Oracle 9i.
+  #
   # [:bind_string_as_nchar]
   #     +true+ when string bind variables are bound as NCHAR,
   #     otherwise +false+. The default value is +false+.
+  #
+  # [:float_conversion_type]
+  #     (new in 2.1.0)
+  #     
+  #     +:ruby+ when Oracle decimal numbers are converted to ruby Float values
+  #     same as Float#to_s does. (default)
+  #     +:oracle:+ when they are done by Oracle OCI functions.
+  #     
+  #     From ruby 1.9.2, a float value converted from Oracle number 15.7 by
+  #     the Oracle function OCINumberToReal() makes a string representation
+  #     15.700000000000001 by Float#to_s.
+  #     See: http://rubyforge.org/forum/forum.php?thread_id=50030&forum_id=1078
+  #
   def self.properties
     @@properties
   end

data/ruby-oci8.gemspec

@@ -8,10 +8,17 @@
 #
 require 'fileutils'
 
-if ARGV.size > 3
-   gem_platform = ARGV[3]
+build_args = if (defined? Gem::Command and Gem::Command.respond_to? :build_args)
+               Gem::Command.build_args
+             else
+               # for old rubygems
+               ARGV.include?("--") ? ARGV[(ARGV.index("--") + 1)...ARGV.size] : []
+             end
+
+if build_args.size > 0
+  gem_platform = build_args[0]
 else
-   gem_platform = Gem::Platform::RUBY
+  gem_platform = Gem::Platform::RUBY
 end
 
 spec = Gem::Specification.new do |s|

data/test/README

@@ -1,4 +1,42 @@
-This directory includes test cases using RubyUnit.
+Before runing unit test:
 
-If RubyUnit is installed in your site, it is used to run test cases.
-If not installed, support files in this package are used.
+1. connect to Oracle as system:
+
+    $ sqlplus system/<password_of_system>
+
+2. create user ruby:
+
+    SQL> CREATE USER ruby IDENTIFIED BY oci8;
+
+   or
+
+    SQL> CREATE USER ruby IDENTIFIED BY oci8
+       2 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
+
+3. grant the privilege to connect and execute.
+
+    SQL> GRANT connect, resource, create view TO ruby;
+
+4. connect to Oracle as sys
+
+    $ sqlplus 'sys/<password_of_sys> as sysdba'
+
+5. grant privileges
+
+    SQL> GRANT EXECUTE ON dbms_lock TO ruby;
+    SQL> GRANT CREATE VIEW TO ruby;
+
+6. connect as ruby user.
+
+    $ sqlplus ruby/oci8
+
+7. Create object types
+
+    SQL> @test/setup_test_object.sql
+
+8. change $dbname if the database 
+
+Then you can run:
+  $ make check
+or
+  $ nmake check   (If your compiler is MS Visual C++.)

data/test/config.rb

@@ -5,6 +5,9 @@ $dbuser = "ruby"
 $dbpass = "oci8"
 $dbname = nil
 
+# for test_bind_string_as_nchar in test_encoding.rb
+ENV['ORA_NCHAR_LITERAL_REPLACE'] = 'TRUE' if OCI8.client_charset_name.include? 'UTF8'
+
 # test_clob.rb
 
 nls_lang = ENV['NLS_LANG']
@@ -103,6 +106,19 @@ module Test
           end
         end
       end # drop_table
+
+      def drop_type(type_name)
+        begin
+          @conn.exec("DROP TYPE BODY #{type_name}")
+        rescue OCIError
+          raise if $!.code != 4043
+        end
+        begin
+          @conn.exec("DROP TYPE #{type_name}")
+        rescue OCIError
+          raise if $!.code != 4043
+        end
+      end # drop_type
     end
   end
 end

data/test/test_all.rb

@@ -6,6 +6,7 @@ require "#{srcdir}/config"
 
 require "#{srcdir}/test_oradate"
 require "#{srcdir}/test_oranumber"
+require "#{srcdir}/test_bind_string"
 require "#{srcdir}/test_bind_time"
 require "#{srcdir}/test_bind_raw"
 if $test_clob
@@ -21,6 +22,8 @@ require "#{srcdir}/test_array_dml"
 require "#{srcdir}/test_rowid"
 require "#{srcdir}/test_appinfo"
 require "#{srcdir}/test_oracle_version"
+require "#{srcdir}/test_error"
+require "#{srcdir}/test_connection_pool"
 
 if OCI8.respond_to? :encoding
   require "#{srcdir}/test_encoding"

data/test/test_bind_string.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+require 'oci8'
+require 'test/unit'
+require File.dirname(__FILE__) + '/config'
+
+class TestBindString < Test::Unit::TestCase
+  def setup
+    @conn = get_oci8_connection
+  end
+
+  def teardown
+    @conn.logoff
+  end
+
+  if OCI8.client_charset_name.include? 'UTF8'
+
+    def test_bind_string_as_nchar
+      if ['AL32UTF8', 'UTF8', 'ZHS32GB18030'].include? @conn.database_charset_name
+        warn "Skip test_bind_string_as_nchar. It needs Oracle server whose database chracter set is incompatible with unicode."
+      else
+        drop_table('test_table')
+        @conn.exec("CREATE TABLE test_table (ID NUMBER(5), V VARCHAR2(10), NV1 NVARCHAR2(10), NV2 NVARCHAR2(10))")
+
+        orig_prop = OCI8.properties[:bind_string_as_nchar]
+        begin
+          utf8_string = "a¡あ"
+
+          OCI8.properties[:bind_string_as_nchar] = false
+          @conn.exec("INSERT INTO test_table VALUES (1, N'#{utf8_string}', N'#{utf8_string}', :1)", utf8_string)
+          v, nv1, nv2 = @conn.select_one('select V, NV1, NV2 from test_table where ID = 1')
+          assert_not_equal(utf8_string, v) # Some UTF-8 chracters should be garbled.
+          assert_equal(utf8_string, nv1) # No garbled characters
+          assert_equal(v, nv2) # Garbled as VARCHAR2 column.
+
+          OCI8.properties[:bind_string_as_nchar] = true
+          @conn.exec("INSERT INTO test_table VALUES (2, N'#{utf8_string}', N'#{utf8_string}', :1)", utf8_string)
+          v, nv1, nv2 = @conn.select_one('select V, NV1, NV2 from test_table where ID = 2')
+          assert_not_equal(utf8_string, v) # Some UTF-8 chracters should be garbled.
+          assert_equal(utf8_string, nv1) # No garbled characters
+          assert_equal(nv1, nv2) # Same as NVARCHAR2.
+
+          @conn.commit
+        ensure
+          OCI8.properties[:bind_string_as_nchar] = orig_prop
+        end
+      end
+    end
+
+    def test_length_semantics # This test needs to be revised.
+      orig_prop = OCI8.properties[:length_semantics]
+      begin
+        utf8_string = "a¡あ"
+
+        OCI8.properties[:length_semantics] = :byte
+        assert_equal(:byte, OCI8.properties[:length_semantics])
+        cursor = @conn.parse <<EOS
+DECLARE
+  TMP VARCHAR2(6);
+BEGIN
+  TMP := :in;
+  :out := TMP;
+END;
+EOS
+        cursor.bind_param(:in, utf8_string)
+        cursor.bind_param(:out, nil, String, 5)
+        begin
+          cursor.exec
+        rescue OCIError
+          assert_equal(6502, $!.code)
+        end
+        cursor.bind_param(:out, nil, String, 6)
+        cursor.exec
+        assert_equal(utf8_string, cursor[:out])
+
+        OCI8.properties[:length_semantics] = :char
+        assert_equal(:char, OCI8.properties[:length_semantics])
+        cursor = @conn.parse <<EOS
+DECLARE
+  TMP VARCHAR2(6);
+BEGIN
+  TMP := :in;
+  :out := TMP;
+END;
+EOS
+        cursor.bind_param(:in, utf8_string, String, 3)
+        cursor.bind_param(:out, nil, String, 2)
+        begin
+          cursor.exec
+        rescue OCIError
+          assert_equal(6502, $!.code)
+        end
+        cursor.bind_param(:out, nil, String, 3)
+        cursor.exec
+        assert_equal(utf8_string, cursor[:out])
+      ensure
+        OCI8.properties[:length_semantics] = orig_prop
+      end
+    end
+
+  else
+
+    def test_dummy
+      # to suppress "No tests were specified."
+    end
+  end
+end

data/test/test_break.rb

@@ -1,6 +1,7 @@
 # High-level API
 require 'oci8'
 require 'test/unit'
+require 'timeout'
 require File.dirname(__FILE__) + '/config'
 
 class TestBreak < Test::Unit::TestCase
@@ -16,7 +17,18 @@ class TestBreak < Test::Unit::TestCase
   def report(str)
     printf "%d: %s\n", (Time.now - $start_time), str
   end
-  
+
+  @@server_is_runing_on_windows = nil
+  def server_is_runing_on_windows?
+    if @@server_is_runing_on_windows.nil?
+      @@server_is_runing_on_windows = false
+      @conn.exec('select banner from v$version') do |row|
+        @@server_is_runing_on_windows = true if row[0].include? 'Windows'
+      end
+    end
+    @@server_is_runing_on_windows
+  end
+
   PLSQL_DONE = 1
   OCIBREAK = 2
   SEND_BREAK = 3
@@ -33,6 +45,7 @@ class TestBreak < Test::Unit::TestCase
         assert_equal(expect[PLSQL_DONE], (Time.now - $start_time).round, 'PLSQL_DONE')
       rescue OCIBreak
         assert_equal(expect[OCIBREAK], (Time.now - $start_time).round, 'OCIBREAK')
+        assert_equal('Canceled by user request.', $!.to_s)
       end
     end
 
@@ -54,15 +67,10 @@ class TestBreak < Test::Unit::TestCase
   end
 
   def test_non_blocking_mode
-    is_windows_server = false
-    @conn.exec('select banner from v$version') do |row|
-      is_windows_server = true if row[0].include? 'Windows'
-    end
-
     @conn.non_blocking = true
     assert_equal(true, @conn.non_blocking?)
     expect = []
-    if is_windows_server
+    if server_is_runing_on_windows?
       if $oracle_server_version >= OCI8::ORAVER_9_0
         # raise after sleeping #{TIME_IN_PLSQL} seconds.
         expect[PLSQL_DONE] = "Invalid status"
@@ -79,4 +87,22 @@ class TestBreak < Test::Unit::TestCase
     expect[SEND_BREAK]   = TIME_TO_BREAK
     do_test_ocibreak(@conn, expect)
   end
+
+  def test_timeout
+    @conn.non_blocking = true
+    start_time = Time.now
+    assert_raise(Timeout::Error) do
+      Timeout.timeout(1) do
+        @conn.exec("BEGIN DBMS_LOCK.SLEEP(5); END;")
+      end
+    end
+    if server_is_runing_on_windows?
+      end_time = start_time + 5
+    else
+      end_time = start_time + 1
+    end
+    assert_in_delta(Time.now, end_time, 1)
+    @conn.exec("BEGIN NULL; END;")
+    assert_in_delta(Time.now, end_time, 1)
+  end
 end

data/test/test_clob.rb

@@ -7,13 +7,15 @@ class TestCLob < Test::Unit::TestCase
 
   def setup
     @conn = get_oci8_connection
+    drop_table('test_table')
+    @conn.exec('CREATE TABLE test_table (filename VARCHAR2(40), content CLOB)')
   end
 
   def test_insert
     filename = File.basename($lobfile)
-    @conn.exec("DELETE FROM test_clob WHERE filename = :1", filename)
-    @conn.exec("INSERT INTO test_clob(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
-    cursor = @conn.exec("SELECT content FROM test_clob WHERE filename = :1 FOR UPDATE", filename)
+    @conn.exec("DELETE FROM test_table WHERE filename = :1", filename)
+    @conn.exec("INSERT INTO test_table(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
+    cursor = @conn.exec("SELECT content FROM test_table WHERE filename = :1 FOR UPDATE", filename)
     lob = cursor.fetch[0]
     open($lobfile) do |f|
       while f.gets()
@@ -25,9 +27,9 @@ class TestCLob < Test::Unit::TestCase
 
   def test_insert_with_flush
     filename = File.basename($lobfile)
-    @conn.exec("DELETE FROM test_clob WHERE filename = :1", filename)
-    @conn.exec("INSERT INTO test_clob(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
-    cursor = @conn.exec("SELECT content FROM test_clob WHERE filename = :1 FOR UPDATE", filename)
+    @conn.exec("DELETE FROM test_table WHERE filename = :1", filename)
+    @conn.exec("INSERT INTO test_table(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
+    cursor = @conn.exec("SELECT content FROM test_table WHERE filename = :1 FOR UPDATE", filename)
     lob = cursor.fetch[0]
     lob.sync = false
     open($lobfile) do |f|
@@ -42,9 +44,9 @@ class TestCLob < Test::Unit::TestCase
   def test_insert_symbol
     filename = 'test_symbol'
     value = :foo_bar
-    @conn.exec("DELETE FROM test_clob WHERE filename = :1", filename)
-    @conn.exec("INSERT INTO test_clob(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
-    cursor = @conn.exec("SELECT content FROM test_clob WHERE filename = :1 FOR UPDATE", filename)
+    @conn.exec("DELETE FROM test_table WHERE filename = :1", filename)
+    @conn.exec("INSERT INTO test_table(filename, content) VALUES (:1, EMPTY_CLOB())", filename)
+    cursor = @conn.exec("SELECT content FROM test_table WHERE filename = :1 FOR UPDATE", filename)
     lob = cursor.fetch[0]
     lob.write(value)
     lob.rewind
@@ -55,7 +57,7 @@ class TestCLob < Test::Unit::TestCase
   def test_read
     test_insert() # first insert data.
     filename = File.basename($lobfile)
-    cursor = @conn.exec("SELECT content FROM test_clob WHERE filename = :1 FOR UPDATE", filename)
+    cursor = @conn.exec("SELECT content FROM test_table WHERE filename = :1 FOR UPDATE", filename)
     lob = cursor.fetch[0]
 
     open($lobfile) do |f|
@@ -74,6 +76,7 @@ class TestCLob < Test::Unit::TestCase
   end
 
   def teardown
+    drop_table('test_table')
     @conn.logoff
   end
 end

data/test/test_connection_pool.rb

@@ -0,0 +1,125 @@
+require 'oci8'
+require 'test/unit'
+require File.dirname(__FILE__) + '/config'
+
+class TestConnectionPool < Test::Unit::TestCase
+
+  def create_pool(min, max, incr)
+    OCI8::ConnectionPool.new(min, max, incr, $dbuser, $dbpass, $dbname)
+  rescue OCIError
+    raise if $!.code != 12516 && $!.code != 12520
+    sleep(5)
+    OCI8::ConnectionPool.new(min, max, incr, $dbuser, $dbpass, $dbname)
+  end
+
+  def test_connect
+    pool = create_pool(1, 5, 3)
+    assert_equal(1, pool.min)
+    assert_equal(5, pool.max)
+    assert_equal(3, pool.incr)
+  end
+
+  def test_reinitialize
+    pool = create_pool(1, 5, 3)
+    pool.reinitialize(2, 6, 4)
+    assert_equal(2, pool.min)
+    assert_equal(6, pool.max)
+    assert_equal(4, pool.incr)
+  end
+
+  def test_busy_and_open_count
+    check_busy_and_open_count(1, 5, 3)
+    check_busy_and_open_count(2, 4, 1)
+  end
+
+  def check_busy_and_open_count(min_cnt, max_cnt, incr_cnt)
+    msg = "create_pool(#{min_cnt}, #{max_cnt}, #{incr_cnt})"
+    # Create a connection pool.
+    pool = create_pool(min_cnt, max_cnt, incr_cnt)
+    assert_equal(min_cnt, pool.open_count, msg)
+    assert_equal(0, pool.busy_count, msg)
+
+    non_blocking = true
+
+    # Create connections from the pool.
+    conns = []
+    max_cnt.times do |cnt|
+      conn = OCI8.new($dbuser, $dbpass, pool)
+      if cnt == 0
+        unless conn.non_blocking?
+          non_blocking = false
+          assert_raise(RuntimeError) do
+            # This should raise "Could not set non-blocking mode to a connection allocated from OCI8::ConnectionPool."
+            conn.non_blocking = true
+          end
+        end
+      end
+      conns << conn
+    end
+    assert_equal(min_cnt, pool.open_count, msg)
+    assert_equal(0, pool.busy_count, msg)
+
+    # Execute blocking SQL statements sequentially.
+    max_cnt.times do |n|
+      thread = Thread.start do
+        conns[n].exec "BEGIN DBMS_LOCK.SLEEP(1); END;"
+      end
+      sleep(0.5)
+      assert_equal(min_cnt, pool.open_count, msg)
+      assert_equal(non_blocking ? 1 : 0, pool.busy_count, msg)
+      thread.join
+    end
+    assert_equal(min_cnt, pool.open_count, msg)
+    assert_equal(0, pool.busy_count, msg)
+
+    # Execute blocking SQL statements parallel to increment open_count.
+    threads = []
+    (min_cnt + 1).times do |n|
+      threads << Thread.start do
+        conns[n].exec "BEGIN DBMS_LOCK.SLEEP(2); END;"
+      end
+    end
+    sleep(0.5)
+    assert_equal(non_blocking ? (min_cnt + incr_cnt) : min_cnt, pool.open_count, msg)
+    assert_equal(non_blocking ? (min_cnt + 1) : 0, pool.busy_count, msg)
+
+    # Execute blocking SQL statements parallel up to maximum.
+    (min_cnt + 1).upto(max_cnt - 1) do |n|
+      threads << Thread.start do
+        conns[n].exec "BEGIN DBMS_LOCK.SLEEP(1); END;"
+      end
+    end
+    sleep(0.5)
+    assert_equal(non_blocking ? max_cnt : min_cnt, pool.open_count, msg)
+    assert_equal(non_blocking ? max_cnt : 0, pool.busy_count, msg)
+
+    # 
+    threads.each do |thr|
+      thr.join
+    end
+    assert_equal(non_blocking ? max_cnt : min_cnt, pool.open_count, msg)
+    assert_equal(0, pool.busy_count, msg)
+
+    # Set timeout
+    pool.timeout = 1
+    sleep(1.5)
+    assert_equal(non_blocking ? max_cnt : min_cnt, pool.open_count, msg) # open_count doesn't shrink.
+    assert_equal(0, pool.busy_count, msg)
+    conns[0].ping # make a network roundtrip.
+    sleep(0.5)
+    # open_count shrinks.
+    # The decrement count depends on Oracle version.
+    assert_operator(pool.open_count, :<, max_cnt, msg)
+    assert_equal(0, pool.busy_count, msg)
+
+    # Close all conections.
+    conns.each do | conn |
+      conn.logoff
+    end
+    assert_equal(min_cnt, pool.open_count, msg)
+    assert_equal(0, pool.busy_count, msg)
+  end
+
+  def test_nowait
+  end
+end