tiny_tds 2.1.2 → 3.2.0

data/tasks/ports.rake

@@ -1,87 +1,24 @@
-# encoding: UTF-8
-require 'mini_portile2'
-require 'fileutils'
-require_relative 'ports/libiconv'
-require_relative 'ports/openssl'
-require_relative 'ports/freetds'
-require_relative '../ext/tiny_tds/extconsts'
-
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE if defined? OpenSSL
+require_relative "../ext/tiny_tds/extconsts"
 
 namespace :ports do
-  openssl = Ports::Openssl.new(OPENSSL_VERSION)
-  libiconv = Ports::Libiconv.new(ICONV_VERSION)
-  freetds = Ports::Freetds.new(FREETDS_VERSION)
-
-  directory "ports"
-
-  task :openssl, [:host] do |task, args|
-    args.with_defaults(host: RbConfig::CONFIG['host'])
+  libraries_to_compile = {
+    openssl: OPENSSL_VERSION,
+    libiconv: ICONV_VERSION,
+    freetds: FREETDS_VERSION
+  }
 
-    openssl.files = [OPENSSL_SOURCE_URI]
-    openssl.host = args.host
-    openssl.cook
-    openssl.activate
-  end
-
-  task :libiconv, [:host] do |task, args|
-    args.with_defaults(host: RbConfig::CONFIG['host'])
+  desc "Notes the actual versions for the compiled ports into a file"
+  task "version_file", [:gem_platform] do |_task, args|
+    args.with_defaults(gem_platform: RbConfig::CONFIG["arch"])
 
-    libiconv.files = [ICONV_SOURCE_URI]
-    libiconv.host = args.host
-    libiconv.cook
-    libiconv.activate
-  end
+    ports_version = {}
 
-  task :freetds, [:host] do |task, args|
-    args.with_defaults(host: RbConfig::CONFIG['host'])
-
-    freetds.files = [FREETDS_SOURCE_URI]
-    freetds.host = args.host
-
-    if openssl
-      # freetds doesn't have an option that will provide an rpath
-      # so we do it manually
-      ENV['OPENSSL_CFLAGS'] = "-Wl,-rpath -Wl,#{openssl.path}/lib"
-      # Add the pkgconfig file with MSYS2'ish path, to prefer our ports build
-      # over MSYS2 system OpenSSL.
-      ENV['PKG_CONFIG_PATH'] = "#{openssl.path.gsub(/^(\w):/i){"/"+$1.downcase}}/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
-      freetds.configure_options << "--with-openssl=#{openssl.path}"
+    libraries_to_compile.each do |library, version|
+      ports_version[library] = version
     end
 
-    if libiconv
-      freetds.configure_options << "--with-libiconv-prefix=#{libiconv.path}"
-    end
+    ports_version[:platform] = args.gem_platform
 
-    freetds.cook
-    freetds.activate
-  end
-
-  task :compile, [:host] do |task,args|
-    args.with_defaults(host: RbConfig::CONFIG['host'])
-
-    puts "Compiling ports for #{args.host}..."
-
-    ['openssl','libiconv','freetds'].each do |lib|
-      Rake::Task["ports:#{lib}"].invoke(args.host)
-    end
-  end
-
-  desc 'Build the ports windows binaries via rake-compiler-dock'
-  task 'cross' do
-    require 'rake_compiler_dock'
-
-    # make sure to install our bundle
-    build = ['bundle']
-
-    # build the ports for all our cross compile hosts
-    GEM_PLATFORM_HOSTS.each do |gem_platform, host|
-      build << "rake ports:compile[#{host}] MAKE='make -j`nproc`'"
-    end
-
-    RakeCompilerDock.sh build.join(' && ')
+    File.write(".ports_versions", ports_version)
   end
 end
-
-desc 'Build ports and activate libraries for the current architecture.'
-task :ports => ['ports:compile']

data/tasks/test.rake

@@ -1,9 +1,7 @@
-# encoding: UTF-8
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
-

data/test/bin/install-freetds.sh

@@ -10,11 +10,9 @@ fi
 wget http://www.freetds.org/files/stable/freetds-$FREETDS_VERSION.tar.gz
 tar -xzf freetds-$FREETDS_VERSION.tar.gz
 cd freetds-$FREETDS_VERSION
-./configure --prefix=/opt/local \
-            --with-openssl=/opt/local \
-            --with-tdsver=7.3
+./configure
 make
-make install
+sudo make install
 cd ..
 rm -rf freetds-$FREETDS_VERSION
 rm freetds-$FREETDS_VERSION.tar.gz

data/test/bin/install-mssql.ps1

@@ -0,0 +1,42 @@
+param ([int] $Version)
+
+$ProgressPreference = 'SilentlyContinue'
+
+$DownloadLinkTable = @{
+    2017 = "https://go.microsoft.com/fwlink/?linkid=829176";
+    2019 = "https://download.microsoft.com/download/7/c/1/7c14e92e-bdcb-4f89-b7cf-93543e7112d1/SQLEXPR_x64_ENU.exe";
+    2022 = "https://download.microsoft.com/download/3/8/d/38de7036-2433-4207-8eae-06e247e17b25/SQLEXPR_x64_ENU.exe";
+}
+
+$MajorVersionTable = @{
+    2017 = 14;
+    2019 = 15;
+    2022 = 16;
+}
+
+if (-not(Test-path "C:\Downloads")) {
+    mkdir "C:\Downloads"
+}
+
+$sqlInstallationFile = "C:\Downloads\sqlexpress.exe"
+if (-not(Test-path $sqlInstallationFile -PathType leaf)) {
+    Write-Host "Downloading SQL Express ..."
+    Invoke-WebRequest -Uri $DownloadLinkTable[$Version] -OutFile "C:\Downloads\sqlexpress.exe"
+}
+
+Write-Host "Installing SQL Express ..."
+Start-Process -Wait -FilePath "C:\Downloads\sqlexpress.exe" -ArgumentList /qs, /x:"C:\Downloads\setup"
+C:\Downloads\setup\setup.exe /q /ACTION=Install /INSTANCENAME=SQLEXPRESS /FEATURES=SQLEngine /UPDATEENABLED=0 /SQLSVCACCOUNT='NT AUTHORITY\System' /SQLSYSADMINACCOUNTS='BUILTIN\ADMINISTRATORS' /TCPENABLED=1 /NPENABLED=0 /IACCEPTSQLSERVERLICENSETERMS
+
+Write-Host "Configuring SQL Express ..."
+stop-service MSSQL`$SQLEXPRESS
+set-itemproperty -path "HKLM:\software\microsoft\microsoft sql server\mssql$($MajorVersionTable[$Version]).SQLEXPRESS\mssqlserver\supersocketnetlib\tcp\ipall" -name tcpdynamicports -value ''
+set-itemproperty -path "HKLM:\software\microsoft\microsoft sql server\mssql$($MajorVersionTable[$Version]).SQLEXPRESS\mssqlserver\supersocketnetlib\tcp\ipall" -name tcpport -value 1433
+set-itemproperty -path "HKLM:\software\microsoft\microsoft sql server\mssql$($MajorVersionTable[$Version]).SQLEXPRESS\mssqlserver\" -name LoginMode -value 2
+
+Write-Host "Starting SQL Express ..."
+start-service MSSQL`$SQLEXPRESS
+
+Write-Host "Configuring MSSQL for TinyTDS ..."
+& sqlcmd -i './test/sql/db-create.sql'
+& sqlcmd -i './test/sql/db-login.sql'

data/test/bin/install-mssqltools.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -x
+set -e
+
+curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
+curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list | sudo tee /etc/apt/sources.list.d/msprod.list
+sudo apt-get update
+sudo ACCEPT_EULA=Y apt-get -y install mssql-tools unixodbc-dev

data/test/bin/restore-from-native-gem.ps1

@@ -0,0 +1,10 @@
+$gemVersion = (Get-Content VERSION).Trim()
+$gemToUnpack = "./tiny_tds-$gemVersion-$env:RUBY_ARCHITECTURE.gem"
+
+Write-Host "Looking to unpack $gemToUnpack"
+gem unpack --target ./tmp "$gemToUnpack"
+
+# Restore precompiled code
+$source = (Resolve-Path ".\tmp\tiny_tds-$gemVersion-$env:RUBY_ARCHITECTURE\lib\tiny_tds").Path
+$destination = (Resolve-Path ".\lib\tiny_tds").Path
+Get-ChildItem $source -Recurse -Exclude "*.rb" | Copy-Item -Destination {Join-Path $destination $_.FullName.Substring($source.length)}

data/test/bin/setup_tinytds_db.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -x
+set -e
+
+/opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P $SA_PASSWORD -i ./test/sql/db-create.sql
+/opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P $SA_PASSWORD -i ./test/sql/db-login.sql

data/test/bin/setup_volume_permissions.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -x
+
+sudo groupadd -g 3434 circleci_tinytds
+sudo usermod -a -G circleci_tinytds $USER
+sudo useradd circleci_tinytds -u 3434 -g 3434
+sudo usermod -a -G circleci_tinytds circleci_tinytds
+sudo chgrp -R circleci_tinytds .
+sudo chmod -R g+rwx .

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
-