forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathConnectionTests.cs
More file actions
1997 lines (1716 loc) · 82.9 KB
/
ConnectionTests.cs
File metadata and controls
1997 lines (1716 loc) · 82.9 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 System;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Security;
using System.Net.Sockets;
using System.Runtime.InteropServices;
using System.Security.Cryptography.X509Certificates;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Npgsql.Internal;
using Npgsql.PostgresTypes;
using Npgsql.Tests.Support;
using Npgsql.Util;
using NpgsqlTypes;
using NUnit.Framework;
using static Npgsql.Tests.TestUtil;
namespace Npgsql.Tests;
public class ConnectionTests : TestBase
{
[Test, Description("Makes sure the connection goes through the proper state lifecycle")]
public async Task Basic_lifecycle()
{
await using var conn = CreateConnection();
var eventOpen = false;
var eventClosed = false;
conn.StateChange += (s, e) =>
{
if (e is { OriginalState: ConnectionState.Closed, CurrentState: ConnectionState.Open })
eventOpen = true;
if (e is { OriginalState: ConnectionState.Open, CurrentState: ConnectionState.Closed })
eventClosed = true;
};
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
await conn.OpenAsync();
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
Assert.That(eventOpen, Is.True);
await using (var cmd = new NpgsqlCommand("SELECT 1", conn))
await using (var reader = await cmd.ExecuteReaderAsync())
{
await reader.ReadAsync();
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open | ConnectionState.Fetching));
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
}
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
await conn.CloseAsync();
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
Assert.That(eventClosed, Is.True);
}
[Test, Description("Makes sure the connection goes through the proper state lifecycle")]
public async Task Broken_lifecycle([Values] bool openFromClose)
{
await using var dataSource = CreateDataSource();
await using var conn = dataSource.CreateConnection();
var eventOpen = false;
var eventClosed = false;
conn.StateChange += (s, e) =>
{
if (e is { OriginalState: ConnectionState.Closed, CurrentState: ConnectionState.Open })
eventOpen = true;
if (e is { OriginalState: ConnectionState.Open, CurrentState: ConnectionState.Closed })
eventClosed = true;
};
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
await conn.OpenAsync();
await using var transaction = await conn.BeginTransactionAsync();
Assert.That(conn.State, Is.EqualTo(ConnectionState.Open));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
Assert.That(eventOpen, Is.True);
var sleep = conn.ExecuteNonQueryAsync("SELECT pg_sleep(5)");
// Wait for a query
await Task.Delay(1000);
await using (var killingConn = await OpenConnectionAsync())
killingConn.ExecuteNonQuery($"SELECT pg_terminate_backend({conn.ProcessID})");
Assert.ThrowsAsync<PostgresException>(() => sleep);
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Broken));
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(eventClosed, Is.True);
Assert.That(conn.Connector is null);
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(0));
if (openFromClose)
{
await conn.CloseAsync();
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
Assert.That(eventClosed, Is.True);
}
Assert.DoesNotThrowAsync(conn.OpenAsync);
Assert.That(await conn.ExecuteScalarAsync("SELECT 1"), Is.EqualTo(1));
Assert.That(conn.NpgsqlDataSource.Statistics.Total, Is.EqualTo(1));
Assert.DoesNotThrowAsync(conn.CloseAsync);
}
[Test]
public async Task Break_while_open()
{
await using var dataSource = CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
using (var conn2 = await OpenConnectionAsync())
conn2.ExecuteNonQuery($"SELECT pg_terminate_backend({conn.ProcessID})");
// Allow some time for the pg_terminate to kill our connection
using (var cmd = CreateSleepCommand(conn, 10))
Assert.That(() => cmd.ExecuteNonQuery(), Throws.Exception
.AssignableTo<NpgsqlException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Broken));
}
#region Connection Errors
#if IGNORE
[Test]
[TestCase(true)]
[TestCase(false)]
public async Task Connection_refused(bool pooled)
{
var csb = new NpgsqlConnectionStringBuilder(ConnectionString) { Port = 44444, Pooling = pooled };
using (var conn = new NpgsqlConnection(csb)) {
Assert.That(() => conn.Open(), Throws.Exception
.TypeOf<SocketException>()
// CoreCLR currently has an issue which causes the wrong SocketErrorCode to be set on Linux:
// https://github.com/dotnet/corefx/issues/8464
.With.Property(nameof(SocketException.SocketErrorCode)).EqualTo(SocketError.ConnectionRefused)
);
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
}
}
[Test]
[TestCase(true)]
[TestCase(false)]
public async Task Connection_refused_async(bool pooled)
{
var csb = new NpgsqlConnectionStringBuilder(ConnectionString) { Port = 44444, Pooling = pooled };
using (var conn = new NpgsqlConnection(csb))
{
Assert.That(async () => await conn.OpenAsync(), Throws.Exception
.TypeOf<SocketException>()
.With.Property(nameof(SocketException.SocketErrorCode)).EqualTo(SocketError.ConnectionRefused)
);
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
}
}
#endif
[Test]
public void Invalid_Username()
{
var connString = new NpgsqlConnectionStringBuilder(ConnectionString)
{
Username = "unknown", Pooling = false
}.ToString();
using var conn = new NpgsqlConnection(connString);
Assert.That(conn.Open, Throws.Exception
.TypeOf<PostgresException>()
.With.Property(nameof(PostgresException.SqlState)).EqualTo(PostgresErrorCodes.InvalidPassword)
);
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Closed));
}
[Test]
public void Bad_database()
{
using var dataSource = CreateDataSource(csb => csb.Database = "does_not_exist");
using var conn = dataSource.CreateConnection();
Assert.That(() => conn.Open(),
Throws.Exception.TypeOf<PostgresException>()
.With.Property(nameof(PostgresException.SqlState)).EqualTo(PostgresErrorCodes.InvalidCatalogName)
);
}
[Test, Description("Tests that mandatory connection string parameters are indeed mandatory")]
public void Mandatory_connection_string_params()
=> Assert.Throws<ArgumentNullException>(() =>
new NpgsqlConnection("User ID=npgsql_tests;Password=npgsql_tests;Database=npgsql_tests"));
[Test, Description("Reuses the same connection instance for a failed connection, then a successful one")]
public async Task Fail_connect_then_succeed([Values] bool pooling)
{
var dbName = GetUniqueIdentifier(nameof(Fail_connect_then_succeed));
await using var conn1 = await OpenConnectionAsync();
await conn1.ExecuteNonQueryAsync($"DROP DATABASE IF EXISTS \"{dbName}\"");
try
{
await using var dataSource = CreateDataSource(csb =>
{
csb.Database = dbName;
csb.Pooling = pooling;
});
await using var conn2 = dataSource.CreateConnection();
var pgEx = Assert.ThrowsAsync<PostgresException>(conn2.OpenAsync)!;
Assert.That(pgEx.SqlState, Is.EqualTo(PostgresErrorCodes.InvalidCatalogName)); // database doesn't exist
Assert.That(conn2.FullState, Is.EqualTo(ConnectionState.Closed));
await conn1.ExecuteNonQueryAsync($"CREATE DATABASE \"{dbName}\" TEMPLATE template0");
Assert.DoesNotThrowAsync(conn2.OpenAsync);
Assert.DoesNotThrowAsync(conn2.CloseAsync);
}
finally
{
await conn1.ExecuteNonQueryAsync($"DROP DATABASE IF EXISTS \"{dbName}\"");
}
}
[Test]
public void Open_timeout_unknown_ip([Values(true, false)] bool async)
{
const int timeoutSeconds = 2;
var unknownIp = Environment.GetEnvironmentVariable("NPGSQL_UNKNOWN_IP");
if (unknownIp is null)
{
Assert.Ignore("NPGSQL_UNKNOWN_IP isn't defined and is required for connection timeout tests");
return;
}
using var dataSource = CreateDataSource(csb =>
{
csb.Host = unknownIp;
csb.Timeout = timeoutSeconds;
});
using var conn = dataSource.CreateConnection();
var sw = Stopwatch.StartNew();
if (async)
{
Assert.That(async () => await conn.OpenAsync(), Throws.Exception
.TypeOf<NpgsqlException>()
.With.InnerException.TypeOf<TimeoutException>());
}
else
{
Assert.That(() => conn.Open(), Throws.Exception
.TypeOf<NpgsqlException>()
.With.InnerException.TypeOf<TimeoutException>());
}
Assert.That(sw.Elapsed.TotalMilliseconds, Is.GreaterThanOrEqualTo(timeoutSeconds * 1000 - 100),
$"Timeout was supposed to happen after {timeoutSeconds} seconds, but fired after {sw.Elapsed.TotalSeconds}");
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
}
[Test]
public void Connect_timeout_cancel()
{
var unknownIp = Environment.GetEnvironmentVariable("NPGSQL_UNKNOWN_IP");
if (unknownIp is null)
{
Assert.Ignore("NPGSQL_UNKNOWN_IP isn't defined and is required for connection cancellation tests");
return;
}
var connString = new NpgsqlConnectionStringBuilder(ConnectionString)
{
Host = unknownIp,
Pooling = false,
Timeout = 30
}.ToString();
using var conn = new NpgsqlConnection(connString);
var cts = new CancellationTokenSource(1000);
Assert.That(async () => await conn.OpenAsync(cts.Token), Throws.Exception.TypeOf<OperationCanceledException>());
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
}
[Test]
public void Bad_hostname()
{
using var dataSource = CreateDataSource(csb => csb.Host = "hostname.that.does.not.exist");
using var conn = dataSource.CreateConnection();
Assert.That(
() => conn.Open(),
Throws.Exception
.TypeOf<NpgsqlException>()
.With
.Property(nameof(NpgsqlException.InnerException))
.TypeOf<SocketException>()
);
}
[Test]
public void Bad_hostname_async()
{
using var dataSource = CreateDataSource(csb => csb.Host = "hostname.that.does.not.exist");
using var conn = dataSource.CreateConnection();
Assert.That(
async () => await conn.OpenAsync(),
Throws.Exception
.TypeOf<NpgsqlException>()
.With
.Property(nameof(NpgsqlException.InnerException))
.TypeOf<SocketException>()
);
}
#endregion
#region Client Encoding
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1065")]
public async Task Client_encoding_is_UTF8_by_default()
{
using var conn = await OpenConnectionAsync();
Assert.That(await conn.ExecuteScalarAsync("SHOW client_encoding"), Is.EqualTo("UTF8"));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1065")]
[NonParallelizable] // Sets environment variable
public async Task Client_encoding_env_var()
{
using (var testConn = await OpenConnectionAsync())
Assert.That(await testConn.ExecuteScalarAsync("SHOW client_encoding"), Is.Not.EqualTo("SQL_ASCII"));
// Note that the pool is unaware of the environment variable, so if a connection is
// returned from the pool it may contain the wrong client_encoding
using var _ = SetEnvironmentVariable("PGCLIENTENCODING", "SQL_ASCII");
await using var dataSource = CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(await conn.ExecuteScalarAsync("SHOW client_encoding"), Is.EqualTo("SQL_ASCII"));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1065")]
public async Task Client_encoding_connection_param()
{
using (var conn = await OpenConnectionAsync())
Assert.That(await conn.ExecuteScalarAsync("SHOW client_encoding"), Is.Not.EqualTo("SQL_ASCII"));
await using var dataSource = CreateDataSource(csb => csb.ClientEncoding = "SQL_ASCII");
using (var conn = await dataSource.OpenConnectionAsync())
Assert.That(await conn.ExecuteScalarAsync("SHOW client_encoding"), Is.EqualTo("SQL_ASCII"));
}
#endregion Client Encoding
#region Timezone
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1634")]
[NonParallelizable] // Sets environment variable
public async Task Timezone_env_var()
{
string newTimezone;
using (var conn1 = await OpenConnectionAsync())
{
newTimezone = (string?)await conn1.ExecuteScalarAsync("SHOW TIMEZONE") == "Africa/Bamako"
? "Africa/Lagos"
: "Africa/Bamako";
}
// Note that the pool is unaware of the environment variable, so if a connection is
// returned from the pool it may contain the wrong timezone
using var _ = SetEnvironmentVariable("PGTZ", newTimezone);
await using var dataSource = CreateDataSource();
using var conn2 = await dataSource.OpenConnectionAsync();
Assert.That(await conn2.ExecuteScalarAsync("SHOW TIMEZONE"), Is.EqualTo(newTimezone));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1634")]
public async Task Timezone_connection_param()
{
string newTimezone;
using (var conn = await OpenConnectionAsync())
{
newTimezone = (string?)await conn.ExecuteScalarAsync("SHOW TIMEZONE") == "Africa/Bamako"
? "Africa/Lagos"
: "Africa/Bamako";
}
await using var dataSource = CreateDataSource(csb => csb.Timezone = newTimezone);
using (var conn = await dataSource.OpenConnectionAsync())
Assert.That(await conn.ExecuteScalarAsync("SHOW TIMEZONE"), Is.EqualTo(newTimezone));
}
#endregion Timezone
#region Application Name
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/6133")]
[NonParallelizable] // Sets environment variable
public async Task Application_name_env_var()
{
const string testAppName = "MyTestApp";
// Note that the pool is unaware of the environment variable, so if a connection is
// returned from the pool it may contain the wrong application name
using var _ = SetEnvironmentVariable("PGAPPNAME", testAppName);
await using var dataSource = CreateDataSource();
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(conn.PostgresParameters["application_name"], Is.EqualTo(testAppName));
}
[Test]
public async Task Application_name_connection_param()
{
const string testAppName = "MyTestApp2";
await using var dataSource = CreateDataSource(csb => csb.ApplicationName = testAppName);
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(conn.PostgresParameters["application_name"], Is.EqualTo(testAppName));
}
[Test]
[NonParallelizable] // Sets environment variable
public async Task Application_name_connection_param_overrides_env_var()
{
const string envAppName = "EnvApp";
const string connAppName = "ConnApp";
using var _ = SetEnvironmentVariable("PGAPPNAME", envAppName);
await using var dataSource = CreateDataSource(csb => csb.ApplicationName = connAppName);
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(conn.PostgresParameters["application_name"], Is.EqualTo(connAppName));
}
#endregion Application Name
#region ConnectionString - Host
[TestCase("127.0.0.1", ExpectedResult = new [] { "127.0.0.1:5432" })]
[TestCase("127.0.0.1:5432", ExpectedResult = new [] { "127.0.0.1:5432" })]
[TestCase("::1", ExpectedResult = new [] { "::1:5432" })]
[TestCase("[::1]", ExpectedResult = new [] { "[::1]:5432" })]
[TestCase("[::1]:5432", ExpectedResult = new [] { "[::1]:5432" })]
[TestCase("localhost", ExpectedResult = new [] { "localhost:5432" })]
[TestCase("localhost:5432", ExpectedResult = new [] { "localhost:5432" })]
[TestCase("127.0.0.1,127.0.0.1:5432,::1,[::1],[::1]:5432,localhost,localhost:5432",
ExpectedResult = new []
{
"127.0.0.1:5432",
"127.0.0.1:5432",
"::1:5432",
"[::1]:5432",
"[::1]:5432",
"localhost:5432",
"localhost:5432"
})]
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/3802")]
public string[] ConnectionString_Host(string host)
{
var dataSourceBuilder = new NpgsqlDataSourceBuilder
{
ConnectionStringBuilder = { Host = host }
};
using var dataSource = dataSourceBuilder.BuildMultiHost();
return dataSource.Pools.Select(ds => $"{ds.Settings.Host}:{ds.Settings.Port}").ToArray()!;
}
#endregion ConnectionString - Host
[Test]
public async Task Unix_domain_socket()
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
if (Environment.OSVersion.Version.Major < 10 || Environment.OSVersion.Version.Build < 17093)
Assert.Ignore("Unix-domain sockets support was introduced in Windows build 17093");
// On Windows we first need a classic IP connection to make sure we're running against the
// right backend version
using var versionConnection = await OpenConnectionAsync();
MinimumPgVersion(versionConnection, "13.0", "Unix-domain sockets support on Windows was introduced in PostgreSQL 13");
}
var port = new NpgsqlConnectionStringBuilder(ConnectionString).Port;
var candidateDirectories = new[] { "/var/run/postgresql", "/tmp", Environment.GetEnvironmentVariable("TMP") ?? "C:\\" };
var dir = candidateDirectories.FirstOrDefault(d => File.Exists(Path.Combine(d, $".s.PGSQL.{port}")));
if (dir == null)
{
IgnoreExceptOnBuildServer("No PostgreSQL unix domain socket was found");
return;
}
try
{
await using var dataSource = CreateDataSource(csb => csb.Host = dir);
await using var conn = await dataSource.OpenConnectionAsync();
await using var tx = await conn.BeginTransactionAsync();
Assert.That(await conn.ExecuteScalarAsync("SELECT 1", tx), Is.EqualTo(1));
Assert.That(conn.DataSource, Is.EqualTo(Path.Combine(dir, $".s.PGSQL.{port}")));
}
catch (Exception ex)
{
IgnoreExceptOnBuildServer($"Connection via unix domain socket failed: {ex}");
}
}
[Test]
[Platform(Exclude = "MacOsX", Reason = "Fails only on mac, needs to be investigated")]
public async Task Unix_abstract_domain_socket()
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
Assert.Ignore("Abstract unix-domain sockets are not supported on windows");
}
// We first need a classic IP connection to make sure we're running against the
// right backend version
using var versionConnection = await OpenConnectionAsync();
MinimumPgVersion(versionConnection, "14.0", "Abstract unix-domain sockets support was introduced in PostgreSQL 14");
var csb = new NpgsqlConnectionStringBuilder(ConnectionString)
{
Host = "@/npgsql_unix"
};
try
{
await using var dataSource = CreateDataSource(csb.ToString());
await using var conn = await dataSource.OpenConnectionAsync();
await using var tx = await conn.BeginTransactionAsync();
Assert.That(await conn.ExecuteScalarAsync("SELECT 1", tx), Is.EqualTo(1));
Assert.That(conn.DataSource, Is.EqualTo(Path.Combine(csb.Host, $".s.PGSQL.{csb.Port}")));
}
catch (Exception ex)
{
IgnoreExceptOnBuildServer($"Connection via abstract unix domain socket failed: {ex}");
}
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/903")]
public void DataSource_property()
{
using var conn = new NpgsqlConnection();
Assert.That(conn.DataSource, Is.EqualTo(string.Empty));
var csb = new NpgsqlConnectionStringBuilder(ConnectionString);
conn.ConnectionString = csb.ConnectionString;
Assert.That(conn.DataSource, Is.EqualTo($"tcp://{csb.Host}:{csb.Port}"));
csb.Host = "127.0.0.1, 127.0.0.2";
conn.ConnectionString = csb.ConnectionString;
Assert.That(conn.DataSource, Is.EqualTo(string.Empty));
}
#region Server version
[Test]
public async Task PostgreSqlVersion_ServerVersion()
{
await using var c = new NpgsqlConnection(ConnectionString);
Assert.That(() => c.PostgreSqlVersion, Throws.InvalidOperationException
.With.Message.EqualTo("Connection is not open"));
Assert.That(() => c.ServerVersion, Throws.InvalidOperationException
.With.Message.EqualTo("Connection is not open"));
await c.OpenAsync();
var backendVersionString = (string)(await c.ExecuteScalarAsync("SHOW server_version"))!;
Assert.That(backendVersionString, Is.EqualTo(c.ServerVersion));
Assert.That(backendVersionString, Does.Contain(
new[] { "rc", "beta", "devel" }.Any(x => backendVersionString.Contains(x))
? c.PostgreSqlVersion.Major.ToString()
: c.PostgreSqlVersion.ToString()));
}
[TestCase("X13.0")]
[TestCase("13.")]
[TestCase("13.1.")]
[TestCase("13.1.1.")]
[TestCase("13.1.1.1.")]
[TestCase("13.1.1.1.1")]
public void ParseVersion_fails(string versionString)
=> Assert.That(() => TestDbInfo.ParseServerVersion(versionString), Throws.Exception);
[TestCase("13.3", ExpectedResult = "13.3")]
[TestCase("13.3X", ExpectedResult = "13.3")]
[TestCase("9.6.4", ExpectedResult = "9.6.4")]
[TestCase("9.6.4X", ExpectedResult = "9.6.4")]
[TestCase("9.5alpha2", ExpectedResult = "9.5")]
[TestCase("9.5alpha2X", ExpectedResult = "9.5")]
[TestCase("9.5devel", ExpectedResult = "9.5")]
[TestCase("9.5develX", ExpectedResult = "9.5")]
[TestCase("9.5deveX", ExpectedResult = "9.5")]
[TestCase("9.4beta3", ExpectedResult = "9.4")]
[TestCase("9.4rc1", ExpectedResult = "9.4")]
[TestCase("9.4rc1X", ExpectedResult = "9.4")]
[TestCase("13devel", ExpectedResult = "13.0")]
[TestCase("13beta1", ExpectedResult = "13.0")]
// The following should not occur as PostgreSQL version string in the wild these days but we support it.
[TestCase("13", ExpectedResult = "13.0")]
[TestCase("13X", ExpectedResult = "13.0")]
[TestCase("13alpha1", ExpectedResult = "13.0")]
[TestCase("13alpha", ExpectedResult = "13.0")]
[TestCase("13alphX", ExpectedResult = "13.0")]
[TestCase("13beta", ExpectedResult = "13.0")]
[TestCase("13betX", ExpectedResult = "13.0")]
[TestCase("13rc1", ExpectedResult = "13.0")]
[TestCase("13rc", ExpectedResult = "13.0")]
[TestCase("13rX", ExpectedResult = "13.0")]
[TestCase("99999.99999.99999.99999", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999.99999X", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999.99999devel", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999.99999alpha99999", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999alpha99999", ExpectedResult = "99999.99999.99999")]
[TestCase("99999.99999.99999.99999beta99999", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999beta99999", ExpectedResult = "99999.99999.99999")]
[TestCase("99999.99999.99999.99999rc99999", ExpectedResult = "99999.99999.99999.99999")]
[TestCase("99999.99999.99999rc99999", ExpectedResult = "99999.99999.99999")]
public string ParseVersion_succeeds(string versionString)
=> TestDbInfo.ParseServerVersion(versionString).ToString();
class TestDbInfo : NpgsqlDatabaseInfo
{
public TestDbInfo(string host, int port, string databaseName, Version version) : base(host, port, databaseName, version)
=> throw new NotImplementedException();
protected override IEnumerable<PostgresType> GetTypes()
=> throw new NotImplementedException();
public new static Version ParseServerVersion(string versionString)
=> NpgsqlDatabaseInfo.ParseServerVersion(versionString);
}
#endregion Server version
[Test]
public void Setting_connection_string_while_open_throws()
{
using var conn = new NpgsqlConnection();
conn.ConnectionString = ConnectionString;
conn.Open();
Assert.That(() => conn.ConnectionString = "", Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
public void Empty_constructor()
{
var conn = new NpgsqlConnection();
Assert.That(conn.ConnectionTimeout, Is.EqualTo(NpgsqlConnectionStringBuilder.DefaultTimeout));
Assert.That(conn.ConnectionString, Is.SameAs(string.Empty));
Assert.That(() => conn.Open(), Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
public void Constructor_with_null_connection_string()
{
var conn = new NpgsqlConnection(null);
Assert.That(conn.ConnectionString, Is.SameAs(string.Empty));
Assert.That(() => conn.Open(), Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
public void Constructor_with_empty_connection_string()
{
var conn = new NpgsqlConnection("");
Assert.That(conn.ConnectionString, Is.SameAs(string.Empty));
Assert.That(() => conn.Open(), Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
public void Set_connection_string_to_null()
{
var conn = new NpgsqlConnection(ConnectionString);
conn.ConnectionString = null;
Assert.That(conn.ConnectionString, Is.SameAs(string.Empty));
Assert.That(conn.Settings.Host, Is.Null);
Assert.That(() => conn.Open(), Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
public void Set_connection_string_to_empty()
{
var conn = new NpgsqlConnection(ConnectionString);
conn.ConnectionString = "";
Assert.That(conn.ConnectionString, Is.SameAs(string.Empty));
Assert.That(conn.Settings.Host, Is.Null);
Assert.That(() => conn.Open(), Throws.Exception.TypeOf<InvalidOperationException>());
}
[Test]
[TestCase("test_schema_1", "public", true)]
[TestCase("test_schema_1", "test_schema_2", true)]
[TestCase("test_schema_2", "test_schema_3", true)]
[TestCase("test_schema_1", "public", false)]
[TestCase("test_schema_1", "test_schema_2", false)]
[TestCase("test_schema_2", "test_schema_3", false)]
[TestCase("'DROP TABLE X", "'COMMIT; ", false)]
[Parallelizable(ParallelScope.None)]
public async Task Set_Schemas_And_Load_Relevant_Types(string testSchema, string otherSchema, bool enabled)
{
await using var conn1 = await OpenConnectionAsync();
try
{
await conn1.ExecuteNonQueryAsync("DROP TYPE IF EXISTS public.test_type_1");
await conn1.ExecuteNonQueryAsync("DROP TYPE IF EXISTS public.test_type_2");
await conn1.ExecuteNonQueryAsync("DROP TYPE IF EXISTS public.test_type_3");
await conn1.ExecuteNonQueryAsync("CREATE TYPE public.test_type_3 AS (id int, name text)");
if (testSchema != "public")
{
await conn1.ExecuteNonQueryAsync($"DROP SCHEMA IF EXISTS \"{testSchema}\" CASCADE");
await conn1.ExecuteNonQueryAsync($"CREATE SCHEMA \"{testSchema}\"");
}
if (otherSchema != "public")
{
await conn1.ExecuteNonQueryAsync($"DROP SCHEMA IF EXISTS \"{otherSchema}\" CASCADE");
await conn1.ExecuteNonQueryAsync($"CREATE SCHEMA \"{otherSchema}\"");
}
await conn1.ExecuteNonQueryAsync($"DROP TYPE IF EXISTS \"{testSchema}\".test_type_1");
await conn1.ExecuteNonQueryAsync($"CREATE TYPE \"{testSchema}\".test_type_1 AS (id int)");
await conn1.ExecuteNonQueryAsync($"DROP TYPE IF EXISTS \"{otherSchema}\".test_type_2");
await conn1.ExecuteNonQueryAsync($"CREATE TYPE \"{otherSchema}\".test_type_2 AS (id int, name text)");
using var dataSource = CreateDataSource(builder =>
{
builder.ConfigureTypeLoading(builder =>
{
if (enabled)
builder.SetTypeLoadingSchemas(testSchema, otherSchema);
});
});
using var conn = await dataSource.OpenConnectionAsync();
var databaseInfo = dataSource.CurrentReloadableState.DatabaseInfo;
if (enabled)
{
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_1"));
if (testSchema == "public" || otherSchema == "public")
{
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_2"));
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_3"));
}
else
{
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_2"));
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_3"), Is.False);
}
}
else
{
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_1"));
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_2"));
Assert.That(databaseInfo.CompositeTypes.Any(x => x.Name == "test_type_3"));
}
}
finally
{
if (testSchema != "public")
await conn1.ExecuteNonQueryAsync($"DROP SCHEMA IF EXISTS \"{testSchema}\" CASCADE");
if (otherSchema != "public")
await conn1.ExecuteNonQueryAsync($"DROP SCHEMA IF EXISTS \"{otherSchema}\" CASCADE");
}
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/703")]
public async Task No_database_defaults_to_username()
{
var csb = new NpgsqlConnectionStringBuilder(ConnectionString) { Database = null };
using var conn = new NpgsqlConnection(csb.ToString());
Assert.That(conn.Database, Is.EqualTo(csb.Username));
conn.Open();
Assert.That(await conn.ExecuteScalarAsync("SELECT current_database()"), Is.EqualTo(csb.Username));
Assert.That(conn.Database, Is.EqualTo(csb.Username));
}
[Test, Description("Breaks a connector while it's in the pool, with a keepalive and without")]
[TestCase(false, TestName = nameof(Break_connector_in_pool) + "_without_keep_alive")]
[TestCase(true, TestName = nameof(Break_connector_in_pool) + "_with_keep_alive")]
public async Task Break_connector_in_pool(bool keepAlive)
{
var dataSourceBuilder = CreateDataSourceBuilder();
dataSourceBuilder.ConnectionStringBuilder.MaxPoolSize = 1;
if (keepAlive)
dataSourceBuilder.ConnectionStringBuilder.KeepAlive = 1;
await using var dataSource = dataSourceBuilder.Build();
await using var conn = await dataSource.OpenConnectionAsync();
var connector = conn.Connector;
Assert.That(connector, Is.Not.Null);
await conn.CloseAsync();
// Use another connection to kill the connector currently in the pool
await using (var conn2 = await OpenConnectionAsync())
await conn2.ExecuteNonQueryAsync($"SELECT pg_terminate_backend({connector!.BackendProcessId})");
// Allow some time for the terminate to occur
await Task.Delay(3000);
await conn.OpenAsync();
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
if (keepAlive)
{
Assert.That(conn.Connector, Is.Not.SameAs(connector));
Assert.That(await conn.ExecuteScalarAsync("SELECT 1"), Is.EqualTo(1));
}
else
{
Assert.That(conn.Connector, Is.SameAs(connector));
Assert.That(async () => await conn.ExecuteScalarAsync("SELECT 1"), Throws.Exception
.AssignableTo<NpgsqlException>());
}
}
[Test]
[IssueLink("https://github.com/npgsql/npgsql/issues/4603")]
public async Task Reload_types_keepalive_concurrent()
{
await using var dataSource = CreateDataSource(csb => csb.KeepAlive = 1);
await using var conn = await dataSource.OpenConnectionAsync();
var startTimestamp = Stopwatch.GetTimestamp();
// Give a few seconds for a KeepAlive to possibly perform
while (Stopwatch.GetElapsedTime(startTimestamp).TotalSeconds < 2)
Assert.DoesNotThrow(conn.ReloadTypes);
}
#region ChangeDatabase
[Test]
public async Task ChangeDatabase()
{
using var conn = await OpenConnectionAsync();
conn.ChangeDatabase("template1");
using var cmd = new NpgsqlCommand("select current_database()", conn);
Assert.That(await cmd.ExecuteScalarAsync(), Is.EqualTo("template1"));
}
[Test]
public async Task ChangeDatabase_does_not_affect_other_connections()
{
using var conn1 = new NpgsqlConnection(ConnectionString);
using var conn2 = new NpgsqlConnection(ConnectionString);
// Connection 1 changes database
conn1.Open();
conn1.ChangeDatabase("template1");
Assert.That(await conn1.ExecuteScalarAsync("SELECT current_database()"), Is.EqualTo("template1"));
// Connection 2's database should not changed
conn2.Open();
Assert.That(await conn2.ExecuteScalarAsync("SELECT current_database()"), Is.Not.EqualTo(conn1.Database));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/1331")]
public void ChangeDatabase_connection_on_closed_connection_throws()
{
using var conn = new NpgsqlConnection(ConnectionString);
Assert.That(() => conn.ChangeDatabase("template1"), Throws.Exception
.TypeOf<InvalidOperationException>()
.With.Message.EqualTo("Connection is not open"));
}
#endregion
[Test, Description("Tests closing a connector while a reader is open")]
public async Task Close_during_read([Values(PooledOrNot.Pooled, PooledOrNot.Unpooled)] PooledOrNot pooled)
{
await using var dataSource = CreateDataSource(csb => csb.Pooling = pooled == PooledOrNot.Pooled);
await using var conn = await dataSource.OpenConnectionAsync();
await using (var cmd = new NpgsqlCommand("SELECT 1", conn))
await using (var reader = await cmd.ExecuteReaderAsync())
{
reader.Read();
conn.Close();
Assert.That(conn.State, Is.EqualTo(ConnectionState.Closed));
Assert.That(reader.IsClosed);
}
conn.Open();
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
Assert.That(await conn.ExecuteScalarAsync("SELECT 1"), Is.EqualTo(1));
}
[Test]
public async Task Search_path()
{
await using var dataSource = CreateDataSource(csb => csb.SearchPath = "foo");
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(await conn.ExecuteScalarAsync("SHOW search_path"), Contains.Substring("foo"));
}
[Test]
public async Task Set_options()
{
await using var dataSource = CreateDataSource(csb =>
csb.Options =
"-c default_transaction_isolation=serializable -c default_transaction_deferrable=on -c foo.bar=My\\ Famous\\\\Thing");
await using var conn = await dataSource.OpenConnectionAsync();
Assert.That(await conn.ExecuteScalarAsync("SHOW default_transaction_isolation"), Is.EqualTo("serializable"));
Assert.That(await conn.ExecuteScalarAsync("SHOW default_transaction_deferrable"), Is.EqualTo("on"));
Assert.That(await conn.ExecuteScalarAsync("SHOW foo.bar"), Is.EqualTo("My Famous\\Thing"));
}
[Test]
public async Task Connector_not_initialized_exception()
{
var command = new NpgsqlCommand();
command.CommandText = @"SELECT 123";
for (var i = 0; i < 2; i++)
{
await using var connection = await OpenConnectionAsync();
command.Connection = connection;
await using var tx = await connection.BeginTransactionAsync();
await command.ExecuteScalarAsync();
await tx.CommitAsync();
}
}
[Test]
public void Bug1011001()
{
//[#1011001] Bug in NpgsqlConnectionStringBuilder affects on cache and connection pool
var csb1 = new NpgsqlConnectionStringBuilder(@"Server=server;Port=5432;User Id=user;Password=passwor;Database=database;");
var cs1 = csb1.ToString();
var csb2 = new NpgsqlConnectionStringBuilder(cs1);
var cs2 = csb2.ToString();
Assert.That(cs1 == cs2);
}
[Test, IssueLink("https://github.com/npgsql/npgsql/pull/164")]
public void Connection_State_is_Closed_when_disposed()
{
var c = new NpgsqlConnection();
c.Dispose();
Assert.That(c.State, Is.EqualTo(ConnectionState.Closed));
}
[Test]
public void Change_ApplicationName_with_connection_string_builder()
{
// Test for issue #165 on github.
var builder = new NpgsqlConnectionStringBuilder();
builder.ApplicationName = "test";
}
[Test, Description("Makes sure notices are probably received and emitted as events")]
public async Task Notice()
{
// Make sure messages are in English
await using var dataSource = CreateDataSource(csb => csb.Options = "-c lc_messages=en_US.UTF-8");
await using var conn = await dataSource.OpenConnectionAsync();
var function = await GetTempFunctionName(conn);
await conn.ExecuteNonQueryAsync($@"
CREATE OR REPLACE FUNCTION {function}() RETURNS VOID AS
'BEGIN RAISE NOTICE ''testnotice''; END;'
LANGUAGE 'plpgsql'");
var mre = new ManualResetEvent(false);
PostgresNotice? notice = null;
NoticeEventHandler action = (sender, args) =>
{
notice = args.Notice;
mre.Set();
};
conn.Notice += action;
try
{
// See docs for CreateSleepCommand
await conn.ExecuteNonQueryAsync($"SELECT {function}()::TEXT");
mre.WaitOne(5000);
Assert.That(notice, Is.Not.Null, "No notice was emitted");
Assert.That(notice!.MessageText, Is.EqualTo("testnotice"));