Module: FixpointTestHelpers

Defined in:
lib/fixpoint_test_helpers.rb

Overview

Helper methods to be included into RSpec

Instance Method Summary collapse

Instance Method Details

#compare_fixpoint(fixname, ignored_columns = [:updated_at, :created_at], tables_to_compare: :all, store_fixpoint_and_fail: false, parent_fixname: nil, connection: default_connection) ⇒ Object

Compares the fixpoint with the records in the database. If there is no such fixpoint yet, it will write a new one to the file system. The latter is useful if the fixpoint was deleted to accommodate changes to it (see example in class description).

tables_to_compare can either be :all or a list of table names (e.g. [‘users’, ‘posts’]) ignored_columns see Fixnum#records_for_table store_fixpoint_and_fail when given and the fixpoint does not already exist, a new fixpoint is created an the test will be marked pending/failed parent_fixname when storing a new fixpoint, use this as parent fixpoint (you can specify ‘:last_restored` then the last given to restore_fixpoint is used; not thread safe)

If we refactor this to a gem, we should rely on rspec (e.g. use minitest or move comparison logic to Fixpoint class). Anyhow, we keep it like this for now, because the expectations give much nicer output than the minitest assertions.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/fixpoint_test_helpers.rb', line 19

def compare_fixpoint(fixname, ignored_columns=[:updated_at, :created_at], tables_to_compare: :all, store_fixpoint_and_fail: false, parent_fixname: nil, connection: default_connection)
  if !IncrementalFixpoint.exists?(fixname)
    if store_fixpoint_and_fail
      store_fixpoint(fixname, parent_fixname, connection: connection)
      pending("Fixpoint \"#{fixname}\" did not exist yet. Skipping comparison, but created fixpoint from database. Try re-running the test.")
      fail
    else
      raise Fixpoint::Error, "Fixpoint #{fixname} does not exist"
    end
  end

  database_fp = IncrementalFixpoint.from_database(nil, connection)
  fixpoint_fp = IncrementalFixpoint.from_file(fixname)

  tables_to_compare = (database_fp.table_names + fixpoint_fp.table_names).uniq if tables_to_compare == :all
  tables_to_compare.each do |table_name|
    db_records = database_fp.records_for_table(table_name, ignored_columns)
    fp_records = fixpoint_fp.records_for_table(table_name, ignored_columns)

    expect(fp_records).not_to be_empty, "#{table_name} not in fixpoint, but in database"
    # we assume that the order of records returned by SELECT is stable (so we do not do any sorting)
    expect(db_records).to eq(fp_records), "Database records for table \"#{table_name}\" did not match fixpoint \"#{fixname}\". Consider removing the fixpoint and re-running the test if the change is intended."
  end
end

#restore_fixpoint(fixname, connection: default_connection) ⇒ Object 



3
4
5
6
 
# File 'lib/fixpoint_test_helpers.rb', line 3

def restore_fixpoint(fixname, connection: default_connection)
  @last_restored = fixname
  IncrementalFixpoint.from_file(fixname).load_into_database(connection)
end

#store_fixpoint(fixname, parent_fixname = nil, connection: default_connection) ⇒ Object

parent_fixname when given, only the (incremental) changes to the parent are saved please see store_fixpoint_unless_present for note on why not to use this method



52
53
54
55
 
# File 'lib/fixpoint_test_helpers.rb', line 52

def store_fixpoint(fixname, parent_fixname = nil, connection: default_connection)
  parent_fixname = @last_restored if parent_fixname == :last_restored
  IncrementalFixpoint.from_database(parent_fixname, connection).save_to_file(fixname)
end

#store_fixpoint_unless_present(fixname, parent_fixname = nil, connection: default_connection) ⇒ Object

it is not a good idea to overwrite the fixpoint each time because timestamps may change (which then shows up in version control). Hence we only provide a method to write to it if it does not exist.



46
47
48
 
# File 'lib/fixpoint_test_helpers.rb', line 46

def store_fixpoint_unless_present(fixname, parent_fixname = nil, connection: default_connection)
  store_fixpoint(fixname, parent_fixname, connection: connection) unless IncrementalFixpoint.exists?(fixname)
end