forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathExceptionTests.cs
More file actions
212 lines (185 loc) · 8.74 KB
/
ExceptionTests.cs
File metadata and controls
212 lines (185 loc) · 8.74 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
using System;
using System.Collections;
using System.Data;
using System.IO;
using System.Net.Sockets;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Formatters.Binary;
using System.Threading.Tasks;
using NUnit.Framework;
using static Npgsql.Tests.TestUtil;
namespace Npgsql.Tests;
public class ExceptionTests : TestBase
{
[Test, Description("Generates a basic server-side exception, checks that it's properly raised and populated")]
public void Basic()
{
// Make sure messages are in English
using var dataSource = CreateDataSource(csb => csb.Options = "-c lc_messages=en_US.UTF-8");
using var conn = dataSource.OpenConnection();
conn.ExecuteNonQuery(
"""
CREATE OR REPLACE FUNCTION pg_temp.emit_exception() RETURNS VOID AS
'BEGIN RAISE EXCEPTION ''testexception'' USING ERRCODE = ''12345'', DETAIL = ''testdetail''; END;'
LANGUAGE 'plpgsql';
""");
PostgresException ex = null!;
try
{
conn.ExecuteNonQuery("SELECT pg_temp.emit_exception()");
Assert.Fail("No exception was thrown");
}
catch (PostgresException e)
{
ex = e;
}
Assert.That(ex.MessageText, Is.EqualTo("testexception"));
Assert.That(ex.Severity, Is.EqualTo("ERROR"));
Assert.That(ex.InvariantSeverity, Is.EqualTo("ERROR"));
Assert.That(ex.SqlState, Is.EqualTo("12345"));
Assert.That(ex.Position, Is.EqualTo(0));
Assert.That(ex.Message, Does.StartWith("12345: testexception"));
var data = ex.Data;
Assert.That(data[nameof(PostgresException.Severity)], Is.EqualTo("ERROR"));
Assert.That(data[nameof(PostgresException.SqlState)], Is.EqualTo("12345"));
Assert.That(data.Contains(nameof(PostgresException.Position)), Is.False);
var exString = ex.ToString();
Assert.That(exString, Does.StartWith("Npgsql.PostgresException (0x80004005): 12345: testexception"));
Assert.That(exString, Contains.Substring(nameof(PostgresException.Severity) + ": ERROR"));
Assert.That(exString, Contains.Substring(nameof(PostgresException.SqlState) + ": 12345"));
Assert.That(conn.ExecuteScalar("SELECT 1"), Is.EqualTo(1), "Connection in bad state after an exception");
}
[Test, Description("Ensures Detail is redacted by default in PostgresException and PostgresNotice")]
public async Task Error_details_are_redacted()
{
await using var conn = await OpenConnectionAsync();
var raiseExceptionFunc = await GetTempFunctionName(conn);
var raiseNoticeFunc = await GetTempFunctionName(conn);
await conn.ExecuteNonQueryAsync($@"
CREATE OR REPLACE FUNCTION {raiseExceptionFunc}() RETURNS VOID AS $$
BEGIN
RAISE EXCEPTION 'testexception' USING DETAIL = 'secret';
END;
$$ LANGUAGE 'plpgsql';
CREATE OR REPLACE FUNCTION {raiseNoticeFunc}() RETURNS VOID AS $$
BEGIN
RAISE NOTICE 'testexception' USING DETAIL = 'secret';
END;
$$ LANGUAGE 'plpgsql';");
var ex = Assert.ThrowsAsync<PostgresException>(() => conn.ExecuteNonQueryAsync($"SELECT * FROM {raiseExceptionFunc}()"))!;
Assert.That(ex.Detail, Does.Not.Contain("secret"));
Assert.That(ex.Message, Does.Not.Contain("secret"));
Assert.That(ex.Data[nameof(PostgresException.Detail)], Does.Not.Contain("secret"));
Assert.That(ex.ToString(), Does.Not.Contain("secret"));
PostgresNotice? notice = null;
conn.Notice += (___, a) => notice = a.Notice;
await conn.ExecuteNonQueryAsync($"SELECT * FROM {raiseNoticeFunc}()");
Assert.That(notice!.Detail, Does.Not.Contain("secret"));
}
[Test]
public async Task IncludeErrorDetail()
{
await using var dataSource = CreateDataSource(csb => csb.IncludeErrorDetail = true);
await using var conn = await dataSource.OpenConnectionAsync();
var raiseExceptionFunc = await GetTempFunctionName(conn);
var raiseNoticeFunc = await GetTempFunctionName(conn);
await conn.ExecuteNonQueryAsync($@"
CREATE OR REPLACE FUNCTION {raiseExceptionFunc}() RETURNS VOID AS $$
BEGIN
RAISE EXCEPTION 'testexception' USING DETAIL = 'secret';
END;
$$ LANGUAGE 'plpgsql';
CREATE OR REPLACE FUNCTION {raiseNoticeFunc}() RETURNS VOID AS $$
BEGIN
RAISE NOTICE 'testexception' USING DETAIL = 'secret';
END;
$$ LANGUAGE 'plpgsql';");
var ex = Assert.ThrowsAsync<PostgresException>(() => conn.ExecuteNonQueryAsync($"SELECT * FROM {raiseExceptionFunc}()"))!;
Assert.That(ex.Detail, Does.Contain("secret"));
Assert.That(ex.Message, Does.Contain("secret"));
Assert.That(ex.Data[nameof(PostgresException.Detail)], Does.Contain("secret"));
Assert.That(ex.ToString(), Does.Contain("secret"));
PostgresNotice? notice = null;
conn.Notice += (____, a) => notice = a.Notice;
await conn.ExecuteNonQueryAsync($"SELECT * FROM {raiseNoticeFunc}()");
Assert.That(notice!.Detail, Does.Contain("secret"));
}
[Test]
public async Task Error_position()
{
await using var conn = await OpenConnectionAsync();
var ex = Assert.ThrowsAsync<PostgresException>(() => conn.ExecuteNonQueryAsync("SELECT 1; SELECT * FROM \"NonExistingTable\""))!;
Assert.That(ex.Message, Does.Contain("POSITION: 15"));
}
[Test]
public void Exception_fields_are_populated()
{
using var conn = OpenConnection();
TestUtil.MinimumPgVersion(conn, "9.3.0", "5 error fields haven't been added yet");
conn.ExecuteNonQuery("CREATE TEMP TABLE uniqueviolation (id INT NOT NULL, CONSTRAINT uniqueviolation_pkey PRIMARY KEY (id))");
conn.ExecuteNonQuery("INSERT INTO uniqueviolation (id) VALUES(1)");
try
{
conn.ExecuteNonQuery("INSERT INTO uniqueviolation (id) VALUES(1)");
}
catch (PostgresException ex)
{
Assert.That(ex.ColumnName, Is.Null, "ColumnName should not be populated for unique violations");
Assert.That(ex.TableName, Is.EqualTo("uniqueviolation"));
Assert.That(ex.SchemaName, Does.StartWith("pg_temp"));
Assert.That(ex.ConstraintName, Is.EqualTo("uniqueviolation_pkey"));
Assert.That(ex.DataTypeName, Is.Null, "DataTypeName should not be populated for unique violations");
}
}
[Test]
public void Column_name_exception_field_is_populated()
{
using var conn = OpenConnection();
TestUtil.MinimumPgVersion(conn, "9.3.0", "5 error fields haven't been added yet");
conn.ExecuteNonQuery("CREATE TEMP TABLE notnullviolation (id INT NOT NULL)");
try
{
conn.ExecuteNonQuery("INSERT INTO notnullviolation (id) VALUES(NULL)");
}
catch (PostgresException ex)
{
Assert.That(ex.SchemaName, Does.StartWith("pg_temp"));
Assert.That(ex.TableName, Is.EqualTo("notnullviolation"));
Assert.That(ex.ColumnName, Is.EqualTo("id"));
}
}
[Test]
public async Task DataTypeName_is_populated()
{
// On reading the source code for PostgreSQL9.3beta1, the only time that the
// datatypename field is populated is when using domain types. So here we'll
// create a domain that simply does not allow NULLs then try and cast NULL
// to it.
await using var conn = await OpenConnectionAsync();
MinimumPgVersion(conn, "9.3.0", "5 error fields haven't been added yet");
var domainName = await GetTempTypeName(conn);
await conn.ExecuteNonQueryAsync($"CREATE DOMAIN {domainName} AS INT NOT NULL");
var pgEx = Assert.ThrowsAsync<PostgresException>(async () => await conn.ExecuteNonQueryAsync($"SELECT CAST(NULL AS {domainName})"))!;
Assert.That(pgEx.SqlState, Is.EqualTo(PostgresErrorCodes.NotNullViolation));
Assert.That(pgEx.SchemaName, Is.EqualTo("public"));
Assert.That(pgEx.DataTypeName, Is.EqualTo(domainName));
}
[Test]
public void NpgsqlException_with_async()
{
using var conn = OpenConnection();
Assert.That(async () => await conn.ExecuteNonQueryAsync("MALFORMED"),
Throws.Exception.TypeOf<PostgresException>());
// Just in case, anything but a PostgresException would trigger the connection breaking, check that
Assert.That(conn.FullState, Is.EqualTo(ConnectionState.Open));
}
[Test]
public void NpgsqlException_IsTransient()
{
Assert.That(new NpgsqlException("", new IOException()).IsTransient);
Assert.That(new NpgsqlException("", new SocketException()).IsTransient);
Assert.That(new NpgsqlException("", new TimeoutException()).IsTransient);
Assert.That(new NpgsqlException().IsTransient, Is.False);
Assert.That(new NpgsqlException("", new Exception("Inner Exception")).IsTransient, Is.False);
}
}