-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathConfigTests.cs
More file actions
786 lines (683 loc) · 29.1 KB
/
ConfigTests.cs
File metadata and controls
786 lines (683 loc) · 29.1 KB
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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
using System;
using System.Globalization;
using System.IO;
using System.IO.Pipelines;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Reflection;
using System.Security.Authentication;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging.Abstractions;
using StackExchange.Redis.Configuration;
using Xunit;
namespace StackExchange.Redis.Tests;
[RunPerProtocol]
public class ConfigTests(ITestOutputHelper output, SharedConnectionFixture fixture) : TestBase(output, fixture)
{
public Version DefaultVersion = new(3, 0, 0);
[Fact]
public void ExpectedFields()
{
// if this test fails, check that you've updated ConfigurationOptions.Clone(), then: fix the test!
// this is a simple but pragmatic "have you considered?" check
var fields = Array.ConvertAll(
typeof(ConfigurationOptions).GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance),
x => Regex.Replace(x.Name, """^<(\w+)>k__BackingField$""", "$1"));
Array.Sort(fields);
Assert.Equal(
new[]
{
"abortOnConnectFail",
"allowAdmin",
"asyncTimeout",
"backlogPolicy",
"BeforeSocketConnect",
"CertificateSelection",
"CertificateValidation",
"ChannelPrefix",
"checkCertificateRevocation",
"ClientName",
"commandMap",
"configChannel",
"configCheckSeconds",
"connectRetry",
"connectTimeout",
"DefaultDatabase",
"defaultOptions",
"defaultVersion",
"EndPoints",
"heartbeatConsistencyChecks",
"heartbeatInterval",
"highIntegrity",
"includeDetailInExceptions",
"includePerformanceCountersInExceptions",
"keepAlive",
"LibraryName",
"loggerFactory",
"password",
"Protocol",
"proxy",
"reconnectRetryPolicy",
"resolveDns",
"responseTimeout",
"ServiceName",
"setClientLibrary",
"SocketManager",
"ssl",
#if !NETFRAMEWORK
"SslClientAuthenticationOptions",
#endif
"sslHost",
"SslProtocols",
"syncTimeout",
"tieBreaker",
"Tunnel",
"user",
},
fields);
}
[Fact]
public void SslProtocols_SingleValue()
{
var options = ConfigurationOptions.Parse("myhost,sslProtocols=Tls12");
Assert.Equal(SslProtocols.Tls12, options.SslProtocols.GetValueOrDefault());
}
[Fact]
public void SslProtocols_MultipleValues()
{
var options = ConfigurationOptions.Parse("myhost,sslProtocols=Tls12|Tls13");
Assert.Equal(SslProtocols.Tls12 | SslProtocols.Tls13, options.SslProtocols.GetValueOrDefault());
}
[Theory]
[InlineData("checkCertificateRevocation=false", false)]
[InlineData("checkCertificateRevocation=true", true)]
[InlineData("", true)]
public void ConfigurationOption_CheckCertificateRevocation(string conString, bool expectedValue)
{
var options = ConfigurationOptions.Parse($"host,{conString}");
Assert.Equal(expectedValue, options.CheckCertificateRevocation);
var toString = options.ToString();
Assert.Contains(conString, toString, StringComparison.CurrentCultureIgnoreCase);
}
[Fact]
public void SslProtocols_UsingIntegerValue()
{
// The below scenario is for cases where the *targeted*
// .NET framework version (e.g. .NET 4.0) doesn't define an enum value (e.g. Tls11)
// but the OS has been patched with support
const int integerValue = (int)(SslProtocols.Tls12 | SslProtocols.Tls13);
var options = ConfigurationOptions.Parse("myhost,sslProtocols=" + integerValue);
Assert.Equal(SslProtocols.Tls12 | SslProtocols.Tls13, options.SslProtocols.GetValueOrDefault());
}
[Fact]
public void SslProtocols_InvalidValue()
{
Assert.Throws<ArgumentOutOfRangeException>(() => ConfigurationOptions.Parse("myhost,sslProtocols=InvalidSslProtocol"));
}
[Theory]
[InlineData("contoso.redis.cache.windows.net:6380", true)]
[InlineData("contoso.REDIS.CACHE.chinacloudapi.cn:6380", true)] // added a few upper case chars to validate comparison
[InlineData("contoso.redis.cache.usgovcloudapi.net:6380", true)]
[InlineData("contoso.redis.cache.sovcloud-api.de:6380", true)]
[InlineData("contoso.redis.cache.sovcloud-api.fr:6380", true)]
public void ConfigurationOptionsDefaultForAzure(string hostAndPort, bool sslShouldBeEnabled)
{
Version defaultAzureVersion = new(6, 0, 0);
var options = ConfigurationOptions.Parse(hostAndPort);
Assert.True(options.DefaultVersion.Equals(defaultAzureVersion));
Assert.False(options.AbortOnConnectFail);
Assert.Equal(sslShouldBeEnabled, options.Ssl);
}
[Theory]
[InlineData("contoso.redis.azure.net:10000", true)]
[InlineData("contoso.redis.chinacloudapi.cn:10000", true)]
[InlineData("contoso.redis.usgovcloudapi.net:10000", true)]
[InlineData("contoso.redisenterprise.cache.azure.net:10000", true)]
public void ConfigurationOptionsDefaultForAzureManagedRedis(string hostAndPort, bool sslShouldBeEnabled)
{
Version defaultAzureVersion = new(7, 4, 0);
var options = ConfigurationOptions.Parse(hostAndPort);
Assert.True(options.DefaultVersion.Equals(defaultAzureVersion));
Assert.False(options.AbortOnConnectFail);
Assert.Equal(sslShouldBeEnabled, options.Ssl);
}
[Fact]
public void ConfigurationOptionsForAzureWhenSpecified()
{
var options = ConfigurationOptions.Parse("contoso.redis.cache.windows.net,abortConnect=true, version=2.1.1");
Assert.True(options.DefaultVersion.Equals(new Version(2, 1, 1)));
Assert.True(options.AbortOnConnectFail);
}
[Fact]
public void ConfigurationOptionsDefaultForNonAzure()
{
var options = ConfigurationOptions.Parse("redis.contoso.com");
Assert.True(options.DefaultVersion.Equals(DefaultVersion));
Assert.True(options.AbortOnConnectFail);
}
[Fact]
public void ConfigurationOptionsDefaultWhenNoEndpointsSpecifiedYet()
{
var options = new ConfigurationOptions();
Assert.True(options.DefaultVersion.Equals(DefaultVersion));
Assert.True(options.AbortOnConnectFail);
}
[Fact]
public void ConfigurationOptionsSyncTimeout()
{
// Default check
var options = new ConfigurationOptions();
Assert.Equal(5000, options.SyncTimeout);
options = ConfigurationOptions.Parse("syncTimeout=20");
Assert.Equal(20, options.SyncTimeout);
}
[Theory]
[InlineData("127.1:6379", AddressFamily.InterNetwork, "127.0.0.1", 6379)]
[InlineData("127.0.0.1:6379", AddressFamily.InterNetwork, "127.0.0.1", 6379)]
[InlineData("2a01:9820:1:24::1:1:6379", AddressFamily.InterNetworkV6, "2a01:9820:1:24:0:1:1:6379", 0)]
[InlineData("[2a01:9820:1:24::1:1]:6379", AddressFamily.InterNetworkV6, "2a01:9820:1:24::1:1", 6379)]
public void ConfigurationOptionsIPv6Parsing(string configString, AddressFamily family, string address, int port)
{
var options = ConfigurationOptions.Parse(configString);
Assert.Single(options.EndPoints);
var ep = Assert.IsType<IPEndPoint>(options.EndPoints[0]);
Assert.Equal(family, ep.AddressFamily);
Assert.Equal(address, ep.Address.ToString());
Assert.Equal(port, ep.Port);
}
[Fact]
public void CanParseAndFormatUnixDomainSocket()
{
const string ConfigString = "!/some/path,allowAdmin=True";
#if NETFRAMEWORK
var ex = Assert.Throws<PlatformNotSupportedException>(() => ConfigurationOptions.Parse(ConfigString));
Assert.Equal("Unix domain sockets require .NET Core 3 or above", ex.Message);
#else
var config = ConfigurationOptions.Parse(ConfigString);
Assert.True(config.AllowAdmin);
var ep = Assert.IsType<UnixDomainSocketEndPoint>(Assert.Single(config.EndPoints));
Assert.Equal("/some/path", ep.ToString());
Assert.Equal(ConfigString, config.ToString());
#endif
}
[Fact]
public async Task TalkToNonsenseServer()
{
var config = new ConfigurationOptions
{
AbortOnConnectFail = false,
EndPoints =
{
{ "127.0.0.1:1234" },
},
ConnectTimeout = 200,
};
var log = new StringWriter();
await using (var conn = ConnectionMultiplexer.Connect(config, log))
{
Log(log.ToString());
Assert.False(conn.IsConnected);
}
}
[Fact]
public async Task TestManualHeartbeat()
{
var options = ConfigurationOptions.Parse(GetConfiguration());
options.HeartbeatInterval = TimeSpan.FromMilliseconds(100);
await using var conn = await ConnectionMultiplexer.ConnectAsync(options);
foreach (var ep in conn.GetServerSnapshot().ToArray())
{
ep.WriteEverySeconds = 1;
}
var db = conn.GetDatabase();
await db.PingAsync();
var before = conn.OperationCount;
Log("Sleeping to test heartbeat...");
await UntilConditionAsync(TimeSpan.FromSeconds(5), () => conn.OperationCount > before + 1).ForAwait();
var after = conn.OperationCount;
Assert.True(after >= before + 1, $"after: {after}, before: {before}");
}
[Theory]
[InlineData(0)]
[InlineData(10)]
[InlineData(100)]
[InlineData(200)]
public async Task GetSlowlog(int count)
{
await using var conn = Create(allowAdmin: true);
var rows = GetAnyPrimary(conn).SlowlogGet(count);
Assert.NotNull(rows);
}
[Fact]
public async Task ClearSlowlog()
{
await using var conn = Create(allowAdmin: true);
GetAnyPrimary(conn).SlowlogReset();
}
[Fact]
public async Task ClientName()
{
await using var conn = Create(clientName: "Test Rig", allowAdmin: true, shared: false);
Assert.Equal("Test Rig", conn.ClientName);
var db = conn.GetDatabase();
await db.PingAsync();
var name = (string?)(await GetAnyPrimary(conn).ExecuteAsync("CLIENT", "GETNAME"));
Assert.Equal("TestRig", name);
}
[Fact]
public async Task ClientLibraryName()
{
await using var conn = Create(allowAdmin: true, shared: false);
var server = GetAnyPrimary(conn);
await server.PingAsync();
var possibleId = conn.GetConnectionId(server.EndPoint, ConnectionType.Interactive);
if (possibleId is null)
{
Log("(client id not available)");
return;
}
var id = possibleId.Value;
var libName = server.ClientList().Single(x => x.Id == id).LibraryName;
if (libName is not null) // server-version dependent
{
Log("library name: {0}", libName);
Assert.Equal("SE.Redis", libName);
conn.AddLibraryNameSuffix("foo");
conn.AddLibraryNameSuffix("bar");
conn.AddLibraryNameSuffix("foo");
libName = (await server.ClientListAsync()).Single(x => x.Id == id).LibraryName;
Log($"library name: {libName}");
Assert.Equal("SE.Redis-bar-foo", libName);
}
else
{
Log("(library name not available)");
}
}
[Fact]
public async Task DefaultClientName()
{
await using var conn = Create(allowAdmin: true, caller: "", shared: false); // force default naming to kick in
Assert.Equal($"{Environment.MachineName}(SE.Redis-v{Utils.GetLibVersion()})", conn.ClientName);
var db = conn.GetDatabase();
await db.PingAsync();
var name = (string?)GetAnyPrimary(conn).Execute("CLIENT", "GETNAME");
Assert.Equal($"{Environment.MachineName}(SE.Redis-v{Utils.GetLibVersion()})", name);
}
[Fact]
public async Task ReadConfigWithConfigDisabled()
{
await using var conn = Create(allowAdmin: true, disabledCommands: ["config", "info"]);
var server = GetAnyPrimary(conn);
var ex = Assert.Throws<RedisCommandException>(() => server.ConfigGet());
Assert.Equal("This operation has been disabled in the command-map and cannot be used: CONFIG", ex.Message);
}
[Fact]
public async Task ConnectWithSubscribeDisabled()
{
await using var conn = Create(allowAdmin: true, disabledCommands: ["subscribe"]);
Assert.True(conn.IsConnected);
var servers = conn.GetServerSnapshot();
Assert.True(servers[0].IsConnected);
if (!TestContext.Current.IsResp3())
{
Assert.False(servers[0].IsSubscriberConnected);
}
var ex = Assert.Throws<RedisCommandException>(() => conn.GetSubscriber().Subscribe(RedisChannel.Literal(Me()), (_, _) => GC.KeepAlive(this)));
Assert.Equal("This operation has been disabled in the command-map and cannot be used: SUBSCRIBE", ex.Message);
}
[Fact]
public async Task ReadConfig()
{
await using var conn = Create(allowAdmin: true);
Log("about to get config");
var server = GetAnyPrimary(conn);
var all = server.ConfigGet();
Assert.True(all.Length > 0, "any");
var pairs = all.ToDictionary(x => (string)x.Key, x => (string)x.Value, StringComparer.InvariantCultureIgnoreCase);
Assert.Equal(all.Length, pairs.Count);
Assert.True(pairs.ContainsKey("timeout"), "timeout");
var val = int.Parse(pairs["timeout"]);
Assert.True(pairs.ContainsKey("port"), "port");
val = int.Parse(pairs["port"]);
Assert.Equal(TestConfig.Current.PrimaryPort, val);
}
[Fact]
public async Task GetTime()
{
await using var conn = Create();
var server = GetAnyPrimary(conn);
var serverTime = server.Time();
var localTime = DateTime.UtcNow;
Log("Server: " + serverTime.ToString(CultureInfo.InvariantCulture));
Log("Local: " + localTime.ToString(CultureInfo.InvariantCulture));
Assert.Equal(localTime, serverTime, TimeSpan.FromSeconds(10));
}
[Fact]
public async Task DebugObject()
{
await using var conn = Create(allowAdmin: true);
var db = conn.GetDatabase();
RedisKey key = Me();
db.KeyDelete(key, CommandFlags.FireAndForget);
db.StringIncrement(key, flags: CommandFlags.FireAndForget);
var debug = (string?)db.DebugObject(key);
Assert.NotNull(debug);
Assert.Contains("encoding:int serializedlength:2", debug);
}
[Fact]
public async Task GetInfo()
{
await using var conn = Create(allowAdmin: true);
var server = GetAnyPrimary(conn);
var info1 = server.Info();
Assert.True(info1.Length > 5);
Log("All sections");
foreach (var group in info1)
{
Log(group.Key);
}
var first = info1[0];
Log("Full info for: " + first.Key);
foreach (var setting in first)
{
Log(" {0} ==> {1}", setting.Key, setting.Value);
}
var info2 = server.Info("cpu");
Assert.Single(info2);
var cpu = info2.Single();
Log("Full info for: " + cpu.Key);
foreach (var setting in cpu)
{
Log(" {0} ==> {1}", setting.Key, setting.Value);
}
var cpuCount = cpu.Count();
Assert.True(cpuCount > 2);
if (cpu.Key != "CPU")
{
// seem to be seeing this in logs; add lots of detail
var sb = new StringBuilder("Expected CPU, got ").AppendLine(cpu.Key);
foreach (var setting in cpu)
{
sb.Append(setting.Key).Append('=').AppendLine(setting.Value);
}
Assert.Fail(sb.ToString());
}
Assert.Equal("CPU", cpu.Key);
Assert.Contains(cpu, x => x.Key == "used_cpu_sys");
Assert.Contains(cpu, x => x.Key == "used_cpu_user");
}
[Fact]
public async Task GetInfoRaw()
{
await using var conn = Create(allowAdmin: true);
var server = GetAnyPrimary(conn);
var info = server.InfoRaw();
Assert.Contains("used_cpu_sys", info);
Assert.Contains("used_cpu_user", info);
}
[Fact]
public async Task GetClients()
{
var name = Guid.NewGuid().ToString();
await using var conn = Create(clientName: name, allowAdmin: true, shared: false);
var server = GetAnyPrimary(conn);
var clients = server.ClientList();
Assert.True(clients.Length > 0, "no clients"); // ourselves!
Assert.True(clients.Any(x => x.Name == name), "expected: " + name);
if (server.Features.ClientId)
{
var id = conn.GetConnectionId(server.EndPoint, ConnectionType.Interactive);
Log("client id: " + id);
Assert.NotNull(id);
Assert.True(clients.Any(x => x.Id == id), "expected: " + id);
id = conn.GetConnectionId(server.EndPoint, ConnectionType.Subscription);
Assert.NotNull(id);
Assert.True(clients.Any(x => x.Id == id), "expected: " + id);
var self = clients.First(x => x.Id == id);
if (server.Version.Major >= 7)
{
Assert.Equal(TestContext.Current.GetProtocol(), self.Protocol);
}
else
{
Assert.Null(self.Protocol);
}
}
}
[Fact]
public async Task SlowLog()
{
await using var conn = Create(allowAdmin: true);
var server = GetAnyPrimary(conn);
server.SlowlogGet();
server.SlowlogReset();
}
[Fact]
public void EndpointIteratorIsReliableOverChanges()
{
var eps = new EndPointCollection
{
{ IPAddress.Loopback, 7999 },
{ IPAddress.Loopback, 8000 },
};
using var iter = eps.GetEnumerator();
Assert.True(iter.MoveNext());
Assert.Equal(7999, ((IPEndPoint)iter.Current).Port);
eps[1] = new IPEndPoint(IPAddress.Loopback, 8001); // boom
Assert.True(iter.MoveNext());
Assert.Equal(8001, ((IPEndPoint)iter.Current).Port);
Assert.False(iter.MoveNext());
}
[Fact]
public async Task ThreadPoolManagerIsDetected()
{
var config = new ConfigurationOptions
{
EndPoints = { { IPAddress.Loopback, 6379 } },
SocketManager = SocketManager.ThreadPool,
};
await using var conn = ConnectionMultiplexer.Connect(config);
Assert.Same(PipeScheduler.ThreadPool, conn.SocketManager?.Scheduler);
}
[Fact]
public async Task DefaultThreadPoolManagerIsDetected()
{
var config = new ConfigurationOptions
{
EndPoints = { { IPAddress.Loopback, 6379 } },
};
await using var conn = ConnectionMultiplexer.Connect(config);
Assert.Same(SocketManager.Shared.Scheduler, conn.SocketManager?.Scheduler);
}
[Theory]
[InlineData("myDNS:myPort,password=myPassword,connectRetry=3,connectTimeout=15000,syncTimeout=15000,defaultDatabase=0,abortConnect=false,ssl=true,sslProtocols=Tls12", SslProtocols.Tls12)]
[InlineData("myDNS:myPort,password=myPassword,abortConnect=false,ssl=true,sslProtocols=Tls12", SslProtocols.Tls12)]
#pragma warning disable CS0618 // Type or member is obsolete
[InlineData("myDNS:myPort,password=myPassword,abortConnect=false,ssl=true,sslProtocols=Ssl3", SslProtocols.Ssl3)]
#pragma warning restore CS0618
[InlineData("myDNS:myPort,password=myPassword,abortConnect=false,ssl=true,sslProtocols=Tls12 ", SslProtocols.Tls12)]
public void ParseTlsWithoutTrailingComma(string configString, SslProtocols expected)
{
var config = ConfigurationOptions.Parse(configString);
Assert.Equal(expected, config.SslProtocols);
}
[Theory]
[InlineData("foo,sslProtocols=NotAThing", "Keyword 'sslProtocols' requires an SslProtocol value (multiple values separated by '|'); the value 'NotAThing' is not recognised.", "sslProtocols")]
[InlineData("foo,SyncTimeout=ten", "Keyword 'SyncTimeout' requires an integer value; the value 'ten' is not recognised.", "SyncTimeout")]
[InlineData("foo,syncTimeout=-42", "Keyword 'syncTimeout' has a minimum value of '1'; the value '-42' is not permitted.", "syncTimeout")]
[InlineData("foo,AllowAdmin=maybe", "Keyword 'AllowAdmin' requires a boolean value; the value 'maybe' is not recognised.", "AllowAdmin")]
[InlineData("foo,Version=current", "Keyword 'Version' requires a version value; the value 'current' is not recognised.", "Version")]
[InlineData("foo,proxy=epoxy", "Keyword 'proxy' requires a proxy value; the value 'epoxy' is not recognised.", "proxy")]
public void ConfigStringErrorsGiveMeaningfulMessages(string configString, string expected, string paramName)
{
var ex = Assert.Throws<ArgumentOutOfRangeException>(() => ConfigurationOptions.Parse(configString));
Assert.StartsWith(expected, ex.Message); // param name gets concatenated sometimes
Assert.Equal(paramName, ex.ParamName); // param name gets concatenated sometimes
}
[Fact]
public void ConfigStringInvalidOptionErrorGiveMeaningfulMessages()
{
var ex = Assert.Throws<ArgumentException>(() => ConfigurationOptions.Parse("foo,flibble=value"));
Assert.StartsWith("Keyword 'flibble' is not supported.", ex.Message); // param name gets concatenated sometimes
Assert.Equal("flibble", ex.ParamName);
}
[Fact]
public void NullApply()
{
var options = ConfigurationOptions.Parse("127.0.0.1,name=FooApply");
Assert.Equal("FooApply", options.ClientName);
// Doesn't go boom
var result = options.Apply(null!);
Assert.Equal("FooApply", options.ClientName);
Assert.Equal(result, options);
}
[Fact]
public void Apply()
{
var options = ConfigurationOptions.Parse("127.0.0.1,name=FooApply");
Assert.Equal("FooApply", options.ClientName);
var randomName = Guid.NewGuid().ToString();
var result = options.Apply(options => options.ClientName = randomName);
Assert.Equal(randomName, options.ClientName);
Assert.Equal(randomName, result.ClientName);
Assert.Equal(result, options);
}
[Fact]
public async Task BeforeSocketConnect()
{
var options = ConfigurationOptions.Parse(TestConfig.Current.PrimaryServerAndPort);
int count = 0;
options.BeforeSocketConnect = (endpoint, connType, socket) =>
{
Interlocked.Increment(ref count);
Log($"Endpoint: {endpoint}, ConnType: {connType}, Socket: {socket}");
socket.DontFragment = true;
socket.Ttl = (short)(connType == ConnectionType.Interactive ? 12 : 123);
};
await using var conn = ConnectionMultiplexer.Connect(options);
Assert.True(conn.IsConnected);
Assert.Equal(2, count);
var endpoint = conn.GetServerSnapshot()[0];
var interactivePhysical = endpoint.GetBridge(ConnectionType.Interactive)?.TryConnect(null);
var subscriptionPhysical = endpoint.GetBridge(ConnectionType.Subscription)?.TryConnect(null);
Assert.NotNull(interactivePhysical);
Assert.NotNull(subscriptionPhysical);
var interactiveSocket = interactivePhysical.VolatileSocket;
var subscriptionSocket = subscriptionPhysical.VolatileSocket;
Assert.NotNull(interactiveSocket);
Assert.NotNull(subscriptionSocket);
Assert.Equal(12, interactiveSocket.Ttl);
Assert.Equal(123, subscriptionSocket.Ttl);
Assert.True(interactiveSocket.DontFragment);
Assert.True(subscriptionSocket.DontFragment);
}
[Fact]
public async Task MutableOptions()
{
var options = ConfigurationOptions.Parse(TestConfig.Current.PrimaryServerAndPort + ",name=Details");
options.LoggerFactory = NullLoggerFactory.Instance;
var originalConfigChannel = options.ConfigurationChannel = "originalConfig";
var originalUser = options.User = "originalUser";
var originalPassword = options.Password = "originalPassword";
Assert.Equal("Details", options.ClientName);
await using var conn = await ConnectionMultiplexer.ConnectAsync(options);
// Same instance
Assert.Same(options, conn.RawConfig);
// Copies
Assert.NotSame(options.EndPoints, conn.EndPoints);
// Same until forked - it's not cloned
Assert.Same(options.CommandMap, conn.CommandMap);
options.CommandMap = CommandMap.Envoyproxy;
Assert.NotSame(options.CommandMap, conn.CommandMap);
#pragma warning disable CS0618 // Type or member is obsolete
// Defaults true
Assert.True(options.IncludeDetailInExceptions);
Assert.True(conn.IncludeDetailInExceptions);
options.IncludeDetailInExceptions = false;
Assert.False(options.IncludeDetailInExceptions);
Assert.False(conn.IncludeDetailInExceptions);
// Defaults false
Assert.False(options.IncludePerformanceCountersInExceptions);
Assert.False(conn.IncludePerformanceCountersInExceptions);
options.IncludePerformanceCountersInExceptions = true;
Assert.True(options.IncludePerformanceCountersInExceptions);
Assert.True(conn.IncludePerformanceCountersInExceptions);
#pragma warning restore CS0618
var newName = Guid.NewGuid().ToString();
options.ClientName = newName;
Assert.Equal(newName, conn.ClientName);
// TODO: This forks due to memoization of the byte[] for efficiency
// If we could cheaply detect change it'd be good to let this change
const string newConfigChannel = "newConfig";
options.ConfigurationChannel = newConfigChannel;
Assert.Equal(newConfigChannel, options.ConfigurationChannel);
Assert.NotNull(conn.ConfigurationChangedChannel);
Assert.Equal(Encoding.UTF8.GetString(conn.ConfigurationChangedChannel), originalConfigChannel);
Assert.Equal(originalUser, conn.RawConfig.User);
Assert.Equal(originalPassword, conn.RawConfig.Password);
var newPass = options.Password = "newPassword";
Assert.Equal(newPass, conn.RawConfig.Password);
Assert.Equal(options.LoggerFactory, conn.RawConfig.LoggerFactory);
}
[Theory]
[InlineData("http://somewhere:22", "http:somewhere:22")]
[InlineData("http:somewhere:22", "http:somewhere:22")]
public void HttpTunnelCanRoundtrip(string input, string expected)
{
var config = ConfigurationOptions.Parse($"127.0.0.1:6380,tunnel={input}");
var ip = Assert.IsType<IPEndPoint>(Assert.Single(config.EndPoints));
Assert.Equal(6380, ip.Port);
Assert.Equal("127.0.0.1", ip.Address.ToString());
Assert.NotNull(config.Tunnel);
Assert.Equal(expected, config.Tunnel.ToString());
var cs = config.ToString();
Assert.Equal($"127.0.0.1:6380,tunnel={expected}", cs);
}
private sealed class CustomTunnel : Tunnel { }
[Fact]
public void CustomTunnelCanRoundtripMinusTunnel()
{
// we don't expect to be able to parse custom tunnels, but we should still be able to round-trip
// the rest of the config, which means ignoring them *in both directions* (unless first party)
var options = ConfigurationOptions.Parse("127.0.0.1,Ssl=true");
options.Tunnel = new CustomTunnel();
var cs = options.ToString();
Assert.Equal("127.0.0.1,ssl=True", cs);
options = ConfigurationOptions.Parse(cs);
Assert.Null(options.Tunnel);
}
[Theory]
[InlineData("server:6379", true)]
[InlineData("server:6379,setlib=True", true)]
[InlineData("server:6379,setlib=False", false)]
public void DefaultConfigOptionsForSetLib(string configurationString, bool setlib)
{
var options = ConfigurationOptions.Parse(configurationString);
Assert.Equal(setlib, options.SetClientLibrary);
Assert.Equal(configurationString, options.ToString());
options = options.Clone();
Assert.Equal(setlib, options.SetClientLibrary);
Assert.Equal(configurationString, options.ToString());
}
[Theory]
[InlineData(null, false, "dummy")]
[InlineData(false, false, "dummy,highIntegrity=False")]
[InlineData(true, true, "dummy,highIntegrity=True")]
public void CheckHighIntegrity(bool? assigned, bool expected, string cs)
{
var options = ConfigurationOptions.Parse("dummy");
if (assigned.HasValue) options.HighIntegrity = assigned.Value;
Assert.Equal(expected, options.HighIntegrity);
Assert.Equal(cs, options.ToString());
var clone = options.Clone();
Assert.Equal(expected, clone.HighIntegrity);
Assert.Equal(cs, clone.ToString());
var parsed = ConfigurationOptions.Parse(cs);
Assert.Equal(expected, parsed.HighIntegrity);
}
}