sbf-data_objects 0.10.17

data/lib/data_objects/spec/shared/connection_spec.rb

@@ -0,0 +1,148 @@
+def test_connection(conn)
+  reader = conn.create_command(CONFIG.testsql || 'SELECT 1').execute_reader
+  reader.next!
+  result = reader.values[0]
+  result
+ensure
+  reader.close
+  conn.close
+end
+
+shared_examples 'a Connection' do
+  before :all do
+    setup_test_environment
+  end
+
+  before do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+  end
+
+  after do
+    @connection.close
+  end
+
+  it { expect(@connection).to be_kind_of(DataObjects::Connection) }
+  it { expect(@connection).to be_kind_of(DataObjects::Pooling) }
+
+  it { expect(@connection).to respond_to(:dispose) }
+  it 'responds to #create_command' do
+    expect(@connection).to respond_to(:create_command)
+  end
+
+  describe 'create_command' do
+    it 'is a kind of Command' do
+      expect(@connection.create_command('This is a dummy command')).to be_kind_of(DataObjects::Command)
+    end
+  end
+
+  describe 'various connection URIs' do
+    it 'opens with an uri object' do
+      uri = DataObjects::URI.new(
+        scheme: @driver,
+        user: @user,
+        password: @password,
+        host: @host,
+        port: @port&.to_i,
+        path: @database
+      )
+      conn = DataObjects::Connection.new(uri)
+      expect(test_connection(conn)).to eq 1
+      conn.close
+    end
+
+    it 'works with non-JDBC URLs' do
+      conn = DataObjects::Connection.new(CONFIG.uri.sub('jdbc:', '').to_s)
+      expect(test_connection(conn)).to eq 1
+      conn.close
+    end
+  end
+
+  describe 'dispose' do
+    describe 'on open connection' do
+      it 'dispose is true' do
+        conn = DataObjects::Connection.new(CONFIG.uri)
+        conn.detach
+        expect(conn.dispose).to be true
+        conn.close
+      end
+    end
+
+    describe 'on closed connection' do
+      before do
+        @closed_connection = DataObjects::Connection.new(CONFIG.uri)
+        @closed_connection&.detach
+        @closed_connection&.dispose
+      end
+
+      after do
+        @closed_connection&.close
+        @closed_connection = nil
+      end
+
+      it { expect(@closed_connection&.dispose).to be false }
+
+      it 'raises an error on creating a command' do
+        expect do
+          @closed_connection&.create_command('INSERT INTO non_existent_table (tester) VALUES (1)')&.execute_non_query
+        end.to raise_error(DataObjects::ConnectionError)
+      end
+    end
+  end
+end
+
+shared_examples 'a Connection with authentication support' do
+  before :all do
+    %w(@driver @user @password @host @port @database).each do |ivar|
+      raise "+#{ivar}+ should be defined in before block" unless instance_variable_get(ivar)
+    end
+  end
+
+  describe 'with an invalid URI' do
+    it 'raises an error if bad username is given' do
+      expect { DataObjects::Connection.new("#{@driver}://thisreallyshouldntexist:#{@password}@#{@host}:#{@port}#{@database}") }
+        .to raise_error(DataObjects::ConnectionError)
+    end
+
+    it 'raises an error if bad password is given' do
+      expect { DataObjects::Connection.new("#{@driver}://#{@user}:completelyincorrectpassword:#{@host}:#{@port}#{@database}") }
+        .to raise_error(DataObjects::SQLError)
+    end
+
+    it 'raises an error if an invalid port is given' do
+      expect { DataObjects::Connection.new("#{@driver}://#{@user}:#{@password}:#{@host}:648646543#{@database}") }.to raise_error(DataObjects::SQLError)
+    end
+
+    it 'raises an error if an invalid database is given' do
+      expect { DataObjects::Connection.new("#{@driver}://#{@user}:#{@password}:#{@host}:#{@port}/someweirddatabase") }.to raise_error(DataObjects::SQLError)
+    end
+  end
+end
+
+shared_examples 'a Connection allowing default database' do
+  describe 'with a URI without a database' do
+    it 'connects properly' do
+      conn = DataObjects::Connection.new("#{@driver}://#{@user}:#{@password}@#{@host}:#{@port}")
+      expect(test_connection(conn)).to eq 1
+    end
+  end
+end
+
+shared_examples 'a Connection with SSL support' do
+  if DataObjectsSpecHelpers.test_environment_supports_ssl?
+    describe 'connecting with SSL' do
+      it 'connects securely' do
+        conn = DataObjects::Connection.new("#{CONFIG.uri}?#{CONFIG.ssl}")
+        expect(conn.secure?).to be true
+        conn.close
+      end
+    end
+  end
+
+  describe 'connecting without SSL' do
+    it 'does not connect securely' do
+      conn = DataObjects::Connection.new(CONFIG.uri)
+      expect(conn.secure?).to be false
+      conn.close
+    end
+  end
+end

data/lib/data_objects/spec/shared/encoding_spec.rb

@@ -0,0 +1,161 @@
+shared_examples 'a driver supporting different encodings' do
+  describe 'character_set' do
+    before do
+      @connection = DataObjects::Connection.new(CONFIG.uri)
+    end
+
+    after do
+      @connection.close
+    end
+
+    it { expect(@connection).to respond_to(:character_set) }
+
+    it 'uses utf8 by default' do
+      expect(@connection.character_set).to eq 'UTF-8'
+    end
+
+    describe 'sets the character set through the URI' do
+      before do
+        # @latin1_connection = DataObjects::Connection.new("#{CONFIG.uri}?encoding=latin1")
+        @latin1_connection = DataObjects::Connection.new(
+          "#{CONFIG.scheme}://#{CONFIG.user}:#{CONFIG.pass}@#{CONFIG.host}:#{CONFIG.port}#{CONFIG.database}?encoding=ISO-8859-1"
+        )
+      end
+
+      after { @latin1_connection.close }
+
+      it { expect(@latin1_connection.character_set).to eq 'ISO-8859-1' }
+    end
+
+    describe 'uses UTF-8 when an invalid encoding is given' do
+      before do
+        @latin1_connection = DataObjects::Connection.new(
+          "#{CONFIG.scheme}://#{CONFIG.user}:#{CONFIG.pass}@#{CONFIG.host}:#{CONFIG.port}#{CONFIG.database}?encoding=ISO-INVALID"
+        )
+      end
+
+      after { @latin1_connection.close }
+
+      it { expect(@latin1_connection.character_set).to eq 'UTF-8' }
+    end
+  end
+end
+
+shared_examples 'returning correctly encoded strings for the default database encoding' do
+  if defined?(Encoding)
+
+    before :all do
+      setup_test_environment
+    end
+
+    describe 'with encoded string support' do
+      before do
+        @connection = DataObjects::Connection.new(CONFIG.uri)
+      end
+
+      after do
+        @connection.close
+      end
+
+      describe 'reading a String' do
+        before do
+          @reader = @connection.create_command('SELECT name, whitepaper_text FROM widgets WHERE ad_description = ?')
+                               .execute_reader('Buy this product now!')
+          @reader.next!
+          @values = @reader.values
+        end
+
+        after do
+          @reader.close
+        end
+
+        it 'returns UTF-8 encoded String' do
+          expect(@values.first).to be_kind_of(String)
+          expect(@values.first.encoding.name).to eq 'UTF-8'
+          expect(@values.last).to be_kind_of(String)
+          expect(@values.last.encoding.name).to eq 'UTF-8'
+        end
+      end
+
+      describe 'reading a ByteArray' do
+        before do
+          @command = @connection.create_command('SELECT ad_image FROM widgets WHERE ad_description = ?')
+          @command.set_types(Extlib::ByteArray)
+          @reader = @command.execute_reader('Buy this product now!')
+          @reader.next!
+          @values = @reader.values
+        end
+
+        after do
+          @reader.close
+        end
+
+        it 'returns ASCII-8BIT encoded ByteArray' do
+          expect(@values.first).to be_kind_of(Extlib::ByteArray)
+          expect(@values.first.encoding.name).to eq 'ASCII-8BIT'
+        end
+      end
+    end
+  end
+end
+
+shared_examples 'returning correctly encoded strings for the default internal encoding' do
+  if defined?(Encoding)
+
+    before :all do
+      setup_test_environment
+    end
+
+    describe 'with encoded string support' do
+      before do
+        @encoding_before = Encoding.default_internal
+        Encoding.default_internal = 'ISO-8859-1'
+        @connection = DataObjects::Connection.new(CONFIG.uri)
+      end
+
+      after do
+        @connection.close
+        Encoding.default_internal = @encoding_before
+      end
+
+      describe 'reading a String' do
+        before do
+          @reader = @connection.create_command('SELECT name, whitepaper_text FROM widgets WHERE ad_description = ?')
+                               .execute_reader('Buy this product now!')
+          @reader.next!
+          @values = @reader.values
+        end
+
+        after do
+          @reader.close
+        end
+
+        it 'returns ISO-8859-1 encoded String' do
+          expect(@values.first).to be_kind_of(String)
+          expect(@values.first.encoding.name).to eq 'ISO-8859-1'
+          expect(@values.last).to be_kind_of(String)
+          expect(@values.last.encoding.name).to eq 'ISO-8859-1'
+        end
+      end
+
+      describe 'reading a ByteArray' do
+        before do
+          @command = @connection.create_command('SELECT ad_image FROM widgets WHERE ad_description = ?')
+          @command.set_types(Extlib::ByteArray)
+          @reader = @command.execute_reader('Buy this product now!')
+          @reader.next!
+          @values = @reader.values
+        end
+
+        after do
+          @reader.close
+        end
+
+        it 'returns ASCII-8BIT encoded ByteArray' do
+          expect(@values.first).to be_kind_of(Extlib::ByteArray)
+          expect(@values.first.encoding.name).to eq 'ASCII-8BIT'
+        end
+      end
+    end
+  end
+end

data/lib/data_objects/spec/shared/error/sql_error_spec.rb

@@ -0,0 +1,23 @@
+shared_examples 'raising a SQLError' do
+  before :all do
+    setup_test_environment
+  end
+
+  describe 'an invalid query' do
+    it 'raises an error' do
+      @connection = DataObjects::Connection.new(CONFIG.uri)
+      invalid_query = @connection.create_command('SLCT * FROM widgets WHERE ad_description = ? order by id')
+      expect { invalid_query.execute_reader('Buy this product now!') }.to raise_error(DataObjects::SQLError)
+      @connection.close
+    end
+  end
+
+  describe 'an invalid result set' do
+    it 'raises an error' do
+      @connection = DataObjects::Connection.new(CONFIG.uri)
+      invalid_result = @connection.create_command('SELECT MAX((SELECT 1 UNION SELECT 2))')
+      expect { invalid_result.execute_reader }.to raise_error(DataObjects::SQLError)
+      @connection.close
+    end
+  end
+end

data/lib/data_objects/spec/shared/reader_spec.rb

@@ -0,0 +1,180 @@
+shared_examples 'a Reader' do
+  before :all do
+    setup_test_environment
+  end
+
+  before do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+    @reader     = @connection.create_command('SELECT code, name FROM widgets WHERE ad_description = ? order by id')
+                             .execute_reader('Buy this product now!')
+    @reader2    = @connection.create_command('SELECT code FROM widgets WHERE ad_description = ? order by id').execute_reader('Buy this product now!')
+  end
+
+  after do
+    @reader.close
+    @reader2.close
+    @connection.close
+  end
+
+  it { expect(@reader).to respond_to(:fields) }
+
+  describe 'fields' do
+    it 'returns the correct fields in the reader' do
+      # we downcase the field names as some drivers such as do_derby, do_h2,
+      # do_hsqldb, do_oracle return the field names as uppercase
+      expect(@reader.fields).to be_array_case_insensitively_equal_to(%w(code name))
+    end
+
+    it 'returns the field alias as the name, when the SQL AS keyword is specified' do
+      reader = @connection.create_command('SELECT code AS codigo, name AS nombre FROM widgets WHERE ad_description = ? order by id')
+                          .execute_reader('Buy this product now!')
+      expect(reader.fields).not_to be_array_case_insensitively_equal_to(%w(code name))
+      expect(reader.fields).to be_array_case_insensitively_equal_to(%w(codigo nombre))
+      reader.close
+    end
+  end
+
+  it { expect(@reader).to respond_to(:values) }
+
+  describe 'values' do
+    describe 'when the reader is uninitialized' do
+      it 'raises an error' do
+        expect { @reader.values }.to raise_error(DataObjects::DataError)
+      end
+    end
+
+    describe 'when the reader is moved to the first result' do
+      before do
+        @reader.next!
+      end
+
+      it 'returns the correct first set of in the reader' do
+        expect(@reader.values).to eq ['W0000001', 'Widget 1']
+      end
+    end
+
+    describe 'when the reader is moved to the second result' do
+      before do
+        @reader.next!
+        @reader.next!
+      end
+
+      it 'returns the correct first set of in the reader' do
+        expect(@reader.values).to eq ['W0000002', 'Widget 2']
+      end
+    end
+
+    describe 'when the reader is moved to the end' do
+      before do
+        while @reader.next!; end
+      end
+
+      it 'raises an error again' do
+        expect { @reader.values }.to raise_error(DataObjects::DataError)
+      end
+    end
+  end
+
+  it { expect(@reader).to respond_to(:close) }
+
+  describe 'close' do
+    describe 'on an open reader' do
+      it 'returns true' do
+        expect(@reader.close).to be true
+      end
+    end
+
+    describe 'on an already closed reader' do
+      before do
+        @reader.close
+      end
+
+      it 'returns false' do
+        expect(@reader.close).to be false
+      end
+    end
+  end
+
+  it { expect(@reader).to respond_to(:next!) }
+
+  describe 'next!' do
+    describe 'successfully moving the cursor initially' do
+      it 'returns true' do
+        expect(@reader.next!).to be true
+      end
+    end
+
+    describe 'moving the cursor' do
+      before do
+        @reader.next!
+      end
+
+      it 'moves the cursor to the next value' do
+        expect(@reader.values).to eq ['W0000001', 'Widget 1']
+        expect { @reader.next! }.to(change { @reader.values })
+        expect(@reader.values).to eq ['W0000002', 'Widget 2']
+      end
+    end
+
+    describe 'arriving at the end of the reader' do
+      before do
+        while @reader.next!; end
+      end
+
+      it 'returns false when the end is reached' do
+        expect(@reader.next!).to be false
+      end
+    end
+  end
+
+  it { expect(@reader).to respond_to(:field_count) }
+
+  describe 'field_count' do
+    it 'counts the number of fields' do
+      expect(@reader.field_count).to eq 2
+    end
+  end
+
+  it { expect(@reader).to respond_to(:values) }
+
+  describe 'each' do
+    it 'yields each row to the block for multiple columns' do
+      rows_yielded = 0
+      @reader.each do |row|
+        expect(row).to respond_to(:[])
+
+        expect(row.size).to eq 2
+
+        # the field names need to be case insensitive as some drivers such as
+        # do_derby, do_h2, do_hsqldb return the field names as uppercase
+        expect(row['name'] || row['NAME']).to be_kind_of(String)
+        expect(row['code'] || row['CODE']).to be_kind_of(String)
+
+        rows_yielded += 1
+      end
+      expect(rows_yielded).to eq 15
+    end
+
+    it 'yields each row to the block for a single column' do
+      rows_yielded = 0
+      @reader2.each do |row|
+        expect(row).to respond_to(:[])
+
+        expect(row.size).to eq 1
+
+        # the field names need to be case insensitive as some drivers such as
+        # do_derby, do_h2, do_hsqldb return the field names as uppercase
+        expect(row['code'] || row['CODE']).to be_kind_of(String)
+
+        rows_yielded += 1
+      end
+      expect(rows_yielded).to eq 15
+    end
+
+    it 'returns the reader' do
+      expect(@reader.each do |_row|
+        # empty block
+      end).to equal(@reader)
+    end
+  end
+end

data/lib/data_objects/spec/shared/result_spec.rb

@@ -0,0 +1,67 @@
+shared_examples 'a Result' do
+  before :all do
+    setup_test_environment
+  end
+
+  before do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+    @result = @connection.create_command('INSERT INTO users (name) VALUES (?)').execute_non_query('monkey')
+  end
+
+  after do
+    @connection.close
+  end
+
+  it { expect(@result).to respond_to(:affected_rows) }
+
+  describe 'affected_rows' do
+    it 'returns the number of affected rows' do
+      expect(@result.affected_rows).to eq 1
+    end
+  end
+end
+
+shared_examples 'a Result which returns inserted key with sequences' do
+  describe 'insert_id' do
+    before do
+      setup_test_environment
+      @connection = DataObjects::Connection.new(CONFIG.uri)
+      command = @connection.create_command('INSERT INTO users (name) VALUES (?)')
+      # execute the command twice and expose the second result
+      command.execute_non_query('monkey')
+      @result = command.execute_non_query('monkey')
+    end
+
+    after do
+      @connection.close
+    end
+
+    it { expect(@result).to respond_to(:affected_rows) }
+
+    it 'returns the insert_id' do
+      # This is actually the 2nd record inserted
+      expect(@result.insert_id).to eq 2
+    end
+  end
+end
+
+shared_examples 'a Result which returns nil without sequences' do
+  describe 'insert_id' do
+    before do
+      setup_test_environment
+      @connection = DataObjects::Connection.new(CONFIG.uri)
+      command = @connection.create_command('INSERT INTO invoices (invoice_number) VALUES (?)')
+      # execute the command twice and expose the second result
+      @result = command.execute_non_query('monkey')
+    end
+
+    after do
+      @connection.close
+    end
+
+    it 'returns the insert_id' do
+      # This is actually the 2nd record inserted
+      expect(@result.insert_id).to be_nil
+    end
+  end
+end

data/lib/data_objects/spec/shared/typecast/array_spec.rb

@@ -0,0 +1,29 @@
+shared_examples 'supporting Array' do
+  before :all do
+    setup_test_environment
+  end
+
+  before do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+  end
+
+  after do
+    @connection.close
+  end
+
+  describe 'passing an Array as a parameter in execute_reader' do
+    before do
+      @reader = @connection.create_command('SELECT * FROM widgets WHERE id in ?').execute_reader([2, 3, 4, 5])
+    end
+
+    after do
+      @reader.close
+    end
+
+    it 'returns correct number of rows' do
+      counter  = 0
+      counter += 1 while @reader.next!
+      expect(counter).to eq 4
+    end
+  end
+end