tiny_tds 2.1.3.pre → 2.1.5

data/test/client_test.rb

@@ -2,9 +2,7 @@
 require 'test_helper'
 
 class ClientTest < TinyTds::TestCase
-
-  describe 'With valid credentials' do
-
+  describe 'with valid credentials' do
     before do
       @client = new_connection
     end
@@ -67,10 +65,12 @@ class ClientTest < TinyTds::TestCase
         client.close if client
       end
     end unless sqlserver_azure?
-
   end
 
   describe 'With in-valid options' do
+    before(:all) do
+      init_toxiproxy
+    end
 
     it 'raises an argument error when no :host given and :dataserver is blank' do
       assert_raises(ArgumentError) { new_connection :dataserver => nil, :host => nil }
@@ -132,30 +132,64 @@ class ClientTest < TinyTds::TestCase
       end
     end
 
-    it 'must run this test to prove we account for dropped connections' do
-      skip
+    it 'raises TinyTds exception with tcp socket network failure' do
+      skip if ENV['CI'] && ENV['APPVEYOR_BUILD_FOLDER'] # only CI using docker
       begin
-        client = new_connection :login_timeout => 2, :timeout => 2
+        client = new_connection timeout: 2, port: 1234
         assert_client_works(client)
-        STDOUT.puts "Disconnect network!"
-        sleep 10
-        STDOUT.puts "This should not get stuck past 6 seconds!"
-        action = lambda { client.execute('SELECT 1 as [one]').each }
+        action = lambda { client.execute("waitfor delay '00:00:05'").do }
+
+        # Use toxiproxy to close the TCP socket after 1 second.
+        # We want TinyTds to execute the statement, hit the timeout configured above, and then not be able to use the network to cancel
+        # the network connection needs to close after the sql batch is sent and before the timeout above is hit
+        Toxiproxy[:sqlserver_test].toxic(:slow_close, delay: 1000).apply do
+          assert_raise_tinytds_error(action) do |e|
+            assert_equal 20003, e.db_error_number
+            assert_equal 6, e.severity
+            assert_match %r{timed out}i, e.message, 'ignore if non-english test run'
+          end
+        end
+      ensure
+        assert_new_connections_work
+      end
+    end
+
+    it 'raises TinyTds exception with dead connection network failure' do
+      skip if ENV['CI'] && ENV['APPVEYOR_BUILD_FOLDER'] # only CI using docker
+      begin
+        client = new_connection timeout: 2, port: 1234
+        assert_client_works(client)
+        action = lambda { client.execute("waitfor delay '00:00:05'").do }
+
+        # Use toxiproxy to close the network connection after 1 second.
+        # We want TinyTds to execute the statement, hit the timeout configured above, and then not be able to use the network to cancel
+        # the network connection needs to close after the sql batch is sent and before the timeout above is hit
+        Toxiproxy[:sqlserver_test].toxic(:timeout, timeout: 1000).apply do
+          assert_raise_tinytds_error(action) do |e|
+            assert_equal 20047, e.db_error_number
+            assert_includes [1,9], e.severity
+            assert_match %r{dead or not enabled}i, e.message, 'ignore if non-english test run'
+          end
+        end
+      ensure
+        assert_new_connections_work
+      end
+    end
+
+    it 'raises TinyTds exception with login timeout' do
+      skip if ENV['CI'] && ENV['APPVEYOR_BUILD_FOLDER'] # only CI using docker
+      begin
+        action = lambda do
+          Toxiproxy[:sqlserver_test].toxic(:timeout, timeout: 0).apply do
+            new_connection login_timeout: 1, port: 1234
+          end
+        end
         assert_raise_tinytds_error(action) do |e|
           assert_equal 20003, e.db_error_number
           assert_equal 6, e.severity
           assert_match %r{timed out}i, e.message, 'ignore if non-english test run'
         end
       ensure
-        STDOUT.puts "Reconnect network!"
-        sleep 10
-        action = lambda { client.execute('SELECT 1 as [one]').each }
-        assert_raise_tinytds_error(action) do |e|
-          assert_equal 20047, e.db_error_number
-          assert_equal 1, e.severity
-          assert_match %r{dead or not enabled}i, e.message, 'ignore if non-english test run'
-        end
-        close_client(client)
         assert_new_connections_work
       end
     end
@@ -174,57 +208,68 @@ class ClientTest < TinyTds::TestCase
 
   end
 
-  describe 'Private methods' do
-
+  describe '#parse_username' do
     let(:client) { @client = new_connection }
 
-    it '#parse_username returns username if azure is not true' do
-      username = 'user@abc123.database.windows.net'
-      client.send(:parse_username, username: username).must_equal username
+    it 'returns username if azure is not true' do
+      _(
+        client.send(:parse_username, username: 'user@abc123.database.windows.net')
+      ).must_equal 'user@abc123.database.windows.net'
     end
 
-    it '#parse_username returns short username if azure is true' do
-      client.send(:parse_username,
-        username: 'user@abc123.database.windows.net',
-        host: 'abc123.database.windows.net',
-        azure: true
+    it 'returns short username if azure is true' do
+      _(
+        client.send(
+          :parse_username,
+          username: 'user@abc123.database.windows.net',
+          host:     'abc123.database.windows.net',
+          azure:    true
+        )
       ).must_equal 'user@abc123'
     end
 
-    it '#parse_username returns full username if azure is false' do
-      client.send(:parse_username,
-        username: 'user@abc123.database.windows.net',
-        host: 'abc123.database.windows.net',
-        azure: false
+    it 'returns full username if azure is false' do
+      _(
+        client.send(
+          :parse_username,
+          username: 'user@abc123.database.windows.net',
+          host:     'abc123.database.windows.net',
+          azure:    false
+        )
       ).must_equal 'user@abc123.database.windows.net'
     end
 
-    it '#parse_username returns short username if passed and azure is true' do
-      client.send(:parse_username,
-        username: 'user@abc123',
-        host: 'abc123.database.windows.net',
-        azure: true
+    it 'returns short username if passed and azure is true' do
+      _(
+        client.send(
+          :parse_username,
+          username: 'user@abc123',
+          host:     'abc123.database.windows.net',
+          azure:    true
+        )
       ).must_equal 'user@abc123'
     end
 
-    it '#parse_username returns username with servername if passed and azure is true' do
-      client.send(:parse_username,
-        username: 'user',
-        host: 'abc123.database.windows.net',
-        azure: true
+    it 'returns username with servername if passed and azure is true' do
+      _(
+        client.send(
+          :parse_username,
+          username: 'user',
+          host:     'abc123.database.windows.net',
+          azure:    true
+        )
       ).must_equal 'user@abc123'
     end
 
-    it '#parse_username returns username with servername if passed and azure is false' do
-      client.send(:parse_username,
-        username: 'user',
-        host: 'abc123.database.windows.net',
-        azure: false
+    it 'returns username with servername if passed and azure is false' do
+      _(
+        client.send(
+          :parse_username,
+          username: 'user',
+          host:     'abc123.database.windows.net',
+          azure:    false
+        )
       ).must_equal 'user'
     end
-
   end
-
-
 end
-

data/test/gem_test.rb

@@ -21,13 +21,13 @@ class GemTest < MiniTest::Spec
       let(:root_path) { TinyTds::Gem.root_path }
 
       it 'should be the root path' do
-        root_path.must_equal gem_root
+        _(root_path).must_equal gem_root
       end
 
       it 'should be the root path no matter the cwd' do
         Dir.chdir '/'
 
-        root_path.must_equal gem_root
+        _(root_path).must_equal gem_root
       end
     end
 
@@ -35,19 +35,19 @@ class GemTest < MiniTest::Spec
       let(:ports_root_path) { TinyTds::Gem.ports_root_path }
 
       it 'should be the ports path' do
-        ports_root_path.must_equal File.join(gem_root,'ports')
+        _(ports_root_path).must_equal File.join(gem_root,'ports')
       end
 
       it 'should be the ports path no matter the cwd' do
         Dir.chdir '/'
 
-        ports_root_path.must_equal File.join(gem_root,'ports')
+        _(ports_root_path).must_equal File.join(gem_root,'ports')
       end
     end
 
     describe '#ports_bin_paths' do
       let(:ports_bin_paths) { TinyTds::Gem.ports_bin_paths }
-        
+
       describe 'when the ports directories exist' do
         let(:fake_bin_paths) do
           ports_host_root = File.join(gem_root, 'ports', 'fake-host-with-dirs')
@@ -74,12 +74,12 @@ class GemTest < MiniTest::Spec
         end
 
         it 'should return all the bin directories' do
-          ports_bin_paths.sort.must_equal fake_bin_paths.sort
+          _(ports_bin_paths.sort).must_equal fake_bin_paths.sort
         end
 
         it 'should return all the bin directories regardless of cwd' do
           Dir.chdir '/'
-          ports_bin_paths.sort.must_equal fake_bin_paths.sort
+          _(ports_bin_paths.sort).must_equal fake_bin_paths.sort
         end
       end
 
@@ -89,19 +89,19 @@ class GemTest < MiniTest::Spec
         end
 
         it 'should return no directories' do
-          ports_bin_paths.must_be_empty
+          _(ports_bin_paths).must_be_empty
         end
 
         it 'should return no directories regardless of cwd' do
           Dir.chdir '/'
-          ports_bin_paths.must_be_empty
+          _(ports_bin_paths).must_be_empty
         end
       end
     end
 
     describe '#ports_lib_paths' do
       let(:ports_lib_paths) { TinyTds::Gem.ports_lib_paths }
-        
+
       describe 'when the ports directories exist' do
         let(:fake_lib_paths) do
           ports_host_root = File.join(gem_root, 'ports', 'fake-host-with-dirs')
@@ -128,12 +128,12 @@ class GemTest < MiniTest::Spec
         end
 
         it 'should return all the lib directories' do
-          ports_lib_paths.sort.must_equal fake_lib_paths.sort
+          _(ports_lib_paths.sort).must_equal fake_lib_paths.sort
         end
 
         it 'should return all the lib directories regardless of cwd' do
           Dir.chdir '/'
-          ports_lib_paths.sort.must_equal fake_lib_paths.sort
+          _(ports_lib_paths.sort).must_equal fake_lib_paths.sort
         end
       end
 
@@ -144,12 +144,12 @@ class GemTest < MiniTest::Spec
 
 
         it 'should return no directories' do
-          ports_lib_paths.must_be_empty
+          _(ports_lib_paths).must_be_empty
         end
 
         it 'should return no directories regardless of cwd' do
           Dir.chdir '/'
-          ports_lib_paths.must_be_empty
+          _(ports_lib_paths).must_be_empty
         end
       end
     end
@@ -169,7 +169,7 @@ class GemTest < MiniTest::Spec
           end
 
           it "should return a #{expected} ports host" do
-            TinyTds::Gem.ports_host.must_equal expected
+            _(TinyTds::Gem.ports_host).must_equal expected
           end
         end
       end

data/test/result_test.rb

@@ -80,7 +80,7 @@ class ResultTest < TinyTds::TestCase
         @client.execute("DELETE FROM [datatypes]").do
         @client.execute("INSERT INTO [datatypes] ([char_10], [varchar_50]) VALUES ('1', '2')").do
         result = @client.execute("SELECT TOP (1) [char_10] + 'test' + [varchar_50] AS [test] FROM [datatypes]").each.first['test']
-        result.must_equal "1         test2"
+        _(result).must_equal "1         test2"
       end
     end
 
@@ -135,10 +135,10 @@ class ResultTest < TinyTds::TestCase
         text = 'test affected rows sql'
         @client.execute("DELETE FROM [datatypes]").do
         afrows = @client.execute("SELECT @@ROWCOUNT AS AffectedRows").each.first['AffectedRows']
-        ['Fixnum', 'Integer'].must_include afrows.class.name
+        _(['Fixnum', 'Integer']).must_include afrows.class.name
         @client.execute("INSERT INTO [datatypes] ([varchar_50]) VALUES ('#{text}')").do
         pk1 = @client.execute(@client.identity_sql).each.first['Ident']
-        ['Fixnum', 'Integer'].must_include pk1.class.name, 'we it be able to CAST to bigint'
+        _(['Fixnum', 'Integer']).must_include pk1.class.name, 'we it be able to CAST to bigint'
         @client.execute("UPDATE [datatypes] SET [varchar_50] = NULL WHERE [varchar_50] = '#{text}'").do
         afrows = @client.execute("SELECT @@ROWCOUNT AS AffectedRows").each.first['AffectedRows']
         assert_equal 1, afrows
@@ -215,34 +215,34 @@ class ResultTest < TinyTds::TestCase
       @client.execute("DELETE FROM [datatypes]").do
       @client.execute("ROLLBACK TRANSACTION").do
       count = @client.execute("SELECT COUNT(*) AS [count] FROM [datatypes]").each.first['count']
-      0.wont_equal count
+      _(count).wont_equal 0
     end
 
     it 'has a #fields accessor with logic default and valid outcome' do
       result = @client.execute(@query1)
-      result.fields.must_equal ['one']
+      _(result.fields).must_equal ['one']
       result.each
-      result.fields.must_equal ['one']
+      _(result.fields).must_equal ['one']
     end
 
     it 'always returns an array for fields for all sql' do
       result = @client.execute("USE [tinytdstest]")
-      result.fields.must_equal []
+      _(result.fields).must_equal []
       result.do
-      result.fields.must_equal []
+      _(result.fields).must_equal []
     end
 
     it 'returns fields even when no results are found' do
       no_results_query = "SELECT [id], [varchar_50] FROM [datatypes] WHERE [varchar_50] = 'NOTFOUND'"
       # Fields before each.
       result = @client.execute(no_results_query)
-      result.fields.must_equal ['id','varchar_50']
+      _(result.fields).must_equal ['id','varchar_50']
       result.each
-      result.fields.must_equal ['id','varchar_50']
+      _(result.fields).must_equal ['id','varchar_50']
       # Each then fields
       result = @client.execute(no_results_query)
       result.each
-      result.fields.must_equal ['id','varchar_50']
+      _(result.fields).must_equal ['id','varchar_50']
     end
 
     it 'allows the result to be canceled before reading' do
@@ -254,27 +254,27 @@ class ResultTest < TinyTds::TestCase
     it 'works in tandem with the client when needing to find out if client has sql sent and result is canceled or not' do
       # Default state.
       @client = TinyTds::Client.new(connection_options)
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal false
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal false
       # With active result before and after cancel.
       result = @client.execute(@query1)
-      @client.sqlsent?.must_equal true
-      @client.canceled?.must_equal false
+      _(@client.sqlsent?).must_equal true
+      _(@client.canceled?).must_equal false
       result.cancel
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal true
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal true
       assert result.cancel, 'must be safe to call again'
       # With each and no block.
       @client.execute(@query1).each
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal false
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal false
       # With each and block.
       @client.execute(@query1).each do |row|
-        @client.sqlsent?.must_equal true, 'when iterating over each row in a block'
-        @client.canceled?.must_equal false
+        _(@client.sqlsent?).must_equal true, 'when iterating over each row in a block'
+        _(@client.canceled?).must_equal false
       end
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal false
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal false
       # With each and block canceled half way thru.
       count = @client.execute("SELECT COUNT([id]) AS [count] FROM [datatypes]").each[0]['count']
       assert count > 10, 'since we want to cancel early for test'
@@ -284,25 +284,25 @@ class ResultTest < TinyTds::TestCase
         break if index > 10
         index += 1
       end
-      @client.sqlsent?.must_equal true
-      @client.canceled?.must_equal false
+      _(@client.sqlsent?).must_equal true
+      _(@client.canceled?).must_equal false
       result.cancel
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal true
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal true
       # With do method.
       @client.execute(@query1).do
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal true
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal true
       # With insert method.
       rollback_transaction(@client) do
         @client.execute("INSERT INTO [datatypes] ([varchar_50]) VALUES ('test')").insert
-        @client.sqlsent?.must_equal false
-        @client.canceled?.must_equal true
+        _(@client.sqlsent?).must_equal false
+        _(@client.canceled?).must_equal true
       end
       # With first
       @client.execute("SELECT [id] FROM [datatypes]").each(:first => true)
-      @client.sqlsent?.must_equal false
-      @client.canceled?.must_equal true
+      _(@client.sqlsent?).must_equal false
+      _(@client.canceled?).must_equal true
     end
 
     it 'use same string object for hash keys' do
@@ -337,7 +337,7 @@ class ResultTest < TinyTds::TestCase
 
     it 'with LOGINPROPERTY function' do
       v = @client.execute("SELECT LOGINPROPERTY('sa', 'IsLocked') as v").first['v']
-      v.must_equal 0
+      _(v).must_equal 0
     end
 
     describe 'with multiple result sets' do
@@ -652,6 +652,48 @@ class ResultTest < TinyTds::TestCase
             assert_equal 1, messages.length, 'there should be one message after one print statement'
             assert_equal msg, m.message, 'message text'
           end
+
+          it 'must raise an error preceded by a `print` message' do
+            messages.clear
+            action = lambda { @client.execute("EXEC tinytds_TestPrintWithError").do }
+            assert_raise_tinytds_error(action) do |e|
+              assert_equal 'hello', messages.first.message, 'message text'
+
+              assert_equal "Error following print", e.message
+              assert_equal 16, e.severity
+              assert_equal 50000, e.db_error_number
+            end
+          end
+
+          it 'calls the provided message handler for each of a series of `print` messages' do
+            messages.clear
+            @client.execute("EXEC tinytds_TestSeveralPrints").do
+            assert_equal ['hello 1', 'hello 2', 'hello 3'], messages.map { |e| e.message }, 'message list'
+          end
+
+          it 'should flush info messages before raising error in cases of timeout' do
+            @client = new_connection timeout: 1, message_handler: Proc.new { |m| messages << m }
+            action = lambda { @client.execute("print 'hello'; waitfor delay '00:00:02'").do }
+            messages.clear
+            assert_raise_tinytds_error(action) do |e|
+              assert_match %r{timed out}i, e.message, 'ignore if non-english test run'
+              assert_equal 6, e.severity
+              assert_equal 20003, e.db_error_number
+              assert_equal 'hello', messages.first&.message, 'message text'
+            end
+          end
+
+          it 'should print info messages before raising error in cases of timeout' do
+            @client = new_connection timeout: 1, message_handler: Proc.new { |m| messages << m }
+            action = lambda { @client.execute("raiserror('hello', 1, 1) with nowait; waitfor delay '00:00:02'").do }
+            messages.clear
+            assert_raise_tinytds_error(action) do |e|
+              assert_match %r{timed out}i, e.message, 'ignore if non-english test run'
+              assert_equal 6, e.severity
+              assert_equal 20003, e.db_error_number
+              assert_equal 'hello', messages.first&.message, 'message text'
+            end
+          end
         end
 
         it 'must not raise an error when severity is 10 or less' do
@@ -684,7 +726,7 @@ class ResultTest < TinyTds::TestCase
       end
 
       it 'throws an error when you execute another query with other results pending' do
-        result1 = @client.execute(@query1)
+        @client.execute(@query1)
         action = lambda { @client.execute(@query1) }
         assert_raise_tinytds_error(action) do |e|
           assert_match %r|with results pending|i, e.message
@@ -717,22 +759,22 @@ class ResultTest < TinyTds::TestCase
       it 'must not error at all from reading non-convertable charcters and just use ? marks' do
         close_client
         @client = new_connection :encoding => 'ASCII'
-        @client.charset.must_equal 'ASCII'
-        find_value(202, :nvarchar_50).must_equal 'test nvarchar_50 ??'
+        _(@client.charset).must_equal 'ASCII'
+        _(find_value(202, :nvarchar_50)).must_equal 'test nvarchar_50 ??'
       end
 
       it 'must error gracefully from writing non-convertable characters' do
         close_client
         @client = new_connection :encoding => 'ASCII'
-        @client.charset.must_equal 'ASCII'
+        _(@client.charset).must_equal 'ASCII'
         rollback_transaction(@client) do
           text = 'Test ✓'
           @client.execute("DELETE FROM [datatypes] WHERE [nvarchar_50] IS NOT NULL").do
           action = lambda { @client.execute("INSERT INTO [datatypes] ([nvarchar_50]) VALUES ('#{text}')").do }
           assert_raise_tinytds_error(action) do |e|
-            e.message.must_match %r{Unclosed quotation mark}i
-            e.severity.must_equal 15
-            e.db_error_number.must_equal 105
+            _(e.message).must_match %r{Unclosed quotation mark}i
+            _(e.severity).must_equal 15
+            _(e.db_error_number).must_equal 105
           end
           assert_followup_query
         end
@@ -770,4 +812,3 @@ class ResultTest < TinyTds::TestCase
   end
 
 end
-