forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathMultipleHostsTests.cs
More file actions
1283 lines (1074 loc) · 57.1 KB
/
MultipleHostsTests.cs
File metadata and controls
1283 lines (1074 loc) · 57.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
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using Npgsql.Internal;
using Npgsql.Tests.Support;
using NUnit.Framework;
using System;
using System.Collections.Generic;
using System.Data;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Threading;
using System.Threading.Tasks;
using System.Transactions;
using static Npgsql.Tests.Support.MockState;
using static Npgsql.Tests.TestUtil;
using IsolationLevel = System.Transactions.IsolationLevel;
using TransactionStatus = Npgsql.Internal.TransactionStatus;
namespace Npgsql.Tests;
#pragma warning disable CS0618
public class MultipleHostsTests : TestBase
{
static readonly object[] MyCases =
[
new object[] { TargetSessionAttributes.Standby, new[] { Primary, Standby }, 1 },
new object[] { TargetSessionAttributes.Standby, new[] { PrimaryReadOnly, Standby }, 1 },
new object[] { TargetSessionAttributes.PreferStandby, new[] { Primary, Standby }, 1 },
new object[] { TargetSessionAttributes.PreferStandby, new[] { PrimaryReadOnly, Standby }, 1 },
new object[] { TargetSessionAttributes.PreferStandby, new[] { Primary, Primary }, 0 },
new object[] { TargetSessionAttributes.Primary, new[] { Standby, Primary }, 1 },
new object[] { TargetSessionAttributes.Primary, new[] { Standby, PrimaryReadOnly }, 1 },
new object[] { TargetSessionAttributes.PreferPrimary, new[] { Standby, Primary }, 1 },
new object[] { TargetSessionAttributes.PreferPrimary, new[] { Standby, PrimaryReadOnly }, 1 },
new object[] { TargetSessionAttributes.PreferPrimary, new[] { Standby, Standby }, 0 },
new object[] { TargetSessionAttributes.Any, new[] { Standby, Primary }, 0 },
new object[] { TargetSessionAttributes.Any, new[] { Primary, Standby }, 0 },
new object[] { TargetSessionAttributes.Any, new[] { PrimaryReadOnly, Standby }, 0 },
new object[] { TargetSessionAttributes.ReadWrite, new[] { Standby, Primary }, 1 },
new object[] { TargetSessionAttributes.ReadWrite, new[] { PrimaryReadOnly, Primary }, 1 },
new object[] { TargetSessionAttributes.ReadOnly, new[] { Primary, Standby }, 1 },
new object[] { TargetSessionAttributes.ReadOnly, new[] { PrimaryReadOnly, Standby }, 0 }
];
[Test]
[TestCaseSource(nameof(MyCases))]
public async Task Connect_to_correct_host_pooled(TargetSessionAttributes targetSessionAttributes, MockState[] servers, int expectedServer)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
Pooling = true
};
await using var dataSource = new NpgsqlDataSourceBuilder(connectionStringBuilder.ConnectionString)
.BuildMultiHost();
await using var conn = await dataSource.OpenConnectionAsync(targetSessionAttributes);
Assert.That(conn.Port, Is.EqualTo(postmasters[expectedServer].Port));
for (var i = 0; i <= expectedServer; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test]
[TestCaseSource(nameof(MyCases))]
public async Task Connect_to_correct_host_unpooled(TargetSessionAttributes targetSessionAttributes, MockState[] servers, int expectedServer)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
Pooling = false
};
await using var dataSource = new NpgsqlDataSourceBuilder(connectionStringBuilder.ConnectionString)
.BuildMultiHost();
await using var conn = await dataSource.OpenConnectionAsync(targetSessionAttributes);
Assert.That(conn.Port, Is.EqualTo(postmasters[expectedServer].Port));
for (var i = 0; i <= expectedServer; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test]
[TestCaseSource(nameof(MyCases))]
public async Task Connect_to_correct_host_legacy(TargetSessionAttributes targetSessionAttributes, MockState[] servers, int expectedServer)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
TargetSessionAttributes = TargetSessionAttributesAsString(targetSessionAttributes)
};
using var pool = CreateTempPool(connectionStringBuilder, out var connectionString);
await using var conn = new NpgsqlConnection(connectionString);
await conn.OpenAsync();
Assert.That(conn.Port, Is.EqualTo(postmasters[expectedServer].Port));
for (var i = 0; i <= expectedServer; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test]
[TestCaseSource(nameof(MyCases))]
public async Task Connect_to_correct_host_connection_string(TargetSessionAttributes targetSessionAttributes, MockState[] servers, int expectedServer)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
TargetSessionAttributes = TargetSessionAttributesAsString(targetSessionAttributes)
};
await using var dataSource = new NpgsqlDataSourceBuilder(connectionStringBuilder.ConnectionString)
.Build();
Assert.That(dataSource, Is.TypeOf<NpgsqlMultiHostDataSource>());
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(conn.Port, Is.EqualTo(postmasters[expectedServer].Port));
for (var i = 0; i <= expectedServer; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test]
[TestCaseSource(nameof(MyCases))]
public async Task Connect_to_correct_host_with_available_idle(
TargetSessionAttributes targetSessionAttributes, MockState[] servers, int expectedServer)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
// First, open and close a connection with the TargetSessionAttributes matching the first server.
// This ensures wew have an idle connection in the pool.
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
};
await using var dataSource = new NpgsqlDataSourceBuilder(connectionStringBuilder.ConnectionString)
.BuildMultiHost();
var idleConnTargetSessionAttributes = servers[0] switch
{
Primary => TargetSessionAttributes.ReadWrite,
PrimaryReadOnly => TargetSessionAttributes.ReadOnly,
Standby => TargetSessionAttributes.Standby,
_ => throw new ArgumentOutOfRangeException()
};
await using (_ = await dataSource.OpenConnectionAsync(idleConnTargetSessionAttributes))
{
// Do nothing, close to have an idle connection in the pool.
}
// Now connect with the test TargetSessionAttributes
await using var conn = await dataSource.OpenConnectionAsync(targetSessionAttributes);
Assert.That(conn.Port, Is.EqualTo(postmasters[expectedServer].Port));
for (var i = 0; i <= expectedServer; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test]
public async Task Legacy_connection_shares_datasource()
{
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby);
var builder1 = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
TargetSessionAttributes = "Prefer-Primary"
};
// Use the exact same pool for both connections as CreateTempPool adds a unique `ApplicationName` to connection string
using var pool = CreateTempPool(builder1, out var connectionString1);
var connectionString2 = new NpgsqlConnectionStringBuilder(connectionString1)
{
TargetSessionAttributes = "Prefer-Standby"
}.ConnectionString;
await using var conn1 = new NpgsqlConnection(connectionString1);
await conn1.OpenAsync();
Assert.That(conn1.Port, Is.EqualTo(primaryPostmaster.Port));
await using var conn2 = new NpgsqlConnection(connectionString2);
await conn2.OpenAsync();
Assert.That(conn2.Port, Is.EqualTo(standbyPostmaster.Port));
Assert.That(conn1.NpgsqlDataSource, Is.Not.SameAs(conn2.NpgsqlDataSource));
Assert.That(conn1.NpgsqlDataSource, Is.TypeOf<MultiHostDataSourceWrapper>());
Assert.That(conn2.NpgsqlDataSource, Is.TypeOf<MultiHostDataSourceWrapper>());
Assert.That(((MultiHostDataSourceWrapper)conn1.NpgsqlDataSource).WrappedSource, Is.SameAs(((MultiHostDataSourceWrapper)conn2.NpgsqlDataSource).WrappedSource));
}
[Test]
[TestCase(TargetSessionAttributes.Standby, new[] { Primary, Primary })]
[TestCase(TargetSessionAttributes.Primary, new[] { Standby, Standby })]
[TestCase(TargetSessionAttributes.ReadWrite, new[] { PrimaryReadOnly, Standby })]
[TestCase(TargetSessionAttributes.ReadOnly, new[] { Primary, Primary })]
public async Task Valid_host_not_found(TargetSessionAttributes targetSessionAttributes, MockState[] servers)
{
var postmasters = servers.Select(s => PgPostmasterMock.Start(state: s)).ToArray();
await using var __ = new DisposableWrapper(postmasters);
var connectionStringBuilder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(postmasters),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
};
await using var dataSource = new NpgsqlDataSourceBuilder(connectionStringBuilder.ConnectionString)
.BuildMultiHost();
var exception = Assert.ThrowsAsync<NpgsqlException>(async () => await dataSource.OpenConnectionAsync(targetSessionAttributes))!;
Assert.That(exception.Message, Is.EqualTo("No suitable host was found."));
Assert.That(exception.InnerException, Is.Null);
for (var i = 0; i < servers.Length; i++)
_ = await postmasters[i].WaitForServerConnection();
}
[Test, Platform(Exclude = "MacOsX", Reason = "#3786")]
public void All_hosts_are_down()
{
var endpoint = new IPEndPoint(IPAddress.Loopback, 0);
using var socket1 = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
socket1.Bind(endpoint);
var localEndPoint1 = (IPEndPoint)socket1.LocalEndPoint!;
using var socket2 = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
socket2.Bind(endpoint);
var localEndPoint2 = (IPEndPoint)socket2.LocalEndPoint!;
// Note that we Bind (to reserve the port), but do not Listen - connection attempts will fail.
var connectionString = new NpgsqlConnectionStringBuilder
{
Host = $"{localEndPoint1.Address}:{localEndPoint1.Port},{localEndPoint2.Address}:{localEndPoint2.Port}"
}.ConnectionString;
using var dataSource = new NpgsqlDataSourceBuilder(connectionString).BuildMultiHost();
var exception = Assert.ThrowsAsync<NpgsqlException>(async () => await dataSource.OpenConnectionAsync(TargetSessionAttributes.Any))!;
var aggregateException = (AggregateException)exception.InnerException!;
Assert.That(aggregateException.InnerExceptions, Has.Count.EqualTo(2));
for (var i = 0; i < aggregateException.InnerExceptions.Count; i++)
{
Assert.That(aggregateException.InnerExceptions[i], Is.TypeOf<NpgsqlException>()
.With.InnerException.TypeOf<SocketException>()
.With.InnerException.Property(nameof(SocketException.SocketErrorCode)).EqualTo(SocketError.ConnectionRefused));
}
}
[Test]
public async Task All_hosts_are_unavailable(
[Values] bool pooling,
[Values(PostgresErrorCodes.InvalidCatalogName, PostgresErrorCodes.CannotConnectNow)] string errorCode)
{
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary, startupErrorCode: errorCode);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby, startupErrorCode: errorCode);
var builder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
Pooling = pooling,
};
await using var dataSource = new NpgsqlDataSourceBuilder(builder.ConnectionString).BuildMultiHost();
var ex = Assert.ThrowsAsync<PostgresException>(async () => await dataSource.OpenConnectionAsync(TargetSessionAttributes.Any))!;
Assert.That(ex.SqlState, Is.EqualTo(errorCode));
}
[Test]
public async Task First_host_is_down()
{
using var socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
var endpoint = new IPEndPoint(IPAddress.Loopback, 0);
socket.Bind(endpoint);
var localEndPoint = (IPEndPoint)socket.LocalEndPoint!;
// Note that we Bind (to reserve the port), but do not Listen - connection attempts will fail.
await using var postmaster = PgPostmasterMock.Start(state: Primary);
var connectionString = new NpgsqlConnectionStringBuilder
{
Host = $"{localEndPoint.Address}:{localEndPoint.Port},{postmaster.Host}:{postmaster.Port}",
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading
}.ConnectionString;
await using var dataSource = new NpgsqlDataSourceBuilder(connectionString).BuildMultiHost();
await using var conn = await dataSource.OpenConnectionAsync(TargetSessionAttributes.Any);
Assert.That(conn.Port, Is.EqualTo(postmaster.Port));
}
[Test]
[TestCase("any")]
[TestCase("primary")]
[TestCase("standby")]
[TestCase("prefer-primary")]
[TestCase("prefer-standby")]
[TestCase("read-write")]
[TestCase("read-only")]
public async Task TargetSessionAttributes_with_single_host(string targetSessionAttributes)
{
var connectionString = new NpgsqlConnectionStringBuilder(ConnectionString)
{
TargetSessionAttributes = targetSessionAttributes
}.ConnectionString;
if (targetSessionAttributes == "any")
{
await using var postmasterMock = PgPostmasterMock.Start(connectionString);
using var pool = CreateTempPool(postmasterMock.ConnectionString, out connectionString);
await using var conn = new NpgsqlConnection(connectionString);
await conn.OpenAsync();
_ = await postmasterMock.WaitForServerConnection();
}
else
{
Assert.That(() => new NpgsqlConnection(connectionString), Throws.Exception.TypeOf<NotSupportedException>());
}
}
[Test]
public void TargetSessionAttributes_default_is_null()
=> Assert.That(new NpgsqlConnectionStringBuilder().TargetSessionAttributes, Is.Null);
[Test]
[NonParallelizable] // Sets environment variable
public async Task TargetSessionAttributes_uses_environment_variable()
{
using var envVarResetter = SetEnvironmentVariable("PGTARGETSESSIONATTRS", "prefer-standby");
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby);
var builder = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading
};
Assert.That(builder.TargetSessionAttributes, Is.Null);
await using var dataSource = new NpgsqlDataSourceBuilder(builder.ConnectionString)
.BuildMultiHost();
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(conn.Port, Is.EqualTo(standbyPostmaster.Port));
}
[Test]
public void TargetSessionAttributes_invalid_throws()
=> Assert.Throws<ArgumentException>(() =>
new NpgsqlConnectionStringBuilder
{
TargetSessionAttributes = nameof(TargetSessionAttributes_invalid_throws)
});
[Test]
public void HostRecheckSeconds_default_value()
{
var builder = new NpgsqlConnectionStringBuilder();
Assert.That(builder.HostRecheckSeconds, Is.EqualTo(10));
Assert.That(builder.HostRecheckSecondsTranslated, Is.EqualTo(TimeSpan.FromSeconds(10)));
}
[Test]
public void HostRecheckSeconds_zero_value()
{
var builder = new NpgsqlConnectionStringBuilder
{
HostRecheckSeconds = 0,
};
Assert.That(builder.HostRecheckSeconds, Is.EqualTo(0));
Assert.That(builder.HostRecheckSecondsTranslated, Is.EqualTo(TimeSpan.FromSeconds(-1)));
}
[Test]
public void HostRecheckSeconds_invalid_throws()
=> Assert.Throws<ArgumentOutOfRangeException>(() =>
new NpgsqlConnectionStringBuilder
{
HostRecheckSeconds = -1
});
[Test]
public async Task Connect_with_load_balancing()
{
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby);
var defaultCsb = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
MaxPoolSize = 1,
LoadBalanceHosts = true,
};
await using var dataSource = new NpgsqlDataSourceBuilder(defaultCsb.ConnectionString)
.BuildMultiHost();
NpgsqlConnector firstConnector;
NpgsqlConnector secondConnector;
await using (var firstConnection = await dataSource.OpenConnectionAsync())
{
firstConnector = firstConnection.Connector!;
}
await using (var secondConnection = await dataSource.OpenConnectionAsync())
{
secondConnector = secondConnection.Connector!;
}
Assert.That(secondConnector, Is.Not.SameAs(firstConnector));
await using (var firstBalancedConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(firstBalancedConnection.Connector, Is.SameAs(firstConnector));
}
await using (var secondBalancedConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(secondBalancedConnection.Connector, Is.SameAs(secondConnector));
}
await using (var thirdBalancedConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(thirdBalancedConnection.Connector, Is.SameAs(firstConnector));
}
}
[Test]
public async Task Connect_without_load_balancing()
{
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby);
var defaultCsb = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
MaxPoolSize = 1,
LoadBalanceHosts = false,
};
await using var dataSource = new NpgsqlDataSourceBuilder(defaultCsb.ConnectionString)
.BuildMultiHost();
NpgsqlConnector firstConnector;
NpgsqlConnector secondConnector;
await using (var firstConnection = await dataSource.OpenConnectionAsync())
{
firstConnector = firstConnection.Connector!;
}
await using (var secondConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(secondConnection.Connector, Is.SameAs(firstConnector));
}
await using (var firstConnection = await dataSource.OpenConnectionAsync())
await using (var secondConnection = await dataSource.OpenConnectionAsync())
{
secondConnector = secondConnection.Connector!;
}
Assert.That(secondConnector, Is.Not.SameAs(firstConnector));
await using (var firstUnbalancedConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(firstUnbalancedConnection.Connector, Is.SameAs(firstConnector));
}
await using (var secondUnbalancedConnection = await dataSource.OpenConnectionAsync())
{
Assert.That(secondUnbalancedConnection.Connector, Is.SameAs(firstConnector));
}
}
[Test]
public async Task Connect_state_changing_hosts([Values] bool alwaysCheckHostState)
{
await using var primaryPostmaster = PgPostmasterMock.Start(state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(state: Standby);
var defaultCsb = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
MaxPoolSize = 1,
HostRecheckSeconds = alwaysCheckHostState ? 0 : int.MaxValue,
NoResetOnClose = true,
};
await using var dataSource = new NpgsqlDataSourceBuilder(defaultCsb.ConnectionString)
.BuildMultiHost();
NpgsqlConnector firstConnector;
NpgsqlConnector secondConnector;
var firstServerTask = Task.Run(async () =>
{
var server = await primaryPostmaster.WaitForServerConnection();
if (!alwaysCheckHostState)
return;
// If we always check the host, we will send the request for the state
// even though we got one while opening the connection
await server.SendMockState(Primary);
// Update the state after a 'failover'
await server.SendMockState(Standby);
});
var secondServerTask = Task.Run(async () =>
{
var server = await standbyPostmaster.WaitForServerConnection();
if (!alwaysCheckHostState)
return;
// If we always check the host, we will send the request for the state
// even though we got one while opening the connection
await server.SendMockState(Standby);
// As TargetSessionAttributes is 'prefer', it does another cycle for the 'unpreferred'
await server.SendMockState(Standby);
// Update the state after a 'failover'
await server.SendMockState(Primary);
});
await using (var firstConnection = await dataSource.OpenConnectionAsync(TargetSessionAttributes.PreferPrimary))
await using (var secondConnection = await dataSource.OpenConnectionAsync(TargetSessionAttributes.PreferPrimary))
{
firstConnector = firstConnection.Connector!;
secondConnector = secondConnection.Connector!;
}
await using var thirdConnection = await dataSource.OpenConnectionAsync(TargetSessionAttributes.PreferPrimary);
Assert.That(thirdConnection.Connector, Is.SameAs(alwaysCheckHostState ? secondConnector : firstConnector));
await firstServerTask;
await secondServerTask;
}
[Test]
public void Database_state_cache_basic()
{
using var dataSource = CreateDataSource();
var timeStamp = DateTime.UtcNow;
dataSource.UpdateDatabaseState(DatabaseState.PrimaryReadWrite, timeStamp, TimeSpan.Zero);
Assert.That(dataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.PrimaryReadWrite));
// Update with the same timestamp - shouldn't change anything
dataSource.UpdateDatabaseState(DatabaseState.Standby, timeStamp, TimeSpan.Zero);
Assert.That(dataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.PrimaryReadWrite));
// Update with a new timestamp
timeStamp = timeStamp.AddSeconds(1);
dataSource.UpdateDatabaseState(DatabaseState.PrimaryReadOnly, timeStamp, TimeSpan.Zero);
Assert.That(dataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.PrimaryReadOnly));
// Expired state returns as Unknown (depending on ignoreExpiration)
timeStamp = timeStamp.AddSeconds(1);
dataSource.UpdateDatabaseState(DatabaseState.PrimaryReadWrite, timeStamp, TimeSpan.FromSeconds(-1));
Assert.That(dataSource.GetDatabaseState(ignoreExpiration: false), Is.EqualTo(DatabaseState.Unknown));
Assert.That(dataSource.GetDatabaseState(ignoreExpiration: true), Is.EqualTo(DatabaseState.PrimaryReadWrite));
}
[Test]
public async Task Offline_state_on_connection_failure()
{
await using var server = PgPostmasterMock.Start(ConnectionString, startupErrorCode: PostgresErrorCodes.ConnectionFailure);
await using var dataSource = server.CreateDataSource();
await using var conn = dataSource.CreateConnection();
var ex = Assert.ThrowsAsync<PostgresException>(conn.OpenAsync)!;
Assert.That(ex.SqlState, Is.EqualTo(PostgresErrorCodes.ConnectionFailure));
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Offline));
}
[Test]
public async Task Unknown_state_on_connection_authentication_failure()
{
await using var server = PgPostmasterMock.Start(ConnectionString, startupErrorCode: PostgresErrorCodes.InvalidAuthorizationSpecification);
await using var dataSource = server.CreateDataSource();
await using var conn = dataSource.CreateConnection();
var ex = Assert.ThrowsAsync<PostgresException>(conn.OpenAsync)!;
Assert.That(ex.SqlState, Is.EqualTo(PostgresErrorCodes.InvalidAuthorizationSpecification));
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
}
[Test]
public async Task Offline_state_on_query_execution_pg_critical_failure()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
await using var anotherConn = await dataSource.OpenConnectionAsync();
await anotherConn.CloseAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(2));
var server = await postmaster.WaitForServerConnection();
await server.WriteErrorResponse(PostgresErrorCodes.CrashShutdown).FlushAsync();
var ex = Assert.ThrowsAsync<PostgresException>(() => conn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(ex.SqlState, Is.EqualTo(PostgresErrorCodes.CrashShutdown));
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Offline));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(0));
}
[Test, NonParallelizable]
public async Task Offline_state_on_query_execution_pg_non_critical_failure()
{
await using var dataSource = CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
// Starting with PG14 we get the cluster's state from PG automatically
var expectedState = conn.PostgreSqlVersion.Major > 13 ? DatabaseState.PrimaryReadWrite : DatabaseState.Unknown;
var state = dataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(expectedState));
Assert.That(dataSource.Statistics.Total, Is.EqualTo(1));
var ex = Assert.ThrowsAsync<PostgresException>(() => conn.ExecuteNonQueryAsync("SELECT abc"))!;
Assert.That(ex.SqlState, Is.EqualTo(PostgresErrorCodes.UndefinedColumn));
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
state = dataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(expectedState));
Assert.That(dataSource.Statistics.Total, Is.EqualTo(1));
}
[Test]
public async Task Offline_state_on_query_execution_IOException()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
await using var anotherConn = await dataSource.OpenConnectionAsync();
await anotherConn.CloseAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(2));
var server = await postmaster.WaitForServerConnection();
server.Close();
var ex = Assert.ThrowsAsync<NpgsqlException>(() => conn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(ex.InnerException, Is.InstanceOf<IOException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Offline));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(0));
}
[Test]
public async Task Offline_state_on_query_execution_TimeoutException()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource(builder =>
{
builder.ConnectionStringBuilder.CommandTimeout = 1;
builder.ConnectionStringBuilder.CancellationTimeout = 1;
});
await using var conn = await dataSource.OpenConnectionAsync();
await using var anotherConn = await dataSource.OpenConnectionAsync();
await anotherConn.CloseAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(2));
var ex = Assert.ThrowsAsync<NpgsqlException>(() => conn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(ex.InnerException, Is.TypeOf<TimeoutException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Offline));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(0));
}
[Test]
public async Task Unknown_state_on_query_execution_TimeoutException_with_disabled_cancellation()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource(builder =>
{
builder.ConnectionStringBuilder.CommandTimeout = 1;
builder.ConnectionStringBuilder.CancellationTimeout = -1;
});
await using var conn = await dataSource.OpenConnectionAsync();
await using var anotherConn = await dataSource.OpenConnectionAsync();
await anotherConn.CloseAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(2));
var ex = Assert.ThrowsAsync<NpgsqlException>(() => conn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(ex.InnerException, Is.TypeOf<TimeoutException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
}
[Test]
public async Task Unknown_state_on_query_execution_cancellation_with_disabled_cancellation_timeout()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource(builder =>
{
builder.ConnectionStringBuilder.CommandTimeout = 30;
builder.ConnectionStringBuilder.CancellationTimeout = -1;
});
await using var conn = await dataSource.OpenConnectionAsync();
await using var anotherConn = await dataSource.OpenConnectionAsync();
await anotherConn.CloseAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(2));
using var cts = new CancellationTokenSource();
var query = conn.ExecuteNonQueryAsync("SELECT 1", cancellationToken: cts.Token);
cts.Cancel();
var ex = Assert.ThrowsAsync<OperationCanceledException>(async () => await query)!;
Assert.That(ex.InnerException, Is.TypeOf<TimeoutException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
}
[Test]
public async Task Unknown_state_on_query_execution_TimeoutException_with_cancellation_failure()
{
await using var postmaster = PgPostmasterMock.Start(ConnectionString);
await using var dataSource = postmaster.CreateDataSource(builder =>
{
builder.ConnectionStringBuilder.CommandTimeout = 1;
builder.ConnectionStringBuilder.CancellationTimeout = 0;
});
await using var conn = await dataSource.OpenConnectionAsync();
var state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
var server = await postmaster.WaitForServerConnection();
var query = conn.ExecuteNonQueryAsync("SELECT 1");
await postmaster.WaitForCancellationRequest();
await server.WriteCancellationResponse().WriteReadyForQuery().FlushAsync();
var ex = Assert.ThrowsAsync<NpgsqlException>(async () => await query)!;
Assert.That(ex.InnerException, Is.TypeOf<TimeoutException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
state = conn.NpgsqlDataSource.GetDatabaseState();
Assert.That(state, Is.EqualTo(DatabaseState.Unknown));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
}
[Test]
public async Task Clear_pool_one_host_only_on_admin_shutdown()
{
await using var primaryPostmaster = PgPostmasterMock.Start(ConnectionString, state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(ConnectionString, state: Standby);
var dataSourceBuilder = new NpgsqlDataSourceBuilder
{
ConnectionStringBuilder =
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
MaxPoolSize = 2
}
};
await using var multiHostDataSource = dataSourceBuilder.BuildMultiHost();
await using var preferPrimaryDataSource = multiHostDataSource.WithTargetSession(TargetSessionAttributes.PreferPrimary);
await using var primaryConn = await preferPrimaryDataSource.OpenConnectionAsync();
await using var anotherPrimaryConn = await preferPrimaryDataSource.OpenConnectionAsync();
await using var standbyConn = await preferPrimaryDataSource.OpenConnectionAsync();
var primaryDataSource = primaryConn.Connector!.DataSource;
var standbyDataSource = standbyConn.Connector!.DataSource;
await anotherPrimaryConn.CloseAsync();
await standbyConn.CloseAsync();
Assert.That(primaryDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.PrimaryReadWrite));
Assert.That(standbyDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Standby));
Assert.That(primaryConn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(3));
var server = await primaryPostmaster.WaitForServerConnection();
await server.WriteErrorResponse(PostgresErrorCodes.AdminShutdown).FlushAsync();
var ex = Assert.ThrowsAsync<PostgresException>(() => primaryConn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(ex.SqlState, Is.EqualTo(PostgresErrorCodes.AdminShutdown));
Assert.That(primaryConn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(primaryDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Offline));
Assert.That(standbyDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Standby));
Assert.That(primaryConn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
multiHostDataSource.ClearDatabaseStates();
Assert.That(primaryDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Unknown));
Assert.That(standbyDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Unknown));
}
[Test]
[TestCase("any", true)]
[TestCase("primary", true)]
[TestCase("standby", false)]
[TestCase("prefer-primary", true)]
[TestCase("prefer-standby", false)]
[TestCase("read-write", true)]
[TestCase("read-only", false)]
public async Task Transaction_enlist_reuses_connection(string targetSessionAttributes, bool primary)
{
await using var primaryPostmaster = PgPostmasterMock.Start(ConnectionString, state: Primary);
await using var standbyPostmaster = PgPostmasterMock.Start(ConnectionString, state: Standby);
var csb = new NpgsqlConnectionStringBuilder
{
Host = MultipleHosts(primaryPostmaster, standbyPostmaster),
TargetSessionAttributes = targetSessionAttributes,
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
MaxPoolSize = 10,
// Our mock PG server doesn't know how to handle the reset messages
NoResetOnClose = true,
};
using var _ = CreateTempPool(csb, out var connString);
using var scope = new TransactionScope(TransactionScopeOption.Required,
new TransactionOptions { IsolationLevel = IsolationLevel.ReadCommitted }, TransactionScopeAsyncFlowOption.Enabled);
var query1Task = Query(connString);
var server = primary
? await primaryPostmaster.WaitForServerConnection()
: await standbyPostmaster.WaitForServerConnection();
await server
.WriteCommandComplete()
.WriteReadyForQuery(TransactionStatus.InTransactionBlock)
.WriteParseComplete()
.WriteBindComplete()
.WriteNoData()
.WriteCommandComplete()
.WriteReadyForQuery(TransactionStatus.InTransactionBlock)
.FlushAsync();
await query1Task;
var query2Task = Query(connString);
await server
.WriteParseComplete()
.WriteBindComplete()
.WriteNoData()
.WriteCommandComplete()
.WriteReadyForQuery(TransactionStatus.InTransactionBlock)
.FlushAsync();
await query2Task;
await server
.WriteCommandComplete()
.WriteReadyForQuery()
.FlushAsync();
scope.Complete();
async Task Query(string connectionString)
{
await using var conn = new NpgsqlConnection(connectionString);
await conn.OpenAsync();
await using var cmd = conn.CreateCommand();
cmd.CommandText = "SELECT 1";
await cmd.ExecuteNonQueryAsync();
}
}
[Test]
public async Task Primary_host_failover_can_connect()
{
await using var firstPostmaster = PgPostmasterMock.Start(ConnectionString, state: Primary);
await using var secondPostmaster = PgPostmasterMock.Start(ConnectionString, state: Standby);
var dataSourceBuilder = new NpgsqlDataSourceBuilder
{
ConnectionStringBuilder =
{
Host = MultipleHosts(firstPostmaster, secondPostmaster),
ServerCompatibilityMode = ServerCompatibilityMode.NoTypeLoading,
HostRecheckSeconds = 5
}
};
await using var multiHostDataSource = dataSourceBuilder.BuildMultiHost();
var (firstDataSource, secondDataSource) = (multiHostDataSource.Pools[0], multiHostDataSource.Pools[1]);
await using var primaryDataSource = multiHostDataSource.WithTargetSession(TargetSessionAttributes.Primary);
await using var conn = await primaryDataSource.OpenConnectionAsync();
Assert.That(conn.Port, Is.EqualTo(firstPostmaster.Port));
var firstServer = await firstPostmaster.WaitForServerConnection();
await firstServer
.WriteErrorResponse(PostgresErrorCodes.AdminShutdown)
.FlushAsync();
var failoverEx = Assert.ThrowsAsync<PostgresException>(async () => await conn.ExecuteNonQueryAsync("SELECT 1"))!;
Assert.That(failoverEx.SqlState, Is.EqualTo(PostgresErrorCodes.AdminShutdown));
var noHostFoundEx = Assert.ThrowsAsync<NpgsqlException>(async () => await conn.OpenAsync())!;
Assert.That(noHostFoundEx.Message, Is.EqualTo("No suitable host was found."));
Assert.That(firstDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Offline));
Assert.That(secondDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Standby));
firstPostmaster.State = Standby;
secondPostmaster.State = Primary;
var secondServer = await secondPostmaster.WaitForServerConnection();
await secondServer.SendMockState(Primary);
await Task.Delay(TimeSpan.FromSeconds(10));
Assert.That(firstDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Unknown));
Assert.That(secondDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Unknown));
await conn.OpenAsync();
Assert.That(conn.Port, Is.EqualTo(secondPostmaster.Port));
Assert.That(firstDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.Standby));
Assert.That(secondDataSource.GetDatabaseState(), Is.EqualTo(DatabaseState.PrimaryReadWrite));
}
[Test, NonParallelizable]
public void IntegrationTest([Values] bool loadBalancing, [Values] bool alwaysCheckHostState)
{
PoolManager.Reset();
var dataSourceBuilder = new NpgsqlDataSourceBuilder(ConnectionString)
{
ConnectionStringBuilder =
{
Host = "localhost,127.0.0.1",
Pooling = true,
MaxPoolSize = 2,
LoadBalanceHosts = loadBalancing,
HostRecheckSeconds = alwaysCheckHostState ? 0 : 10,
}
};
using var dataSource = dataSourceBuilder.BuildMultiHost();
var queriesDone = 0;
var clientsTask = Task.WhenAll(
Client(dataSource, TargetSessionAttributes.Any),
Client(dataSource, TargetSessionAttributes.Primary),