File: nulldb_spec.rb

package info (click to toggle)
ruby-activerecord-nulldb-adapter 1.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 252 kB
  • sloc: ruby: 1,039; makefile: 6
file content (533 lines) | stat: -rw-r--r-- 16,983 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
require 'rubygems'

# Optional simplecov loading
begin
  require 'simplecov'
  SimpleCov.start
rescue LoadError
end

require 'active_record'
require 'active_record/version'
$: << File.join(File.dirname(__FILE__), "..", "lib")

require 'rspec'
require 'nulldb_rspec'

class Employee < ActiveRecord::Base
  after_save :on_save_finished

  def on_save_finished
  end
end

class TablelessModel < ActiveRecord::Base
end

NullDB.configure {|ndb| ndb.project_root = 'Rails.root'}

describe "NullDB with no schema pre-loaded" do
  before :each do
    allow( Kernel ).to receive :load
    allow( ActiveRecord::Migration ).to receive :verbose=
  end

  it "should load Rails.root/db/schema.rb if no alternate is specified" do
    ActiveRecord::Base.establish_connection :adapter => :nulldb
    expect( Kernel ).to receive(:load).with("Rails.root/db/schema.rb")
    ActiveRecord::Base.connection.columns('schema_info')
  end

  it "should load the specified schema relative to Rails.root" do
    expect( Kernel ).to receive(:load).with("Rails.root/foo/myschema.rb")
    ActiveRecord::Base.establish_connection :adapter => :nulldb,
                                            :schema => "foo/myschema.rb"
    ActiveRecord::Base.connection.columns('schema_info')
  end

  it "should suppress migration output" do
    expect( ActiveRecord::Migration).to receive(:verbose=).with(false)
    ActiveRecord::Base.establish_connection :adapter => :nulldb,
                                            :schema => "foo/myschema.rb"
    ActiveRecord::Base.connection.columns('schema_info')
  end

  it "should allow creating a table without passing a block" do
    ActiveRecord::Base.establish_connection :adapter => :nulldb
    ActiveRecord::Schema.define do
      create_table(:employees)
    end
  end
end

describe "NullDB" do
  before :all do
    ActiveRecord::Base.establish_connection :adapter => :nulldb
    ActiveRecord::Migration.verbose = false
    ActiveRecord::Schema.define do
      create_table(:employees) do |t|
        t.string  :name, null: false, limit: 50
        t.date    :hire_date
        t.integer :employee_number
        t.decimal :salary
        t.boolean :active, default: true
      end

      create_table(:employees_widgets, :id => false, :force => true) do |t|
        t.integer :employee_id
        t.integer :widget_id
      end

      add_index "employees", :name, :name => "index_employees_on_name"
      add_index "employees", ["employee_number"], :name => "index_employees_on_employee_number", :unique => true
      add_index "employees", :hire_date
      remove_index "employees", :hire_date
      add_index "employees_widgets", ["employee_id", "widget_id"], :name => "my_index"

      add_fk_constraint "foo", "bar", "baz", "buz", "bungle"
      add_pk_constraint "foo", "bar", {}, "baz", "buz"
    end
  end

  before :each do
    @employee =  Employee.new(:name           => "John Smith",
                             :hire_date       => Date.civil(2000, 1, 1),
                             :employee_number => 42,
                             :salary          => 56000.00)
  end

  it "should set the @config instance variable so plugins that assume its there can use it" do
    expect( Employee.connection.instance_variable_get(:@config)[:adapter]).to eq :nulldb
  end

  it "should enable instantiation of AR objects without a database" do
    expect( @employee ).to be_a_kind_of(ActiveRecord::Base)
  end

  it "should remember columns defined in migrations" do
    should_have_column(Employee, :name, :string)
    should_have_column(Employee, :hire_date, :date)
    should_have_column(Employee, :employee_number, :integer)
    should_have_column(Employee, :salary, :decimal)
    should_have_column(Employee, :active, :boolean)
  end

  it 'should have limit on name' do
    expect(Employee.columns_hash['name'].limit).to eq 50
  end

  it "should return true on nullable field" do
    expect(Employee.columns_hash['salary'].null).to be true
  end

  it "should return false on non-nullable field" do
    expect(Employee.columns_hash['name'].null).to be false
  end

  it "should stringify default values" do
    expect(Employee.columns_hash['active'].default).to eq "true"
  end

  it "should have no default for employee_number" do
    expect(Employee.columns_hash['employee_number'].default).to eq nil
  end

  it "should return the appropriate primary key" do
    expect( ActiveRecord::Base.connection.primary_key('employees') ).to eq 'id'
  end

  it "should return a nil primary key on habtm" do
    expect( ActiveRecord::Base.connection.primary_key('employees_widgets') ).to eq nil
  end

  it "should return an empty array of columns for a table-less model" do
    expect( TablelessModel.columns).to eq []
  end

  it "should enable simulated saving of AR objects" do
    expect{ @employee.save! }.to_not raise_error
  end

  it "should enable AR callbacks during simulated save" do
    expect( @employee ).to receive :on_save_finished
    @employee.save
  end

  it "should enable simulated deletes of AR objects" do
    expect{ @employee.destroy }.to_not raise_error
  end

  it "should enable simulated creates of AR objects" do
    emp = Employee.create(:name => "Bob Jones")
    expect( emp.name ).to eq "Bob Jones"
  end

  it "should generate new IDs when inserting unsaved objects" do
    cxn = Employee.connection
    id1 = cxn.insert("some sql", "SomeClass Create", "id", nil, nil)
    id2 = cxn.insert("some sql", "SomeClass Create", "id", nil, nil)
    expect( id2 ).to eq (id1 + 1)
  end

  it "should re-use object ID when inserting saved objects" do
    cxn = Employee.connection
    id1 = cxn.insert("some sql", "SomeClass Create", "id", 23, nil)
    expect( id1 ).to eq 23
  end

  it "should log executed SQL statements" do
    cxn = Employee.connection
    exec_count = cxn.execution_log.size
    @employee.save!
    expect( cxn.execution_log.size ).to eq (exec_count + 1)
  end

  it "should have the adapter name 'NullDB'" do
    expect( Employee.connection.adapter_name ).to eq "NullDB"
  end

  it "should support migrations" do
    expect( Employee.connection.supports_migrations? ).to eq true
  end

  it "should always have a schema_info table definition" do
    expect( Employee.connection.tables ).to include "schema_info"
  end

  it "should return an empty array from #select" do
    result = Employee.connection.select_all("who cares", "blah")
    expect( result ).to eq []
  end

  it "should provide a way to set log checkpoints" do
    cxn = Employee.connection
    @employee.save!
    expect( cxn.execution_log_since_checkpoint.size ).to be > 0

    cxn.checkpoint!
    expect( cxn.execution_log_since_checkpoint.size ).to eq 0

    @employee.salary = @employee.salary + 1
    @employee.save!
    expect( cxn.execution_log_since_checkpoint.size ).to eq 1
  end

  def should_contain_statement(cxn, entry_point)
    expect( cxn.execution_log_since_checkpoint).to \
      include(ActiveRecord::ConnectionAdapters::NullDBAdapter::Statement.new(entry_point))
  end

  def should_not_contain_statement(cxn, entry_point)
    expect( cxn.execution_log_since_checkpoint ).to_not \
      include(ActiveRecord::ConnectionAdapters::NullDBAdapter::Statement.new(entry_point))
  end

  it "should tag logged statements with their entry point" do
    cxn = Employee.connection

    should_not_contain_statement(cxn, :insert)
    @employee.save
    should_contain_statement(cxn, :insert)

    cxn.checkpoint!
    should_not_contain_statement(cxn, :update)
    @employee.salary = @employee.salary + 1
    @employee.save
    should_contain_statement(cxn, :update)

    cxn.checkpoint!
    should_not_contain_statement(cxn, :delete)
    @employee.destroy
    should_contain_statement(cxn, :delete)

    cxn.checkpoint!
    should_not_contain_statement(cxn, :select_all)
    Employee.all.each do |emp|; end
    should_contain_statement(cxn, :select_all)

    cxn.checkpoint!
    should_not_contain_statement(cxn, :select_value)
    Employee.count_by_sql("frobozz")
    should_contain_statement(cxn, :select_value)

    cxn.checkpoint!
    should_not_contain_statement(cxn, :select_values)
    cxn.select_values("")
    should_contain_statement(cxn, :select_values)
  end

  it "should allow #finish to be called on the result of #execute" do
    Employee.connection.execute("blah").finish
  end

  it "should #to_a return empty array on the result of #execute" do
    result = Employee.connection.execute("blah")
    expect( result.to_a ).to be_a Array
    expect( result.to_a ).to be_empty
  end

  def should_have_column(klass, col_name, col_type)
    col = klass.columns_hash[col_name.to_s]
    expect(col.sql_type.to_s.gsub(/\([0-9]+\)/, "").to_sym).to eq col_type
  end


  it "should support adding and removing indexes" do
    expect( Employee.connection.indexes('employees').size ).to eq 2
    expect( Employee.connection.indexes('employees_widgets').size ).to eq 1
  end

  it "should support unique indexes" do
    expect( Employee.connection.indexes('employees').detect{|idx| idx.columns == ["name"]}.unique ).to eq false
    expect( Employee.connection.indexes('employees').detect{|idx| idx.columns == ["employee_number"]}.unique ).to eq true
  end

  it "should support multi-column indexes" do
    expect( Employee.connection.indexes('employees_widgets').first.columns).to eq ["employee_id", "widget_id"]
  end

  it "should support custom index names" do
    expect( Employee.connection.indexes('employees_widgets').first.name ).to eq 'my_index'
  end

  it 'should handle ActiveRecord::ConnectionNotEstablished' do
    expect( ActiveRecord::Base ).to receive(:connection_pool).and_raise(ActiveRecord::ConnectionNotEstablished)
    expect { NullDB.nullify }.to_not raise_error
  end

  it 'should handle count queries' do
    expect(Employee.count).to eql(0)
  end
end

# need a fallback db for contextual nullification
if defined?(ActiveRecord::DatabaseConfigurations)
  db_config = { 'test' => {'adapter' => 'nulldb'} }
  ActiveRecord::Base.configurations = ActiveRecord::DatabaseConfigurations.new(db_config)
else
  # Support ActiveRecord 5
  ActiveRecord::Base.configurations['test'] = {'adapter' => 'nulldb'}
end

describe NullDB::RSpec::NullifiedDatabase do
  describe 'have_executed rspec matcher' do
    before(:all) do
      ActiveRecord::Schema.define do
        create_table(:employees)
      end
    end

    include NullDB::RSpec::NullifiedDatabase

    before { NullDB.checkpoint }

    it 'passes if an execution was made' do
      expect( Employee.connection ).to receive(:insert)
      allow( Kernel ).to receive :load
      Employee.create
    end
  end

  describe '.globally_nullify_database' do
    it 'nullifies the database' do
      expect( NullDB::RSpec::NullifiedDatabase ).to respond_to(:nullify_database)
      expect( NullDB::RSpec::NullifiedDatabase ).to receive(:nullify_database)
      NullDB::RSpec::NullifiedDatabase.globally_nullify_database
    end
  end
end

describe 'table changes' do
  before(:each) do
    ActiveRecord::Base.establish_connection :adapter => :nulldb
    ActiveRecord::Migration.verbose = false

    ActiveRecord::Schema.define do
      create_table(:employees) do |t|
        t.string  :name, null: false, limit: 50
        t.date    :hire_date
        t.integer :employee_number
        t.decimal :salary
      end
    end
  end

  def should_have_column(klass, col_name, col_type)
    col = klass.columns_hash[col_name.to_s]
    expect(col.sql_type.to_s.gsub(/\([0-9]+\)/, "").to_sym).to eq col_type
  end

  describe 'rename_table' do
    it 'should rename a table' do
      expect{
        ActiveRecord::Schema.define do
          rename_table :employees, :workers
        end
      }.to_not raise_error

      class Worker < ActiveRecord::Base
        after_save :on_save_finished

        def on_save_finished
        end
      end

      should_have_column(Worker, :name, :string)
      should_have_column(Worker, :hire_date, :date)
      should_have_column(Worker, :employee_number, :integer)
      should_have_column(Worker, :salary, :decimal)

      worker = Worker.create(:name => "Bob Jones")
      expect(worker.name).to eq "Bob Jones"
    end
  end

  describe 'add_column' do
    it 'should add a column to an existing table' do
      expect{
        ActiveRecord::Schema.define do
          add_column :employees, :title, :string
        end
        Employee.connection.schema_cache.clear!
        Employee.reset_column_information
      }.to_not raise_error

      should_have_column(Employee, :name, :string)
      should_have_column(Employee, :hire_date, :date)
      should_have_column(Employee, :employee_number, :integer)
      should_have_column(Employee, :salary, :decimal)
      should_have_column(Employee, :title, :string)
    end
  end

  describe 'change_column' do
    it 'should change the column type' do
      expect{
        ActiveRecord::Schema.define do
          change_column :employees, :name, :text
        end
        Employee.connection.schema_cache.clear!
        Employee.reset_column_information
      }.to_not raise_error

      should_have_column(Employee, :name, :text)
      should_have_column(Employee, :hire_date, :date)
      should_have_column(Employee, :employee_number, :integer)
      should_have_column(Employee, :salary, :decimal)
    end
  end

  describe 'rename_column' do
    it 'should rename a column' do
      expect{
        ActiveRecord::Schema.define do
          rename_column :employees, :name, :full_name
        end
        Employee.connection.schema_cache.clear!
        Employee.reset_column_information
      }.to_not raise_error

      should_have_column(Employee, :full_name, :string)
      should_have_column(Employee, :hire_date, :date)
      should_have_column(Employee, :employee_number, :integer)
      should_have_column(Employee, :salary, :decimal)
    end
  end

  describe 'change_column_default' do
    it 'should change default value of a column' do
      expect{
        ActiveRecord::Schema.define do
          change_column_default :employees, :name, 'Jon Doe'
        end
        Employee.connection.schema_cache.clear!
        Employee.reset_column_information
      }.to_not raise_error

      columns = Employee.columns
      expect(columns.second.default).to eq('Jon Doe')
    end

    it 'should change default value of a with has syntax' do
      expect{
        ActiveRecord::Schema.define do
          change_column_default :employees, :name, from: nil, to: 'Jon Doe'
        end
        Employee.connection.schema_cache.clear!
        Employee.reset_column_information
      }.to_not raise_error

      columns = Employee.columns
      expect(columns.second.default).to eq('Jon Doe')
    end
  end
end

describe 'adapter-specific extensions' do
  before(:all) do
    ActiveRecord::Base.establish_connection :adapter => :nulldb
    ActiveRecord::Migration.verbose = false
  end

  def should_have_column(klass, col_name, col_type)
    col = klass.columns_hash[col_name.to_s]
    expect(col.sql_type.to_s.gsub(/\([0-9]+\)/, "").to_sym).to eq col_type
  end

  it "supports 'enable_extension' in the schema definition" do
    expect{
      ActiveRecord::Schema.define do
        enable_extension "plpgsql"
      end
    }.to_not raise_error
  end

  it 'supports postgres extension columns' do
    expect {
      ActiveRecord::Schema.define do
        create_table :extended_models do |t|
          t.citext :text
          t.interval :time_interval
          t.geometry :feature_geometry, srid: 4326, type: "multi_polygon"
          t.jsonb :jsonb_column
          t.hstore :hstore_column
        end
      end
    }.to_not raise_error

    class ExtendedModel < ActiveRecord::Base
    end

    should_have_column(ExtendedModel, :text, :text)
    should_have_column(ExtendedModel, :time_interval, :text)
    should_have_column(ExtendedModel, :feature_geometry, :text)
    should_have_column(ExtendedModel, :jsonb_column, :json)
  end

  it 'supports ActiveModel attributes with postgres modifiers' do
    class ExtendedModel < ActiveRecord::Base
      attribute :strings, :string, array: true
      attribute :size, :integer, range: true
    end

    expect(ExtendedModel.type_for_attribute(:strings))
      .to be_a ActiveRecord::ConnectionAdapters::NullDBAdapter::DummyOID
    expect(ExtendedModel.new(strings: %w[a b]).strings).to eq %w[a b]
    expect(ExtendedModel.type_for_attribute(:size))
      .to be_a ActiveRecord::ConnectionAdapters::NullDBAdapter::DummyOID
    expect(ExtendedModel.new(size: 1..5).size).to eq 1..5
  end

  it 'registers a primary_key type' do
    expect(ActiveRecord::Type.lookup(:primary_key, adapter: 'NullDB'))
      .to be_a(ActiveModel::Type::Integer)
  end
end

describe ActiveRecord::ConnectionAdapters::NullDBAdapter::EmptyResult do
  it "should return an empty array from #cast_values" do
    result = described_class.new
    expect( result.cast_values ).to be_a Array
    expect( result.cast_values ).to be_empty
  end
end