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
|
# frozen_string_literal: true
require "test_helper"
class RedisClient
class ConfigTest < RedisClientTestCase
def test_simple_uri
config = Config.new(url: "redis://example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "default", config.username
assert_nil config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
end
def test_unix_uri
config = Config.new(url: "/run/redis/test.sock?db=1")
assert_equal "/run/redis/test.sock", config.path
assert_nil config.host
assert_nil config.port
assert_equal 1, config.db
config = Config.new(url: "run/redis/test.sock?db=1")
assert_equal "run/redis/test.sock", config.path
assert_nil config.host
assert_nil config.port
assert_equal 1, config.db
config = Config.new(url: "unix:///run/redis/test.sock?db=1")
assert_equal "/run/redis/test.sock", config.path
assert_nil config.host
assert_nil config.port
assert_equal 1, config.db
config = Config.new(url: "unix://run/redis/test.sock?db=1")
assert_equal "run/redis/test.sock", config.path
assert_nil config.host
assert_nil config.port
assert_equal 1, config.db
end
def test_uri_instance
config = Config.new(url: URI.parse("redis://example.com"))
assert_equal "example.com", config.host
end
def test_invalid_url
error = assert_raises ArgumentError do
Config.new(url: "http://example.com")
end
assert_includes error.message, "Unknown URL scheme"
assert_includes error.message, "example.com"
end
def test_defaults_to_localhost
config = Config.new(url: "redis://")
assert_equal "localhost", config.host
end
def test_ipv6_uri
config = Config.new(url: "redis://[::1]")
assert_equal "::1", config.host
end
def test_resp2_user_password_uri
config = Config.new(protocol: 2, url: "redis://username:password@example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "username", config.username
assert_equal "password", config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
assert_equal [%w[AUTH username password]], config.connection_prelude
end
def test_resp3_user_password_uri
config = Config.new(url: "redis://username:password@example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "username", config.username
assert_equal "password", config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
assert_equal [%w[HELLO 3 AUTH username password]], config.connection_prelude
end
def test_hide_password
config = Config.new(password: "PASSWORD")
refute_match "PASSWORD", config.inspect
refute_match "PASSWORD", config.to_s
end
def test_hide_password_in_uri
config = Config.new(url: "redis://username:PASSWORD@example.com")
refute_match "PASSWORD", config.inspect
refute_match "PASSWORD", config.to_s
end
def test_resp2_frozen_prelude
config = Config.new(protocol: 2, url: "redis://username:password@example.com")
prelude = config.connection_prelude
assert_equal [%w[AUTH username password]], prelude
assert_equal true, prelude.frozen?
assert_equal true, (prelude.all? { |commands| commands.frozen? })
prelude.each do |commands|
assert_equal true, (commands.all? { |arg| arg.frozen? })
end
end
def test_resp3_frozen_prelude
config = Config.new(url: "redis://username:password@example.com")
prelude = config.connection_prelude
assert_equal [%w[HELLO 3 AUTH username password]], prelude
assert_equal true, prelude.frozen?
assert_equal true, (prelude.all? { |commands| commands.frozen? })
prelude.each do |commands|
assert_equal true, (commands.all? { |arg| arg.frozen? })
end
end
def test_resp2_simple_password_uri
config = Config.new(protocol: 2, url: "redis://password@example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "default", config.username
assert_equal "password", config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
assert_equal [%w[AUTH password]], config.connection_prelude
end
def test_resp3_simple_password_uri
config = Config.new(url: "redis://password@example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "default", config.username
assert_equal "password", config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
assert_equal [%w[HELLO 3 AUTH default password]], config.connection_prelude
end
def test_simple_password_uri_empty_user
config = Config.new(url: "redis://:password@example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "default", config.username
assert_equal "password", config.password
assert_equal 0, config.db
refute_predicate config, :ssl?
assert_equal [%w[HELLO 3 AUTH default password]], config.connection_prelude
end
def test_percent_encoded_password_uri
# from https://redis.io/topics/rediscli#host-port-password-and-database
config = Config.new(url: "redis://p%40ssw0rd@redis-16379.hosted.com:16379/12")
assert_equal "redis-16379.hosted.com", config.host
assert_equal 16379, config.port
assert_equal "default", config.username
assert_equal "p@ssw0rd", config.password
assert_equal 12, config.db
refute_predicate config, :ssl?
assert_equal [%w[HELLO 3 AUTH default p@ssw0rd], %w[SELECT 12]], config.connection_prelude
end
def test_rediss_url
config = Config.new(url: "rediss://example.com")
assert_equal "example.com", config.host
assert_equal 6379, config.port
assert_equal "default", config.username
assert_nil config.password
assert_equal 0, config.db
assert_predicate config, :ssl?
assert_equal [%w[HELLO 3]], config.connection_prelude
end
def test_trailing_slash_url
config = Config.new(url: "redis://example.com/")
assert_equal 0, config.db
assert_equal [%w[HELLO 3]], config.connection_prelude
config = Config.new(url: "redis://[::1]/")
assert_equal 0, config.db
assert_equal [%w[HELLO 3]], config.connection_prelude
end
def test_overriding
config = Config.new(
url: "redis://p%40ssw0rd@redis-16379.hosted.com:16379/12",
ssl: true,
username: "george",
password: "hunter2",
host: "example.com",
port: 12,
db: 5,
)
assert_equal "example.com", config.host
assert_equal 12, config.port
assert_equal "george", config.username
assert_equal "hunter2", config.password
assert_equal 5, config.db
assert_predicate config, :ssl?
assert_equal [%w[HELLO 3 AUTH george hunter2], %w[SELECT 5]], config.connection_prelude
end
def test_overriding_nil
config = Config.new(
url: "redis://p%40ssw0rd@redis-16379.hosted.com:16379/12",
username: nil,
password: nil,
host: nil,
port: nil,
db: nil,
)
assert_equal "redis-16379.hosted.com", config.host
assert_equal 16379, config.port
assert_equal "default", config.username
assert_equal "p@ssw0rd", config.password
assert_equal 12, config.db
end
def test_server_url
assert_equal "redis://localhost:6379", Config.new.server_url
assert_equal "redis://localhost:6379", Config.new(username: "george", password: "hunter2").server_url
assert_equal "redis://localhost:6379/5", Config.new(db: 5).server_url
assert_equal "redis://192.168.0.1:6379", Config.new(host: "192.168.0.1", port: 6379).server_url
assert_equal "redis://192.168.0.1:6379/5", Config.new(host: "192.168.0.1", port: 6379, db: 5).server_url
assert_equal "redis://example.com:8080", Config.new(host: "example.com", port: 8080).server_url
assert_equal "rediss://localhost:6379", Config.new(ssl: true).server_url
assert_equal "redis://[::1]:6379", Config.new(host: "::1", port: 6379).server_url
assert_equal "redis://[::1]:6379/2", Config.new(host: "::1", port: 6379, db: 2).server_url
assert_equal "redis://[::1]:6379/2", Config.new(url: "redis://[::1]:6379/2").server_url
assert_equal "redis://[ffff:aaaa:1111::fcf]:6379", Config.new(host: "ffff:aaaa:1111::fcf", port: 6379).server_url
assert_equal "redis://[ffff:aaaa:1111::fcf]:6379/2", Config.new(host: "ffff:aaaa:1111::fcf", port: 6379, db: 2).server_url
assert_equal "unix:///var/redis/redis.sock?db=5", Config.new(path: "/var/redis/redis.sock", db: 5).server_url
end
def test_custom_field
config = Config.new(custom: { foo: "bar" })
assert_equal({ foo: "bar" }, config.custom)
end
def test_callable_password
called = 0
argument = nil
password_callable = lambda do |username|
called += 1
argument = username
username.upcase.reverse
end
config = Config.new(
username: "george",
password: password_callable,
)
assert_equal [%w(HELLO 3 AUTH george EGROEG)], config.connection_prelude
assert_equal 1, called
assert_equal "george", argument
end
def test_connection_prelude_with_driver_info
config = Config.new(driver_info: "rails_v7.0.0")
prelude = config.connection_prelude
assert_equal [
%w[HELLO 3],
%w[CLIENT SETINFO LIB-NAME redis-client(rails_v7.0.0)],
["CLIENT", "SETINFO", "LIB-VER", RedisClient::VERSION],
], prelude
end
def test_connection_prelude_with_multiple_upstream_drivers_string
config = Config.new(driver_info: "rails_v7.0.0;sidekiq_v7.1.0")
prelude = config.connection_prelude
assert_equal [
%w[HELLO 3],
["CLIENT", "SETINFO", "LIB-NAME", "redis-client(rails_v7.0.0;sidekiq_v7.1.0)"],
["CLIENT", "SETINFO", "LIB-VER", RedisClient::VERSION],
], prelude
end
def test_connection_prelude_with_driver_info_array
config = Config.new(driver_info: ["rails_v7.0.0", "sidekiq_v7.1.0"])
prelude = config.connection_prelude
assert_equal [
%w[HELLO 3],
["CLIENT", "SETINFO", "LIB-NAME", "redis-client(rails_v7.0.0;sidekiq_v7.1.0)"],
["CLIENT", "SETINFO", "LIB-VER", RedisClient::VERSION],
], prelude
end
def test_driver_info_attribute
config = Config.new(driver_info: "sidekiq_v7.1.0")
assert_equal "sidekiq_v7.1.0", config.driver_info
assert_equal "redis-client(sidekiq_v7.1.0)", config.build_lib_name
end
def test_build_lib_name_with_empty_string
config = Config.new(driver_info: "")
assert_equal "redis-client", config.build_lib_name
end
def test_build_lib_name_with_invalid_type
config = Config.new(driver_info: 123)
assert_raises ArgumentError do
config.build_lib_name
end
end
end
end
|
