Module: Switchman::RSpecHelper

Defined in:
lib/switchman/r_spec_helper.rb

Overview

including this module in your specs will give you several shards to work with during specs:

* Shard.default - the test database itself
* @shard1 - a shard possibly using the same connection as Shard.default
* @shard2 - a shard using a dedicated connection
* @shard3 - a shard using the same connection as @shard1 (this might
            be Shard.default if they already share a connection, or
            a separate shard)

Constant Summary collapse

@@keep_the_shards = 
false
@@shard1 = 
nil

Class Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



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
 
# File 'lib/switchman/r_spec_helper.rb', line 20

def self.included(klass)
  # our before handlers have already been configured from a parent group; don't add them again
  parent_group = klass.parent_groups[1]
  return if parent_group && included_in?(parent_group)

  # set up sharding schemas/dbs before the root group runs, so that
  # they persist across transactional groups (e.g. once-ler)
  root_group = klass.parent_groups.last
  root_group.prepend_before(:all) do |group|
    next if @@shard1
    # if we aren't actually going to run a sharding group/example,
    # don't set it up after all
    groups = group.class.descendant_filtered_examples.map(&:example_group).uniq
    next unless groups.any?{ |group| RSpecHelper.included_in?(group) }

    puts "Setting up sharding for all specs..."
    Shard.delete_all

    @@shard1, @@shard2 = TestHelper.recreate_persistent_test_shards
    @@default_shard = Shard.default
    if @@shard1.is_a?(Shard)
      @@keep_the_shards = true
      @@shard3 = nil
    else # @@shard1.is_a?(DatabaseServer)
      begin
        @@shard1 = @@shard1.create_new_shard
        @@shard2 = @@shard2.create_new_shard
        if @@shard1.database_server == Shard.default.database_server
          @@shard3 = nil
        else
          @@shard3 = @@shard1.database_server.create_new_shard
        end
      rescue
        @@shard1 = @@shard2 = @@shard3 = nil
        raise
      end
    end
    # we'll re-persist in the group's `before :all`; we don't want them to exist
    # in the db before then
    Shard.delete_all
    Shard.default(true)
    puts "Done!"

    at_exit do
      # preserve rspec's exit status
      status= $!.is_a?(::SystemExit) ? $!.status : nil
      puts "Tearing down sharding for all specs"
      @@shard1.database_server.destroy unless @@shard1.database_server == Shard.default.database_server
      unless @@keep_the_shards
        @@shard1.drop_database
        @@shard1.destroy
        @@shard2.drop_database
        @@shard2.destroy
        if @@shard3
          @@shard3.drop_database
          @@shard3.destroy
        end
      end
      @@shard2.database_server.destroy
      exit status if status
    end
  end

  klass.before(:all) do
    dup = @@default_shard.dup
    dup.id = @@default_shard.id
    dup.save!
    Shard.default(true)
    dup = @@shard1.dup
    dup.id = @@shard1.id
    dup.save!
    dup = @@shard2.dup
    dup.id = @@shard2.id
    dup.save!
    if @@shard3
      dup = @@shard3.dup
      dup.id = @@shard3.id
      dup.save!
    end
    @shard1, @shard2 = @@shard1, @@shard2
    @shard3 = @@shard3 ? @@shard3 : Shard.default
  end

  klass.before do
    Shard.clear_cache
    if use_transactional_fixtures
      Shard.default(true)
      @shard1 = Shard.find(@shard1)
      @shard2 = Shard.find(@shard2)
      shards = [@shard2]
      shards << @shard1 unless @shard1.database_server == Shard.default.database_server
      shards.each do |shard|
        shard.activate do
          # this is how AR does it in database_statements.rb
          if ::Rails.version < '4'
            conn = ::ActiveRecord::Base.connection
            # support nested transactions around (groups of) specs (e.g. for once-ler) 
            if conn.open_transactions == 0
              conn.transaction_joinable = false
              conn.begin_db_transaction
            else
              conn.create_savepoint
            end
            conn.increment_open_transactions
          else
            ::ActiveRecord::Base.connection.begin_transaction joinable: false
          end
        end
      end
    end
  end

  klass.after do
    if use_transactional_fixtures
      shards = [@shard2]
      shards << @shard1 unless @shard1.database_server == Shard.default.database_server
      shards.each do |shard|
        shard.activate do
          if ::Rails.version < '4'
            conn = ::ActiveRecord::Base.connection
            conn.decrement_open_transactions
            if conn.open_transactions == 0
              conn.rollback_db_transaction
            else
              conn.rollback_to_savepoint
            end
          else
            ::ActiveRecord::Base.connection.rollback_transaction if ::ActiveRecord::Base.connection.transaction_open?
          end
        end
      end
    end
  end

  klass.after(:all) do
    Shard.delete_all
    Shard.default(true)
  end
end

.included_in?(klass) ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/switchman/r_spec_helper.rb', line 16

def self.included_in?(klass)
  klass.parent_groups.any? { |group| group.included_modules.include?(self) }
end