File: middlewares_test.rb

package info (click to toggle)
ruby-redis-client 0.28.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,116 kB
  • sloc: ansic: 7,517; ruby: 5,801; makefile: 246; sh: 123
file content (277 lines) | stat: -rw-r--r-- 7,646 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
# frozen_string_literal: true

require "test_helper"

class RedisClient
  class MiddlewaresTest < RedisClientTestCase
    include ClientTestHelper

    def setup
      @original_module = RedisClient::Middlewares
      new_module = @original_module.dup
      RedisClient.send(:remove_const, :Middlewares)
      RedisClient.const_set(:Middlewares, new_module)
      RedisClient.register(TestMiddleware)
      super
      TestMiddleware.calls.clear
    end

    def teardown
      if @original_module
        RedisClient.send(:remove_const, :Middlewares)
        RedisClient.const_set(:Middlewares, @original_module)
      end
      TestMiddleware.calls.clear
      super
    end

    def test_call_instrumentation
      @redis.call("PING")
      assert_call [:call, :success, ["PING"], "PONG", @redis.config]
    end

    def test_failing_call_instrumentation
      assert_raises CommandError do
        @redis.call("PONG")
      end
      call = TestMiddleware.calls.first
      assert_equal [:call, :error, ["PONG"]], call.first(3)
      assert_instance_of CommandError, call[3]
    end

    def test_call_once_instrumentation
      @redis.call_once("PING")
      assert_call [:call, :success, ["PING"], "PONG", @redis.config]
    end

    def test_blocking_call_instrumentation
      @redis.blocking_call(nil, "PING")
      assert_call [:call, :success, ["PING"], "PONG", @redis.config]
    end

    def test_pipeline_instrumentation
      @redis.pipelined do |pipeline|
        pipeline.call("PING")
      end
      assert_call [:pipeline, :success, [["PING"]], ["PONG"], @redis.config]
    end

    def test_multi_instrumentation
      @redis.multi do |transaction|
        transaction.call("PING")
      end
      assert_call [
        :pipeline,
        :success,
        [["MULTI"], ["PING"], ["EXEC"]],
        ["OK", "QUEUED", ["PONG"]],
        @redis.config,
      ]
    end

    def test_final_errors
      client = new_client(reconnect_attempts: 1)
      simulate_network_errors(client, ["PING"]) do
        assert_equal("PONG", client.call("PING"))
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 2, calls.size

      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      refute_predicate call[3], :final?

      call = calls[1]
      assert_equal :success, call[1]
      assert_equal ["PING"], call[2]

      TestMiddleware.calls.clear

      client = new_client(reconnect_attempts: 1)
      simulate_network_errors(client, ["PING", "PING"]) do
        assert_raises ConnectionError do
          client.call("PING")
        end
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 2, calls.size

      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      refute_predicate call[3], :final?

      call = calls[1]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      assert_predicate call[3], :final?

      TestMiddleware.calls.clear

      client = new_client(reconnect_attempts: 1)
      simulate_network_errors(client, ["PING"]) do
        assert_raises ConnectionError do
          client.call_once("PING")
        end
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 1, calls.size

      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      assert_predicate call[3], :final?

      TestMiddleware.calls.clear
    end

    def test_final_errors_during_reconnect
      client = new_client(reconnect_attempts: 1)
      simulate_network_errors(client, ["PING", "HELLO"]) do
        assert_raises ConnectionError do
          client.call("PING")
        end
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 1, calls.size

      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      refute_predicate call[3], :final?

      pipeline_calls = TestMiddleware.calls.select { |type, _| type == :pipeline }
      assert_equal 2, pipeline_calls.size

      failing_pipeline = pipeline_calls[1]
      assert_equal :error, failing_pipeline[1]
      assert_equal [["HELLO", "3"]], failing_pipeline[2]
      assert_predicate failing_pipeline[3], :final?
    end

    def test_command_error_final
      tcp_server = TCPServer.new("127.0.0.1", 0)
      tcp_server.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
      port = tcp_server.addr[1]

      server_thread = Thread.new do
        session = tcp_server.accept
        session.write("-Whoops\r\n")
        session.close
      end

      assert_raises CommandError do
        new_client(host: "127.0.0.1", port: port, reconnect_attempts: 1, protocol: 2).call("PING")
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 1, calls.size
      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      assert_predicate call[3], :final?
    ensure
      server_thread&.kill
    end

    def test_protocol_error
      tcp_server = TCPServer.new("127.0.0.1", 0)
      tcp_server.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
      port = tcp_server.addr[1]

      server_thread = Thread.new do
        2.times do
          session = tcp_server.accept
          session.write("garbage\r\n")
          session.flush
          session.close
        end
      end

      assert_raises ProtocolError do
        new_client(host: "127.0.0.1", port: port, reconnect_attempts: 1, protocol: 2).call("PING")
      end

      calls = TestMiddleware.calls.select { |type, _| type == :call }
      assert_equal 2, calls.size

      call = calls[0]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      refute_predicate call[3], :final?

      call = calls[1]
      assert_equal :error, call[1]
      assert_equal ["PING"], call[2]
      assert_predicate call[3], :final?
    ensure
      server_thread&.kill
    end

    module DummyMiddleware
      def call(command, _config, &_)
        command
      end

      def call_pipelined(commands, _config, &_)
        commands
      end
    end

    def test_instance_middleware
      second_client = new_client(middlewares: [DummyMiddleware])
      assert_equal ["GET", "2"], second_client.call("GET", 2)
      assert_equal([["GET", "2"]], second_client.pipelined { |p| p.call("GET", 2) })
    end

    private

    def assert_call(call)
      assert_equal call, TestMiddleware.calls.first
      assert_equal 1, TestMiddleware.calls.size
    end

    def assert_calls(calls)
      assert_equal calls, TestMiddleware.calls
    end

    module TestMiddleware
      class << self
        attr_accessor :calls
      end
      @calls = []

      def connect(config)
        result = super
        TestMiddleware.calls << [:connect, :success, result, config]
        result
      rescue => error
        TestMiddleware.calls << [:connect, :error, error, config]
        raise
      end

      def call(command, config)
        result = super
        TestMiddleware.calls << [:call, :success, command, result, config]
        result
      rescue => error
        TestMiddleware.calls << [:call, :error, command, error, config]
        raise
      end

      def call_pipelined(commands, config)
        result = super
        TestMiddleware.calls << [:pipeline, :success, commands, result, config]
        result
      rescue => error
        TestMiddleware.calls << [:pipeline, :error, commands, error, config]
        raise
      end
    end
  end
end