tiny_tds 2.1.2 → 3.4.0

data/test/client_test.rb

@@ -1,126 +1,123 @@
-# encoding: utf-8
-require 'test_helper'
+require "test_helper"
 
 class ClientTest < TinyTds::TestCase
-
-  describe 'With valid credentials' do
-
+  describe "with valid credentials" do
     before do
       @client = new_connection
     end
 
-    it 'must not be closed' do
+    it "must not be closed" do
       assert !@client.closed?
       assert @client.active?
     end
 
-    it 'allows client connection to be closed' do
+    it "allows client connection to be closed" do
       assert @client.close
       assert @client.closed?
       assert !@client.active?
-      action = lambda { @client.execute('SELECT 1 as [one]').each }
+      assert @client.dead?
+      action = lambda { @client.execute("SELECT 1 as [one]").each }
       assert_raise_tinytds_error(action) do |e|
-        assert_match %r{closed connection}i, e.message, 'ignore if non-english test run'
+        assert_match %r{closed connection}i, e.message, "ignore if non-english test run"
       end
     end
 
-    it 'has getters for the tds version information (brittle since conf takes precedence)' do
-      if sybase_ase?
-        assert_equal 7, @client.tds_version
-        assert_equal 'DBTDS_5_0 - 5.0 SQL Server', @client.tds_version_info
-      elsif @client.tds_73?
+    it "has getters for the tds version information (brittle since conf takes precedence)" do
+      if @client.tds_73?
         assert_equal 11, @client.tds_version
-        assert_equal 'DBTDS_7_3 - Microsoft SQL Server 2008', @client.tds_version_info
+        assert_equal "DBTDS_7_3 - Microsoft SQL Server 2008", @client.tds_version_info
       else
         assert_equal 9, @client.tds_version
-        assert_equal 'DBTDS_7_1/DBTDS_8_0 - Microsoft SQL Server 2000', @client.tds_version_info
+        assert_equal "DBTDS_7_1/DBTDS_8_0 - Microsoft SQL Server 2000", @client.tds_version_info
       end
     end
 
-    it 'uses UTF-8 client charset/encoding by default' do
-      assert_equal 'UTF-8', @client.charset
-      assert_equal Encoding.find('UTF-8'), @client.encoding
+    it "uses UTF-8 client charset/encoding by default" do
+      assert_equal "UTF-8", @client.charset
+      assert_equal Encoding.find("UTF-8"), @client.encoding
     end
 
-    it 'has a #escape method used for quote strings' do
+    it "has a #escape method used for quote strings" do
       assert_equal "''hello''", @client.escape("'hello'")
     end
 
-    ['CP850', 'CP1252', 'ISO-8859-1'].each do |encoding|
+    ["CP850", "CP1252", "ISO-8859-1"].each do |encoding|
       it "allows valid iconv character set - #{encoding}" do
+        client = new_connection(encoding: encoding)
+        assert_equal encoding, client.charset
+        assert_equal Encoding.find(encoding), client.encoding
+      ensure
+        client&.close
+      end
+    end
+
+    unless sqlserver_azure?
+      it "must be able to use :host/:port connection" do
+        host = ENV["TINYTDS_UNIT_HOST_TEST"] || ENV["TINYTDS_UNIT_HOST"] || "localhost"
+        port = ENV["TINYTDS_UNIT_PORT_TEST"] || ENV["TINYTDS_UNIT_PORT"] || 1433
         begin
-          client = new_connection(:encoding => encoding)
-          assert_equal encoding, client.charset
-          assert_equal Encoding.find(encoding), client.encoding
+          client = new_connection dataserver: nil, host: host, port: port
         ensure
-          client.close if client
+          client&.close
         end
       end
     end
-
-    it 'must be able to use :host/:port connection' do
-      host = ENV['TINYTDS_UNIT_HOST_TEST'] || ENV['TINYTDS_UNIT_HOST'] || 'localhost'
-      port = ENV['TINYTDS_UNIT_PORT_TEST'] || ENV['TINYTDS_UNIT_PORT'] || 1433
-      begin
-        client = new_connection dataserver: nil, host: host, port: port
-      ensure
-        client.close if client
-      end
-    end unless sqlserver_azure?
-
   end
 
-  describe 'With in-valid options' do
+  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 }
+    it "raises an argument error when no :host given and :dataserver is blank" do
+      assert_raises(ArgumentError) { new_connection dataserver: nil, host: nil }
     end
 
-    it 'raises an argument error when no :username is supplied' do
-      assert_raises(ArgumentError) { TinyTds::Client.new :username => nil }
+    it "raises an argument error when no :username is supplied" do
+      assert_raises(ArgumentError) { TinyTds::Client.new username: nil }
     end
 
-    it 'raises TinyTds exception with undefined :dataserver' do
-      options = connection_options :login_timeout => 1, :dataserver => 'DOESNOTEXIST'
+    it "raises TinyTds exception with undefined :dataserver" do
+      options = connection_options login_timeout: 1, dataserver: "DOESNOTEXIST"
       action = lambda { new_connection(options) }
       assert_raise_tinytds_error(action) do |e|
         # Not sure why tese are different.
         if ruby_darwin?
           assert_equal 20009, e.db_error_number
           assert_equal 9, e.severity
-          assert_match %r{is unavailable or does not exist}i, e.message, 'ignore if non-english test run'
+          assert_match %r{is unavailable or does not exist}i, e.message, "ignore if non-english test run"
         else
           assert_equal 20012, e.db_error_number
           assert_equal 2, e.severity
-          assert_match %r{server name not found in configuration files}i, e.message, 'ignore if non-english test run'
+          assert_match %r{server name not found in configuration files}i, e.message, "ignore if non-english test run"
         end
       end
       assert_new_connections_work
     end
 
-    it 'raises TinyTds exception with long query past :timeout option' do
-      client = new_connection :timeout => 1
+    it "raises TinyTds exception with long query past :timeout option" do
+      client = new_connection timeout: 1
       action = lambda { client.execute("WaitFor Delay '00:00:02'").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'
+        assert_match %r{timed out}i, e.message, "ignore if non-english test run"
       end
       assert_client_works(client)
       close_client(client)
       assert_new_connections_work
     end
 
-    it 'must not timeout per sql batch when not under transaction' do
-      client = new_connection :timeout => 2
+    it "must not timeout per sql batch when not under transaction" do
+      client = new_connection timeout: 2
       client.execute("WaitFor Delay '00:00:01'").do
       client.execute("WaitFor Delay '00:00:01'").do
       client.execute("WaitFor Delay '00:00:01'").do
       close_client(client)
     end
 
-    it 'must not timeout per sql batch when under transaction' do
-      client = new_connection :timeout => 2
+    it "must not timeout per sql batch when under transaction" do
+      client = new_connection timeout: 2
       begin
         client.execute("BEGIN TRANSACTION").do
         client.execute("WaitFor Delay '00:00:01'").do
@@ -132,99 +129,138 @@ class ClientTest < TinyTds::TestCase
       end
     end
 
-    it 'must run this test to prove we account for dropped connections' do
-      skip
-      begin
-        client = new_connection :login_timeout => 2, :timeout => 2
-        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 }
+    it "raises TinyTds exception with tcp socket network failure" do
+      client = new_connection timeout: 2, port: 1234, host: ENV["TOXIPROXY_HOST"]
+      assert_client_works(client)
+      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'
+          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
+    ensure
+      assert_new_connections_work
+    end
+
+    it "raises TinyTds exception with dead connection network failure" do
+      skip if ruby_windows?
+
+      begin
+        client = new_connection timeout: 2, port: 1234, host: ENV["TOXIPROXY_HOST"]
+        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
-        close_client(client)
+      ensure
         assert_new_connections_work
       end
     end
 
-    it 'raises TinyTds exception with wrong :username' do
-      skip if ENV['CI'] && sqlserver_azure? # Some issue with db_error_number.
-      options = connection_options :username => 'willnotwork'
+    it "raises TinyTds exception with login timeout" do
+      action = lambda do
+        Toxiproxy[:sqlserver_test].toxic(:timeout, timeout: 0).apply do
+          new_connection login_timeout: 1, port: 1234, host: ENV["TOXIPROXY_HOST"]
+        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
+      assert_new_connections_work
+    end
+
+    it "raises TinyTds exception with wrong :username" do
+      skip if ENV["CI"] && sqlserver_azure? # Some issue with db_error_number.
+      options = connection_options username: "willnotwork"
       action = lambda { new_connection(options) }
       assert_raise_tinytds_error(action) do |e|
-        assert_equal sybase_ase? ? 4002 : 18456, e.db_error_number
+        assert_equal 18456, e.db_error_number
         assert_equal 14, e.severity
-        assert_match %r{login failed}i, e.message, 'ignore if non-english test run'
+        assert_match %r{login failed}i, e.message, "ignore if non-english test run"
       end
       assert_new_connections_work
     end
-
   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
-      ).must_equal 'user@abc123'
+    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
-      ).must_equal 'user@abc123.database.windows.net'
+    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
-      ).must_equal 'user@abc123'
+    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
-      ).must_equal 'user@abc123'
+    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
-      ).must_equal 'user'
+    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

@@ -1,179 +1,95 @@
-# encoding: utf-8
-require 'test_helper'
-require 'tiny_tds/gem'
+require "test_helper"
+require "tiny_tds/gem"
 
-class GemTest < MiniTest::Spec
-  gem_root ||= File.expand_path '../..', __FILE__
+class GemTest < Minitest::Spec
+  gem_root ||= File.expand_path "../..", __FILE__
 
   describe TinyTds::Gem do
-
     # We're going to muck with some system globals so lets make sure
     # they get set back later
-    original_host = RbConfig::CONFIG['host']
     original_pwd = Dir.pwd
 
     after do
-      RbConfig::CONFIG['host'] = original_host
       Dir.chdir original_pwd
     end
 
-    describe '#root_path' do
+    describe "#root_path" do
       let(:root_path) { TinyTds::Gem.root_path }
 
-      it 'should be the root path' do
-        root_path.must_equal gem_root
+      it "should be the root path" do
+        _(root_path).must_equal gem_root
       end
 
-      it 'should be the root path no matter the cwd' do
-        Dir.chdir '/'
+      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
 
-    describe '#ports_root_path' do
+    describe "#ports_root_path" do
       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')
+      it "should be the ports path" do
+        _(ports_root_path).must_equal File.join(gem_root, "ports")
       end
 
-      it 'should be the ports path no matter the cwd' do
-        Dir.chdir '/'
+      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')
-          [
-            File.join('a','bin'),
-            File.join('a','inner','bin'),
-            File.join('b','bin')
-          ].map do |p|
+    describe "#ports_bin_and_lib_paths" do
+      let(:ports_bin_and_lib_paths) { TinyTds::Gem.ports_bin_and_lib_paths }
+
+      describe "when the ports directories exist" do
+        let(:fake_bin_and_lib_path) do
+          ports_host_root = File.join(gem_root, "ports", "x86_64-unknown")
+          ["bin", "lib"].map do |p|
             File.join(ports_host_root, p)
           end
         end
 
         before do
-          RbConfig::CONFIG['host'] = 'fake-host-with-dirs'
-          fake_bin_paths.each do |path|
+          fake_bin_and_lib_path.each do |path|
             FileUtils.mkdir_p(path)
           end
         end
 
         after do
           FileUtils.remove_entry_secure(
-            File.join(gem_root, 'ports', 'fake-host-with-dirs'), true
+            File.join(gem_root, "ports", "x86_64-unknown"), true
           )
         end
 
-        it 'should return all the bin directories' do
-          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
-        end
-      end
-
-      describe 'when the ports directories are missing' do
-        before do
-          RbConfig::CONFIG['host'] = 'fake-host-without-dirs'
-        end
-
-        it 'should return no directories' do
-          ports_bin_paths.must_be_empty
-        end
-
-        it 'should return no directories regardless of cwd' do
-          Dir.chdir '/'
-          ports_bin_paths.must_be_empty
-        end
-      end
-    end
+        it "should return all the bin directories" do
+          fake_platform = Gem::Platform.new("x86_64-unknown")
 
-    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')
-          [
-            File.join('a','lib'),
-            File.join('a','inner','lib'),
-            File.join('b','lib')
-          ].map do |p|
-            File.join(ports_host_root, p)
-          end
-        end
+          Gem::Platform.stub(:local, fake_platform) do
+            _(ports_bin_and_lib_paths.sort).must_equal fake_bin_and_lib_path.sort
 
-        before do
-          RbConfig::CONFIG['host'] = 'fake-host-with-dirs'
-          fake_lib_paths.each do |path|
-            FileUtils.mkdir_p(path)
+            # should return the same regardless of path
+            Dir.chdir "/"
+            _(ports_bin_and_lib_paths.sort).must_equal fake_bin_and_lib_path.sort
           end
         end
-
-        after do
-          FileUtils.remove_entry_secure(
-            File.join(gem_root, 'ports', 'fake-host-with-dirs'), true
-          )
-        end
-
-        it 'should return all the lib directories' do
-          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
-        end
       end
 
-      describe 'when the ports directories are missing' do
-        before do
-          RbConfig::CONFIG['host'] = 'fake-host-without-dirs'
-        end
-
-
-        it 'should return no directories' do
-          ports_lib_paths.must_be_empty
-        end
-
-        it 'should return no directories regardless of cwd' do
-          Dir.chdir '/'
-          ports_lib_paths.must_be_empty
-        end
-      end
-    end
+      describe "when the ports directories are missing" do
+        it "should return no directories" do
+          fake_platform = Gem::Platform.new("x86_64-unknown")
 
-    describe '#ports_host' do
-      {
-        'i686-pc-linux-gnu' => 'i686-pc-linux-gnu',
-        'x86_64-pc-linux-gnu' => 'x86_64-pc-linux-gnu',
-        'i686-w64-mingw32' => 'i686-w64-mingw32',
-        'x86_64-w64-mingw32' => 'x86_64-w64-mingw32',
-        # consolidate this host to our build w64-mingw32 arch
-        'i686-pc-mingw32' => 'i686-w64-mingw32'
-      }.each do |host,expected|
-        describe "on a #{host} architecture" do
-          before do
-            RbConfig::CONFIG['host'] = host
-          end
+          Gem::Platform.stub(:local, fake_platform) do
+            _(ports_bin_and_lib_paths).must_be_empty
 
-          it "should return a #{expected} ports host" do
-            TinyTds::Gem.ports_host.must_equal expected
+            # should be empty regardless of path
+            Dir.chdir "/"
+            _(ports_bin_and_lib_paths).must_be_empty
           end
         end
       end
     end
   end
 end
-